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.

Sign up for GitHub

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

Jump to bottom

Use nil checks for defaults when applicable #12099

Merged
merged 1 commit into from Feb 9, 2023
Merged

Use nil checks for defaults when applicable #12099

merged 1 commit into from Feb 9, 2023

Conversation

iwahbe
Copy link
Member

@iwahbe iwahbe commented Feb 8, 2023 •
edited

Fixes #12106

Description

We can see some passed values not respected when applying default values to interface types when the value passed to the interface is a plan value.

type Args struct {
  Field pulumi.BoolPtrInput // default: true in the schema
}

(&Args{ Field: pulumi.BoolPtr(false) }).Defaults().Field // False
(&Args{ Field: pulumi.Bool(false) }).Defaults().Field // True

See https://go.dev/play/p/aiuA7Jzy0mH for a complete example.

We can fix this by switching the internal check of Defaults() to use a == nil check when an interface is being checked.

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

@iwahbe iwahbe self-assigned this Feb 8, 2023
@pulumi-bot
Copy link
Contributor

pulumi-bot commented Feb 8, 2023 •
edited

Changelog

[uncommitted] (2023-02-09)

Bug Fixes

  • [sdkgen/go] Prevent defaults from overriding set values.
    #12099

abhinav
abhinav reviewed Feb 8, 2023
View reviewed changes
Copy link
Contributor

@abhinav abhinav left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Outside of the generated code, do we have a test exercising the actual generated behavior we want? Specifically, the behavior you have in the PR description against a generated test type?

@iwahbe
Copy link
Member Author

iwahbe commented Feb 8, 2023 •
edited

Outside of the generated code, do we have a test exercising the actual generated behavior we want? Specifically, the behavior you have in the PR description against a generated test type?

No, but there should be such a test. I'll add it.

@iwahbe iwahbe requested a review from abhinav February 8, 2023 22:42
abhinav
abhinav approved these changes Feb 8, 2023
View reviewed changes
Copy link
Contributor

@abhinav abhinav left a comment •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the test!
Made a couple minor tweaks but LGTM. Would recommend squashing the commits before merging since.

@iwahbe
Copy link
Member Author

iwahbe commented Feb 8, 2023

bors r+

@bors
Copy link
Contributor

bors bot commented Feb 8, 2023

🕐 Waiting for PR status (GitHub check) to be set, probably by CI. Bors will automatically try to run when all required PR statuses are set.

bors bot added a commit that referenced this pull request Feb 8, 2023
@bors @iwahbe
Merge #12099
d83e40f 
12099: Use `nil` checks for defaults when applicable r=iwahbe a=iwahbe

<!--- 
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.
-->

Fixes #12106

# Description

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

We can see some passed values not respected when applying default values to interface types when the value passed to the interface is a plan value.

```go
type Args struct {
  Field pulumi.BoolPtrInput // default: true in the schema
}

(&Args{ Field: pulumi.BoolPtr(false) }).Defaults().Field // False
(&Args{ Field: pulumi.Bool(false) }).Defaults().Field // True
```

See https://go.dev/play/p/aiuA7Jzy0mH for a complete example.

We can fix this by switching the internal check of `Defaults()` to use a `== nil` check when an interface is being checked.

## 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.
-->
- [ ] 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: Ian Wahbe <ian@wahbe.com>
@bors
Copy link
Contributor

bors bot commented Feb 9, 2023

Build failed:

@abhinav
Copy link
Contributor

abhinav commented Feb 9, 2023 

        	            	Diff:
        	            	--- Expected
        	            	+++ Actual
        	            	@@ -418,4 +418,10 @@
        	            	 
        	            	+        __props__.__dict__["optional_bool"] = None
        	            	         return ModuleResource(resource_name, opts=opts, __props__=__props__)
        	            	 
        	            	-
        	            	+    @property
        	            	+    @pulumi.getter
        	            	+    def optional_bool(self) -> pulumi.Output[Optional[bool]]:
        	            	+        return pulumi.get(self, "optional_bool")
        	            	+
        	            	+
        	Test:       	TestGeneratePackage/plain-and-default
        	Messages:   	pulumi_foobar/module_resource.py
    helpers.go:155: pulumi_foobar/module_resource.py did not agree

Might need to regenerate

@iwahbe
Use nil checks when appropriate
e15d0c5 
Regnerate tests

Add behavior test
@iwahbe
Copy link
Member Author

iwahbe commented Feb 9, 2023

bors r+

@bors
Copy link
Contributor

bors bot commented Feb 9, 2023

🕐 Waiting for PR status (GitHub check) to be set, probably by CI. Bors will automatically try to run when all required PR statuses are set.

bors bot added a commit that referenced this pull request Feb 9, 2023
@bors @iwahbe
Merge #12099
d8406f8 
12099: Use `nil` checks for defaults when applicable r=iwahbe a=iwahbe

<!--- 
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.
-->

Fixes #12106

# Description

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

We can see some passed values not respected when applying default values to interface types when the value passed to the interface is a plan value.

```go
type Args struct {
  Field pulumi.BoolPtrInput // default: true in the schema
}

(&Args{ Field: pulumi.BoolPtr(false) }).Defaults().Field // False
(&Args{ Field: pulumi.Bool(false) }).Defaults().Field // True
```

See https://go.dev/play/p/aiuA7Jzy0mH for a complete example.

We can fix this by switching the internal check of `Defaults()` to use a `== nil` check when an interface is being checked.

## 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.
-->
- [ ] 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: Ian Wahbe <ian@wahbe.com>
@bors
Copy link
Contributor

bors bot commented Feb 9, 2023

Build failed:

@iwahbe
Copy link
Member Author

iwahbe commented Feb 9, 2023

bors retry

@bors
Copy link
Contributor

bors bot commented Feb 9, 2023

Build succeeded:

  • bors-ok

@bors bors bot merged commit 5578294 into master Feb 9, 2023
@bors bors bot deleted the iwahbe/default-nil-checks branch February 9, 2023 04:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@abhinav abhinav abhinav approved these changes

@jazzyfresh jazzyfresh jazzyfresh approved these changes

@Zaid-Ajaj Zaid-Ajaj Awaiting requested review from Zaid-Ajaj

@AaronFriel AaronFriel Awaiting requested review from AaronFriel

Assignees

@iwahbe iwahbe

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Go Object default: true doesn't allow setting to false
5 participants
@iwahbe @pulumi-bot @abhinav @AaronFriel @jazzyfresh