Skip to content

feat: Every SDK includes reason in responses for identity and environment flags - #87

Open
flagsmithsmith[bot] wants to merge 2 commits into
mainfrom
openhands/sdk-spec-v0.10.0
Open

flagsmithsmith[bot] wants to merge 2 commits into
mainfrom
openhands/sdk-spec-v0.10.0

Conversation

@flagsmithsmith

Copy link
Copy Markdown
Contributor

Contributes to Flagsmith/sdk-spec#27

@codspeed

codspeed Bot commented Nov 20, 2026 •

Copy link
Copy Markdown

Merging this PR will not alter performance

✅ 15 untouched benchmarks
⏩ 15 skipped benchmarks1


Comparing openhands/sdk-spec-v0.10.0 (ab459e3) with main (e2029c1)

Open in CodSpeed

Footnotes

  1. 15 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩

Add `Flag::reason`: the engine's reason under local evaluation, and
the `reason` Flagsmith returns from /flags/ and /identities/ otherwise.
Wire it into the spec steps for sdk-spec v0.10.0.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@flagsmithsmith

Copy link
Copy Markdown
Contributor Author

Implemented flag reasons for sdk-spec v0.10.0 (ab459e3):

  • Flag::reason: Option<String> (src/flagsmith/models.rs): why the flag was evaluated to its value, e.g. STATIC, DEFAULT, TARGETING_MATCH; segment=…, SPLIT; weight=….
    • Local evaluation: taken from the engine's FlagResult.reason.
    • Remote evaluation: read from each flag's reason in the /flags/ and /identities/ responses (Flagsmith 2.294.0+, feat(SDK): Surface engine reasons in flag responses flagsmith#8944). It is None when the API returns null or omits it (Edge API, older Flagsmith), and for default and offline flags.
  • Spec steps (sdk-spec/steps.rs): SpecFlag now passes the SDK's reason through.
  • Tests: unit tests for parsing reason from API flags, present and null. Integration tests now check reasons for remote and local environment and identity flags, including a segment override (TARGETING_MATCH; segment=Test Segment).

The previous run failed because the spec now checks a reason column, and the SDK didn't expose one.

@flagsmithsmith
flagsmithsmith Bot marked this pull request as ready for review November 20, 2026 20:24
@flagsmithsmith
flagsmithsmith Bot requested a review from a team as a code owner November 20, 2026 20:24
@flagsmithsmith
flagsmithsmith Bot requested review from emyller and removed request for a team November 20, 2026 20:24

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

No issues found across 5 files

Confidence score: 5/5

  • Automated review surfaced no issues in the provided summaries.
  • No files require special attention.

Requires human review: Adds an optional reason field to the public Flag model and bumps the sdk-spec workflow. Because this changes the SDK's public response shape, a human should sign off on API compatibility and exposure of evaluation reasons.

Turn on auto-fix | Re-trigger cubic

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

Labels

sdk-spec Bumps of the Flagsmith SDK behavioural spec

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants