@openfeature/flagd-provider 0.13.2 → 0.13.3

package/README.md

@@ -38,6 +38,7 @@ Options can be defined in the constructor or as environment variables. Construct
 | selector                               | FLAGD_SOURCE_SELECTOR          | string  | -                                                              |                  |
 | cache                                  | FLAGD_CACHE                    | string  | lru                                                            | lru, disabled    |
 | maxCacheSize                           | FLAGD_MAX_CACHE_SIZE           | int     | 1000                                                           |                  |
+| defaultAuthority                       | FLAGD_DEFAULT_AUTHORITY        | string  | -                                                              | rpc, in-process  |
 
 #### Resolver type-specific Defaults
 
@@ -93,6 +94,18 @@ To enable this mode, you should provide a valid flag configuration file with the
 Offline mode uses `fs.watchFile` and polls every 5 seconds for changes to the file.
 This mode is useful for local development, test cases, and for offline applications.
 
+### Default Authority usage (optional)
+
+This is useful for complex routing or service-discovery use cases that involve a proxy (e.g., Envoy).
+Please refer to this [GitHub issue](https://github.com/open-feature/js-sdk-contrib/issues/1187) for more information.
+
+```ts
+  OpenFeature.setProvider(new FlagdProvider({
+      resolverType: 'in-process',
+      defaultAuthority: 'b-target-api.service',
+  }))
+```
+
 ### Supported Events
 
 The flagd provider emits `PROVIDER_READY`, `PROVIDER_ERROR` and `PROVIDER_CONFIGURATION_CHANGED` events.

package/index.cjs.js

@@ -64,10 +64,11 @@ var ENV_VAR;
     ENV_VAR["FLAGD_SOURCE_SELECTOR"] = "FLAGD_SOURCE_SELECTOR";
     ENV_VAR["FLAGD_RESOLVER"] = "FLAGD_RESOLVER";
     ENV_VAR["FLAGD_OFFLINE_FLAG_SOURCE_PATH"] = "FLAGD_OFFLINE_FLAG_SOURCE_PATH";
+    ENV_VAR["FLAGD_DEFAULT_AUTHORITY"] = "FLAGD_DEFAULT_AUTHORITY";
 })(ENV_VAR || (ENV_VAR = {}));
 const getEnvVarConfig = () => {
     var _a;
-    return (Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, (process.env[ENV_VAR.FLAGD_HOST] && {
+    return (Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, (process.env[ENV_VAR.FLAGD_HOST] && {
         host: process.env[ENV_VAR.FLAGD_HOST],
     })), (Number(process.env[ENV_VAR.FLAGD_PORT]) && {
         port: Number(process.env[ENV_VAR.FLAGD_PORT]),
@@ -85,6 +86,8 @@ const getEnvVarConfig = () => {
         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],
+    })), (process.env[ENV_VAR.FLAGD_DEFAULT_AUTHORITY] && {
+        defaultAuthority: process.env[ENV_VAR.FLAGD_DEFAULT_AUTHORITY],
     })));
 };
 function getConfig(options = {}) {
@@ -4793,13 +4796,16 @@ const ResolveAllRequest = {
     },
 };
 function createBaseResolveAllResponse() {
-    return { flags: {} };
+    return { flags: {}, metadata: undefined };
 }
 const ResolveAllResponse = {
     encode(message, writer = _m0.Writer.create()) {
         Object.entries(message.flags).forEach(([key, value]) => {
             ResolveAllResponse_FlagsEntry.encode({ key: key, value }, writer.uint32(10).fork()).ldelim();
         });
+        if (message.metadata !== undefined) {
+            Struct.encode(Struct.wrap(message.metadata), writer.uint32(18).fork()).ldelim();
+        }
         return writer;
     },
     decode(input, length) {
@@ -4818,6 +4824,12 @@ const ResolveAllResponse = {
                         message.flags[entry1.key] = entry1.value;
                     }
                     continue;
+                case 2:
+                    if (tag !== 18) {
+                        break;
+                    }
+                    message.metadata = Struct.unwrap(Struct.decode(reader, reader.uint32()));
+                    continue;
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -4834,6 +4846,7 @@ const ResolveAllResponse = {
                     return acc;
                 }, {})
                 : {},
+            metadata: isObject$1(object.metadata) ? object.metadata : undefined,
         };
     },
     toJSON(message) {
@@ -4847,13 +4860,16 @@ const ResolveAllResponse = {
                 });
             }
         }
+        if (message.metadata !== undefined) {
+            obj.metadata = message.metadata;
+        }
         return obj;
     },
     create(base) {
         return ResolveAllResponse.fromPartial(base !== null && base !== undefined ? base : {});
     },
     fromPartial(object) {
-        var _a;
+        var _a, _b;
         const message = createBaseResolveAllResponse();
         message.flags = Object.entries((_a = object.flags) !== null && _a !== undefined ? _a : {}).reduce((acc, [key, value]) => {
             if (value !== undefined) {
@@ -4861,6 +4877,7 @@ const ResolveAllResponse = {
             }
             return acc;
         }, {});
+        message.metadata = (_b = object.metadata) !== null && _b !== undefined ? _b : undefined;
         return message;
     },
 };
