fix(deps): update dependency configcat-js to v9 (open-feature#664)

Signed-off-by: Lukas Reining <lukas.reining@codecentric.de>
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Lukas Reining <lukas.reining@codecentric.de>

Author: renovate[bot]

libs/providers/config-cat/package.json

@@ -7,6 +7,6 @@
   },
   "peerDependencies": {
     "@openfeature/server-sdk": "^1.8.0",
-    "configcat-js": "^8.0.0"
+    "configcat-js": "^8.0.0 || ^9.0.0"
   }
 }

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

@@ -1,10 +1,11 @@
 import { ConfigCatProvider } from './config-cat-provider';
 import { ParseError, ProviderEvents, ProviderStatus, TypeMismatchError } from '@openfeature/server-sdk';
 import {
+  ClientCacheState,
   createConsoleLogger,
   createFlagOverridesFromMap,
   HookEvents,
-  ISetting,
+  ISettingUnion,
   LogLevel,
   OverrideBehaviour,
   PollingMode,
@@ -72,9 +73,10 @@ describe('ConfigCatProvider', () => {
 
   describe('status', () => {
     it('should be NOT_READY before initialization and READY after successful initialization', async () => {
-      const newProvider = ConfigCatProvider.create('key', PollingMode.ManualPoll, {
+      const newProvider = ConfigCatProvider.create('wrong_key', PollingMode.ManualPoll, {
         logger: createConsoleLogger(LogLevel.Off),
         offline: true,
+        flagOverrides: createFlagOverridesFromMap(values, OverrideBehaviour.LocalOnly),
       });
 
       expect(newProvider.status).toEqual(ProviderStatus.NOT_READY);
@@ -90,7 +92,7 @@ describe('ConfigCatProvider', () => {
     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');
+      configCatEmitter.emit('clientReady', ClientCacheState.HasCachedFlagDataOnly);
       expect(provider.status).toEqual(ProviderStatus.READY);
     });
   });
@@ -99,7 +101,7 @@ describe('ConfigCatProvider', () => {
     it('should emit PROVIDER_READY event', () => {
       const handler = jest.fn();
       provider.events.addHandler(ProviderEvents.Ready, handler);
-      configCatEmitter.emit('clientReady');
+      configCatEmitter.emit('clientReady', ClientCacheState.HasCachedFlagDataOnly);
       expect(handler).toHaveBeenCalled();
     });
 
@@ -118,7 +120,9 @@ describe('ConfigCatProvider', () => {
     });
 
     it('should emit PROVIDER_READY event without options', async () => {
-      const newProvider = ConfigCatProvider.create('__yet_another_key__', PollingMode.ManualPoll);
+      const newProvider = ConfigCatProvider.create('__yet_another_key__', PollingMode.ManualPoll, {
+        flagOverrides: createFlagOverridesFromMap(values, OverrideBehaviour.LocalOnly),
+      });
 
       const handler = jest.fn();
       newProvider.events.addHandler(ProviderEvents.Ready, handler);
@@ -129,7 +133,7 @@ describe('ConfigCatProvider', () => {
 
     it('should emit PROVIDER_CONFIGURATION_CHANGED event', () => {
       const handler = jest.fn();
-      const eventData = { settings: { myFlag: {} as ISetting } };
+      const eventData = { settings: { myFlag: {} as ISettingUnion }, salt: undefined, segments: [] };
 
       provider.events.addHandler(ProviderEvents.ConfigurationChanged, handler);
       configCatEmitter.emit('configChanged', eventData);

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

@@ -84,7 +84,7 @@ export class ConfigCatProvider implements Provider {
   }
 
   public async onClose(): Promise<void> {
-    await this._client?.dispose();
+    this._client?.dispose();
   }
 
   async resolveBooleanEvaluation(
@@ -199,7 +199,11 @@ function toResolutionDetails<U extends JsonValue>(
   data: Omit<IEvaluationDetails, 'value'>,
   reason?: ResolutionReason,
 ): ResolutionDetails<U> {
-  const matchedRule = Boolean(data.matchedEvaluationRule || data.matchedEvaluationPercentageRule);
+  const matchedTargeting = 'matchedEvaluationRule' in data ? data.matchedEvaluationRule : data.matchedTargetingRule;
+  const matchedPercentage =
+    'matchedEvaluationPercentageRule' in data ? data.matchedEvaluationPercentageRule : data.matchedPercentageOption;
+
+  const matchedRule = Boolean(matchedTargeting || matchedPercentage);
   const evaluatedReason = matchedRule ? StandardResolutionReasons.TARGETING_MATCH : StandardResolutionReasons.STATIC;
 
   return {

libs/providers/config-cat/src/lib/context-transformer.spec.ts

@@ -18,6 +18,9 @@ describe('context-transformer', () => {
 
       const user = {
         identifier: context['targetingKey'],
+        country: undefined,
+        custom: {},
+        email: undefined,
       };
 
       expect(transformContext(context)).toEqual(user);
@@ -34,6 +37,7 @@ describe('context-transformer', () => {
         identifier: context['targetingKey'],
         email: context['email'],
         country: context['country'],
+        custom: {},
       };
 
       expect(transformContext(context)).toEqual(user);

libs/providers/config-cat/src/lib/context-transformer.ts

@@ -1,5 +1,5 @@
 import { EvaluationContext, EvaluationContextValue, TargetingKeyMissingError } from '@openfeature/server-sdk';
-import { User as ConfigCatUser } from 'configcat-common/lib/RolloutEvaluator';
+import { User as ConfigCatUser } from 'configcat-js';
 
 function contextValueToString(contextValue: EvaluationContextValue): string | undefined {
   if (typeof contextValue === 'string') {
@@ -21,14 +21,14 @@ function contextValueToString(contextValue: EvaluationContextValue): string | un
   return JSON.stringify(contextValue);
 }
 
-function transformContextValues(contextValue: EvaluationContextValue): ConfigCatUser['custom'] | undefined {
+function transformContextValues(contextValue: EvaluationContextValue): ConfigCatUser['custom'] {
   if (contextValue === null) {
-    return undefined;
+    return {};
   }
 
   if (typeof contextValue !== 'object' || Array.isArray(contextValue)) {
     const value = contextValueToString(contextValue);
-    return value ? { value } : undefined;
+    return value ? { value } : {};
   }
 
   if (contextValue instanceof Date) {
@@ -38,7 +38,7 @@ function transformContextValues(contextValue: EvaluationContextValue): ConfigCat
   return Object.entries(contextValue).reduce<ConfigCatUser['custom']>((context, [key, value]) => {
     const transformedValue = contextValueToString(value);
     return transformedValue ? { ...context, [key]: transformedValue } : context;
-  }, undefined);
+  }, {});
 }
 
 function stringOrUndefined(param?: unknown): string | undefined {

package-lock.json

@@ -24,7 +24,7 @@
     "@swc/helpers": "0.5.3",
     "ajv": "^8.12.0",
     "axios": "1.6.7",
-    "configcat-js": "^8.0.0",
+    "configcat-js": "^9.0.0",
     "copy-anything": "^3.0.5",
     "imurmurhash": "^0.1.4",
     "json-logic-engine": "1.3.1",