Repository navigation
feat: Add the flag-overrides capability to the contract test service - #225
Open
kinyoklion wants to merge 1 commit into
Open
kinyoklion wants to merge 1 commit into
kinyoklion wants to merge 1 commit into
Conversation
kinyoklion
force-pushed
the
rlamb/overrides-java-file-override-source
branch
from
September 28, 2026 21:04
bc2e4a9 to
657a598
Compare
kinyoklion
force-pushed
the
rlamb/overrides-java-contract-tests
branch
from
September 28, 2026 21:04
5069a69 to
dd3942a
Compare
kinyoklion
force-pushed
the
rlamb/overrides-java-file-override-source
branch
from
October 1, 2026 23:44
657a598 to
5be8948
Compare
kinyoklion
force-pushed
the
rlamb/overrides-java-contract-tests
branch
from
October 1, 2026 23:44
dd3942a to
56efaf2
Compare
kinyoklion
force-pushed
the
rlamb/overrides-java-file-override-source
branch
from
October 3, 2026 00:58
5be8948 to
9992774
Compare
kinyoklion
force-pushed
the
rlamb/overrides-java-contract-tests
branch
from
October 3, 2026 00:58
56efaf2 to
c355fd9
Compare
Member
Author
|
bugbot review |
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
✅ Bugbot reviewed your changes and found no new issues!
Comment @cursor review or bugbot run to trigger another review on this PR
Reviewed by Cursor Bugbot for commit c355fd9. Configure here.
kinyoklion
force-pushed
the
rlamb/overrides-java-file-override-source
branch
from
October 3, 2026 01:43
9992774 to
1728c29
Compare
kinyoklion
force-pushed
the
rlamb/overrides-java-contract-tests
branch
from
October 3, 2026 01:43
c355fd9 to
310a4a1
Compare
kinyoklion
force-pushed
the
rlamb/overrides-java-file-override-source
branch
from
October 13, 2026 21:02
1728c29 to
c134bcc
Compare
kinyoklion
force-pushed
the
rlamb/overrides-java-contract-tests
branch
2 times, most recently
from
October 15, 2026 22:24
712cb2f to
048b678
Compare
kinyoklion
force-pushed
the
rlamb/overrides-java-file-override-source
branch
from
October 16, 2026 21:18
a0f4c55 to
21f7364
Compare
kinyoklion
force-pushed
the
rlamb/overrides-java-contract-tests
branch
from
October 16, 2026 21:18
048b678 to
948f0bc
Compare
kinyoklion
added a commit
that referenced
this pull request
Oct 23, 2026
…240) ## Summary The Java contract test service did not declare the `flag-change-listeners` and `flag-value-change-listeners` capabilities, so the test harness skipped its flag change listener suite for Java. The suite now also covers dependent-flag notifications (sdk-test-harness #514) and override change notifications (#515), and Java should be checked by all of it. The service now declares both capabilities and handles the three listener commands. `ListenerRegistry` keeps the listeners the harness has registered with one SDK client, keyed by the harness's listener ID. A general flag change listener is registered with `FlagTracker.addFlagChangeListener` and posts the flag key of every change event to its callback URI. A flag value change listener uses `FlagTracker.addFlagValueChangeListener` for the given flag and context and posts the old and new values when the SDK reports a value change. `unregisterListener` removes the listener and returns 400 for an unknown ID; closing the client removes them all; re-registering an ID replaces the earlier listener. Notifications are posted through the existing `HookCallbackService`, and a failed post is logged rather than thrown, since the SDK calls listeners from its worker thread. The Java API has no application default value for a value change listener, so the `defaultValue` the harness sends is accepted and not used; the harness tests only compare the values of flags that exist. ## Verification Run locally: the released harness listener suite passes against this service, and so does the dependent-flag suite from sdk-test-harness #514 (prerequisite chains, segment and nested segment references, a segment behind a prerequisite, deletions, and full data sets). With this commit cherry-picked onto the flag overrides stack (#225), the override change notification suite from sdk-test-harness #515 passes as well. CI will run the released suite once the capabilities are declared. [SDK-3355](https://launchdarkly.atlassian.net/browse/SDK-3355) [SDK-3355]: https://launchdarkly.atlassian.net/browse/SDK-3355?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
kinyoklion
force-pushed
the
rlamb/overrides-java-file-override-source
branch
from
October 28, 2026 22:19
21f7364 to
68fe0d8
Compare
kinyoklion
force-pushed
the
rlamb/overrides-java-contract-tests
branch
from
October 28, 2026 22:19
948f0bc to
4b626ae
Compare
kinyoklion
force-pushed
the
rlamb/overrides-java-file-override-source
branch
from
October 28, 2026 22:39
68fe0d8 to
7f0a3eb
Compare
kinyoklion
force-pushed
the
rlamb/overrides-java-contract-tests
branch
3 times, most recently
from
October 28, 2026 23:05
2bdbcd3 to
c7d26c1
Compare
kinyoklion
force-pushed
the
rlamb/overrides-java-file-override-source
branch
from
October 29, 2026 16:49
8ccc74b to
af78d3a
Compare
kinyoklion
force-pushed
the
rlamb/overrides-java-contract-tests
branch
from
October 29, 2026 16:49
c7d26c1 to
3fb7c29
Compare
The contract test service advertises the flag-overrides capability and accepts the overrides object in the SDK configuration: filePaths, duplicateKeysHandling, changeDetection, and pollIntervalMs. The block configures FileOverrides.source() on the data system builder. An overrides block without a dataSystem block is rejected, because the override source is an option of the FDv2 data system. The service reads its listening port from the PORT environment variable when set, which the Makefile already passes, so several test services can run side by side. The default stays 8000.
kinyoklion
force-pushed
the
rlamb/overrides-java-file-override-source
branch
from
October 29, 2026 17:01
af78d3a to
2ab2fe7
Compare
kinyoklion
force-pushed
the
rlamb/overrides-java-contract-tests
branch
from
October 29, 2026 17:01
3fb7c29 to
d9ec2af
Compare
kinyoklion
marked this pull request as ready for review
November 2, 2026 23:46
kinyoklion
added a commit
to launchdarkly/sdk-test-harness
that referenced
this pull request
Nov 3, 2026
…thout the init key (#539) <!-- TERMAG_PR_BODY_BEGIN --> ## Summary Overrides only add to what the SDK reports: a flag that the override layer does not hold evaluates as it does without an override source, and the all-flags state holds every flag it holds without one, plus the overridden flags. A client that has not initialized is where SDKs broke this, and only when the store holds flags without being initialized, for example a persistent store that holds data but no init key. The flag overrides suite uses the SDK's in-memory store, which is empty until a data source provides data, so it could not tell a read of the override layer apart from a read of everything the store returns. A new `flag overrides` group in the persistent data store suite (`server_side_persistence_overrides.go`) runs when the test service has the `flag-overrides` capability. It writes flags to the store without the init key and gives the client a data source that never provides data. Each test compares a client with an override source to a client without one against the same store, so it holds whatever an SDK reports for an uninitialized store: - **a flag without an override evaluates as it does without an override source**: an override file that holds a different flag leaves the evaluation of a store flag unchanged (OVERRIDE Requirements 1.5.1 and 1.5.3). - **an empty override source leaves the all-flags state unchanged** (Requirement 1.2.2). - **overrides add to the all-flags state and make it valid**: the state holds exactly the flags of the client without a source, with override values for the overridden keys, plus the flags that exist only in the override layer, and it is valid (launchdarkly/sdk-specs#280, Requirements 1.4.1.2 and 1.4.1.3). The flag overrides suite gains **evaluate all flags returns only the override flags as a valid state** in its uninitialized client group, where the store is empty and every SDK reports only the override flags. ## Results Run with `-enable-persistence-tests` against Redis. | Test service | flag without an override | empty override source | overrides add | |---|---|---|---| | Go `v7` | fails: served from the store | fails: valid state of the store's flags | fails: the store's flags join the overrides | | Go launchdarkly/go-server-sdk#491 | passes | passes | passes | | Node `main` | passes | fails: valid state of the store's flags | passes | | Node launchdarkly/js-core#2132 first commit (`57498a9e`) | passes | passes | fails: drops a store flag the state holds without overrides | | Node launchdarkly/js-core#2132 | passes | passes | passes | | Python (top of the launchdarkly/python-server-sdk#530 stack, sync and async) | passes | passes | passes | | Ruby (top of the launchdarkly/ruby-server-sdk#454 stack) | passes | passes | passes | The Java (launchdarkly/java-core#225) and .NET (`dotnet-server-sdk-v9`) test services do not support persistent stores, so the group skips there; the new uninitialized client test passes on both. The full Redis persistent data store suite and the flag overrides suite pass against Go #491 at `30d4f216` (131 tests run). `golangci-lint` reports no issues. Go and Node fail these tests until launchdarkly/go-server-sdk#491 and launchdarkly/js-core#2132 are merged, for test services whose CI runs the persistent data store suite with this harness version. [SDK-3419](https://launchdarkly.atlassian.net/browse/SDK-3419) <!-- TERMAG_PR_BODY_END --> <!-- termag: box=i-0575d1c54853058d7 project=sdk-test-harness --> <sub>Opened from termag</sub> [SDK-3419]: https://launchdarkly.atlassian.net/browse/SDK-3419?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Overview** > Adds harness coverage for **file flag overrides** when the SDK never initializes but a **persistent store already holds feature data without the `$inited` key**—a case the existing in-memory override suite could not distinguish from “read everything from the store.” > > A new **`flag overrides`** group under the server-side persistent data store suite (`server_side_persistence_overrides.go`, gated on `flag-overrides`) seeds Redis/Consul/Dynamo with flags, uses a blocking unavailable data source, and compares clients with and without override files via `uninitializedClient`. Scenarios assert: store flags not in the override file behave like no override source; an empty override file leaves **evaluate all flags** unchanged; overrides merge into all-flags state, mark it **valid**, and apply override values while retaining other store flags. > > The standalone flag-overrides **`uninitialized client`** group gains **evaluate all flags returns only the override flags as a valid state** (empty store, overrides-only valid state). The persistent suite registers the new group from `server_side_persistence_base.go`. > > <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit 09a8e02. Bugbot is set up for automated code reviews on this repo. Configure [here](https://www.cursor.com/dashboard/bugbot).</sup> <!-- /CURSOR_SUMMARY -->
This branch has not been deployed
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.
Summary
The contract test service now advertises the
flag-overridescapability and accepts theoverridesobject in the SDK configuration, as the test harness service specification describes:filePaths(required),duplicateKeysHandling(failorignore),changeDetection(pollingorwatching), andpollIntervalMs. The block configuresFileOverrides.source()on the data system builder. Anoverridesblock without adataSystemblock is rejected, because the override source is an option of the FDv2 data system.The service also reads its listening port from the
PORTenvironment variable when set, which the Makefile already passes, so several test services can run side by side on one machine. The default stays 8000.This PR depends on the file-based override source (rlamb/overrides-java-file-override-source) and is based on that branch; retarget it to feat/overrides once that branch merges.
The existing file data source keeps its current behavior; this change does not touch its code paths.
SDK-3246
Note
Overview
The Java server-side contract test service now implements the
flag-overridesharness capability so cross-SDK conformance tests can drive file-based flag overrides.Configuration: Create-instance payloads can include an
overridesblock onSdkConfigParams(filePaths,duplicateKeysHandling,changeDetection,pollIntervalMs), modeled by newSdkConfigOverridesParams. When adataSystemblock is present, the service maps that JSON intoFileOverrides.source()on the FDv2 data system builder viamakeOverridesConfig. Ifoverridesis sent withoutdataSystem, client creation fails with an explicit error, matching the requirement that overrides attach only to the data system.Operational: The service advertises
flag-overridesin its status capabilities list. It also honors thePORTenvironment variable for the HTTP listener (default 8000), enabling multiple test service instances on one machine.Reviewed by Cursor Bugbot for commit d9ec2af. Bugbot is set up for automated code reviews on this repo. Configure here.