@@ -6109,10 +6126,16 @@ class GRPCService {
                     throw new serverSdk.GeneralError(err === null || err === undefined ? undefined : err.details);
             }
         };
-        const { host, port, tls, socketPath } = config;
+        const { host, port, tls, socketPath, defaultAuthority } = config;
+        let clientOptions;
+        if (defaultAuthority) {
+            clientOptions = {
+                'grpc.default_authority': defaultAuthority,
+            };
+        }
         this._client = client
             ? client
-            : new ServiceClient(socketPath ? `unix://${socketPath}` : `${host}:${port}`, tls ? grpcJs.credentials.createSsl() : grpcJs.credentials.createInsecure());
+            : new ServiceClient(socketPath ? `unix://${socketPath}` : `${host}:${port}`, tls ? grpcJs.credentials.createSsl() : grpcJs.credentials.createInsecure(), clientOptions);
         if (config.cache === 'lru') {
             this._cacheEnabled = true;
             this._cache = new lruCache.LRUCache({ maxSize: config.maxCacheSize || DEFAULT_MAX_CACHE_SIZE, sizeCalculation: () => 1 });
@@ -6670,10 +6693,16 @@ class GrpcFetch {
          * false if the connection is lost.
          */
         this._isConnected = false;
-        const { host, port, tls, socketPath, selector } = config;
+        const { host, port, tls, socketPath, selector, defaultAuthority } = config;
+        let clientOptions;
+        if (defaultAuthority) {
+            clientOptions = {
+                'grpc.default_authority': defaultAuthority,
+            };
+        }
         this._syncClient = syncServiceClient
             ? syncServiceClient
-            : new FlagSyncServiceClient(socketPath ? `unix://${socketPath}` : `${host}:${port}`, tls ? grpcJs.credentials.createSsl() : grpcJs.credentials.createInsecure());
+            : new FlagSyncServiceClient(socketPath ? `unix://${socketPath}` : `${host}:${port}`, tls ? grpcJs.credentials.createSsl() : grpcJs.credentials.createInsecure(), clientOptions);
         this._logger = logger;
         this._request = { providerId: '', selector: selector ? selector : '' };
     }

package/index.esm.js

@@ -62,10 +62,11 @@ var ENV_VAR;
     ENV_VAR["FLAGD_SOURCE_SELECTOR"] = "FLAGD_SOURCE_SELECTOR";
     ENV_VAR["FLAGD_RESOLVER"] = "FLAGD_RESOLVER";
     ENV_VAR["FLAGD_OFFLINE_FLAG_SOURCE_PATH"] = "FLAGD_OFFLINE_FLAG_SOURCE_PATH";
+    ENV_VAR["FLAGD_DEFAULT_AUTHORITY"] = "FLAGD_DEFAULT_AUTHORITY";
 })(ENV_VAR || (ENV_VAR = {}));
 const getEnvVarConfig = () => {
     var _a;
-    return (Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, (process.env[ENV_VAR.FLAGD_HOST] && {
+    return (Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, (process.env[ENV_VAR.FLAGD_HOST] && {
         host: process.env[ENV_VAR.FLAGD_HOST],
     })), (Number(process.env[ENV_VAR.FLAGD_PORT]) && {
         port: Number(process.env[ENV_VAR.FLAGD_PORT]),
@@ -83,6 +84,8 @@ const getEnvVarConfig = () => {
         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],
+    })), (process.env[ENV_VAR.FLAGD_DEFAULT_AUTHORITY] && {
+        defaultAuthority: process.env[ENV_VAR.FLAGD_DEFAULT_AUTHORITY],
     })));
 };
 function getConfig(options = {}) {
@@ -4791,13 +4794,16 @@ const ResolveAllRequest = {
     },
 };
 function createBaseResolveAllResponse() {
-    return { flags: {} };
+    return { flags: {}, metadata: undefined };
 }
 const ResolveAllResponse = {
     encode(message, writer = _m0.Writer.create()) {
         Object.entries(message.flags).forEach(([key, value]) => {
             ResolveAllResponse_FlagsEntry.encode({ key: key, value }, writer.uint32(10).fork()).ldelim();
         });
+        if (message.metadata !== undefined) {
+            Struct.encode(Struct.wrap(message.metadata), writer.uint32(18).fork()).ldelim();
+        }
         return writer;
     },
     decode(input, length) {
@@ -4816,6 +4822,12 @@ const ResolveAllResponse = {
                         message.flags[entry1.key] = entry1.value;
                     }
                     continue;
+                case 2:
+                    if (tag !== 18) {
+                        break;
+                    }
+                    message.metadata = Struct.unwrap(Struct.decode(reader, reader.uint32()));
+                    continue;
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -4832,6 +4844,7 @@ const ResolveAllResponse = {
                     return acc;
                 }, {})
                 : {},
+            metadata: isObject$1(object.metadata) ? object.metadata : undefined,
         };
     },
     toJSON(message) {
@@ -4845,13 +4858,16 @@ const ResolveAllResponse = {
                 });
             }
         }
