feat: removing build dependencies and using testcontainers for container spin up

Signed-off-by: Simon Schrottner <[email protected]>

Author: aepfli

.npmrc

@@ -0,0 +1 @@
+@buf:registry=https://buf.build/gen/npm/v1/

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

@@ -2,14 +2,15 @@
 export default {
   displayName: 'providers-flagd-web',
   preset: '../../../jest.preset.js',
-  globals: {
-    'ts-jest': {
-      tsconfig: '<rootDir>/tsconfig.spec.json',
-    },
-  },
+  moduleDirectories: ["node_modules", "src"],
   transform: {
-    '^.+\\.[tj]s$': 'ts-jest',
+    '^.+\\.[tj]s$': ['ts-jest', {
+      tsconfig: '<rootDir>/tsconfig.spec.json'
+    }]
   },
+  transformIgnorePatterns: [
+    'node_modules/(?!@buf/.*)'
+  ],
   testEnvironment: 'jsdom',
   moduleFileExtensions: ['ts', 'js', 'html'],
   // ignore e2e path

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

@@ -7,5 +7,12 @@
   },
   "peerDependencies": {
     "@openfeature/web-sdk": "^1.0.0"
+  },
+  "dependencies": {
+    "@buf/open-feature_flagd.bufbuild_es": "^1.10.0-20240215170432-1e611e2999cc.1",
+    "@buf/open-feature_flagd.connectrpc_es": "^1.4.0-20240215170432-1e611e2999cc.3"
+  },
+  "devDependencies": {
+    "testcontainers": "^10.10.0"
   }
 }

libs/providers/flagd-web/package.json

@@ -20,10 +20,7 @@
       "executor": "nx:run-commands",
       "options": {
         "commands": [
-          "git submodule update --init schemas",
-          "rm -f -r ./src/proto",
-          "cd schemas && buf generate buf.build/open-feature/flagd --template protobuf/buf.gen.ts-connect.yaml",
-          "mv -v ./proto ./src"
+          "git submodule update --init schemas"
         ],
         "cwd": "libs/providers/flagd-web",
         "parallel": false
@@ -76,7 +73,7 @@
       "executor": "nx:run-commands",
       "options": {
         "commands": [
-          "npx jest"
+          "npx jest --forceExit"
         ],
         "cwd": "libs/providers/flagd-web/src/e2e",
         "parallel": false

libs/providers/flagd-web/project.json

@@ -1,11 +1,15 @@
 export default {
   displayName: 'providers-flagd-web-e2e',
+  moduleDirectories: ["node_modules", "src"],
   transform: {
-    '^.+\\.[tj]s$': ['ts-jest', { tsConfig: './tsconfig.lib.json' }],
+    '^.+\\.[tj]s$': ['ts-jest', { tsconfig: './tsconfig.lib.json' }],
   },
   moduleNameMapper: {
     '^(.*)\\.js$': ['$1.js', '$1.ts', '$1'],
   },
+  transformIgnorePatterns: [
+    'node_modules/(?!@buf/.*)'
+  ],
   testEnvironment: 'node',
   preset: 'ts-jest',
   clearMocks: true,

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

@@ -2,7 +2,8 @@ import assert from 'assert';
 import { FlagdWebProvider } from '../lib/flagd-web-provider';
 import { OpenFeature } from '@openfeature/web-sdk';
 
-const FLAGD_WEB_NAME = 'flagd-web';
+export const FLAGD_WEB_NAME = 'flagd-web';
+/*
 
 // register the flagd provider before the tests.
 console.log('Setting flagd web provider...');
@@ -11,11 +12,11 @@ OpenFeature.setProvider(
     host: 'localhost',
     port: 8013,
     tls: false,
-    maxRetries: -1,
   }),
 );
 assert(
   OpenFeature.providerMetadata.name === FLAGD_WEB_NAME,
   new Error(`Expected ${FLAGD_WEB_NAME} provider to be configured, instead got: ${OpenFeature.providerMetadata.name}`),
 );
 console.log('flagd web provider configured!');
+*/

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

@@ -6,9 +6,19 @@ import {
   OpenFeature,
   ProviderEvents,
   ResolutionDetails,
-  StandardResolutionReasons,
+  StandardResolutionReasons
 } from '@openfeature/web-sdk';
 import { defineFeature, loadFeature } from 'jest-cucumber';
+import {
+  ContainerRuntimeClient,
+  GenericContainer,
+  getContainerRuntimeClient,
+  StartedTestContainer,
+  TestContainer
+} from 'testcontainers';
+import { FlagdWebProvider } from '../../lib/flagd-web-provider';
+import assert from 'assert';
+import { FLAGD_WEB_NAME } from '../setup';
 
 // load the feature file.
 const feature = loadFeature('features/evaluation.feature');
@@ -17,19 +27,43 @@ const feature = loadFeature('features/evaluation.feature');
 const client = OpenFeature.getClient();
 
 const givenAnOpenfeatureClientIsRegistered = (
-  given: (stepMatcher: string, stepDefinitionCallback: () => void) => void,
+  given: (stepMatcher: string, stepDefinitionCallback: () => void) => void
 ) => {
   given('a provider is registered', () => undefined);
 };
 
 defineFeature(feature, (test) => {
+  const container: TestContainer = new GenericContainer('ghcr.io/open-feature/flagd-testbed:v0.5.4');
+  let startedContainer: StartedTestContainer;
   beforeAll((done) => {
     client.addHandler(ProviderEvents.Ready, async () => {
       done();
     });
-  });
+
+    container
+      .withExposedPorts(8013)
+      .start()
+      .then(c => {
+      startedContainer = c
+
+      console.log('Setting flagd web provider...');
+      OpenFeature.setProvider(
+        new FlagdWebProvider({
+          host: startedContainer.getHost(),
+          port: startedContainer.getMappedPort(8013),
+          tls: false,
+        }),
+      );
+      assert(
+        OpenFeature.providerMetadata.name === FLAGD_WEB_NAME,
+        new Error(`Expected ${FLAGD_WEB_NAME} provider to be configured, instead got: ${OpenFeature.providerMetadata.name}`),
+      );
+      console.log('flagd web provider configured!');
+    });
+  }, 60000);
 
   afterAll(async () => {
+    await startedContainer.stop();
     await OpenFeature.close();
   });
 
@@ -294,7 +328,7 @@ defineFeature(feature, (test) => {
         flagKey = key;
         fallbackValue = defaultValue;
         details = client.getStringDetails(flagKey, defaultValue);
-      },
+      }
     );
 
     then(/^the default string value should be returned$/, () => {
@@ -306,7 +340,7 @@ defineFeature(feature, (test) => {
       (errorCode: string) => {
         expect(details.reason).toEqual(StandardResolutionReasons.ERROR);
         expect(details.errorCode).toEqual(errorCode);
-      },
+      }
     );
   });
 
@@ -323,7 +357,7 @@ defineFeature(feature, (test) => {
         flagKey = key;
         fallbackValue = Number.parseInt(defaultValue);
         details = client.getNumberDetails(flagKey, Number.parseInt(defaultValue));
-      },
+      }
     );
 
     then(/^the default integer value should be returned$/, () => {
@@ -335,7 +369,7 @@ defineFeature(feature, (test) => {
       (errorCode: string) => {
         expect(details.reason).toEqual(StandardResolutionReasons.ERROR);
         expect(details.errorCode).toEqual(errorCode);
-      },
+      }
     );
   });
 });

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

