Prefer KV tags, even when tags are defined as set #35937
Merged
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
brandonc
added
the
1.10-backport
brandonc
force-pushed
the
TF-21807-both-types-of-tags-are-duplicated-when-found-and-subsequently-updated-by-the-cli
branch
from
2a101a4
to
c1069f9
Compare
ctrombley
reviewed
Nov 5, 2024
internal/cloud/backend.go
Outdated
| if err != nil && errors.Is(err, tfe.ErrResourceNotFound) { | ||
| // By this time, the workspace should have been fetched, proving that the | ||
| // authenticated user has access to it. If the tag bindings are not found, | ||
| // it would mean that the backened does not support tag bindings. |
Comment on lines
+1186
to
+1193
| if workspaceMapping.IsTagsStrategy() { | ||
| for _, b := range workspaceMapping.asTFETagBindings() { | ||
| normalizedTagMap[b.Key] = b.Value | ||
| } | ||
|
|
||
| for tag, val := range workspaceMapping.TagsAsMap { | ||
| if existingVal, ok := existingTags[tag]; !ok || existingVal != val { | ||
| return true, nil | ||
| } else { | ||
| // Not a tag strategy | ||
| return | ||
| } |
There was a problem hiding this comment.
Consider moving the else case to the top of the method as a guard clause?
if !workspaceMapping.IsTagsStrategy() { return }
...| log.Printf("[TRACE] cloud: Checking tag %q=%q", k, v) | ||
| if v == "" { | ||
| // Tag can exist in legacy tags or tag bindings | ||
| if !slices.Contains(workspace.TagNames, k) || (result.supportsKVTags && !slices.ContainsFunc(bindings, func(b *tfe.TagBinding) bool { |
There was a problem hiding this comment.
Consider extracting and assigning the slice functions locally or elsewhere, for readability?
ctrombley
approved these changes
Nov 5, 2024
This will prevent duplicate workspace tags from being created when set tags are matched using kv bindings, or vice-versa.
brandonc
force-pushed
the
TF-21807-both-types-of-tags-are-duplicated-when-found-and-subsequently-updated-by-the-cli
branch
from
633346d
to
f41d5a5
Compare
brandonc
deleted the
TF-21807-both-types-of-tags-are-duplicated-when-found-and-subsequently-updated-by-the-cli
branch
|
Reminder for the merging maintainer: if this is a user-visible change, please update the changelog on the appropriate release branch. |
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.
Target Release
1.10.0
Fixes a bug in a the new cloud tags matching that duplicated tags in the backend when set tags are matched using kv bindings, or vice-versa.
In other words, if the workspace was found by set type tags in config, but the actual tags are KV tags, previously, terraform would detect that it should update the workspace with the tags unnecessarily, setting both workspace tags and kv tags. This also happens in the opposite sense: if kv tags are defined in config but matched to pre-existing workspace tags.
I changed the behavior to prefer setting kv tags if they are supported on the backend and evaluating both kinds of tags to determine if an update is needed, regardless of the desired tag provenance.