Merge branch 'main' into update-flipt-web-underlying-sdk

Author: markphelps

.release-please-manifest.json

@@ -4,7 +4,7 @@
   "libs/providers/flagd": "0.13.3",
   "libs/providers/flagd-web": "0.7.3",
   "libs/providers/env-var": "0.3.1",
-  "libs/providers/config-cat": "0.7.4",
+  "libs/providers/config-cat": "0.7.5",
   "libs/providers/launchdarkly-client": "0.3.2",
   "libs/providers/go-feature-flag-web": "0.2.5",
   "libs/shared/flagd-core": "1.0.0",
@@ -17,7 +17,7 @@
   "libs/providers/multi-provider": "0.1.2",
   "libs/providers/multi-provider-web": "0.0.3",
   "libs/providers/growthbook-client": "0.1.2",
-  "libs/providers/config-cat-web": "0.1.5",
+  "libs/providers/config-cat-web": "0.1.6",
   "libs/shared/config-cat-core": "0.1.1",
   "libs/providers/unleash-web": "0.1.1",
   "libs/providers/growthbook": "0.1.2",

CODEOWNERS

@@ -3,4 +3,4 @@
 #
 # Managed by Peribolos: https://github.com/open-feature/community/blob/main/config/open-feature/sdk-javascript/workgroup.yaml
 #
-* @open-feature/sdk-javascript-maintainers
+* @open-feature/sdk-javascript-maintainers @open-feature/maintainers