+        if (message.metadata !== undefined) {
+            obj.metadata = message.metadata;
+        }
         return obj;
     },
     create(base) {
         return ResolveAllResponse.fromPartial(base !== null && base !== undefined ? base : {});
     },
     fromPartial(object) {
-        var _a;
+        var _a, _b;
         const message = createBaseResolveAllResponse();
         message.flags = Object.entries((_a = object.flags) !== null && _a !== undefined ? _a : {}).reduce((acc, [key, value]) => {
             if (value !== undefined) {
@@ -4859,6 +4875,7 @@ const ResolveAllResponse = {
             }
             return acc;
         }, {});
+        message.metadata = (_b = object.metadata) !== null && _b !== undefined ? _b : undefined;
         return message;
     },
 };
@@ -6107,10 +6124,16 @@ class GRPCService {
                     throw new GeneralError(err === null || err === undefined ? undefined : err.details);
             }
         };
-        const { host, port, tls, socketPath } = config;
+        const { host, port, tls, socketPath, defaultAuthority } = config;
+        let clientOptions;
+        if (defaultAuthority) {
+            clientOptions = {
+                'grpc.default_authority': defaultAuthority,
+            };
+        }
         this._client = client
             ? client
-            : new ServiceClient(socketPath ? `unix://${socketPath}` : `${host}:${port}`, tls ? credentials.createSsl() : credentials.createInsecure());
+            : new ServiceClient(socketPath ? `unix://${socketPath}` : `${host}:${port}`, tls ? credentials.createSsl() : credentials.createInsecure(), clientOptions);
         if (config.cache === 'lru') {
             this._cacheEnabled = true;
             this._cache = new LRUCache({ maxSize: config.maxCacheSize || DEFAULT_MAX_CACHE_SIZE, sizeCalculation: () => 1 });
@@ -6668,10 +6691,16 @@ class GrpcFetch {
          * false if the connection is lost.
          */
         this._isConnected = false;
-        const { host, port, tls, socketPath, selector } = config;
+        const { host, port, tls, socketPath, selector, defaultAuthority } = config;
+        let clientOptions;
+        if (defaultAuthority) {
+            clientOptions = {
+                'grpc.default_authority': defaultAuthority,
+            };
+        }
         this._syncClient = syncServiceClient
             ? syncServiceClient
-            : new FlagSyncServiceClient(socketPath ? `unix://${socketPath}` : `${host}:${port}`, tls ? credentials.createSsl() : credentials.createInsecure());
+            : new FlagSyncServiceClient(socketPath ? `unix://${socketPath}` : `${host}:${port}`, tls ? credentials.createSsl() : credentials.createInsecure(), clientOptions);
         this._logger = logger;
         this._request = { providerId: '', selector: selector ? selector : '' };
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfeature/flagd-provider",
-  "version": "0.13.2",
+  "version": "0.13.3",
   "license": "Apache-2.0",
   "scripts": {
     "publish-if-not-exists": "cp $NPM_CONFIG_USERCONFIG .npmrc && if [ \"$(npm show $npm_package_name@$npm_package_version version)\" = \"$(npm run current-version -s)\" ]; then echo 'already published, skipping'; else npm publish --access public; fi",

package/src/lib/configuration.d.ts

@@ -57,6 +57,11 @@ export interface Config {
      * @default 1000
      */
     maxCacheSize?: number;
+    /**
+     * The target host (authority) when routing requests through a proxy (e.g. Envoy)
+     *
+     */
+    defaultAuthority?: string;
 }
 export type FlagdProviderOptions = Partial<Config>;
 export declare function getConfig(options?: FlagdProviderOptions): {
@@ -69,4 +74,5 @@ export declare function getConfig(options?: FlagdProviderOptions): {
     selector?: string;
     cache?: CacheOption;
     maxCacheSize?: number;
+    defaultAuthority?: string;
 };

package/src/proto/ts/flagd/evaluation/v1/evaluation.d.ts

@@ -21,6 +21,10 @@ export interface ResolveAllResponse {
     flags: {
         [key: string]: AnyFlag;
     };
+    /** Metadata for the bulk evaluation */
+    metadata: {
+        [key: string]: any;
+    } | undefined;
 }
 export interface ResolveAllResponse_FlagsEntry {
     key: string;
@@ -38,7 +42,7 @@ export interface AnyFlag {
     objectValue?: {
         [key: string]: any;
     } | undefined;
-    /** Metadata about this flag, see https://openfeature.dev/specification/types/#flag-metadata */
+    /** Metadata for this evaluation */
     metadata: {
         [key: string]: any;
     } | undefined;