feat: Add support for optional timeout for waitForInitialization. (#437)

Author: kinyoklion

contract-tests/sdkClientEntity.js

@@ -109,10 +109,7 @@ export async function newSdkClientEntity(options) {
     makeSdkConfig(options.configuration, options.tag),
   );
   try {
-    await Promise.race([
-      client.waitForInitialization(),
-      new Promise((resolve) => setTimeout(resolve, timeout)),
-    ]);
+    await client.waitForInitialization({timeout: timeout});
   } catch (_) {
     // if waitForInitialization() rejects, the client failed to initialize, see next line
   }

packages/sdk/server-node/__tests__/LDClientNode.bigSegments.test.ts

@@ -93,7 +93,7 @@ describe('given test data with big segments', () => {
         bigSegments: bigSegmentsConfig,
       });
 
-      await client.waitForInitialization();
+      await client.waitForInitialization({ timeout: 10 });
     });
 
     it('can require status', async () => {
@@ -135,7 +135,7 @@ describe('given test data with big segments', () => {
         logger,
       });
 
-      await client.waitForInitialization();
+      await client.waitForInitialization({ timeout: 10 });
     });
 
     it('Can observe the status change', (done) => {

packages/sdk/server-node/__tests__/LDClientNode.fileDataSource.test.ts

@@ -97,7 +97,7 @@ describe('When using a file data source', () => {
       sendEvents: false,
     });
 
-    await client.waitForInitialization();
+    await client.waitForInitialization({ timeout: 10 });
 
     const f1Var = await client.variation(flag1Key, { key: 'user1' }, 'default');
     expect(f1Var).toEqual('off');
@@ -121,7 +121,7 @@ describe('When using a file data source', () => {
       sendEvents: false,
     });
 
-    await client.waitForInitialization();
+    await client.waitForInitialization({ timeout: 10 });
 
     const f1Var = await client.variation(flag1Key, { key: 'user1' }, 'default');
     expect(f1Var).toEqual('off');
@@ -143,7 +143,7 @@ describe('When using a file data source', () => {
       sendEvents: false,
     });
 
-    await client.waitForInitialization();
+    await client.waitForInitialization({ timeout: 10 });
 
     const f1Var = await client.variation(flag1Key, { key: 'user1' }, 'default');
     expect(f1Var).toEqual('off');

packages/sdk/server-node/__tests__/LDClientNode.proxy.test.ts

@@ -53,7 +53,7 @@ describe('When using a proxy', () => {
 
     closeable.push(proxy, server, client);
 
-    await client.waitForInitialization();
+    await client.waitForInitialization({ timeout: 10 });
     expect(client.initialized()).toBe(true);
 
     // If the proxy server did not log a request then the SDK did not actually use the proxy
@@ -81,7 +81,7 @@ describe('When using a proxy', () => {
 
     closeable.push(proxy, server, events, client);
 
-    await client.waitForInitialization();
+    await client.waitForInitialization({ timeout: 10 });
     expect(client.initialized()).toBe(true);
 
     // If the proxy server did not log a request then the SDK did not actually use the proxy
@@ -110,7 +110,7 @@ describe('When using a proxy', () => {
 
     closeable.push(proxy, pollingServer, eventsServer, client);
 
-    await client.waitForInitialization();
+    await client.waitForInitialization({ timeout: 10 });
     expect(client.initialized()).toBe(true);
 
     // If the proxy server did not log a request then the SDK did not actually use the proxy

packages/sdk/server-node/__tests__/LDClientNode.tls.test.ts

@@ -27,7 +27,7 @@ describe('When using a TLS connection', () => {
       tlsParams: { ca: server.certificate },
       diagnosticOptOut: true,
     });
-    await client.waitForInitialization();
+    await client.waitForInitialization({ timeout: 10 });
   });
 
   it('cannot connect via HTTPS to a server with a self-signed certificate, using default config', async () => {
@@ -67,7 +67,7 @@ describe('When using a TLS connection', () => {
     });
 
     // this won't return until the stream receives the "put" event
-    await client.waitForInitialization();
+    await client.waitForInitialization({ timeout: 10 });
     events.close();
   });
 
@@ -85,7 +85,7 @@ describe('When using a TLS connection', () => {
       logger,
     });
 
-    await client.waitForInitialization();
+    await client.waitForInitialization({ timeout: 10 });
     client.identify({ key: 'user' });
     await client.flush();
 

packages/shared/mocks/src/streamingProcessor.ts

@@ -14,6 +14,7 @@ export const setupMockStreamingProcessor = (
   patchResponseJson?: any,
   deleteResponseJson?: any,
   errorTimeoutSeconds: number = 0,
+  initTimeoutMs: number = 0,
 ) => {
   MockStreamingProcessor.mockImplementation(
     (
@@ -35,7 +36,7 @@ export const setupMockStreamingProcessor = (
           }, errorTimeoutSeconds * 1000);
         } else {
           // execute put which will resolve the identify promise
-          setTimeout(() => listeners.get('put')?.processJson(putResponseJson));
+          setTimeout(() => listeners.get('put')?.processJson(putResponseJson), initTimeoutMs);
 
           if (patchResponseJson) {
             setTimeout(() => listeners.get('patch')?.processJson(patchResponseJson));

packages/shared/sdk-server-edge/src/api/LDClient.test.ts

@@ -23,7 +23,7 @@ describe('Edge LDClient', () => {
     const client = new LDClient('client-side-id', basicPlatform.info, {
       sendEvents: true,
     });
-    await client.waitForInitialization();
+    await client.waitForInitialization({ timeout: 10 });
     const passedConfig = mockEventProcessor.mock.calls[0][0];
 
     expect(passedConfig).toMatchObject({

packages/shared/sdk-server/__tests__/LDClient.allFlags.test.ts

@@ -26,7 +26,7 @@ describe('given an LDClient with test data', () => {
       makeCallbacks(true),
     );
 
-    await client.waitForInitialization();
+    await client.waitForInitialization({ timeout: 10 });
   });
 
   afterEach(() => {

packages/shared/sdk-server/__tests__/LDClient.evaluation.test.ts

@@ -44,7 +44,7 @@ describe('given an LDClient with test data', () => {
       makeCallbacks(true),
     );
 
-    await client.waitForInitialization();
+    await client.waitForInitialization({ timeout: 10 });
   });
 
   afterEach(() => {
@@ -298,15 +298,15 @@ describe('given an offline client', () => {
   });
 
   it('returns the default value for variation', async () => {
-    await client.waitForInitialization();
+    await client.waitForInitialization({ timeout: 10 });
     td.update(td.flag('flagkey').variations('value').variationForAll(0));
     const result = await client.variation('flagkey', defaultUser, 'default');
     expect(result).toEqual('default');
     expect(logger.getCount(LogLevel.Info)).toEqual(1);
   });
 
   it('returns the default value for variationDetail', async () => {
-    await client.waitForInitialization();
+    await client.waitForInitialization({ timeout: 10 });
     td.update(td.flag('flagkey').variations('value').variationForAll(0));
     const result = await client.variationDetail('flagkey', defaultUser, 'default');
     expect(result).toMatchObject({

packages/shared/sdk-server/__tests__/LDClient.events.test.ts

@@ -33,7 +33,7 @@ describe('given a client with mock event processor', () => {
       },
       makeCallbacks(false),
     );
-    await client.waitForInitialization();
+    await client.waitForInitialization({ timeout: 10 });
   });
 
   afterEach(() => {