tfsdk: Migrate RequiresReplace(), RequiresReplaceIf(), and UseStateForUnknown() plan modifier functions to the resource package
#434
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ateForUnknown()` plan modifier functions to the `resource` package Reference: #132 Reference: #365 Reference: #366 Reference: #432 Plan modification in the framework is a concept that only applies to managed resources via the protocol `PlanResourceChange` RPC. Following the migration of other `tfsdk` package types into separate `datasource`, `provider`, and `resource` packages, this change migrates the `RequiresReplace()`, `RequiresReplaceIf()` and `UseStateForUnknown()` plan modifier functions into the `resource` package. This change should be bundled in the same release as the package refactoring since it is similar in nature. This change has two immediate benefits: - Aligning the Go package placement tof these functions o hint to provider developers that these are only intended for managed resources. - For future refactoring this removes additional schema-based code imports from the `tfsdk` package, which could enable refactoring the schema logic into internal packages with potentially less breaking changes for provider developers by removing a source of import cycles. Provider developers should be able to update their code using find and replace operations using the table below: | Prior tfsdk Package Function | New resource Package Function | | --- | --- | | `tfsdk.RequiresReplace` | `resource.RequiresReplace` | | `tfsdk.RequiresReplaceIf` | `resource.RequiresReplaceIf` | | `tfsdk.UseStateForUnknown` | `resource.UseStateForUnknown` | To reduce framework maintainer review burden, this code migrations was primarily a lift and shift operation while most code and documentation updates were find and replace operations. The modifier types were unexported as exposing them should not be beneficial for provider developers and should help reduce the Go documentation surface area. The plan modifier unit testing was updated to use a `_test` package so it is verifying only exported functionality.
bflad
added
breaking-change
bflad
added a commit
to hashicorp/terraform-provider-corner
that referenced
this pull request
Aug 2, 2022
… package Reference: hashicorp/terraform-plugin-framework#434 Updated via: ```shell go get github.com/hashicorp/terraform-plugin-framework@a49c78775f1b82a054a4e2a0904375f95134873e go mod tidy ```
|
terraform-provider-corner changes: hashicorp/terraform-provider-corner#83 |
|
Just to explicitly say it out loud since I didn't mention in the original description, we cannot move |
bflad
added a commit
to hashicorp/terraform-provider-corner
that referenced
this pull request
Aug 2, 2022
… package (#83) Reference: hashicorp/terraform-plugin-framework#434 Updated via: ```shell go get github.com/hashicorp/terraform-plugin-framework@51b944f8a359e8ca29efc8d22c6843a7deedfad9 go mod tidy ```
ewbankkit
added a commit
to hashicorp/terraform-provider-awscc
that referenced
this pull request
Aug 18, 2022
|
I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reference: #132
Reference: #365
Reference: #366
Reference: #432
Plan modification in the framework is a concept that only applies to managed resources via the protocol
PlanResourceChangeRPC. Following the migration of othertfsdkpackage types into separatedatasource,provider, andresourcepackages, this change migrates theRequiresReplace(),RequiresReplaceIf()andUseStateForUnknown()plan modifier functions into theresourcepackage. This change should be bundled in the same release as the package refactoring since it is similar in nature.This change has two immediate benefits:
tfsdkpackage, which could enable refactoring the schema logic into internal packages with potentially less breaking changes for provider developers by removing a source of import cycles.Provider developers should be able to update their code using find and replace operations using the table below:
tfsdk.RequiresReplaceresource.RequiresReplacetfsdk.RequiresReplaceIfresource.RequiresReplaceIftfsdk.UseStateForUnknownresource.UseStateForUnknownTo reduce framework maintainer review burden, this code migrations was primarily a lift and shift operation while most code and documentation updates were find and replace operations. The modifier types were unexported as exposing them should not be beneficial for provider developers and should help reduce the Go documentation surface area. The plan modifier unit testing was updated to use a
_testpackage so it is verifying only exported functionality.