Skip to content

feat: Populate OpenFeature flag metadata from the evaluation reason - #53

Open
kinyoklion wants to merge 1 commit into
mainfrom
devin/python-flag-metadata
Open

feat: Populate OpenFeature flag metadata from the evaluation reason#53
kinyoklion wants to merge 1 commit into
mainfrom
devin/python-flag-metadata

Conversation

@kinyoklion

@kinyoklion kinyoklion commented Aug 19, 2026

Copy link
Copy Markdown
Member

Populates OpenFeature flag metadata with the LaunchDarkly specific parts of the evaluation result, so hooks (including the OpenTelemetry hook) can read them.

  • Keys mirror the evaluation reason fields: variationIndex, inExperiment, ruleIndex, ruleId, prerequisiteKey, bigSegmentsStatus.
  • Each key is omitted rather than default-valued when it does not apply, so a consumer can distinguish "not in an experiment" from "no information".
  • Matches openfeature-java-server#56 and openfeature-dotnet-server#61; the naming is being defined in an sdk-specs spec.

No screenshots or staging preview apply - this is a server-side library change with no UI.

Implementation details

Requirements

  • I have added test coverage for new or changed functionality
  • I have followed the repository's pull request submission guidelines
  • I have validated my changes against all supported platform versions

Describe the solution you've provided

ResolutionDetailsConverter now builds flag_metadata from the LaunchDarkly reason dictionary:

flag_metadata=self.__to_flag_metadata(reason, variation_index if not is_default else None)

Each reason field is read defensively with an isinstance check, since the reason is a plain dictionary, so a malformed reason cannot put an unexpected type into the metadata. variationIndex uses the same default-value check that already gates variant.

The README gains a "Flag Metadata" section documenting the keys.

Describe alternatives you've considered

Passing the whole reason dictionary through as a single reason metadata entry would be closer to the LaunchDarkly shape, but FlagMetadata values are scalars, so the flat keys are the only available shape.

Additional context

poetry run pytest
poetry run mypy ld_openfeature tests

All tests pass, including 7 new cases covering each key and the omissions. make test/make lint currently fail on poetry install on main as well, because poetry.lock is out of date relative to pyproject.toml - unrelated to this change.

@cursor review

Link to Devin session: https://app.devin.ai/sessions/0c452d209ec54b068ba120b4c92b8f6c
Requested by: @kinyoklion


Note

Overview
OpenFeature evaluation details now include LaunchDarkly-specific fields on flag_metadata, so hooks (including OpenTelemetry) can read experiment, rule, and related evaluation info that has no OpenFeature equivalent.

ResolutionDetailsConverter maps variationIndex, inExperiment, ruleIndex, ruleId, prerequisiteKey, and bigSegmentsStatus from the LD reason. Keys are omitted when they do not apply (including inExperiment when false, and variationIndex for default values). README documents the keys.

Reviewed by Cursor Bugbot for commit a43597d. Bugbot is set up for automated code reviews on this repo. Configure here.

Co-Authored-By: rlamb@launchdarkly.com <4955475+kinyoklion@users.noreply.github.com>
@kinyoklion kinyoklion self-assigned this Aug 19, 2026
@devin-ai-integration devin-ai-integration Bot added the devin-pr Pull request created by Devin AI label Aug 19, 2026
@devin-ai-integration

Copy link
Copy Markdown
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

@kinyoklion
kinyoklion marked this pull request as ready for review August 20, 2026 22:03
@kinyoklion
kinyoklion requested a review from a team as a code owner August 20, 2026 22:03
kinyoklion added a commit to launchdarkly/openfeature-ruby-server that referenced this pull request Aug 21, 2026
)

Populates OpenFeature flag metadata with the LaunchDarkly specific parts
of the evaluation result, so hooks (including the OpenTelemetry hook)
can read them.

- Keys mirror the evaluation reason fields: `variationIndex`,
`inExperiment`, `ruleIndex`, `ruleId`, `prerequisiteKey`,
`bigSegmentsStatus`.
- Each key is omitted rather than default-valued when it does not apply,
so a consumer can distinguish "not in an experiment" from "no
information".
- Matches
[openfeature-java-server#56](launchdarkly/openfeature-java-server#56),
[openfeature-dotnet-server#61](launchdarkly/openfeature-dotnet-server#61)
and
[openfeature-python-server#53](launchdarkly/openfeature-python-server#53);
the naming is being defined in an [sdk-specs
spec](launchdarkly/sdk-specs#253).

No screenshots or staging preview apply - this is a server-side library
change with no UI.

<details>
<summary>Implementation details</summary>

**Requirements**

- [x] I have added test coverage for new or changed functionality
- [x] I have followed the repository's pull request submission
guidelines
- [x] I have validated my changes against all supported platform
versions

**Describe the solution you've provided**

`ResolutionDetailsConverter#to_resolution_details` now passes
`flag_metadata`:

```ruby
flag_metadata: flag_metadata(reason, is_default ? nil : variation_index)
```

Each entry is gated on the corresponding reason field being present
rather than on the reason kind, so no key is written from a sentinel
value. `big_segments_status` is a symbol in the Ruby SDK, so it is
stringified to keep the metadata value types consistent with the other
providers.

The README gains a "Flag Metadata" section documenting the keys.

**Describe alternatives you've considered**

Exposing the reason object itself as one metadata entry would be closer
to the LaunchDarkly shape, but OpenFeature flag metadata values are
scalars, so the flat keys are the only available shape.

**Additional context**

```
docker run --rm -v "$PWD":/app -w /app ruby:3.4 bash -c "bundle install && bundle exec rake"
```

61 examples, 0 failures; RuboCop clean. 7 new examples cover each key
and the omissions.
</details>

@cursor review


Link to Devin session:
https://app.devin.ai/sessions/0c452d209ec54b068ba120b4c92b8f6c
Requested by: @kinyoklion

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> **Overview**
> OpenFeature evaluations now include LaunchDarkly-only details on
`flag_metadata`, so hooks (including OpenTelemetry) can read them.
> 
> `ResolutionDetailsConverter` maps `variationIndex`, `inExperiment`,
`ruleIndex`, `ruleId`, `prerequisiteKey`, and `bigSegmentsStatus` from
the evaluation reason. Keys are omitted when they do not apply
(including `inExperiment` when false, and `variationIndex` for default
values). `bigSegmentsStatus` is stringified.
> 
> The README documents the keys and a usage example. Specs cover each
field and the omission cases.
> 
> <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit
deaf178. Bugbot is set up for automated
code reviews on this repo. Configure
[here](https://www.cursor.com/dashboard/bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

devin-pr Pull request created by Devin AI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant