chore(flipt): swap underlying flipt web sdk (#1244)

Signed-off-by: Mark Phelps <[email protected]>
Signed-off-by: Simon Schrottner <[email protected]>
Co-authored-by: adams85 <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Simon Schrottner <[email protected]>
Co-authored-by: Todd Baert <[email protected]>

Author: 5 people

libs/providers/flipt-web/README.md

@@ -2,7 +2,7 @@
 
 [Flipt](https://www.flipt.io/) is an open source developer friendly feature flagging solution, that allows for easy management and fast feature evaluation.
 
-This provider is an implementation on top of the official [Flipt Browser Client Side SDK](https://www.npmjs.com/package/@flipt-io/flipt-client-browser).
+This provider is an implementation on top of the official [Flipt JavaScript Client Side SDK](https://www.npmjs.com/package/@flipt-io/flipt-client-js).
 
 The main difference between this provider and [`@openfeature/flipt-provider`](https://www.npmjs.com/package/@openfeature/flipt-provider) is that it uses a **static evaluation context**.  
 This provider is more sustainable for client-side implementation.

libs/providers/flipt-web/package-lock.json

@@ -9,13 +9,8 @@
     "current-version": "echo $npm_package_version"
   },
   "peerDependencies": {
-    "@openfeature/web-sdk": "^1.0.0"
-  },
-  "devDependencies": {
-    "undici": "^6.13.0"
-  },
-  "dependencies": {
-    "@flipt-io/flipt-client-browser": "^0.3.1",
+    "@openfeature/web-sdk": "^1.0.0",
+    "@flipt-io/flipt-client-js": "^0.0.1",
     "undici": "^5.0.0"
   }
 }

libs/providers/flipt-web/package.json

@@ -28,12 +28,12 @@ describe('FliptWebProvider', () => {
   describe('method resolveStringEvaluation', () => {
     it('should throw general error for non-existent flag', () => {
       expect(() => {
-        provider.resolveStringEvaluation('nonExistent', 'default', { fizz: 'buzz' });
+        provider.resolveStringEvaluation('nonExistent', 'default', { targetingKey: '1234', fizz: 'buzz' });
       }).toThrow(GeneralError);
     });
 
     it('should return right value if key exists', () => {
-      const value = provider.resolveStringEvaluation('flag_string', 'default', { fizz: 'buzz' });
+      const value = provider.resolveStringEvaluation('flag_string', 'default', { targetingKey: '1234', fizz: 'buzz' });
       expect(value).toHaveProperty('value', 'variant1');
       expect(value).toHaveProperty('reason', 'TARGETING_MATCH');
     });
@@ -42,12 +42,12 @@ describe('FliptWebProvider', () => {
   describe('method resolveNumberEvaluation', () => {
     it('should throw general error for non-existent flag', () => {
       expect(() => {
-        provider.resolveNumberEvaluation('nonExistent', 1, { fizz: 'buzz' });
+        provider.resolveNumberEvaluation('nonExistent', 1, { targetingKey: '1234', fizz: 'buzz' });
       }).toThrow(GeneralError);
     });
 
     it('should return right value if key exists', () => {
-      const value = provider.resolveNumberEvaluation('flag_number', 0, { fizz: 'buzz' });
+      const value = provider.resolveNumberEvaluation('flag_number', 0, { targetingKey: '1234', fizz: 'buzz' });
       expect(value).toHaveProperty('value', 5);
       expect(value).toHaveProperty('reason', 'TARGETING_MATCH');
     });
@@ -56,12 +56,12 @@ describe('FliptWebProvider', () => {
   describe('method resolveBooleanEvaluation', () => {
     it('should throw general error for non-existent flag', () => {
       expect(() => {
-        provider.resolveBooleanEvaluation('nonExistent', false, { fizz: 'buzz' });
+        provider.resolveBooleanEvaluation('nonExistent', false, { targetingKey: '1234', fizz: 'buzz' });
       }).toThrow(GeneralError);
     });
 
     it('should return right value if key exists', () => {
-      const value = provider.resolveBooleanEvaluation('flag_boolean', false, { fizz: 'buzz' });
+      const value = provider.resolveBooleanEvaluation('flag_boolean', false, { targetingKey: '1234', fizz: 'buzz' });
       expect(value).toHaveProperty('value', true);
       expect(value).toHaveProperty('reason', 'TARGETING_MATCH');
     });
@@ -70,20 +70,24 @@ describe('FliptWebProvider', () => {
   describe('method resolveObjectEvaluation', () => {
     it('should throw general error for non-existent flag', () => {
       expect(() => {
-        provider.resolveObjectEvaluation('nonExistent', {}, { fizz: 'buzz' });
+        provider.resolveObjectEvaluation('nonExistent', {}, { targetingKey: '1234', fizz: 'buzz' });
       }).toThrow(GeneralError);
     });
 
     it('should return right value if key exists', () => {
-      const value = provider.resolveObjectEvaluation('flag_object', { fizz: 'buzz' }, { fizz: 'buzz' });
+      const value = provider.resolveObjectEvaluation(
+        'flag_object',
+        { fizz: 'buzz' },
+        { targetingKey: '1234', fizz: 'buzz' },
+      );
       expect(value).toHaveProperty('value', { foo: 'bar' });
       expect(value).toHaveProperty('reason', 'TARGETING_MATCH');
     });
   });
 
   it('should throw TypeMismatchError on non-number value', () => {
     expect(() => {
-      provider.resolveNumberEvaluation('flag_string', 0, { fizz: 'buzz' });
+      provider.resolveNumberEvaluation('flag_string', 0, { targetingKey: '1234', fizz: 'buzz' });
     }).toThrow(TypeMismatchError);
   });
 });

libs/providers/flipt-web/src/lib/flipt-web-provider.spec.ts

@@ -9,7 +9,7 @@ import {
   GeneralError,
   ProviderFatalError,
 } from '@openfeature/web-sdk';
-import { FliptEvaluationClient } from '@flipt-io/flipt-client-browser';
+import { FliptClient } from '@flipt-io/flipt-client-js/browser';
 import { EvaluationReason, FliptWebProviderOptions } from './models';
 import { transformContext } from './context-transformer';
 
@@ -28,7 +28,7 @@ export class FliptWebProvider implements Provider {
   private _options?: FliptWebProviderOptions;
 
   // client is the Flipt client reference
-  private _client?: FliptEvaluationClient;
+  private _client?: FliptClient;
 
   readonly runsOn = 'client';
 
@@ -48,7 +48,8 @@ export class FliptWebProvider implements Provider {
 
   async initializeClient() {
     try {
-      this._client = await FliptEvaluationClient.init(this._namespace || 'default', {
+      this._client = await FliptClient.init({
+        namespace: this._namespace || 'default',
         url: this._options?.url || 'http://localhost:8080',
         fetcher: this._options?.fetcher,
         authentication: this._options?.authentication,
@@ -70,7 +71,11 @@ export class FliptWebProvider implements Provider {
     const evalContext: Record<string, string> = transformContext(context);
 
     try {
-      const result = this._client?.evaluateBoolean(flagKey, context.targetingKey ?? '', evalContext);
+      const result = this._client?.evaluateBoolean({
+        flagKey,
+        entityId: context.targetingKey ?? '',
+        context: evalContext,
+      });
 
       switch (result?.reason) {
         case EvaluationReason.DEFAULT:
@@ -135,7 +140,11 @@ export class FliptWebProvider implements Provider {
     const evalContext: Record<string, string> = transformContext(context);
 
     try {
-      const result = this._client?.evaluateVariant(flagKey, context.targetingKey ?? '', evalContext);
+      const result = this._client?.evaluateVariant({
+        flagKey,
+        entityId: context.targetingKey ?? '',
+        context: evalContext,
+      });
 
       if (result?.reason === EvaluationReason.FLAG_DISABLED) {
         return {