Skip to content

fix(streaming): deprecate name and description in evaluation snapshot#5990

Merged
kodiakhq[bot] merged 1 commit into
v2from
rd/v2/stream-without-name-desc
Jun 8, 2026
Merged

fix(streaming): deprecate name and description in evaluation snapshot#5990
kodiakhq[bot] merged 1 commit into
v2from
rd/v2/stream-without-name-desc

Conversation

@erka

@erka erka commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

Stop populating name and description fields on EvaluationFlag and EvaluationSegment in evaluation snapshot responses. These fields are marked deprecated in the protobuf schema and are no longer set by the
snapshot builder, reducing the surface of internal information exposed to evaluation clients.

Backward compatible: deprecated fields remain in the wire format but will always be empty strings.

closes: #5989

@github-actions

github-actions Bot commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

The latest Buf updates on your PR. Results from workflow Proto / proto-lint (pull_request).

BuildFormatLintBreakingUpdated (UTC)
✅ passed✅ passed✅ passed✅ passedJun 8, 2026, 6:16 PM

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Verdict: approve

Clean, focused change that safely removes internal flag and segment metadata from evaluation snapshots while preserving backward compatibility through proto field deprecation. No issues found.

🤖 Automated review by the Flipt PR review agent.

@codecov

codecov Bot commented Jun 8, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 61.40%. Comparing base (9ebef94) to head (eaa323e).
⚠️ Report is 1 commits behind head on v2.

Additional details and impacted files
@@            Coverage Diff             @@
##               v2    #5990      +/-   ##
==========================================
- Coverage   61.41%   61.40%   -0.02%     
==========================================
  Files         142      142              
  Lines       14265    14261       -4     
==========================================
- Hits         8761     8757       -4     
  Misses       4770     4770              
  Partials      734      734              
Flag Coverage Δ
integrationtests 34.49% <100.00%> (-0.02%) ⬇️
unittests 52.47% <100.00%> (-0.02%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@erka
erka force-pushed the rd/v2/stream-without-name-desc branch from f04b3bb to c303a46 Compare June 8, 2026 13:41
@erka erka added bug v2 Flipt v2 labels Jun 8, 2026
@erka
erka marked this pull request as ready for review June 8, 2026 13:43
@erka
erka requested a review from a team as a code owner June 8, 2026 13:43
@dosubot dosubot Bot added the size:M This PR changes 30-99 lines, ignoring generated files. label Jun 8, 2026

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Verdict: comment

The PR cleanly removes deprecated name and description fields from evaluation snapshots, but the new buf format --write --exit-code line in the go:fmt task will fail after formatting proto files due to the --exit-code flag interacting with set -e.

.mise.toml

  • minor (L217): buf format --write --exit-code exits with code 1 after it rewrites files. Because the script uses set -euo pipefail, the go:fmt task will report failure the first time a developer runs it after modifying an unformatted proto file, even though the formatter succeeded. This is inconsistent with golangci-lint fmt (which exits 0 after writing) and creates a confusing local dev experience. Remove --exit-code from the formatting command, or move proto formatting to a separate proto:fmt task.

🤖 Automated review by the Flipt PR review agent.

@erka
erka force-pushed the rd/v2/stream-without-name-desc branch from c303a46 to fca3779 Compare June 8, 2026 13:52

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Verdict: comment

The snapshot changes are clean and backward-compatible. The only remaining issue is the addition of buf format --write --exit-code in the go:fmt task, which will cause the task to fail when it actually rewrites proto files due to set -e.

.mise.toml

  • minor (L216): The new buf format --write --exit-code command exits with code 1 when it rewrites a file. Because the script uses set -euo pipefail, the go:fmt task will fail the first time a developer runs it after modifying an unformatted proto file, even though the formatter succeeded. This is inconsistent with golangci-lint fmt (which exits 0 after writing) and creates a confusing local dev experience. Remove --exit-code from the formatting command.

🤖 Automated review by the Flipt PR review agent.

Stop populating name and description fields on EvaluationFlag and
EvaluationSegment in evaluation snapshot responses. These fields are
marked deprecated in the protobuf schema and are no longer set by the
snapshot builder, reducing the surface of internal information exposed
to evaluation clients.

Backward compatible: deprecated fields remain in the wire format but
will always be empty strings.

Signed-off-by: Roman Dmytrenko <[email protected]>
@erka
erka force-pushed the rd/v2/stream-without-name-desc branch from fca3779 to eaa323e Compare June 8, 2026 14:07

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Verdict: approve

Looks good — no changes requested.

🤖 Automated review by the Flipt PR review agent.

@markphelps markphelps left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

lgtm!

@erka erka added the automerge Used by Kodiak bot to automerge PRs label Jun 8, 2026
@kodiakhq
kodiakhq Bot merged commit f5bf5e9 into v2 Jun 8, 2026
38 checks passed
@kodiakhq
kodiakhq Bot deleted the rd/v2/stream-without-name-desc branch June 8, 2026 18:16
@github-project-automation github-project-automation Bot moved this to Done in Flipt V2 Jun 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automerge Used by Kodiak bot to automerge PRs bug size:M This PR changes 30-99 lines, ignoring generated files. v2 Flipt v2

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Support metadata on segments (similar to flag metadata)

2 participants