feat: Add hook-environment-id capability and test - #412
Merged
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 12, 2026 20:11
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 7d94492. Configure here.
Co-Authored-By: rlamb@launchdarkly.com <4955475+kinyoklion@users.noreply.github.com>
joker23
approved these changes
Aug 12, 2026
kinyoklion
pushed a commit
that referenced
this pull request
Aug 12, 2026
🤖 I have created a release *beep* *boop* --- ## [3.2.0-alpha.6](v3.1.1-alpha.6...v3.2.0-alpha.6) (2026-08-12) ### Features * Add contract test for streaming connection close on client shutdown ([#403](#403)) ([0f91b2a](0f91b2a)) * Add contract tests for client-side secure mode hash (h query param) ([#376](#376)) ([3e3012c](3e3012c)) * Add hook-environment-id capability and test ([#412](#412)) ([922989a](922989a)) * Add migration op event context redaction tests ([#385](#385)) ([34d68e9](34d68e9)) * add tests for handling redacting attributes prefixed with `/` correctly ([#381](#381)) ([ff6929d](ff6929d)) * Verify the in operator keeps booleans and numbers distinct ([fac2879](fac2879)) ### Bug Fixes * Correct privateAttributes JSON tag in context comparison params ([#392](#392)) ([d9d2c01](d9d2c01)) * Fix capability guarding custom event redaction ([#387](#387)) ([4d3419b](4d3419b)) * Only expect custom-event anonymous redaction for server SDKs ([#389](#389)) ([032ae14](032ae14)) * prevent client side wrapper test datasystem from colliding with primary connection mode ([#394](#394)) ([fb40bc6](fb40bc6)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Overview** > **Release-only PR** — bumps the package from `3.1.1-alpha.6` to **`3.2.0-alpha.6`** in `.release-please-manifest.json`, `main.go` (`versionString`), and adds the matching **CHANGELOG** section. > > No harness or test code changes appear in this diff; the changelog summarizes work already merged on the branch (new contract tests for streaming shutdown, client-side secure mode `h` param, hook-environment-id, migration/context redaction, `/`-prefixed attribute redaction, and `in` operator type distinction, plus fixes for `privateAttributes` JSON tagging, custom-event redaction capability guards, server-only anonymous redaction expectations, and client-side wrapper datasystem collision). > > <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit 104ac51. 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: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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.

Requirements
Related issues
Ports #410 (v2) to v3. Companion SDK work: launchdarkly/python-server-sdk#484, launchdarkly/cpp-sdks#594.
Describe the solution you've provided
Same capability and test as #410, adapted to the v3 data system:
hook-environment-idcapability, documented indocs/service_spec.mdDataSystemOptionEnvironmentID(...), a top-levelSDKDataSystemOptionthat makes every mock service of the data system (initializers and synchronizers, in all connection modes) send anX-LD-EnvIDresponse headerhooks/evaluation/provides the environment ID) assertingevaluationSeriesContext.environmentIdonafterEvaluation, run against the SDK's default data source plus an explicit polling subtest for client-side/server-side-pollingSDKsUnlike v2, where the option wrapped the single
SDKDataSourcehandler, the header is applied increateEndpoints, so both FDv2 initializers and synchronizers report it — matching production, where the header is on every flag-delivery response.Describe alternatives you've considered
Making the option per-connection-mode. Environment ID is a property of the environment, not of a connection mode, so a single top-level option keeps call sites simple and covers every mode.
Additional context
Verified against the FDv2 contract services of python-server-sdk (#484) and cpp-sdks (#594):
hooks/evaluation/provides the environment IDpasses for both, in default (streaming) and polling modes.Track hooks (
trackSeriesContext.environmentId) are documented but not yet asserted, same as in v2.Link to Devin session: https://app.devin.ai/sessions/bfe54128e2804a96bb100e6120e9a3ef
Requested by: @kinyoklion
Note
Overview
Adds the
hook-environment-idcapability so SDKs that read LaunchDarkly’sX-LD-EnvIDfrom streaming/polling responses must surface it on hook series contexts (evaluationSeriesContext.environmentId, andtrackSeriesContextwhen track hooks are supported). The harness documents this inservice_spec.mdand gates a new evaluation hook test on the capability.Mock flag delivery now supports
DataSystemOptionEnvironmentID(...), a top-level data-system option that wraps every initializer and synchronizer endpoint (all connection modes) to emitX-LD-EnvID, matching production flag-delivery responses in the v3 data system.The test “provides the environment ID” evaluates a flag and asserts
environmentIdon theafterEvaluationhook payload, under the default data source and an explicit polling subtest for client-side / server-side-polling SDKs. Track-hookenvironmentIdis documented but not asserted yet (same as v2).Reviewed by Cursor Bugbot for commit 8331c29. Bugbot is set up for automated code reviews on this repo. Configure here.