feat(events): Allow providing config for DefaultEventDispatcher (#122)

* feat(events): Allow providing config for DefaultEventDispatcher

* write test

* fix tests

* fix: for common v4.6.2 (#123)

* Include subject info in log

* Update to setSubjectAndPrecomputedFlagsRequestParameters

---------

Co-authored-by: Sameeran Kunche <[email protected]>

Author: felipecsl

docs/js-client-sdk.iclientconfig.eventingestionconfig.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@eppo/js-client-sdk](./js-client-sdk.md) &gt; [IClientConfig](./js-client-sdk.iclientconfig.md) &gt; [eventIngestionConfig](./js-client-sdk.iclientconfig.eventingestionconfig.md)
+
+## IClientConfig.eventIngestionConfig property
+
+Configuration settings for the event dispatcher
+
+**Signature:**
+
+```typescript
+eventIngestionConfig?: {
+        deliveryIntervalMs?: number;
+        retryIntervalMs?: number;
+        maxRetryDelayMs?: number;
+        maxRetries?: number;
+        batchSize?: number;
+    };
+```

docs/js-client-sdk.iclientconfig.md

@@ -38,6 +38,25 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[eventIngestionConfig?](./js-client-sdk.iclientconfig.eventingestionconfig.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ deliveryIntervalMs?: number; retryIntervalMs?: number; maxRetryDelayMs?: number; maxRetries?: number; batchSize?: number; }
+
+
+</td><td>
+
+_(Optional)_ Configuration settings for the event dispatcher
+
+
+</td></tr>
+<tr><td>
+
 [forceReinitialize?](./js-client-sdk.iclientconfig.forcereinitialize.md)
 
 

js-client-sdk.api.md

@@ -116,6 +116,13 @@ export { IAsyncStore }
 //
 // @public
 export interface IClientConfig extends IBaseRequestConfig {
+    eventIngestionConfig?: {
+        deliveryIntervalMs?: number;
+        retryIntervalMs?: number;
+        maxRetryDelayMs?: number;
+        maxRetries?: number;
+        batchSize?: number;
+    };
     forceReinitialize?: boolean;
     maxCacheAgeSeconds?: number;
     persistentStore?: IAsyncStore<Flag>;

package.json

@@ -59,7 +59,7 @@
     "webpack-cli": "^4.10.0"
   },
   "dependencies": {
-    "@eppo/js-client-sdk-common": "^4.5.4"
+    "@eppo/js-client-sdk-common": "^4.6.2"
   },
   "packageManager": "[email protected]+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
 }

src/i-client-config.ts

@@ -1,4 +1,5 @@
 import { AttributeType, Flag, IAssignmentLogger, IAsyncStore } from '@eppo/js-client-sdk-common';
+import { EventDispatcherConfig } from '@eppo/js-client-sdk-common/src/events/default-event-dispatcher';
 
 import { ServingStoreUpdateStrategy } from './isolatable-hybrid.store';
 
@@ -120,4 +121,18 @@ export interface IClientConfig extends IBaseRequestConfig {
    * Force reinitialize the SDK if it is already initialized.
    */
   forceReinitialize?: boolean;
+
+  /** Configuration settings for the event dispatcher */
+  eventIngestionConfig?: {
+    // number of milliseconds to wait between each batch delivery. Default is 10 seconds.
+    deliveryIntervalMs?: number;
+    // minimum amount of milliseconds to wait before retrying a failed delivery. Default is 5 seconds
+    retryIntervalMs?: number;
+    // maximum amount of milliseconds to wait before retrying a failed delivery. Default is 30 seconds.
+    maxRetryDelayMs?: number;
+    // maximum number of retry attempts before giving up on a batch delivery. Default is 3.
+    maxRetries?: number;
+    // maximum number of events to send per delivery request. Default is 100.
+    batchSize?: number;
+  };
 }

src/index.spec.ts

@@ -29,6 +29,7 @@ import { IClientConfig } from './i-client-config';
 import { ServingStoreUpdateStrategy } from './isolatable-hybrid.store';
 
 import {
+  EppoJSClient,
   EppoPrecomputedJSClient,
   getConfigUrl,
   getInstance,
@@ -1177,3 +1178,36 @@ describe('EppoPrecomputedJSClient E2E test', () => {
     });
   });
 });
+
+describe('EppoClient config', () => {
+  it('should initialize event dispatcher with default values', async () => {
+    global.fetch = jest.fn(() => {
+      return Promise.resolve({
+        ok: true,
+        status: 200,
+        json: () => Promise.resolve({}),
+      });
+    }) as jest.Mock;
+    EppoJSClient.initialized = false;
+    const client = await init({
+      apiKey: 'zCsQuoHJxVPp895.ZWg9MTIzNDU2LmUudGVzdGluZy5lcHBvLmNsb3Vk',
+      assignmentLogger: td.object<IAssignmentLogger>(),
+      eventIngestionConfig: {
+        deliveryIntervalMs: 1,
+        retryIntervalMs: 2,
+        maxRetryDelayMs: 3,
+        maxRetries: 4,
+        batchSize: 5,
+      },
+    });
+    // hack to read the private class members config
+    const eventDispatcher = client['eventDispatcher'];
+    const retryManager = eventDispatcher['retryManager'];
+    const batchProcessor = eventDispatcher['batchProcessor'];
+    expect(eventDispatcher['deliveryIntervalMs']).toEqual(1);
+    expect(batchProcessor['batchSize']).toEqual(5);
+    expect(retryManager['config']['retryIntervalMs']).toEqual(2);
+    expect(retryManager['config']['maxRetryDelayMs']).toEqual(3);
+    expect(retryManager['config']['maxRetries']).toEqual(4);
+  });
+});

