feat: add offline mode file path env (#751)

Signed-off-by: Michael Beemer <[email protected]>
open-feature · Jan 30, 2024 · 4ff73e7 · 4ff73e7
1 parent 35b81e0
commit 4ff73e7
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 8 deletions.
diff --git a/libs/providers/flagd/README.md b/libs/providers/flagd/README.md
@@ -34,8 +34,9 @@ Options can be defined in the constructor or as environment variables. Construct
 | tls                                    | FLAGD_TLS                      | boolean | false     |                  |
 | socketPath                             | FLAGD_SOCKET_PATH              | string  | -         |                  |
 | resolverType                           | FLAGD_SOURCE_RESOLVER          | string  | rpc       | rpc, in-process  |
+| offlineFlagSourcePath                  | FLAGD_OFFLINE_FLAG_SOURCE_PATH | string  | -         |                  |
 | selector                               | FLAGD_SOURCE_SELECTOR          | string  | -         |                  |
-| cache                                  | FLAGD_CACHE                    | string  | lru       | lru,disabled     |
+| cache                                  | FLAGD_CACHE                    | string  | lru       | lru, disabled    |
 | maxCacheSize                           | FLAGD_MAX_CACHE_SIZE           | int     | 1000      |                  |
 
 Below are examples of usage patterns.

diff --git a/libs/providers/flagd/package.json b/libs/providers/flagd/package.json
@@ -6,7 +6,7 @@
     "current-version": "echo $npm_package_version"
   },
   "dependencies": {
-    "@openfeature/flagd-core": "~0.1.7"
+    "@openfeature/flagd-core": "~0.1.10"
   },
   "peerDependencies": {
     "@grpc/grpc-js": "~1.8.0 || ~1.9.0",

diff --git a/libs/providers/flagd/src/lib/configuration.spec.ts b/libs/providers/flagd/src/lib/configuration.spec.ts
@@ -30,6 +30,7 @@ describe('Configuration', () => {
     const cache = 'disabled';
     const resolverType = 'in-process';
     const selector = 'app=weather';
+    const offlineFlagSourcePath = '/tmp/flags.json';
 
     process.env['FLAGD_HOST'] = host;
     process.env['FLAGD_PORT'] = `${port}`;
@@ -39,6 +40,7 @@ describe('Configuration', () => {
     process.env['FLAGD_MAX_CACHE_SIZE'] = `${maxCacheSize}`;
     process.env['FLAGD_SOURCE_SELECTOR'] = `${selector}`;
     process.env['FLAGD_RESOLVER'] = `${resolverType}`;
+    process.env['FLAGD_OFFLINE_FLAG_SOURCE_PATH'] = offlineFlagSourcePath;
 
     expect(getConfig()).toStrictEqual({
       host,
@@ -49,6 +51,7 @@ describe('Configuration', () => {
       cache,
       resolverType,
       selector,
+      offlineFlagSourcePath,
     });
   });
 

diff --git a/libs/providers/flagd/src/lib/configuration.ts b/libs/providers/flagd/src/lib/configuration.ts
@@ -91,6 +91,7 @@ enum ENV_VAR {
   FLAGD_MAX_CACHE_SIZE = 'FLAGD_MAX_CACHE_SIZE',
   FLAGD_SOURCE_SELECTOR = 'FLAGD_SOURCE_SELECTOR',
   FLAGD_RESOLVER = 'FLAGD_RESOLVER',
+  FLAGD_OFFLINE_FLAG_SOURCE_PATH = 'FLAGD_OFFLINE_FLAG_SOURCE_PATH',
 }
 
 const getEnvVarConfig = (): Partial<Config> => ({
@@ -118,6 +119,9 @@ const getEnvVarConfig = (): Partial<Config> => ({
   ...((process.env[ENV_VAR.FLAGD_RESOLVER] === 'rpc' || process.env[ENV_VAR.FLAGD_RESOLVER] === 'in-process') && {
     resolverType: process.env[ENV_VAR.FLAGD_RESOLVER],
   }),
+  ...(process.env[ENV_VAR.FLAGD_OFFLINE_FLAG_SOURCE_PATH] && {
+    offlineFlagSourcePath: process.env[ENV_VAR.FLAGD_OFFLINE_FLAG_SOURCE_PATH],
+  }),
 });
 
 export function getConfig(options: FlagdProviderOptions = {}) {

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -46,7 +46,7 @@
     "@nx/web": "16.9.1",
     "@nx/workspace": "16.9.1",
     "@openfeature/core": "^0.0.21",
-    "@openfeature/flagd-core": ">=0.1.7",
+    "@openfeature/flagd-core": ">=0.1.10",
     "@openfeature/server-sdk": "^1.8.0",
     "@openfeature/web-sdk": "^0.4.0",
     "@opentelemetry/sdk-metrics": "^1.15.0",
@@ -83,4 +83,4 @@
     "ts-node": "10.9.2",
     "typescript": "5.1.6"
   }
-}
+}