Skip to content

feat: Add the flag-overrides capability to the contract test service #225

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kinyoklion wants to merge 1 commit into
base: rlamb/overrides-java-file-override-source
Choose a base branch
from
+70 −4
Open

feat: Add the flag-overrides capability to the contract test service #225

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions lib/sdk/server/contract-tests/service/src/main/java/sdktest/Representations.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,21 @@ public static class SdkConfigParams {
SdkConfigServiceEndpointParams serviceEndpoints;
SdkConfigHookParams hooks;
SdkConfigDataSystemParams dataSystem;
SdkConfigOverridesParams overrides;
}

/**
* Configuration for the SDK's file-based flag overrides (the "flag-overrides" capability).
*/
public static class SdkConfigOverridesParams {
/** Absolute paths of the override files, in precedence order. */
String[] filePaths;
/** "fail" (the default) or "ignore". */
String duplicateKeysHandling;
/** "polling" or "watching"; null means the SDK default. */
String changeDetection;

@cursor cursor Bot Nov 4, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Overrides config field name mismatch

High Severity

The overrides block is deserialized with a changeDetection string, but the test harness protocol documents watch and poll booleans instead. Those properties are ignored, so the source stays on the SDK polling default and watch-mode contract tests never enable watching.

Additional Locations (1)
Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit a2dbdfc. Configure here.

/** The polling interval in milliseconds; the SDK may raise it to its minimum. */
Long pollIntervalMs;
}

public static class SdkConfigStreamParams {
Expand Down
45 changes: 45 additions & 0 deletions lib/sdk/server/contract-tests/service/src/main/java/sdktest/SdkClientEntity.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@
import com.launchdarkly.sdk.server.integrations.FDv2PollingInitializerBuilder;
import com.launchdarkly.sdk.server.integrations.FDv2PollingSynchronizerBuilder;
import com.launchdarkly.sdk.server.integrations.FDv2StreamingSynchronizerBuilder;
import com.launchdarkly.sdk.server.integrations.FileData;
import com.launchdarkly.sdk.server.integrations.FileOverrideSourceBuilder;
import com.launchdarkly.sdk.server.integrations.FileOverrides;
import com.launchdarkly.sdk.server.interfaces.BigSegmentStoreStatusProvider;
import com.launchdarkly.sdk.server.subsystems.DataSourceBuilder;
import com.launchdarkly.sdk.server.datasources.Initializer;
Expand Down Expand Up @@ -68,6 +71,7 @@
import sdktest.Representations.SdkConfigParams;
import sdktest.Representations.SdkConfigDataSystemParams;
import sdktest.Representations.SdkConfigDataInitializerParams;
import sdktest.Representations.SdkConfigOverridesParams;
import sdktest.Representations.SdkConfigSynchronizerParams;
import sdktest.Representations.SdkConfigPollingParams;
import sdktest.Representations.SdkConfigStreamingParams;
Expand Down Expand Up @@ -587,12 +591,53 @@ private LDConfig buildSdkConfig(SdkConfigParams params, String tag) {
dataSystemBuilder.fDv1FallbackSynchronizer(fdv1Polling);
}

if (params.overrides != null) {
dataSystemBuilder.overrides(makeOverridesConfig(params.overrides));
}

builder.dataSystem(dataSystemBuilder);
} else if (params.overrides != null) {
throw new IllegalArgumentException("flag overrides require the data system to be configured");
}

return builder.build();
}

private static FileOverrideSourceBuilder makeOverridesConfig(SdkConfigOverridesParams params) {
FileOverrideSourceBuilder overrides = FileOverrides.source();
if (params.filePaths != null) {
overrides.filePaths(params.filePaths);
}
if (params.duplicateKeysHandling != null) {
switch (params.duplicateKeysHandling) {
case "fail":
overrides.duplicateKeysHandling(FileData.DuplicateKeysHandling.FAIL);
break;
case "ignore":
overrides.duplicateKeysHandling(FileData.DuplicateKeysHandling.IGNORE);
break;
default:
throw new IllegalArgumentException("unknown duplicate keys handling: " + params.duplicateKeysHandling);
}
}
if (params.changeDetection != null) {
switch (params.changeDetection) {
case "polling":
overrides.changeDetection(FileOverrides.ChangeDetection.POLLING);
break;
case "watching":
overrides.changeDetection(FileOverrides.ChangeDetection.WATCHING);
break;
default:
throw new IllegalArgumentException("unknown change detection mode: " + params.changeDetection);
}
}
if (params.pollIntervalMs != null) {
overrides.pollInterval(Duration.ofMillis(params.pollIntervalMs));
}
return overrides;
}

private DataSourceBuilder<Synchronizer> createSynchronizer(
SdkConfigSynchronizerParams synchronizer,
String payloadFilter) {
Expand Down
14 changes: 10 additions & 4 deletions lib/sdk/server/contract-tests/service/src/main/java/sdktest/TestService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
import sdktest.Representations.Status;

public class TestService {
private static final int PORT = 8000;
private static final int DEFAULT_PORT = 8000;
private static final String[] CAPABILITIES = new String[]{
"all-flags-client-side-only",
"all-flags-details-only-for-tracked-flags",
Expand All @@ -47,7 +47,8 @@ public class TestService {
"fdv1-fallback",
"instance-id",
"retry-conformance-fdv1-streaming",
"retry-conformance-fdv1-polling"
"retry-conformance-fdv1-polling",
"flag-overrides"
};

static final Gson gson = new GsonBuilder().serializeNulls().create();
Expand Down Expand Up @@ -83,10 +84,15 @@ public static void main(String[] args) throws Exception {
.addRegex("POST", Pattern.compile("/clients/(.*)"), ctx -> service.postClientCommand(diableKeepAlive(ctx)))
.addRegex("DELETE", Pattern.compile("/clients/(.*)"), ctx -> service.deleteClient(diableKeepAlive(ctx)));

HttpServer server = HttpServer.start(PORT, router);
int port = DEFAULT_PORT;
String portEnv = System.getenv("PORT");
if (portEnv != null && !portEnv.isEmpty()) {
port = Integer.parseInt(portEnv);
}
HttpServer server = HttpServer.start(port, router);
server.getRecorder().setEnabled(false); // don't accumulate a request log

System.out.println("Listening on port " + PORT);
System.out.println("Listening on port " + port);

// need to explicitly sleep because HttpServer now starts as a daemon thread
while (true) {
Expand Down
Loading