src/index.ts

@@ -17,6 +17,7 @@ import {
   ObfuscatedFlag,
   BoundedEventQueue,
   validation,
+  Event,
 } from '@eppo/js-client-sdk-common';
 
 import { assignmentCacheFactory } from './cache/assignment-cache-factory';
@@ -335,6 +336,7 @@ export async function init(config: IClientConfig): Promise<EppoClient> {
     pollAfterSuccessfulInitialization = false,
     pollAfterFailedInitialization = false,
     skipInitialRequest = false,
+    eventIngestionConfig,
   } = config;
   try {
     if (EppoJSClient.initialized) {
@@ -404,7 +406,7 @@ export async function init(config: IClientConfig): Promise<EppoClient> {
       skipInitialPoll: skipInitialRequest,
     };
     instance.setConfigurationRequestParameters(requestConfiguration);
-    instance.setEventDispatcher(newEventDispatcher(apiKey));
+    instance.setEventDispatcher(newEventDispatcher(apiKey, eventIngestionConfig));
 
     // We have two at-bats for initialization: from the configuration store and from fetching
     // We can resolve the initialization promise as soon as either one succeeds
@@ -595,7 +597,7 @@ export async function precomputedInit(
     throwOnFailedInitialization: true, // always use true here as underlying instance fetch is surrounded by try/catch
     skipInitialPoll: skipInitialRequest,
   };
-  instance.setPrecomputedFlagsRequestParameters(precomputedFlagsRequestParameters);
+  instance.setSubjectAndPrecomputedFlagsRequestParameters(precomputedFlagsRequestParameters);
 
   await instance.fetchPrecomputedFlags();
 
@@ -613,14 +615,30 @@ export function getPrecomputedInstance(): EppoPrecomputedClient {
   return EppoPrecomputedJSClient.instance;
 }
 
-function newEventDispatcher(sdkKey: string): EventDispatcher {
+function newEventDispatcher(
+  sdkKey: string,
+  config: IClientConfig['eventIngestionConfig'] = {},
+): EventDispatcher {
   const eventQueue = hasWindowLocalStorage()
-    ? new LocalStorageBackedNamedEventQueue('events')
-    : new BoundedEventQueue('events');
+    ? new LocalStorageBackedNamedEventQueue<Event>('events')
+    : new BoundedEventQueue<Event>('events');
   const emptyNetworkStatusListener =
     // eslint-disable-next-line @typescript-eslint/no-empty-function
     { isOffline: () => false, onNetworkStatusChange: () => {} };
   const networkStatusListener =
     typeof window !== 'undefined' ? new BrowserNetworkStatusListener() : emptyNetworkStatusListener;
-  return newDefaultEventDispatcher(eventQueue, networkStatusListener, sdkKey);
+  // initialize config with default values
+  const {
+    batchSize = 100,
+    deliveryIntervalMs = 10_000,
+    retryIntervalMs = 5_000,
+    maxRetryDelayMs = 30_000,
+    maxRetries = 3,
+  } = config;
+  return newDefaultEventDispatcher(eventQueue, networkStatusListener, sdkKey, batchSize, {
+    deliveryIntervalMs,
+    retryIntervalMs,
+    maxRetryDelayMs,
+    maxRetries,
+  });
 }

yarn.lock

@@ -380,10 +380,10 @@
   resolved "https://registry.yarnpkg.com/@discoveryjs/json-ext/-/json-ext-0.5.7.tgz#1d572bfbbe14b7704e0ba0f39b74815b84870d70"
   integrity sha512-dBVuXR082gk3jsFp7Rd/JI4kytwGHecnCoTtXFb7DB6CNHp4rg5k1bhg0nWdLGLnOV71lmDzGQaLMy8iPLY0pw==
 
-"@eppo/js-client-sdk-common@^4.5.4":
-  version "4.5.4"
-  resolved "https://registry.yarnpkg.com/@eppo/js-client-sdk-common/-/js-client-sdk-common-4.5.4.tgz#089e0eb28ec2fd567f8ed2ec516b1b93f2ceb473"
-  integrity sha512-q3E9BTOcyAuPxWm9MqdqqV9uhaO4v8QW5d6tyDqQVZXC1hAgiMynAHH2DcuSEfE3v4s3JT0xjwzqkrcGNRCRlg==
+"@eppo/js-client-sdk-common@^4.6.2":
+  version "4.6.2"
+  resolved "https://registry.yarnpkg.com/@eppo/js-client-sdk-common/-/js-client-sdk-common-4.6.2.tgz#18b845e1411a9edf861a52e935a17d25ce5055af"
+  integrity sha512-jXxu3zaRd74IKepYj/s1TSMtRqp5pNLqgle7aD4PqfVGxmCFiBU81Jd/v9px7YzLId/8uUrQvLgIm6GAmTJMxg==
   dependencies:
     buffer "npm:@eppo/[email protected]"
     js-base64 "^3.7.7"