libs/providers/config-cat-web/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.1.6](https://github.com/open-feature/js-sdk-contrib/compare/config-cat-web-provider-v0.1.5...config-cat-web-provider-v0.1.6) (2025-04-09)
+
+
+### 🐛 Bug Fixes
+
+* **config-cat:** Rework error reporting ([#1242](https://github.com/open-feature/js-sdk-contrib/issues/1242)) ([0425619](https://github.com/open-feature/js-sdk-contrib/commit/04256197bf6e7da70afd4ac1c31bdaf55ce4b789))
+
 ## [0.1.5](https://github.com/open-feature/js-sdk-contrib/compare/config-cat-web-provider-v0.1.4...config-cat-web-provider-v0.1.5) (2025-03-14)
 
 

libs/providers/config-cat-web/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfeature/config-cat-web-provider",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "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",

libs/providers/config-cat-web/package.json

@@ -3,6 +3,7 @@ import {
   createConsoleLogger,
   createFlagOverridesFromMap,
   HookEvents,
+  IConfigCatCache,
   ISettingUnion,
   LogLevel,
   OverrideBehaviour,
@@ -81,30 +82,47 @@ describe('ConfigCatWebProvider', () => {
       });
     });
 
-    it('should emit PROVIDER_ERROR event', () => {
-      const handler = jest.fn();
-      const eventData: [string, unknown] = ['error', { error: 'error' }];
+    it("should emit PROVIDER_READY event when underlying client is initialized after provider's initialize", async () => {
+      const cacheValue = '253370761200000\nW/"12345678-90a"\n{"f":{"booleanTrue":{"t":0,"v":{"b":true}}}}';
+
+      const fakeSharedCache = new (class implements IConfigCatCache {
+        private _value?: string;
+        get(key: string) {
+          return this._value;
+        }
+        set(key: string, value: string) {
+          this._value = value;
+        }
+      })();
+
+      const provider = ConfigCatWebProvider.create('configcat-sdk-1/1234567890123456789012/1234567890123456789012', {
+        cache: fakeSharedCache,
+        logger: createConsoleLogger(LogLevel.Off),
+        offline: true,
+        maxInitWaitTimeSeconds: 1,
+      });
 
-      provider.events.addHandler(ProviderEvents.Error, handler);
-      configCatEmitter.emit('clientError', ...eventData);
+      const readyHandler = jest.fn();
+      provider.events.addHandler(ProviderEvents.Ready, readyHandler);
 
-      expect(handler).toHaveBeenCalledWith({
-        message: eventData[0],
-        metadata: eventData[1],
-      });
-    });
+      try {
+        await provider.initialize();
+      } catch (err) {
+        expect((err as Error).message).toContain('underlying ConfigCat client could not initialize');
+      }
 
-    it('should emit PROVIDER_READY event after successful evaluation during ERROR condition', async () => {
-      const errorHandler = jest.fn();
-      provider.events.addHandler(ProviderEvents.Error, errorHandler);
+      expect(readyHandler).toHaveBeenCalledTimes(0);
 
-      configCatEmitter.emit('clientError', 'error', { error: 'error' });
-      expect(errorHandler).toHaveBeenCalled();
+      fakeSharedCache.set('', cacheValue);
 
-      const readyHandler = jest.fn();
-      provider.events.addHandler(ProviderEvents.Ready, readyHandler);
+      // Make sure that the internal cache is refreshed.
+      await provider.configCatClient?.forceRefreshAsync();
+
+      provider.resolveBooleanEvaluation('booleanTrue', false, { targetingKey });
+
+      // Wait a little while for the Ready event to be emitted.
+      await new Promise((resolve) => setTimeout(resolve, 100));
 
-      await provider.resolveBooleanEvaluation('booleanTrue', false, { targetingKey });
       expect(readyHandler).toHaveBeenCalled();
     });
   });

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

@@ -19,6 +19,7 @@ import {
   transformContext,
 } from '@openfeature/config-cat-core';
 import {
+  ClientCacheState,
   getClient,
   IConfig,
   IConfigCatClient,
@@ -30,7 +31,7 @@ import {
 export class ConfigCatWebProvider implements Provider {
   public readonly events = new OpenFeatureEventEmitter();
   private readonly _clientFactory: (provider: ConfigCatWebProvider) => IConfigCatClient;
-  private _hasError = false;
+  private _isProviderReady = false;
   private _client?: IConfigCatClient;
 
   public runsOn: Paradigm = 'client';
@@ -53,19 +54,11 @@ export class ConfigCatWebProvider implements Provider {
       options.setupHooks = (hooks) => {
         oldSetupHooks?.(hooks);
 
-        hooks.on('configChanged', (projectConfig: IConfig | undefined) =>
+        hooks.on('configChanged', (config: IConfig) =>
           provider.events.emit(ProviderEvents.ConfigurationChanged, {
-            flagsChanged: projectConfig ? Object.keys(projectConfig.settings) : undefined,
+            flagsChanged: Object.keys(config.settings),
           }),
         );
-
-        hooks.on('clientError', (message: string, error) => {
-          provider._hasError = true;
-          provider.events.emit(ProviderEvents.Error, {
-            message: message,
-            metadata: error,
-          });
-        });
       };
 
       return getClient(sdkKey, PollingMode.AutoPoll, options);
@@ -74,8 +67,19 @@ export class ConfigCatWebProvider implements Provider {
 
   public async initialize(): Promise<void> {
     const client = this._clientFactory(this);
-    await client.waitForReady();
+    const clientCacheState = await client.waitForReady();
     this._client = client;
+
+    if (clientCacheState !== ClientCacheState.NoFlagData) {
+      this._isProviderReady = true;
+    } else {
+      // OpenFeature provider defines ready state like this: "The provider is ready to resolve flags."
+      // However, ConfigCat client's behavior is different: in some cases ready state may be reached
+      // even if the client's internal, in-memory cache hasn't been populated yet, that is,
+      // the client is not able to evaluate feature flags yet. In such cases we throw an error to
+      // prevent the provider from being set ready right away, and check for the ready state later.
+      throw Error('The underlying ConfigCat client could not initialize within maxInitWaitTimeSeconds.');
+    }
   }
 
   public get configCatClient() {
@@ -137,13 +141,22 @@ export class ConfigCatWebProvider implements Provider {
 
     const configCatDefaultValue = flagType !== 'object' ? (defaultValue as SettingValue) : JSON.stringify(defaultValue);
 
-    const { value, ...evaluationData } = this._client
-      .snapshot()
-      .getValueDetails(flagKey, configCatDefaultValue, transformContext(context));
+    const snapshot = this._client.snapshot();
+
+    const { value, ...evaluationData } = snapshot.getValueDetails(
+      flagKey,
+      configCatDefaultValue,
+      transformContext(context),
+    );
+
+    if (!this._isProviderReady && snapshot.cacheState !== ClientCacheState.NoFlagData) {
+      // Ideally, we would check ConfigCat client's initialization state in its "background" polling loop.
+      // This is not possible at the moment, so as a workaround, we do the check on feature flag evaluation.
+      // There are plans to improve this situation, so let's revise this
+      // as soon as ConfigCat SDK implements the necessary event.
 
-    if (this._hasError && !evaluationData.errorMessage && !evaluationData.errorException) {
-      this._hasError = false;
-      this.events.emit(ProviderEvents.Ready);
+      this._isProviderReady = true;
+      setTimeout(() => this.events.emit(ProviderEvents.Ready), 0);
     }
 
     if (evaluationData.isDefaultValue) {

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

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.7.5](https://github.com/open-feature/js-sdk-contrib/compare/config-cat-provider-v0.7.4...config-cat-provider-v0.7.5) (2025-04-09)
+
+
+### 🐛 Bug Fixes
+
+* **config-cat:** Rework error reporting ([#1242](https://github.com/open-feature/js-sdk-contrib/issues/1242)) ([0425619](https://github.com/open-feature/js-sdk-contrib/commit/04256197bf6e7da70afd4ac1c31bdaf55ce4b789))
+
 ## [0.7.4](https://github.com/open-feature/js-sdk-contrib/compare/config-cat-provider-v0.7.3...config-cat-provider-v0.7.4) (2025-03-14)
 
 

libs/providers/config-cat/CHANGELOG.md

@@ -1,6 +1,6 @@
 {
   "name": "@openfeature/config-cat-provider",
-  "version": "0.7.4",
+  "version": "0.7.5",
   "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",