Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Guard against empty inputs for objs expressions. #11311

Merged
merged 3 commits into from Nov 15, 2022
Merged

Conversation

RobbieMcKinstry
Copy link
Contributor

@RobbieMcKinstry RobbieMcKinstry commented Nov 9, 2022

Description

@dirien raised an issue where tfgen would panic converting PCL under an edge case where an ObjectExpression had nil arguments. By introducing this guard, we skip annotating the the Object with the type provided by the schema the function in the schema has no args.

S/o to @Zaid-Ajaj for explaining this code to me and confirming the kill. I was lost without his aid!

Fixes #11305

Checklist

  • I have added tests that prove my fix is effective or that my feature works
  • I have run make changelog and committed the changelog/pending/<file> documenting my change
  • Yes, there are changes in this PR that warrants bumping the Pulumi Service API version

@RobbieMcKinstry RobbieMcKinstry added kind/bug Some behavior is incorrect or out of spec area/providers impact/panic This bug represents a panic or unexpected crash labels Nov 9, 2022
@pulumi-bot
Copy link
Contributor

pulumi-bot commented Nov 9, 2022

Changelog

[uncommitted] (2022-11-14)

Bug Fixes

  • [pkg] Fix a panic in codegen for an edge case involving object expressions without corresponding function arguments.
    #11311

@RobbieMcKinstry RobbieMcKinstry marked this pull request as ready for review November 9, 2022 19:51
@RobbieMcKinstry
Copy link
Contributor Author

These test failures look legit. :(

@RobbieMcKinstry
Copy link
Contributor Author

I'm going to come back to this tomorrow. Putting this down for now to clear my head a bit 👍🏻

@Zaid-Ajaj
Copy link
Contributor

@RobbieMcKinstry this failure:

=== FAIL: codegen/python TestFunctionInvokeBindsArgumentObjectType (re-run 1) (0.07s)
    gen_program_test.go:35: 
        	Error Trace:	/home/runner/work/pulumi/pulumi/pkg/codegen/python/gen_program_test.go:35
        	Error:      	Should NOT be empty, but was []
        	Test:       	TestFunctionInvokeBindsArgumentObjectType
        	Messages:   	Object type should be annotated with a schema type

is because the unit test I wrote before used an empty object as input for the function which is what the new code guards against 😅 the check len(argsObject.Items) > 0 && fn.Inputs != nil might be too strict actually and can be safely reduced to just fn.Inputs != nil

@RobbieMcKinstry
Copy link
Contributor Author

bors r+

bors bot added a commit that referenced this pull request Nov 14, 2022
11311: Guard against empty inputs for objs expressions. r=RobbieMcKinstry a=RobbieMcKinstry

<!--- 
Thanks so much for your contribution! If this is your first time contributing, please ensure that you have read the [CONTRIBUTING](https://github.com/pulumi/pulumi/blob/master/CONTRIBUTING.md) documentation.
-->

# Description

`@dirien` raised an issue where tfgen would panic converting PCL under an edge case where an `ObjectExpression` had `nil` arguments. By introducing this guard, we skip annotating the the Object with the type provided by the schema the function in the schema has no args.

S/o to `@Zaid-Ajaj` for explaining this code to me and confirming the kill. I was lost without his aid! 

<!--- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. -->

Fixes #11305

## Checklist

<!--- Please provide details if the checkbox below is to be left unchecked. -->
- [ ] I have added tests that prove my fix is effective or that my feature works
<!--- 
User-facing changes require a CHANGELOG entry.
-->
- [x] I have run `make changelog` and committed the `changelog/pending/<file>` documenting my change
<!--
If the change(s) in this PR is a modification of an existing call to the Pulumi Service,
then the service should honor older versions of the CLI where this change would not exist.
You must then bump the API version in /pkg/backend/httpstate/client/api.go, as well as add
it to the service.
-->
- [ ] Yes, there are changes in this PR that warrants bumping the Pulumi Service API version
  <!-- `@Pulumi` employees: If yes, you must submit corresponding changes in the service repo. -->


Co-authored-by: Robbie McKinstry <robbie@pulumi.com>
@bors
Copy link
Contributor

bors bot commented Nov 15, 2022

Build failed:

@RobbieMcKinstry
Copy link
Contributor Author

bors retry

bors bot added a commit that referenced this pull request Nov 15, 2022
11311: Guard against empty inputs for objs expressions. r=RobbieMcKinstry a=RobbieMcKinstry

<!--- 
Thanks so much for your contribution! If this is your first time contributing, please ensure that you have read the [CONTRIBUTING](https://github.com/pulumi/pulumi/blob/master/CONTRIBUTING.md) documentation.
-->

# Description

`@dirien` raised an issue where tfgen would panic converting PCL under an edge case where an `ObjectExpression` had `nil` arguments. By introducing this guard, we skip annotating the the Object with the type provided by the schema the function in the schema has no args.

S/o to `@Zaid-Ajaj` for explaining this code to me and confirming the kill. I was lost without his aid! 

<!--- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. -->

Fixes #11305

## Checklist

<!--- Please provide details if the checkbox below is to be left unchecked. -->
- [ ] I have added tests that prove my fix is effective or that my feature works
<!--- 
User-facing changes require a CHANGELOG entry.
-->
- [x] I have run `make changelog` and committed the `changelog/pending/<file>` documenting my change
<!--
If the change(s) in this PR is a modification of an existing call to the Pulumi Service,
then the service should honor older versions of the CLI where this change would not exist.
You must then bump the API version in /pkg/backend/httpstate/client/api.go, as well as add
it to the service.
-->
- [ ] Yes, there are changes in this PR that warrants bumping the Pulumi Service API version
  <!-- `@Pulumi` employees: If yes, you must submit corresponding changes in the service repo. -->


Co-authored-by: Robbie McKinstry <robbie@pulumi.com>
@bors
Copy link
Contributor

bors bot commented Nov 15, 2022

Build failed:

@RobbieMcKinstry
Copy link
Contributor Author

bors retry

@RobbieMcKinstry
Copy link
Contributor Author

Three instances of network connection, 500 error from NPM.

@bors
Copy link
Contributor

bors bot commented Nov 15, 2022

Build succeeded:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/providers impact/panic This bug represents a panic or unexpected crash kind/bug Some behavior is incorrect or out of spec
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Unable to convert HCL example
3 participants