Merge branch 'main' into feat/add_unleash_provider

jarebudev · web-flow · commit c0203e7a7db1 · 2024-12-22T22:44:24.000Z
diff --git a/.release-please-manifest.json b/.release-please-manifest.json
@@ -5,8 +5,8 @@
   "libs/providers/flagd-web": "0.7.2",
   "libs/providers/env-var": "0.3.1",
   "libs/providers/config-cat": "0.7.2",
-  "libs/providers/launchdarkly-client": "0.3.0",
-  "libs/providers/go-feature-flag-web": "0.2.2",
+  "libs/providers/launchdarkly-client": "0.3.1",
+  "libs/providers/go-feature-flag-web": "0.2.3",
   "libs/shared/flagd-core": "0.2.5",
   "libs/shared/ofrep-core": "0.2.0",
   "libs/providers/ofrep": "0.2.0",
diff --git a/libs/providers/go-feature-flag-web/CHANGELOG.md b/libs/providers/go-feature-flag-web/CHANGELOG.md
@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.2.3](https://github.com/open-feature/js-sdk-contrib/compare/go-feature-flag-web-provider-v0.2.2...go-feature-flag-web-provider-v0.2.3) (2024-12-13)
+
+
+### 🐛 Bug Fixes
+
+* **go-feature-flag-web:** avoid infinite loop in waitWebsocketFinalSt… ([#1104](https://github.com/open-feature/js-sdk-contrib/issues/1104)) ([2cc7483](https://github.com/open-feature/js-sdk-contrib/commit/2cc7483ea0f8d178d5abfacfdce804db83704ba7))
+
 ## [0.2.2](https://github.com/open-feature/js-sdk-contrib/compare/go-feature-flag-web-provider-v0.2.1...go-feature-flag-web-provider-v0.2.2) (2024-12-03)
 
 
diff --git a/libs/providers/go-feature-flag-web/package-lock.json b/libs/providers/go-feature-flag-web/package-lock.json
diff --git a/libs/providers/go-feature-flag-web/package.json b/libs/providers/go-feature-flag-web/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@openfeature/go-feature-flag-web-provider",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "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",
     "current-version": "echo $npm_package_version"
diff --git a/libs/providers/go-feature-flag-web/src/lib/go-feature-flag-web-provider.spec.ts b/libs/providers/go-feature-flag-web/src/lib/go-feature-flag-web-provider.spec.ts
diff --git a/libs/providers/go-feature-flag-web/src/lib/go-feature-flag-web-provider.ts b/libs/providers/go-feature-flag-web/src/lib/go-feature-flag-web-provider.ts
@@ -106,7 +106,9 @@ export class GoFeatureFlagWebProvider implements Provider {
     this._logger?.debug(`${GoFeatureFlagWebProvider.name}: Trying to connect the websocket at ${wsURL}`);
 
     this._websocket = new WebSocket(wsURL);
-    await this.waitWebsocketFinalStatus(this._websocket);
+    await this.waitWebsocketFinalStatus(this._websocket).catch((reason) => {
+      throw new Error(`impossible to connect to the websocket: ${reason}`);
+    });
 
     this._websocket.onopen = (event) => {
       this._logger?.info(`${GoFeatureFlagWebProvider.name}: Websocket to go-feature-flag open: ${event}`);
@@ -133,15 +135,24 @@ export class GoFeatureFlagWebProvider implements Provider {
    * @param socket - the websocket you are waiting for
    */
   waitWebsocketFinalStatus(socket: WebSocket): Promise<void> {
-    return new Promise((resolve) => {
-      const checkConnection = () => {
-        if (socket.readyState === WebSocket.OPEN || socket.readyState === WebSocket.CLOSED) {
-          return resolve();
+    return new Promise((resolve, reject) => {
+      // wait until the socket is in a stable state or until the timeout is reached
+      const websocketTimeout = this._apiTimeout !== 0 ? this._apiTimeout : 5000;
+      const timeout = setTimeout(() => {
+        if (socket.readyState !== WebSocket.OPEN && socket.readyState !== WebSocket.CLOSED) {
+          reject(`timeout of ${websocketTimeout} ms reached when initializing the websocket`);
         }
-        // Wait 5 milliseconds before checking again
-        setTimeout(checkConnection, 5);
+      }, websocketTimeout);
+
+      socket.onopen = () => {
+        clearTimeout(timeout);
+        resolve();
+      };
+
+      socket.onclose = () => {
+        clearTimeout(timeout);
+        resolve();
       };
-      checkConnection();
     });
   }
 
diff --git a/libs/providers/launchdarkly-client/CHANGELOG.md b/libs/providers/launchdarkly-client/CHANGELOG.md
@@ -1,5 +1,17 @@
 # Changelog
 
+## [0.3.1](https://github.com/open-feature/js-sdk-contrib/compare/launchdarkly-client-provider-v0.3.0...launchdarkly-client-provider-v0.3.1) (2024-12-17)
+
+
+### ✨ New Features
+
+* Accept timeout for LD waitForInitialization ([#1117](https://github.com/open-feature/js-sdk-contrib/issues/1117)) ([be7851c](https://github.com/open-feature/js-sdk-contrib/commit/be7851ce59a772a32d60fcb3f2d23eac3c862087))
+
+
+### 🧹 Chore
+
+* loosen some test assertions, fix e2e matcher ([#933](https://github.com/open-feature/js-sdk-contrib/issues/933)) ([8def607](https://github.com/open-feature/js-sdk-contrib/commit/8def6072c5d29eaf81d7262b6878cb3d6ff40483))
+
 ## [0.3.0](https://github.com/open-feature/js-sdk-contrib/compare/launchdarkly-client-provider-v0.2.1...launchdarkly-client-provider-v0.3.0) (2024-03-25)
 
 
diff --git a/libs/providers/launchdarkly-client/package-lock.json b/libs/providers/launchdarkly-client/package-lock.json
diff --git a/libs/providers/launchdarkly-client/package.json b/libs/providers/launchdarkly-client/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@openfeature/launchdarkly-client-provider",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "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",
     "current-version": "echo $npm_package_version"
diff --git a/libs/providers/launchdarkly-client/src/lib/launchdarkly-client-provider.spec.ts b/libs/providers/launchdarkly-client/src/lib/launchdarkly-client-provider.spec.ts
@@ -80,6 +80,17 @@ describe('LaunchDarklyClientProvider', () => {
       expect(initialize).toHaveBeenCalledTimes(1);
       /* when not set in open feauture LD sdk initialize should be called with the anonymous context*/
       expect(initialize).toHaveBeenCalledWith(envKey, { anonymous: true }, { logger });
+      expect(ldClientMock.waitForInitialization).toHaveBeenCalledWith(undefined);
+    });
+
+    it('should call Ld waitForInitialization with correct arguments', async () => {
+      const provider = new LaunchDarklyClientProvider(envKey, { logger, initializationTimeout: 5 });
+      await provider.initialize();
+      expect(initialize).toHaveBeenCalledTimes(1);
+      /* when not set in open feauture LD sdk initialize should be called with the anonymous context*/
+      expect(initialize).toHaveBeenCalledWith(envKey, { anonymous: true }, { logger });
+      expect(ldClientMock.waitForInitialization).toHaveBeenCalledTimes(1);
+      expect(ldClientMock.waitForInitialization).toHaveBeenCalledWith(5);
     });
 
     it('should set the status to READY if initialization succeeds', async () => {
diff --git a/libs/providers/launchdarkly-client/src/lib/launchdarkly-client-provider.ts b/libs/providers/launchdarkly-client/src/lib/launchdarkly-client-provider.ts
@@ -42,6 +42,7 @@ export class LaunchDarklyClientProvider implements Provider {
 
   private readonly ldOptions: LDOptions | undefined;
   private readonly logger: Logger;
+  private readonly initializationTimeout?: number;
   private _client?: LDClient;
 
   public events = new OpenFeatureEventEmitter();
@@ -62,13 +63,14 @@ export class LaunchDarklyClientProvider implements Provider {
 
   constructor(
     private readonly envKey: string,
-    { logger, ...ldOptions }: LaunchDarklyProviderOptions,
+    { logger, initializationTimeout, ...ldOptions }: LaunchDarklyProviderOptions,
   ) {
     if (logger) {
       this.logger = logger;
     } else {
       this.logger = basicLogger({ level: 'info' });
     }
+    this.initializationTimeout = initializationTimeout;
     this.ldOptions = { ...ldOptions, logger: this.logger };
   }
 
@@ -92,7 +94,7 @@ export class LaunchDarklyClientProvider implements Provider {
     }
 
     try {
-      await this._client.waitForInitialization();
+      await this._client.waitForInitialization(this.initializationTimeout);
       this.status = ProviderStatus.READY;
     } catch {
       this.status = ProviderStatus.ERROR;
diff --git a/libs/providers/launchdarkly-client/src/lib/launchdarkly-provider-options.ts b/libs/providers/launchdarkly-client/src/lib/launchdarkly-provider-options.ts
@@ -36,4 +36,16 @@ export interface LaunchDarklyProviderOptions extends LDOptions {
    * disclaimer: this logger instance will be used by the launch-darkly sdk
    */
   logger?: LDLogger | Logger;
+
+  /**
+   * Configures the amount of time, in seconds, to wait for initialization when
+   * connecting to the LaunchDarkly service.
+   *
+   * Using a large timeout is not recommended as network delays may cause your
+   * application to wait a long time before continuing execution.
+   *
+   * See the launchdarkly-js-client-sdk docs for more details:
+   * {@link https://launchdarkly.github.io/js-client-sdk/interfaces/LDClient.html#waitForInitialization}
+   */
+  initializationTimeout?: number;
 }
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -63,7 +63,7 @@
     "@types/jest": "29.5.14",
     "@types/lodash.isempty": "^4.4.7",
     "@types/lodash.isequal": "^4.5.6",
-    "@types/node": "20.17.6",
+    "@types/node": "20.17.9",
     "@types/object-hash": "^3.0.0",
     "@types/semver": "^7.5.4",
     "@typescript-eslint/eslint-plugin": "5.62.0",
@@ -85,10 +85,10 @@
     "msw": "^2.2.3",
     "nx": "16.9.1",
     "prettier": "^3.0.3",
-    "testcontainers": "10.13.2",
+    "testcontainers": "10.16.0",
     "ts-jest": "29.2.5",
     "ts-node": "10.9.2",
-    "typescript": "5.6.3",
+    "typescript": "5.7.2",
     "undici": "^5.0.0"
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@openfeature/go-feature-flag-web-provider",`
`3`		`- "version": "0.2.2",`
	`3`	`+ "version": "0.2.3",`
`4`	`4`	`"scripts": {`
`5`	`5`	`"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",`
`6`	`6`	`"current-version": "echo $npm_package_version"`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@openfeature/launchdarkly-client-provider",`
`3`		`- "version": "0.3.0",`
	`3`	`+ "version": "0.3.1",`
`4`	`4`	`"scripts": {`
`5`	`5`	`"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",`
`6`	`6`	`"current-version": "echo $npm_package_version"`