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

Deprecation proposal: Block build-id as a search attribute #6494

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

Shivs11
Copy link
Member

@Shivs11 Shivs11 commented Sep 6, 2024

What changed?

  • Adds a log with the WARN level for Search Attributes having BuildIds set.
  • Only a log statement has been added, for now, since rejecting such requests would mean breaking changes for current customers writing them.
  • Thus, for now, we should notify them that this change is going to take place and plan in which version we deprecate moving forward, to reject such requests.

Why?

  • BuildIds is a default SA and should not be set by the customer.

How did you test it?

  • added unit tests
  • existing suite of tests

Potential risks

none, just a logging statement is being added for now.

Is hotfix candidate?

nope

@@ -118,7 +122,9 @@ func (v *Validator) Validate(searchAttributes *commonpb.SearchAttributes, namesp
fmt.Sprintf("%s attribute can't be set in SearchAttributes", saFieldName),
)
}

if saFieldName == BuildIds {
Copy link
Member Author

Choose a reason for hiding this comment

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

We cannot reject all the predefined attributes, in a similar way system attributes are rejected, because there are some which are considered valid in requests. (For example - TemporalChangeVersion)

@Shivs11 Shivs11 marked this pull request as ready for review September 7, 2024 14:49
@Shivs11 Shivs11 requested a review from a team as a code owner September 7, 2024 14:49
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.

1 participant