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

Warn against using emptyOrUnsetBlockDiffSuppress #6595

Merged
merged 2 commits into from
Sep 22, 2022

Conversation

rileykarson
Copy link
Member

After #6546 fixed some GKE problems, I dug into emptyOrUnsetBlockDiffSuppress a bit. I think we should recommend against using it- it's harder to understand, and is only used in two places so far.

I think what it really does is allow a user to specify an empty block when the API returns nil, which is pretty different than what O+C does. But it reads like an O+C replacement initially (and it somewhat is one). Also, I think it behaves weirdly with some values returned from the API.

If this PR is for Terraform, I acknowledge that I have:

  • Searched through the issue tracker for an open issue that this either resolves or contributes to, commented on it to claim it, and written "fixes {url}" or "part of {url}" in this PR description. If there were no relevant open issues, I opened one and commented that I would like to work on it (not necessary for very small changes).
  • Generated Terraform, and ran make test and make lint to ensure it passes unit and linter tests.
  • Ensured that all new fields I added that can be set by a user appear in at least one example (for generated resources) or third_party test (for handwritten resources or update tests).
  • Ran relevant acceptance tests (If the acceptance tests do not yet pass or you are unable to run them, please let your reviewer know).
  • Read the Release Notes Guide before writing my release note below.

Release Note Template for Downstream PRs (will be copied)

Copy link
Member

@shuyama1 shuyama1 left a comment

Choose a reason for hiding this comment

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

Totally make sense! I think adding O+C plus some modifications to the expanders and flatteners should cover all the cases in emptyOrUnsetBlockDiffSuppress.

@modular-magician
Copy link
Collaborator

Hi! I'm the modular magician. Your PR generated some diffs in downstreams - here they are.

Diff report:

Terraform GA: Diff ( 1 file changed, 2 insertions(+))
Terraform Beta: Diff ( 1 file changed, 2 insertions(+))
TF Validator: Diff ( 2 files changed, 3 insertions(+), 3 deletions(-))

@rileykarson
Copy link
Member Author

rileykarson commented Sep 22, 2022

Yeah, specifically we'd want to return an empty object instead of nil if the API returned nil. We do that in a few places, but it wasn't how we wrote MMv1's expanders. Honestly not sure if that was for a good reason or not- we may have wanted to avoid O+C more strongly at the time or something, as nil works better when everything goes right.

@modular-magician
Copy link
Collaborator

The provider crashed while running the VCR tests in REPLAYING mode
Please fix it to complete your PR
View the build log

@shuyama1 shuyama1 mentioned this pull request Jun 13, 2023
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants