fixup: add readme and missing option

aepfli · aepfli · commit 97f48ae84fd3 · 2025-02-07T13:02:44.000+01:00
Signed-off-by: Simon Schrottner &lt;simon.schrottner@dynatrace.com&gt;
diff --git a/providers/flagd/.gitignore b/providers/flagd/.gitignore
@@ -0,0 +1 @@
+tmp/
diff --git a/providers/flagd/README.md b/providers/flagd/README.md
@@ -54,15 +54,15 @@ The value is updated with every (re)connection to the sync implementation.
 This can be used to enrich evaluations with such data.
 If the `in-process` mode is not used, and before the provider is ready, the `getSyncMetadata` returns an empty map.
 
-#### Offline mode
+### Offline mode (File resolver)
 
 In-process resolvers can also work in an offline mode.
 To enable this mode, you should provide a valid flag configuration file with the option `offlineFlagSourcePath`.
 
 ```java
 FlagdProvider flagdProvider = new FlagdProvider(
         FlagdOptions.builder()
-                .resolverType(Config.Resolver.IN_PROCESS)
+                .resolverType(Config.Resolver.FILE)
                 .offlineFlagSourcePath("PATH")
                 .build());
 ```
@@ -103,24 +103,25 @@ variables.
 
 Given below are the supported configurations:
 
-| Option name           | Environment variable name      | Type & Values            | Default   | Compatible resolver |
-| --------------------- | ------------------------------ | ------------------------ | --------- | ------------------- |
-| resolver              | FLAGD_RESOLVER                 | String - rpc, in-process | rpc       |                     |
-| host                  | FLAGD_HOST                     | String                   | localhost | rpc & in-process    |
-| port                  | FLAGD_PORT                     | int                      | 8013      | rpc & in-process    |
-| targetUri             | FLAGD_TARGET_URI               | string                   | null      | rpc & in-process    |
-| tls                   | FLAGD_TLS                      | boolean                  | false     | rpc & in-process    |
-| socketPath            | FLAGD_SOCKET_PATH              | String                   | null      | rpc & in-process    |
-| certPath              | FLAGD_SERVER_CERT_PATH         | String                   | null      | rpc & in-process    |
-| deadline              | FLAGD_DEADLINE_MS              | int                      | 500       | rpc & in-process    |
-| streamDeadlineMs      | FLAGD_STREAM_DEADLINE_MS       | int                      | 600000    | rpc & in-process    |
-| keepAliveTime         | FLAGD_KEEP_ALIVE_TIME_MS       | long                     | 0         | rpc & in-process    |
-| selector              | FLAGD_SOURCE_SELECTOR          | String                   | null      | in-process          |
-| cache                 | FLAGD_CACHE                    | String - lru, disabled   | lru       | rpc                 |
-| maxCacheSize          | FLAGD_MAX_CACHE_SIZE           | int                      | 1000      | rpc                 |
-| maxEventStreamRetries | FLAGD_MAX_EVENT_STREAM_RETRIES | int                      | 5         | rpc                 |
-| retryBackoffMs        | FLAGD_RETRY_BACKOFF_MS         | int                      | 1000      | rpc                 |
-| offlineFlagSourcePath | FLAGD_OFFLINE_FLAG_SOURCE_PATH | String                   | null      | in-process          |
+| Option name           | Environment variable name      | Type & Values            | Default   | Compatible resolver     |
+|-----------------------|--------------------------------|--------------------------|-----------|-------------------------|
+| resolver              | FLAGD_RESOLVER                 | String - rpc, in-process | rpc       |                         |
+| host                  | FLAGD_HOST                     | String                   | localhost | rpc & in-process        |
+| port                  | FLAGD_PORT                     | int                      | 8013      | rpc & in-process        |
+| targetUri             | FLAGD_TARGET_URI               | string                   | null      | rpc & in-process        |
+| tls                   | FLAGD_TLS                      | boolean                  | false     | rpc & in-process        |
+| socketPath            | FLAGD_SOCKET_PATH              | String                   | null      | rpc & in-process        |
+| certPath              | FLAGD_SERVER_CERT_PATH         | String                   | null      | rpc & in-process        |
+| deadline              | FLAGD_DEADLINE_MS              | int                      | 500       | rpc & in-process & file |
+| streamDeadlineMs      | FLAGD_STREAM_DEADLINE_MS       | int                      | 600000    | rpc & in-process        |
+| keepAliveTime         | FLAGD_KEEP_ALIVE_TIME_MS       | long                     | 0         | rpc & in-process        |
+| selector              | FLAGD_SOURCE_SELECTOR          | String                   | null      | in-process              |
+| cache                 | FLAGD_CACHE                    | String - lru, disabled   | lru       | rpc                     |
+| maxCacheSize          | FLAGD_MAX_CACHE_SIZE           | int                      | 1000      | rpc                     |
+| maxEventStreamRetries | FLAGD_MAX_EVENT_STREAM_RETRIES | int                      | 5         | rpc                     |
+| retryBackoffMs        | FLAGD_RETRY_BACKOFF_MS         | int                      | 1000      | rpc                     |
+| offlineFlagSourcePath | FLAGD_OFFLINE_FLAG_SOURCE_PATH | String                   | null      | file                    |
+| offlinePollIntervalMs | FLAGD_OFFLINE_POLL_MS          | int                      | 5000      | file                    |
 
 > [!NOTE]  
 > Some configurations are only applicable for RPC resolver.
