Merge branch 'main' into release-please--branches--main--components--flagd-web-provider

Signed-off-by: Todd Baert <[email protected]>

Author: toddbaert

.release-please-manifest.json

@@ -1,10 +1,10 @@
 {
   "libs/hooks/open-telemetry": "0.2.2",
-  "libs/providers/go-feature-flag": "0.5.12",
-  "libs/providers/flagd": "0.7.7",
+  "libs/providers/go-feature-flag": "0.5.13",
+  "libs/providers/flagd": "0.8.1",
   "libs/providers/flagd-web": "0.3.5",
   "libs/providers/env-var": "0.1.1",
   "libs/providers/in-memory": "0.2.0",
-  "libs/providers/config-cat": "0.2.0",
+  "libs/providers/config-cat": "0.3.0",
   "libs/providers/launchdarkly-client": "0.1.2"
 }

libs/providers/config-cat/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## [0.3.0](https://github.com/open-feature/js-sdk-contrib/compare/config-cat-provider-v0.2.0...config-cat-provider-v0.3.0) (2023-07-27)
+
+
+### ⚠ BREAKING CHANGES
+
+* remove configcat 7 peer dependency ([#435](https://github.com/open-feature/js-sdk-contrib/issues/435))
+
+### 🐛 Bug Fixes
+
+* **config-cat:** add status flag to provider ([#491](https://github.com/open-feature/js-sdk-contrib/issues/491)) ([f599c31](https://github.com/open-feature/js-sdk-contrib/commit/f599c3145881b81107c9a65b2c4cfe2a8b4111f1))
+* remove configcat 7 peer dependency ([#435](https://github.com/open-feature/js-sdk-contrib/issues/435)) ([da5d212](https://github.com/open-feature/js-sdk-contrib/commit/da5d21208e8929f7cdfc805e256cb892968bcd95))
+
 ## [0.2.0](https://github.com/open-feature/js-sdk-contrib/compare/config-cat-provider-v0.1.1...config-cat-provider-v0.2.0) (2023-06-27)
 
 

libs/providers/config-cat/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfeature/config-cat-provider",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "type": "commonjs",
   "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",

libs/providers/config-cat/src/lib/config-cat-provider.spec.ts

@@ -1,5 +1,5 @@
 import { ConfigCatProvider } from './config-cat-provider';
-import { ParseError, ProviderEvents, TypeMismatchError } from '@openfeature/js-sdk';
+import { ParseError, ProviderEvents, ProviderStatus, TypeMismatchError } from '@openfeature/js-sdk';
 import {
   createConsoleLogger,
   createFlagOverridesFromMap,
@@ -42,8 +42,8 @@ describe('ConfigCatProvider', () => {
     configCatEmitter = (provider.configCatClient as any).options.hooks;
   });
 
-  afterAll(() => {
-    provider.onClose();
+  afterAll(async () => {
+    await provider.onClose();
   });
 
   it('should be an instance of ConfigCatProvider', () => {
@@ -69,6 +69,31 @@ describe('ConfigCatProvider', () => {
     expect(clientDisposeSpy).toHaveBeenCalled();
   });
 
+  describe('status', () => {
+    it('should be NOT_READY before initialization and READY after successful initialization', async () => {
+      const newProvider = ConfigCatProvider.create('key', PollingMode.ManualPoll, {
+        logger: createConsoleLogger(LogLevel.Off),
+        offline: true,
+      });
+
+      expect(newProvider.status).toEqual(ProviderStatus.NOT_READY);
+      await newProvider.initialize();
+      expect(newProvider.status).toEqual(ProviderStatus.READY);
+    });
+
+    it('should set status to ERROR if an error occurs', async () => {
+      configCatEmitter.emit('clientError', 'Error');
+      expect(provider.status).toEqual(ProviderStatus.ERROR);
+    });
+
+    it('should set status back to READY if client switches back to ready after an error occured', async () => {
+      configCatEmitter.emit('clientError', 'Error');
+      expect(provider.status).toEqual(ProviderStatus.ERROR);
+      configCatEmitter.emit('clientReady');
+      expect(provider.status).toEqual(ProviderStatus.READY);
+    });
+  });
+
   describe('events', () => {
     it('should emit PROVIDER_READY event', () => {
       const handler = jest.fn();

libs/providers/config-cat/src/lib/config-cat-provider.ts

@@ -6,34 +6,40 @@ import {
   ParseError,
   Provider,
   ProviderEvents,
+  ProviderStatus,
   ResolutionDetails,
   ResolutionReason,
   StandardResolutionReasons,
   TypeMismatchError,
 } from '@openfeature/js-sdk';
-import { getClient, IConfigCatClient, IEvaluationDetails, SettingValue } from 'configcat-js';
+import { getClient, IConfig, IConfigCatClient, IEvaluationDetails, SettingValue } from 'configcat-js';
 import { transformContext } from './context-transformer';
 
 export class ConfigCatProvider implements Provider {
-  private readonly clientParameters: Parameters<typeof getClient>;
   public readonly events = new OpenFeatureEventEmitter();
-  private client?: IConfigCatClient;
+  private _status: ProviderStatus = ProviderStatus.NOT_READY;
+  private readonly _clientParameters: Parameters<typeof getClient>;
+  private _client?: IConfigCatClient;
 
   public metadata = {
     name: ConfigCatProvider.name,
   };
 
   constructor(...params: Parameters<typeof getClient>) {
-    this.clientParameters = params;
+    this._clientParameters = params;
   }
 
   public static create(...params: Parameters<typeof getClient>) {
     return new ConfigCatProvider(...params);
   }
 
+  get status() {
+    return this._status;
+  }
+
   public async initialize(): Promise<void> {
     return new Promise((resolve) => {
-      const originalParameters = this.clientParameters;
+      const originalParameters = this._clientParameters;
       originalParameters[2] ??= {};
 
       const options = originalParameters[2];
@@ -43,48 +49,54 @@ export class ConfigCatProvider implements Provider {
         oldSetupHooks?.(hooks);
 
         // After resolving, once, we can simply emit events the next time
-        hooks.once('clientReady', () => {
-          hooks.on('clientReady', () => this.events.emit(ProviderEvents.Ready));
+        const onProviderReady = () => {
           this.events.emit(ProviderEvents.Ready);
+          this._status = ProviderStatus.READY;
+        };
+
+        hooks.once('clientReady', () => {
+          hooks.on('clientReady', onProviderReady);
+          onProviderReady();
           resolve();
         });
 
-        hooks.on('configChanged', (projectConfig) =>
+        hooks.on('configChanged', (projectConfig: IConfig | undefined) =>
           this.events.emit(ProviderEvents.ConfigurationChanged, {
-            flagsChanged: Object.keys(projectConfig.settings),
+            flagsChanged: projectConfig ? Object.keys(projectConfig.settings) : undefined,
           })
         );
 
-        hooks.on('clientError', (message: string, error) =>
+        hooks.on('clientError', (message: string, error) => {
+          this._status = ProviderStatus.ERROR;
           this.events.emit(ProviderEvents.Error, {
             message: message,
             metadata: error,
-          })
-        );
+          });
+        });
       };
 
-      this.client = getClient(...originalParameters);
+      this._client = getClient(...originalParameters);
     });
   }
 
   public get configCatClient() {
-    return this.client;
+    return this._client;
   }
 
   public async onClose(): Promise<void> {
-    await this.client?.dispose();
+    await this._client?.dispose();
   }
 
   async resolveBooleanEvaluation(
     flagKey: string,
     defaultValue: boolean,
     context: EvaluationContext
   ): Promise<ResolutionDetails<boolean>> {
-    if (!this.client) {
+    if (!this._client) {
       throw new GeneralError('Provider is not initialized');
     }
 
-    const { value, ...evaluationData } = await this.client.getValueDetailsAsync<SettingValue>(
+    const { value, ...evaluationData } = await this._client.getValueDetailsAsync<SettingValue>(
       flagKey,
       undefined,
       transformContext(context)
@@ -102,11 +114,11 @@ export class ConfigCatProvider implements Provider {
     defaultValue: string,
     context: EvaluationContext
   ): Promise<ResolutionDetails<string>> {
-    if (!this.client) {
+    if (!this._client) {
       throw new GeneralError('Provider is not initialized');
     }
 
-    const { value, ...evaluationData } = await this.client.getValueDetailsAsync<SettingValue>(
+    const { value, ...evaluationData } = await this._client.getValueDetailsAsync<SettingValue>(
       flagKey,
       undefined,
       transformContext(context)
@@ -124,11 +136,11 @@ export class ConfigCatProvider implements Provider {
     defaultValue: number,
     context: EvaluationContext
   ): Promise<ResolutionDetails<number>> {
-    if (!this.client) {
+    if (!this._client) {
       throw new GeneralError('Provider is not initialized');
     }
 
-    const { value, ...evaluationData } = await this.client.getValueDetailsAsync<SettingValue>(
+    const { value, ...evaluationData } = await this._client.getValueDetailsAsync<SettingValue>(
       flagKey,
       undefined,
       transformContext(context)
@@ -146,11 +158,11 @@ export class ConfigCatProvider implements Provider {
     defaultValue: U,
     context: EvaluationContext
   ): Promise<ResolutionDetails<U>> {
-    if (!this.client) {
+    if (!this._client) {
       throw new GeneralError('Provider is not initialized');
     }
 
-    const { value, ...evaluationData } = await this.client.getValueDetailsAsync(
+    const { value, ...evaluationData } = await this._client.getValueDetailsAsync(
       flagKey,
       undefined,
       transformContext(context)

libs/providers/flagd/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 
+## [0.8.1](https://github.com/open-feature/js-sdk-contrib/compare/flagd-provider-v0.8.0...flagd-provider-v0.8.1) (2023-07-27)
+
+
+### 🐛 Bug Fixes
+
+* issue with flagd not disconnecting ([#495](https://github.com/open-feature/js-sdk-contrib/issues/495)) ([ff61206](https://github.com/open-feature/js-sdk-contrib/commit/ff61206f7f51fd5ec30fc85ea2742c0933384330))
+
+## [0.8.0](https://github.com/open-feature/js-sdk-contrib/compare/flagd-provider-v0.7.7...flagd-provider-v0.8.0) (2023-07-27)
+
+
+### ⚠ BREAKING CHANGES
+
+* events, init, shutdown ([#484](https://github.com/open-feature/js-sdk-contrib/issues/484))
+  * constructor arg order changed
+  * 1.3.0 minimum js-sdk version
+
+### ✨ New Features
+
+* events, init, shutdown ([#484](https://github.com/open-feature/js-sdk-contrib/issues/484)) ([a73fc76](https://github.com/open-feature/js-sdk-contrib/commit/a73fc7670c66b2108cef8132a94433d75dea3622))
+
+
+### 🧹 Chore
+
+* migrate buf ([#456](https://github.com/open-feature/js-sdk-contrib/issues/456)) ([8568af1](https://github.com/open-feature/js-sdk-contrib/commit/8568af1e26f92f4d0e9a942b9fc3e001d919ef03))
+
 ## [0.7.7](https://github.com/open-feature/js-sdk-contrib/compare/flagd-provider-v0.7.6...flagd-provider-v0.7.7) (2023-07-03)
 
 

libs/providers/flagd/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfeature/flagd-provider",
-  "version": "0.7.7",
+  "version": "0.8.1",
   "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"

libs/providers/flagd/package.json

@@ -71,9 +71,10 @@ describe(FlagdProvider.name, () => {
               callback({ type: EVENT_PROVIDER_READY });
             }
           }),
-          destroy: jest.fn(),
+          cancel: jest.fn(),
         };
       }),
+      close: jest.fn(),
       resolveBoolean: jest.fn((request: ResolveBooleanRequest, callback: (error: ServiceError | null, response: ResolveBooleanResponse) => void) => {
         callback(null, {
           value: BOOLEAN_VALUE,
@@ -198,9 +199,10 @@ describe(FlagdProvider.name, () => {
               callback({ type: EVENT_PROVIDER_READY });
             }
           }),
-          destroy: jest.fn(),
+          cancel: jest.fn(),
         };
       }),
+      close: jest.fn(),
       resolveBoolean: jest.fn((request: ResolveBooleanRequest, callback: (error: ServiceError | null, response: ResolveBooleanResponse) => void) => {
         callback(null, {
           variant: BOOLEAN_VARIANT,
@@ -312,14 +314,15 @@ describe(FlagdProvider.name, () => {
           registeredOnErrorCallback = callback;
         }
       }),
-      destroy: jest.fn(),
+      cancel: jest.fn(),
     };
 
     // mock ServiceClient to inject
     const streamingServiceClientMock = {
       eventStream: jest.fn(() => {
         return streamMock;
       }),
+      close: jest.fn(),
       resolveBoolean: jest.fn((req: ResolveBooleanRequest, callback: (error: ServiceError | null, response: ResolveBooleanResponse) => void) => {
         const response = {
           variant: BOOLEAN_VARIANT,
@@ -608,9 +611,10 @@ describe(FlagdProvider.name, () => {
               callback({ type: EVENT_PROVIDER_READY });
             }
           }),
-          destroy: jest.fn(),
+          cancel: jest.fn(),
         };
       }),
+      close: jest.fn(),
       resolveBoolean: jest.fn((request: ResolveBooleanRequest, callback: (error: ServiceError | null, response: ResolveBooleanResponse) => void) => {
         callback({ code: status.DATA_LOSS, details } as ServiceError, {} as ResolveBooleanResponse);
       }),
@@ -692,6 +696,7 @@ describe(FlagdProvider.name, () => {
   });
 
   describe('shutdown', () => {
+    const cancelMock = jest.fn();
     const closeMock = jest.fn();
 
     // mock ServiceClient to inject
@@ -703,10 +708,10 @@ describe(FlagdProvider.name, () => {
               callback({ type: EVENT_PROVIDER_READY });
             }
           }),
-          destroy: closeMock,
+          cancel: cancelMock,
         };
       }),
-      
+      close: closeMock,
     } as unknown as ServiceClient;
 
     beforeEach(() => {
@@ -718,6 +723,7 @@ describe(FlagdProvider.name, () => {
     describe(FlagdProvider.prototype.onClose.name, () => {
       it('should call service disconnect', async () => {
         await OpenFeature.close();
+        expect(cancelMock).toHaveBeenCalled();
         expect(closeMock).toHaveBeenCalled();
       });
     });

libs/providers/flagd/src/lib/flagd-provider.spec.ts

@@ -38,7 +38,7 @@ export class FlagdProvider implements Provider {
    */
   constructor(
     options?: FlagdProviderOptions,
-    private logger?: Logger,
+    private readonly logger?: Logger,
     service?: Service,
   ) {
     this._service = service ? service : new GRPCService(getConfig(options), undefined, logger);