fix!: Do not add the targeting key as a custom attribute - #28
Open
kinyoklion wants to merge 1 commit into
Open
Conversation
Co-Authored-By: rlamb@launchdarkly.com <4955475+kinyoklion@users.noreply.github.com>
Contributor
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Contributor
|
@cursor review |
kinyoklion
marked this pull request as ready for review
August 31, 2026 21:25
3 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Stops
targetingKeyfrom being copied into the LaunchDarkly context as a custom attribute.$key === "targetingKey") instead of the attribute name ($k === "targetingKey"), so the attribute was never skipped.targetingKeyattribute per sub-context, where it was visible to targeting rules and on the context in the LaunchDarkly UI.Before, for
{"kind": "multi", "organization": {"targetingKey": "org-key", "name": "the-org"}}:{"kind":"multi","organization":{"key":"org-key","name":"the-org","targetingKey":"org-key"}}Implementation details
Found during the weekly OpenFeature provider audit.
OFPrequirement 2.3 namestargetingKeyas the source of the context key, and 2.4 only requires attributes not named in that section to become custom attributes, so this was a spec violation as well as noise.Only multi-contexts were affected in practice: for a single context the OpenFeature SDK keeps the targeting key outside the attributes, while a multi-context has to carry a
targetingKeyinside each per-kind attribute map. The fix is in the shared single-context builder, which handles both.Requirements
Related issues
None.
Describe the solution you've provided
The attribute name is compared to
"targetingKey", as was clearly intended by the surrounding code and its comment.Describe alternatives you've considered
Filtering the attribute out in the multi-context builder only: that leaves the same latent bug in the single-context path if the SDK ever surfaces a
targetingKeyattribute there.Additional context
Testing:
make check(composer cs-check,composer phpstan,composer phpunit). The new test asserts both that the sub-context key is still taken fromtargetingKeyand that no such custom attribute remains.Link to Devin session: https://app.devin.ai/sessions/38a6eaf69fcf41109e136a1d0fe5e899
Open in Devin Desktop: https://app.devin.ai/desktop/session/38a6eaf69fcf41109e136a1d0fe5e899?variant=devin
Requested by: @kinyoklion
Note
Overview
Fixes a one-character logic bug in
buildSingleContextwhere the skip check used$key === "targetingKey"(the resolved context key) instead of$k === "targetingKey"(the attribute name).keywas already skipped correctly;targetingKeywas not, so multi-context evaluations could emit a duplicatetargetingKeycustom attribute on each sub-context while still using it for the LD context key.Adds
testMultiContextTargetingKeyIsNotAddedAsAnAttributeto assert the sub-context key comes fromtargetingKeyand thattargetingKeydoes not appear in serialized context JSON.Reviewed by Cursor Bugbot for commit 9262dde. Bugbot is set up for automated code reviews on this repo. Configure here.