diff --git a/providers/flagd/schemas b/providers/flagd/schemas
@@ -1 +1 @@
-Subproject commit bb763438abc5b0e97dc26a795bc72b7a9f3e4020
+Subproject commit 37baa2cdea48a5ac614ba3e718b7d02ad4120611
diff --git a/providers/flagd/spec b/providers/flagd/spec
@@ -1 +1 @@
-Subproject commit 8d6eeb3247600f6f66ffc92afa50ebde75b4d3ce
+Subproject commit 5b070659853062262e618c74da5b640555f9ae18
diff --git a/providers/flagd/src/main/java/dev/openfeature/contrib/providers/flagd/Config.java b/providers/flagd/src/main/java/dev/openfeature/contrib/providers/flagd/Config.java
@@ -17,6 +17,7 @@ public final class Config {
     static final int DEFAULT_STREAM_DEADLINE_MS = 10 * 60 * 1000;
     static final int DEFAULT_STREAM_RETRY_GRACE_PERIOD = 5;
     static final int DEFAULT_MAX_CACHE_SIZE = 1000;
+    static final int DEFAULT_OFFLINE_POLL_MS = 5000;
     static final long DEFAULT_KEEP_ALIVE = 0;
 
     static final String RESOLVER_ENV_VAR = "FLAGD_RESOLVER";
@@ -33,6 +34,7 @@ public final class Config {
     static final String STREAM_DEADLINE_MS_ENV_VAR_NAME = "FLAGD_STREAM_DEADLINE_MS";
     static final String SOURCE_SELECTOR_ENV_VAR_NAME = "FLAGD_SOURCE_SELECTOR";
     static final String OFFLINE_SOURCE_PATH = "FLAGD_OFFLINE_FLAG_SOURCE_PATH";
+    static final String OFFLINE_POLL_MS = "FLAGD_OFFLINE_POLL_MS";
     static final String KEEP_ALIVE_MS_ENV_VAR_NAME_OLD = "FLAGD_KEEP_ALIVE_TIME";
     static final String KEEP_ALIVE_MS_ENV_VAR_NAME = "FLAGD_KEEP_ALIVE_TIME_MS";
     static final String TARGET_URI_ENV_VAR_NAME = "FLAGD_TARGET_URI";
diff --git a/providers/flagd/src/main/java/dev/openfeature/contrib/providers/flagd/FlagdOptions.java b/providers/flagd/src/main/java/dev/openfeature/contrib/providers/flagd/FlagdOptions.java
@@ -122,6 +122,13 @@ public class FlagdOptions {
      */
     private String offlineFlagSourcePath;
 
+    /**
+     * File polling interval.
+     * Defaults to 0 (disabled).
+     **/
+    @Builder.Default
+    private int offlinePollIntervalMs = fallBackToEnvOrDefault(Config.OFFLINE_POLL_MS, Config.DEFAULT_OFFLINE_POLL_MS);
+
     /**
      * gRPC custom target string.
      *
diff --git a/providers/flagd/src/main/java/dev/openfeature/contrib/providers/flagd/resolver/process/InProcessResolver.java b/providers/flagd/src/main/java/dev/openfeature/contrib/providers/flagd/resolver/process/InProcessResolver.java
@@ -151,7 +151,7 @@ static Connector getConnector(final FlagdOptions options, Consumer<FlagdProvider
         }
         return options.getOfflineFlagSourcePath() != null
                         && !options.getOfflineFlagSourcePath().isEmpty()
-                ? new FileConnector(options.getOfflineFlagSourcePath())
+                ? new FileConnector(options.getOfflineFlagSourcePath(), options.getOfflinePollIntervalMs())
                 : new GrpcStreamConnector(options, onConnectionEvent);
     }
 
diff --git a/providers/flagd/src/main/java/dev/openfeature/contrib/providers/flagd/resolver/process/storage/connector/file/FileConnector.java b/providers/flagd/src/main/java/dev/openfeature/contrib/providers/flagd/resolver/process/storage/connector/file/FileConnector.java
@@ -24,15 +24,16 @@
 @Slf4j
 public class FileConnector implements Connector {
 
-    private static final int POLL_INTERVAL_MS = 5000;
     private static final String OFFER_WARN = "Unable to offer file content to queue: queue is full";
 
     private final String flagSourcePath;
+    private final int pollInterval;
     private final BlockingQueue<QueuePayload> queue = new LinkedBlockingQueue<>(1);
     private boolean shutdown = false;
 
-    public FileConnector(final String flagSourcePath) {
+    public FileConnector(final String flagSourcePath, int pollInterval) {
         this.flagSourcePath = flagSourcePath;
+        this.pollInterval = pollInterval;
     }
 
     /**
@@ -64,7 +65,7 @@ public void init() throws IOException {
                         }
                     }
 
-                    Thread.sleep(POLL_INTERVAL_MS);
+                    Thread.sleep(pollInterval);
                 }
 
                 log.info("Shutting down file connector.");
diff --git a/providers/flagd/src/test/java/dev/openfeature/contrib/providers/flagd/e2e/RunRpcTest.java b/providers/flagd/src/test/java/dev/openfeature/contrib/providers/flagd/e2e/RunRpcTest.java
@@ -12,7 +12,6 @@
 import org.junit.platform.suite.api.IncludeEngines;
 import org.junit.platform.suite.api.IncludeTags;
 import org.junit.platform.suite.api.SelectDirectories;
-import org.junit.platform.suite.api.SelectFile;
 import org.junit.platform.suite.api.Suite;
 import org.testcontainers.junit.jupiter.Testcontainers;
 
@@ -24,7 +23,7 @@
 @IncludeEngines("cucumber")
 @SelectDirectories("test-harness/gherkin")
 // if you want to run just one feature file, use the following line instead of @SelectDirectories
-//@SelectFile("test-harness/gherkin/rpc-caching.feature")
+// @SelectFile("test-harness/gherkin/rpc-caching.feature")
 @ConfigurationParameter(key = PLUGIN_PROPERTY_NAME, value = "pretty")
 @ConfigurationParameter(key = GLUE_PROPERTY_NAME, value = "dev.openfeature.contrib.providers.flagd.e2e.steps")
 @ConfigurationParameter(key = OBJECT_FACTORY_PROPERTY_NAME, value = "io.cucumber.picocontainer.PicoFactory")
diff --git a/providers/flagd/src/test/java/dev/openfeature/contrib/providers/flagd/e2e/steps/ProviderSteps.java b/providers/flagd/src/test/java/dev/openfeature/contrib/providers/flagd/e2e/steps/ProviderSteps.java
@@ -112,7 +112,10 @@ public void setupProvider(String providerType) throws IOException, InterruptedEx
 
                     state.builder
                             .port(UNAVAILABLE_PORT)
-                            .offlineFlagSourcePath(sharedTempDir.resolve("allFlags.json").toAbsolutePath().toString());
+                            .offlineFlagSourcePath(sharedTempDir
+                                    .resolve("allFlags.json")
+                                    .toAbsolutePath()
+                                    .toString());
                 } else {
                     state.builder.port(container.getPort(State.resolverType));
                 }
diff --git a/providers/flagd/src/test/java/dev/openfeature/contrib/providers/flagd/e2e/steps/config/ConfigSteps.java b/providers/flagd/src/test/java/dev/openfeature/contrib/providers/flagd/e2e/steps/config/ConfigSteps.java
@@ -26,7 +26,6 @@ public class ConfigSteps extends AbstractSteps {
      */
     public static final List<String> IGNORED_FOR_NOW = new ArrayList<String>() {
         {
-            add("offlinePollIntervalMs");
             add("retryBackoffMaxMs");
         }
     };
diff --git a/providers/flagd/src/test/java/dev/openfeature/contrib/providers/flagd/resolver/process/storage/connector/file/FileConnectorTest.java b/providers/flagd/src/test/java/dev/openfeature/contrib/providers/flagd/resolver/process/storage/connector/file/FileConnectorTest.java
@@ -24,7 +24,7 @@ class FileConnectorTest {
     @Test
     void readAndExposeFeatureFlagsFromSource() throws IOException {
         // given
-        final FileConnector connector = new FileConnector(getResourcePath(VALID_LONG));
+        final FileConnector connector = new FileConnector(getResourcePath(VALID_LONG), 5000);
 
         // when
         connector.init();
@@ -45,7 +45,7 @@ void readAndExposeFeatureFlagsFromSource() throws IOException {
     @Test
     void emitErrorStateForInvalidPath() throws IOException {
         // given
-        final FileConnector connector = new FileConnector("INVALID_PATH");
+        final FileConnector connector = new FileConnector("INVALID_PATH", 5000);
 
         // when
         connector.init();
@@ -75,7 +75,7 @@ void watchForFileUpdatesAndEmitThem() throws IOException {
         final Path updPath = Paths.get(getResourcePath(UPDATABLE_FILE));
         Files.write(updPath, initial.getBytes(), StandardOpenOption.WRITE, StandardOpenOption.TRUNCATE_EXISTING);
 
-        final FileConnector connector = new FileConnector(updPath.toString());
+        final FileConnector connector = new FileConnector(updPath.toString(), 5000);
 
         // when
         connector.init();

Original file line number	Diff line number	Diff line change
`@@ -151,7 +151,7 @@ static Connector getConnector(final FlagdOptions options, Consumer<FlagdProvider`
`151`	`151`	`}`
`152`	`152`	`return options.getOfflineFlagSourcePath() != null`
`153`	`153`	`&& !options.getOfflineFlagSourcePath().isEmpty()`
`154`		`- ? new FileConnector(options.getOfflineFlagSourcePath())`
	`154`	`+ ? new FileConnector(options.getOfflineFlagSourcePath(), options.getOfflinePollIntervalMs())`
`155`	`155`	`: new GrpcStreamConnector(options, onConnectionEvent);`
`156`	`156`	`}`
`157`	`157`
Original file line number	Diff line number	Diff line change
`@@ -24,15 +24,16 @@`
`24`	`24`	`@Slf4j`
`25`	`25`	`public class FileConnector implements Connector {`
`26`	`26`
`27`		`- private static final int POLL_INTERVAL_MS = 5000;`
`28`	`27`	`private static final String OFFER_WARN = "Unable to offer file content to queue: queue is full";`
`29`	`28`
`30`	`29`	`private final String flagSourcePath;`
	`30`	`+ private final int pollInterval;`
`31`	`31`	`private final BlockingQueue<QueuePayload> queue = new LinkedBlockingQueue<>(1);`
`32`	`32`	`private boolean shutdown = false;`
`33`	`33`
`34`		`- public FileConnector(final String flagSourcePath) {`
	`34`	`+ public FileConnector(final String flagSourcePath, int pollInterval) {`
`35`	`35`	`this.flagSourcePath = flagSourcePath;`
	`36`	`+ this.pollInterval = pollInterval;`
`36`	`37`	`}`
`37`	`38`
`38`	`39`	`/**`
`@@ -64,7 +65,7 @@ public void init() throws IOException {`
`64`	`65`	`}`
`65`	`66`	`}`
`66`	`67`
`67`		`- Thread.sleep(POLL_INTERVAL_MS);`
	`68`	`+ Thread.sleep(pollInterval);`
`68`	`69`	`}`
`69`	`70`
`70`	`71`	`log.info("Shutting down file connector.");`