Skip to content

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

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

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

wants to merge 4 commits into from

Conversation

Shivs11
Copy link
Member

@Shivs11 Shivs11 commented May 12, 2025 •
edited
Loading

What changed?

  • A deprecation proposal to block the usage of build-id as a search attribute. Note, the changes introduced in this PR shall only emit warnings (for now) to analyze how many current users are actually doing this (expected number to be very low).
  • Once we have a confirmation that the number of users who are using this are low, I will send a follow-up to error out when buildID is used as a SA.

Why?

  • To prevent users from using pre-defined SA's.

How did you test it?

  • built
  • run locally and tested manually
  • covered by existing tests
  • added new unit test(s)
  • added new functional test(s)

@Shivs11 Shivs11 mentioned this pull request May 12, 2025
Closed
Shivs11
Shivs11 commented May 12, 2025
View reviewed changes
common/searchattribute/validator.go
@@ -94,7 +98,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 May 12, 2025 16:31
@Shivs11 Shivs11 requested a review from a team as a code owner May 12, 2025 16:31
rodrigozhou
rodrigozhou requested changes May 14, 2025
View reviewed changes
Copy link
Contributor

@rodrigozhou rodrigozhou left a comment

Choose a reason for hiding this comment

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

I would use logs as a way to measure how many users are using it. I'd suggest creating a new metric for it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rodrigozhou rodrigozhou rodrigozhou requested changes

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Shivs11 @rodrigozhou