Type Block need handle attribute marked as removed contionally. #359
Conversation
This file contains hidden or 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
|
This should fix hashicorp/terraform-provider-azurerm#5819. |
|
We have recently pushed V2's history to |
magodo
force-pushed
the
set_resource_manipulate_removed
branch
from
c2ff9a0 to
dc7dc61
Compare
In some provider, e.g. AzureRM, TypeSet is use quite prevalent to hold a set of sub-resources (e.g. security_rule in azurerm_network_security_group). The reason for using TypeSet instead of TypeList might because service return a collection of info with arbitrary order, or other reasons. In this case: Given a slice of nested blocks, if one of the nested block (B1) attributes is optional and has no default value, and user didn't specify a value for it. Then if another nested block (B2) changed, which triggers some diff, then B1 will also be replaced. That is because the optional attribute contribute a diff of "zero value" -> `null`, which changed the hash of the block. This fix is to carefully handle this case. We keep attribute marked as `NewRemoved` after a `diffString` only when all the attributes are marked as such. Otherwise, as long as one attribute is not marked to be removed, that means this block will be kept. Then we will manipulate the attributes in this block, which being marked as removed just because user didn't specify a value and the original value is the zero value. This keeps consistent as other Resource types (e.g. List Resource). (Though those type just remove the attribute from diff set, while for Set we need to return the complete state as we will not depend on the old state during diff apply).
magodo
force-pushed
the
set_resource_manipulate_removed
branch
from
dc7dc61 to
b6e3d58
Compare
The state representation will only store the primary values, hence we only need to take care of those.
|
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
In some provider, e.g. AzureRM, TypeSet is use quite prevalent to
hold a set of sub-resources (e.g. security_rule in azurerm_network_security_group).
The reason for using TypeSet instead of TypeList might because service
return a collection of info with arbitrary order, or other reasons.
In this case: Given a slice of nested blocks, if one of the nested block (B1)
attributes is optional and has no default value, and user didn't specify a value
for it. Then if another nested block (B2) changed, which triggers some diff,
then B1 will also be replaced. That is because the optional attribute
contribute a diff of "zero value" ->
null, which changed the hash ofthe block.
This fix is to carefully handle this case. We keep attribute marked
as
NewRemovedafter adiffStringonly when all the attributes aremarked as such. Otherwise, as long as one attribute is not marked to be
removed, that means this block will be kept. Then we will manipulate the
attributes in this block, which being marked as removed just because
user didn't specify a value and the original value is the zero value.
This keeps consistent as other Resource types (e.g. List Resource).
(Though those type just remove the attribute from diff set, while for
Set we need to return the complete state as we will not depend on the
old state during diff apply).
Fixes: