@openfeature/flagd-provider 0.8.1 → 0.8.3

package/README.md

@@ -1,4 +1,4 @@
-# Server-side flagd Provider
+# Server-Side flagd Provider
 
 Flagd is a simple daemon for evaluating feature flags.
 It is designed to conform to OpenFeature schema for flag definitions.
@@ -21,19 +21,19 @@ $ npm install @openfeature/js-sdk
 The `FlagdProvider` supports multiple configuration options that determine now the SDK communicates with flagd.
 Options can be defined in the constructor or as environment variables, with constructor options having the highest precedence.
 
-### Available options
+### Available Options
 
-| Option name           | Environment variable name       | Type    | Default   | Values        |
-| --------------------- | ------------------------------- | ------- | --------- | ------------- |
-| host                  | FLAGD_HOST                      | string  | localhost |               |
-| port                  | FLAGD_PORT                      | number  | 8013      |               |
-| tls                   | FLAGD_TLS                       | boolean | false     |               |
-| socketPath            | FLAGD_SOCKET_PATH               | string  | -         |               |
-| cache                 | FLAGD_CACHE                     | string  | lru       | lru,disabled  |
-| maxCacheSize          | FLAGD_MAX_CACHE_SIZE            | int     | 1000      |               |
-| maxEventStreamRetries | FLAGD_MAX_EVENT_STREAM_RETRIES  | int     | 5         |               |
+| Option name           | Environment variable name      | Type    | Default   | Values       |
+| --------------------- | ------------------------------ | ------- | --------- | ------------ |
+| host                  | FLAGD_HOST                     | string  | localhost |              |
+| port                  | FLAGD_PORT                     | number  | 8013      |              |
+| tls                   | FLAGD_TLS                      | boolean | false     |              |
+| socketPath            | FLAGD_SOCKET_PATH              | string  | -         |              |
+| cache                 | FLAGD_CACHE                    | string  | lru       | lru,disabled |
+| maxCacheSize          | FLAGD_MAX_CACHE_SIZE           | int     | 1000      |              |
+| maxEventStreamRetries | FLAGD_MAX_EVENT_STREAM_RETRIES | int     | 5         |              |
 
-### Example using TCP
+### Example Using TCP
 
 ```
   OpenFeature.setProvider(new FlagdProvider({
@@ -42,7 +42,7 @@ Options can be defined in the constructor or as environment variables, with cons
   }))
 ```
 
-### Example using a Unix socket
+### Example Using a Unix Socket
 
 ```
   OpenFeature.setProvider(new FlagdProvider({
@@ -50,7 +50,7 @@ Options can be defined in the constructor or as environment variables, with cons
   }))
 ```
 
-### Supported events
+### Supported Events
 
 The flagd provider emits `PROVIDER_READY`, `PROVIDER_ERROR` and `PROVIDER_CONFIGURATION_CHANGED` events.
 
