fix e2e test, minor refactor

Signed-off-by: Michael Beemer <[email protected]>

Author: beeme1mr

libs/providers/flagd-web/project.json

@@ -59,12 +59,12 @@
       ]
     },
     "e2e": {
-      "executor": "nx:run-commands",
+      "executor": "@nx/jest:jest",
+      "outputs": [
+        "{workspaceRoot}/coverage/libs/providers/flagd-web"
+      ],
       "options": {
-        "commands": [
-          "npx jest"
-        ],
-        "cwd": "libs/providers/flagd-web/src/e2e",
+        "jestConfig": "libs/providers/flagd-web/src/e2e/jest.config.ts",
         "parallel": false
       },
       "dependsOn": [

libs/providers/flagd-web/src/e2e/constants.ts

@@ -1,5 +1,5 @@
 import { getGherkinTestPath } from '@openfeature/flagd-core';
 
-export const FLAGD_NAME = 'flagd-web';
+export const FLAGD_NAME = 'flagd';
 
 export const GHERKIN_EVALUATION_FEATURE = getGherkinTestPath('flagd.feature');

libs/providers/flagd-web/src/e2e/jest.config.ts

@@ -1,16 +1,15 @@
-export default {
+import type { Config } from 'jest';
+
+const config: Config = {
   displayName: 'providers-flagd-web-e2e',
-  transform: {
-    '^.+\\.[tj]s$': ['ts-jest', { tsconfig: './tsconfig.lib.json' }],
-  },
+  clearMocks: true,
+  preset: 'ts-jest',
   moduleNameMapper: {
     '@openfeature/flagd-core': ['<rootDir>/../../../../shared/flagd-core/src'],
-    '^(.*)\\.js$': ['$1.js', '$1.ts', '$1'],
+    '(.+)\\.js$': '$1',
   },
-  testEnvironment: 'node',
-  preset: 'ts-jest',
-  clearMocks: true,
-  setupFiles: [],
+  detectOpenHandles: true,
   verbose: true,
-  silent: false,
 };
+
+export default config;

libs/providers/flagd-web/src/e2e/step-definitions/flag.ts

@@ -35,10 +35,10 @@ export const flagStepDefinitions: StepDefinitions = ({ given, and, when, then })
 
   when(
     /^a boolean flag with key "(.*)" is evaluated with default value "(.*)"$/,
-    async (key: string, defaultValue: string) => {
+    (key: string, defaultValue: string) => {
       flagKey = key;
       fallback = defaultValue;
-      value = await client.getBooleanValue(key, defaultValue === 'true');
+      value = client.getBooleanValue(key, defaultValue === 'true');
     },
   );
 
@@ -48,10 +48,10 @@ export const flagStepDefinitions: StepDefinitions = ({ given, and, when, then })
 
   when(
     /^a string flag with key "(.*)" is evaluated with default value "(.*)"$/,
-    async (key: string, defaultValue: string) => {
+    (key: string, defaultValue: string) => {
       flagKey = key;
       fallback = defaultValue;
-      value = await client.getStringValue(key, defaultValue);
+      value = client.getStringValue(key, defaultValue);
     },
   );
 
@@ -64,7 +64,7 @@ export const flagStepDefinitions: StepDefinitions = ({ given, and, when, then })
     async (key: string, defaultValue: string) => {
       flagKey = key;
       fallback = Number(defaultValue);
-      value = await client.getNumberValue(key, Number.parseInt(defaultValue));
+      value = client.getNumberValue(key, Number.parseInt(defaultValue));
     },
   );
 
@@ -77,7 +77,7 @@ export const flagStepDefinitions: StepDefinitions = ({ given, and, when, then })
     async (key: string, defaultValue: string) => {
       flagKey = key;
       fallback = Number(defaultValue);
-      value = await client.getNumberValue(key, Number.parseFloat(defaultValue));
+      value = client.getNumberValue(key, Number.parseFloat(defaultValue));
     },
   );
 
@@ -89,7 +89,7 @@ export const flagStepDefinitions: StepDefinitions = ({ given, and, when, then })
     const defaultValue = {};
     flagKey = key;
     fallback = '';
-    value = await client.getObjectValue(key, defaultValue);
+    value = client.getObjectValue(key, defaultValue);
   });
 
   then(
@@ -107,7 +107,7 @@ export const flagStepDefinitions: StepDefinitions = ({ given, and, when, then })
     async (key: string, defaultValue: string) => {
       flagKey = key;
       fallback = defaultValue;
-      details = await client.getBooleanDetails(key, defaultValue === 'true');
+      details = client.getBooleanDetails(key, defaultValue === 'true');
     },
   );
 
@@ -123,10 +123,10 @@ export const flagStepDefinitions: StepDefinitions = ({ given, and, when, then })
 
   when(
     /^a string flag with key "(.*)" is evaluated with details and default value "(.*)"$/,
-    async (key: string, defaultValue: string) => {
+    (key: string, defaultValue: string) => {
       flagKey = key;
       fallback = defaultValue;
-      details = await client.getStringDetails(key, defaultValue);
+      details = client.getStringDetails(key, defaultValue);
     },
   );
 
@@ -142,10 +142,10 @@ export const flagStepDefinitions: StepDefinitions = ({ given, and, when, then })
 
   when(
     /^an integer flag with key "(.*)" is evaluated with details and default value (\d+)$/,
-    async (key: string, defaultValue: string) => {
+    (key: string, defaultValue: string) => {
       flagKey = key;
       fallback = defaultValue;
-      details = await client.getNumberDetails(key, Number.parseInt(defaultValue));
+      details = client.getNumberDetails(key, Number.parseInt(defaultValue));
     },
   );
 
@@ -161,10 +161,10 @@ export const flagStepDefinitions: StepDefinitions = ({ given, and, when, then })
 
   when(
     /^a float flag with key "(.*)" is evaluated with details and default value (\d+\.?\d*)$/,
-    async (key: string, defaultValue: string) => {
+    (key: string, defaultValue: string) => {
       flagKey = key;
       fallback = defaultValue;
-      details = await client.getNumberDetails(key, Number.parseFloat(defaultValue));
+      details = client.getNumberDetails(key, Number.parseFloat(defaultValue));
     },
   );
 
@@ -178,10 +178,10 @@ export const flagStepDefinitions: StepDefinitions = ({ given, and, when, then })
     },
   );
 
-  when(/^an object flag with key "(.*)" is evaluated with details and a null default value$/, async (key: string) => {
+  when(/^an object flag with key "(.*)" is evaluated with details and a null default value$/, (key: string) => {
     flagKey = key;
     fallback = {};
-    details = await client.getObjectDetails(key, {});
+    details = client.getObjectDetails(key, {});
   });
 
   then(
@@ -211,10 +211,10 @@ export const flagStepDefinitions: StepDefinitions = ({ given, and, when, then })
 
   when(
     /^a non-existent string flag with key "(.*)" is evaluated with details and a default value "(.*)"$/,
-    async (key: string, defaultValue: string) => {
+    (key: string, defaultValue: string) => {
       flagKey = key;
       fallback = defaultValue;
-      details = await client.getStringDetails(flagKey, defaultValue);
+      details = client.getStringDetails(flagKey, defaultValue);
     },
   );
 
@@ -234,10 +234,10 @@ export const flagStepDefinitions: StepDefinitions = ({ given, and, when, then })
 
   when(
     /^a string flag with key "(.*)" is evaluated as an integer, with details and a default value (\d+)$/,
-    async (key: string, defaultValue: string) => {
+    (key: string, defaultValue: string) => {
       flagKey = key;
       fallback = Number.parseInt(defaultValue);
-      details = await client.getNumberDetails(flagKey, Number.parseInt(defaultValue));
+      details = client.getNumberDetails(flagKey, Number.parseInt(defaultValue));
     },
   );
 
@@ -303,9 +303,9 @@ export const flagStepDefinitions: StepDefinitions = ({ given, and, when, then })
     },
   );
 
-  then(/^the resolved boolean zero-value should be "(.*)"$/, async (expectedVal: string) => {
+  then(/^the resolved boolean zero-value should be "(.*)"$/, (expectedVal: string) => {
     const expectedValue = expectedVal === 'true';
-    const value = await client.getBooleanValue(flagKey, fallback as boolean);
+    const value = client.getBooleanValue(flagKey, fallback as boolean);
     expect(value).toEqual(expectedValue);
   });
 
@@ -314,8 +314,8 @@ export const flagStepDefinitions: StepDefinitions = ({ given, and, when, then })
     fallback = defaultVal;
   });
 
-  then('the resolved string zero-value should be ""', async () => {
-    const value = await client.getStringValue(flagKey, fallback as string);
+  then('the resolved string zero-value should be ""', () => {
+    const value = client.getStringValue(flagKey, fallback as string);
     expect(value).toEqual('');
   });
 
@@ -324,9 +324,9 @@ export const flagStepDefinitions: StepDefinitions = ({ given, and, when, then })
     fallback = defaultVal;
   });
 
-  then(/^the resolved integer zero-value should be (\d+)$/, async (expectedValueString) => {
+  then(/^the resolved integer zero-value should be (\d+)$/, (expectedValueString) => {
     const expectedValue = Number.parseInt(expectedValueString);
-    const value = await client.getNumberValue(flagKey, fallback as number);
+    const value = client.getNumberValue(flagKey, fallback as number);
     expect(value).toEqual(expectedValue);
   });
 
@@ -338,9 +338,9 @@ export const flagStepDefinitions: StepDefinitions = ({ given, and, when, then })
     },
   );
 
-  then(/^the resolved float zero-value should be (\d+\.\d+)$/, async (expectedValueString) => {
+  then(/^the resolved float zero-value should be (\d+\.\d+)$/, (expectedValueString) => {
     const expectedValue = Number.parseFloat(expectedValueString);
-    const value = await client.getNumberValue(flagKey, fallback as number);
+    const value = client.getNumberValue(flagKey, fallback as number);
     expect(value).toEqual(expectedValue);
   });
 

libs/providers/flagd-web/src/e2e/tsconfig.lib.json

@@ -6,7 +6,6 @@ import {
   JsonValue,
   OpenFeature,
   ProviderEvents,
-  ProviderStatus,
   StandardResolutionReasons,
 } from '@openfeature/web-sdk';
 import fetchMock from 'jest-fetch-mock';
@@ -193,21 +192,12 @@ describe(FlagdWebProvider.name, () => {
 
     describe(ProviderEvents.Ready, () => {
       it('should fire as soon as client subscribes, if ready', (done) => {
-        try {
-          // should start NOT_READY
-          expect(provider.status).toEqual(ProviderStatus.NOT_READY);
-          done();
-        } catch (err) {
-          done(err);
-        }
-
         mockCallbackClient.mockMessage({
           type: EVENT_PROVIDER_READY,
         });
 
         client.addHandler(ProviderEvents.Ready, () => {
           try {
-            expect(provider.status).toEqual(ProviderStatus.READY);
             done();
           } catch (err) {
             done(err);
@@ -216,22 +206,14 @@ describe(FlagdWebProvider.name, () => {
       });
 
       it('should fire and be ready if message received', (done) => {
-        try {
-          // should start NOT_READY
-          expect(provider.status).toEqual(ProviderStatus.NOT_READY);
-          done();
-        } catch (err) {
-          done(err);
-        }
-
         client.addHandler(ProviderEvents.Ready, () => {
           try {
-            expect(provider.status).toEqual(ProviderStatus.READY);
             done();
           } catch (err) {
             done(err);
           }
         });
+
         mockCallbackClient.mockMessage({
           type: EVENT_PROVIDER_READY,
         });
@@ -269,9 +251,9 @@ describe(FlagdWebProvider.name, () => {
 
     describe(ProviderEvents.Error, () => {
       it('should fire if message received', (done) => {
-        client.addHandler(ProviderEvents.Error, () => {
+        client.addHandler(ProviderEvents.Error, (event) => {
           try {
-            expect(provider.status).toEqual(ProviderStatus.ERROR);
+            expect(event?.providerName).toBe('flagd');
             done();
           } catch (err) {
             done(err);

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

@@ -11,7 +11,6 @@ import {
   OpenFeatureEventEmitter,
   Provider,
   ProviderEvents,
-  ProviderStatus,
   ResolutionDetails,
   StandardResolutionReasons,
   TypeMismatchError,
@@ -31,10 +30,12 @@ type AnyFlagResolutionType = typeof AnyFlag.prototype.value.case;
 
 export class FlagdWebProvider implements Provider {
   metadata = {
-    name: 'flagd-web',
+    name: 'flagd',
   };
 
-  private _status = ProviderStatus.NOT_READY;
+  readonly runsOn = 'client';
+  readonly events = new OpenFeatureEventEmitter();
+
   private _connected = false;
   private _promiseClient: PromiseClient<typeof Service>;
   private _callbackClient: CallbackClient<typeof Service>;
@@ -64,12 +65,6 @@ export class FlagdWebProvider implements Provider {
     this._logger = logger;
   }
 
-  get status() {
-    return this._status;
-  }
-
-  events = new OpenFeatureEventEmitter();
-
   async onContextChange(oldContext: EvaluationContext, newContext: EvaluationContext): Promise<void> {
     await this.fetchAll(newContext);
   }
@@ -112,6 +107,7 @@ export class FlagdWebProvider implements Provider {
       reason: this._connected ? resolved.reason : StandardResolutionReasons.CACHED,
       variant: resolved.variant,
       value: resolved.value as T,
+      flagMetadata: resolved.flagMetadata,
     };
   }
 
@@ -129,7 +125,6 @@ export class FlagdWebProvider implements Provider {
             case EVENT_PROVIDER_READY:
               this.fetchAll(currentContext).then(() => {
                 this.resetConnectionState();
-                this._status = ProviderStatus.READY;
                 resolve();
               });
               return;
@@ -142,8 +137,7 @@ export class FlagdWebProvider implements Provider {
           }
         },
         (err) => {
-          this._status = ProviderStatus.ERROR;
-          this._logger?.error(`${FlagdWebProvider.name}: could not establish connection to flagd, ${err?.message}`);
+          this._logger?.error(`${FlagdWebProvider.name}: could not establish connection, ${err?.message}`);
           this._logger?.debug(err?.stack);
           if (this._retry < this._maxRetries) {
             this._retry++;
@@ -160,12 +154,12 @@ export class FlagdWebProvider implements Provider {
   private async fetchAll(context: EvaluationContext) {
     const transformedContext = this.transformContext(context);
     const allResolved = await this._promiseClient.resolveAll({ context: transformedContext });
-    this._flags = Object.keys(allResolved.flags).reduce((accumuated, currentKey) => {
+    this._flags = Object.keys(allResolved.flags).reduce((accumulated, currentKey) => {
       const resolved = allResolved.flags[currentKey];
       // reducer to store the resolved bulk response in a map of ResolutionDetails,
       // with an addition annotation for the type (typeof AnyFlag.prototype.value.case)
       return {
-        ...accumuated,
+        ...accumulated,
         [currentKey]: {
           type: resolved.value.case,
           reason: resolved.reason,