@openfeature/flagd-provider 0.8.0 → 0.8.2

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

@@ -5888,7 +5888,9 @@ class GRPCService {
     disconnect() {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            (_a = this._stream) === null || _a === void 0 ? void 0 : _a.destroy();
+            // cancel the stream and close the connection
+            (_a = this._stream) === null || _a === void 0 ? void 0 : _a.cancel();
+            this._client.close();
         });
     }
     resolveBoolean(flagKey, context, logger) {
@@ -5915,9 +5917,15 @@ class GRPCService {
         return new Promise((resolve, reject) => {
             var _a;
             (_a = this.logger) === null || _a === void 0 ? void 0 : _a.debug(`${FlagdProvider.name}: connecting stream, attempt ${this._streamConnectAttempt}...`);
-            const stream = this._client.eventStream({});
-            stream.on('error', () => {
-                this.handleError(reject, connectCallback, changedCallback, disconnectCallback);
+            const stream = this._client.eventStream({}, {});
+            stream.on('error', (err) => {
+                var _a;
+                if ((err === null || err === void 0 ? void 0 : err.code) === grpcJs.status.CANCELLED) {
+                    (_a = this.logger) === null || _a === void 0 ? void 0 : _a.debug(`${FlagdProvider.name}: stream cancelled, will not be re-established`);
+                }
+                else {
+                    this.handleError(reject, connectCallback, changedCallback, disconnectCallback);
+                }
             });
             stream.on('close', () => {
                 this.handleClose();
@@ -6007,6 +6015,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

@@ -5884,7 +5884,9 @@ class GRPCService {
     disconnect() {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            (_a = this._stream) === null || _a === void 0 ? void 0 : _a.destroy();
+            // cancel the stream and close the connection
+            (_a = this._stream) === null || _a === void 0 ? void 0 : _a.cancel();
+            this._client.close();
         });
     }
     resolveBoolean(flagKey, context, logger) {
@@ -5911,9 +5913,15 @@ class GRPCService {
         return new Promise((resolve, reject) => {
             var _a;
             (_a = this.logger) === null || _a === void 0 ? void 0 : _a.debug(`${FlagdProvider.name}: connecting stream, attempt ${this._streamConnectAttempt}...`);
-            const stream = this._client.eventStream({});
-            stream.on('error', () => {
-                this.handleError(reject, connectCallback, changedCallback, disconnectCallback);
+            const stream = this._client.eventStream({}, {});
+            stream.on('error', (err) => {
+                var _a;
+                if ((err === null || err === void 0 ? void 0 : err.code) === status.CANCELLED) {
+                    (_a = this.logger) === null || _a === void 0 ? void 0 : _a.debug(`${FlagdProvider.name}: stream cancelled, will not be re-established`);
+                }
+                else {
+                    this.handleError(reject, connectCallback, changedCallback, disconnectCallback);
+                }
             });
             stream.on('close', () => {
                 this.handleClose();
@@ -6003,6 +6011,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.0",
+  "version": "0.8.2",
   "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"

package/src/lib/flagd-provider.d.ts

@@ -2,7 +2,7 @@ import { EvaluationContext, JsonValue, Logger, OpenFeatureEventEmitter, Provider
 import { FlagdProviderOptions } from './configuration';
 import { Service } from './service/service';
 export declare class FlagdProvider implements Provider {
-    private logger?;
+    private readonly logger?;
     metadata: {
         name: string;
     };