@@ -10,9 +10,14 @@ import {
   StandardResolutionReasons,
 } from '@openfeature/web-sdk';
 import fetchMock from 'jest-fetch-mock';
-import { Service } from '../proto/ts/flagd/evaluation/v1/evaluation_connect';
-import { AnyFlag, EventStreamResponse, ResolveAllResponse } from '../proto/ts/flagd/evaluation/v1/evaluation_pb';
 import { FlagdWebProvider } from './flagd-web-provider';
+import {
+  EventStreamResponse,
+  ResolveAllResponse
+} from '@buf/open-feature_flagd.bufbuild_es/flagd/evaluation/v1/evaluation_pb';
+import { Service } from '@buf/open-feature_flagd.connectrpc_es/schema/v1/schema_connect';
+import { AnyFlag } from '@buf/open-feature_flagd.bufbuild_es/schema/v1/schema_pb';
+
 
 const EVENT_CONFIGURATION_CHANGE = 'configuration_change';
 const EVENT_PROVIDER_READY = 'provider_ready';

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

@@ -16,9 +16,9 @@ import {
   StandardResolutionReasons,
   TypeMismatchError,
 } from '@openfeature/web-sdk';
-import { Service } from '../proto/ts/flagd/evaluation/v1/evaluation_connect';
-import { AnyFlag } from '../proto/ts/flagd/evaluation/v1/evaluation_pb';
 import { FlagdProviderOptions, getOptions } from './options';
+import { AnyFlag } from '@buf/open-feature_flagd.bufbuild_es/schema/v1/schema_pb';
+import { Service } from '@buf/open-feature_flagd.connectrpc_es/schema/v1/schema_connect';
 
 export const ERROR_DISABLED = 'DISABLED';