@@ -62,12 +62,18 @@ The flagd provider emits `PROVIDER_READY`, `PROVIDER_ERROR` and `PROVIDER_CONFIG
 
 For general information on events, see the [official documentation](https://openfeature.dev/docs/reference/concepts/events).
 
+### Flag Metadata
+
+| Field   | Type   | Value                                             |
+| ------- | ------ | ------------------------------------------------- |
+| `scope` | string | "selector" set for the associated source in flagd |
+
 ## Building
 
 Run `nx package providers-flagd` to build the library.
 
 > NOTE: [Buf](https://docs.buf.build/installation) must be installed to build locally.
 
-## Running unit tests
+## Running Unit Tests
 
 Run `nx test providers-flagd` to execute the unit tests via [Jest](https://jestjs.io).

package/index.cjs

@@ -2682,7 +2682,7 @@ function newError(name) {
             configurable: true,
         },
         name: {
-            get: function get() { return name; },
+            get() { return name; },
             set: undefined,
             enumerable: false,
             // configurable: false would accurately preserve the behavior of
@@ -2692,7 +2692,7 @@ function newError(name) {
             configurable: true,
         },
         toString: {
-            value: function value() { return this.name + ": " + this.message; },
+            value() { return this.name + ": " + this.message; },
             writable: true,
             enumerable: false,
             configurable: true,
@@ -5980,7 +5980,9 @@ class GRPCService {
             this._streamConnectAttempt++;
             setTimeout(() => {
                 this._streamConnectBackoff = this._streamConnectBackoff * 2;
-                this.connectStream(connectCallback, changedCallback, disconnectCallback);
+                this.connectStream(connectCallback, changedCallback, disconnectCallback).catch(() => {
+                    // empty catch to avoid unhandled promise rejection
+                });
             }, this._streamConnectBackoff);
         }
         else {
@@ -5992,7 +5994,7 @@ class GRPCService {
     }
     handleClose() {
         var _a, _b;
-        (_a = this.logger) === null || _a === void 0 ? void 0 : _a.info(`${FlagdProvider.name}: streaming connection closed gracefully`);
+        (_a = this.logger) === null || _a === void 0 ? void 0 : _a.info(`${FlagdProvider.name}: streaming connection closed`);
         (_b = this._cache) === null || _b === void 0 ? void 0 : _b.clear();
         this._streamAlive = false;
     }
@@ -6015,6 +6017,7 @@ class GRPCService {
                 value: parser.call(this, response.value),
                 reason: response.reason,
                 variant: response.variant,
+                flagMetadata: response.metadata,
             };
             logger.debug(`${FlagdProvider.name}: resolved flag with key: ${resolved.value}, variant: ${response.variant}, reason: ${response.reason}`);
             if (this._cacheActive && response.reason === jsSdk.StandardResolutionReasons.STATIC) {

package/index.js

@@ -2678,7 +2678,7 @@ function newError(name) {
             configurable: true,
         },
         name: {
-            get: function get() { return name; },
+            get() { return name; },
             set: undefined,
             enumerable: false,
             // configurable: false would accurately preserve the behavior of
@@ -2688,7 +2688,7 @@ function newError(name) {
             configurable: true,
         },
         toString: {
-            value: function value() { return this.name + ": " + this.message; },
+            value() { return this.name + ": " + this.message; },
             writable: true,
             enumerable: false,
             configurable: true,
@@ -5976,7 +5976,9 @@ class GRPCService {
             this._streamConnectAttempt++;
             setTimeout(() => {
                 this._streamConnectBackoff = this._streamConnectBackoff * 2;
-                this.connectStream(connectCallback, changedCallback, disconnectCallback);
+                this.connectStream(connectCallback, changedCallback, disconnectCallback).catch(() => {
+                    // empty catch to avoid unhandled promise rejection
+                });
             }, this._streamConnectBackoff);
         }
         else {
@@ -5988,7 +5990,7 @@ class GRPCService {
     }
     handleClose() {
         var _a, _b;
-        (_a = this.logger) === null || _a === void 0 ? void 0 : _a.info(`${FlagdProvider.name}: streaming connection closed gracefully`);
+        (_a = this.logger) === null || _a === void 0 ? void 0 : _a.info(`${FlagdProvider.name}: streaming connection closed`);
         (_b = this._cache) === null || _b === void 0 ? void 0 : _b.clear();
         this._streamAlive = false;
     }
@@ -6011,6 +6013,7 @@ class GRPCService {
                 value: parser.call(this, response.value),
                 reason: response.reason,
                 variant: response.variant,
+                flagMetadata: response.metadata,
             };
             logger.debug(`${FlagdProvider.name}: resolved flag with key: ${resolved.value}, variant: ${response.variant}, reason: ${response.reason}`);
             if (this._cacheActive && response.reason === StandardResolutionReasons.STATIC) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfeature/flagd-provider",
-  "version": "0.8.1",
+  "version": "0.8.3",
   "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",
     "current-version": "echo $npm_package_version"