Refactor event tracking config options for clarity. disabled by default (#188)

refactor event tracking config options for clarity. disabled by default

Author: petzel

docs/js-client-sdk.iclientconfig.eventingestionconfig.md renamed to docs/js-client-sdk.iclientconfig.eventtracking.md

@@ -1,18 +1,18 @@
 <!-- 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)
+[Home](./index.md) &gt; [@eppo/js-client-sdk](./js-client-sdk.md) &gt; [IClientConfig](./js-client-sdk.iclientconfig.md) &gt; [eventTracking](./js-client-sdk.iclientconfig.eventtracking.md)
 
-## IClientConfig.eventIngestionConfig property
+## IClientConfig.eventTracking property
 
 Configuration settings for the event dispatcher
 
 **Signature:**
 
 ```typescript
-eventIngestionConfig?: {
+eventTracking?: {
         batchSize?: number;
         deliveryIntervalMs?: number;
-        disabled?: boolean;
+        enabled?: boolean;
         maxQueueSize?: number;
         maxRetries?: number;
         maxRetryDelayMs?: number;

docs/js-client-sdk.iclientconfig.md

@@ -57,15 +57,15 @@ _(Optional)_ Enable the Overrides Store for local flag overrides. (default: fals
 </td></tr>
 <tr><td>
 
-[eventIngestionConfig?](./js-client-sdk.iclientconfig.eventingestionconfig.md)
+[eventTracking?](./js-client-sdk.iclientconfig.eventtracking.md)
 
 
 </td><td>
 
 
 </td><td>
 
-{ batchSize?: number; deliveryIntervalMs?: number; disabled?: boolean; maxQueueSize?: number; maxRetries?: number; maxRetryDelayMs?: number; retryIntervalMs?: number; }
+{ batchSize?: number; deliveryIntervalMs?: number; enabled?: boolean; maxQueueSize?: number; maxRetries?: number; maxRetryDelayMs?: number; retryIntervalMs?: number; }
 
 
 </td><td>

js-client-sdk.api.md

@@ -146,10 +146,10 @@ export { IBanditLogger }
 // @public
 export interface IClientConfig extends IBaseRequestConfig {
     enableOverrides?: boolean;
-    eventIngestionConfig?: {
+    eventTracking?: {
         batchSize?: number;
         deliveryIntervalMs?: number;
-        disabled?: boolean;
+        enabled?: boolean;
         maxQueueSize?: number;
         maxRetries?: number;
         maxRetryDelayMs?: number;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eppo/js-client-sdk",
-  "version": "3.13.2",
+  "version": "3.14.0",
   "description": "Eppo SDK for client-side JavaScript applications",
   "main": "dist/index.js",
   "files": [

src/i-client-config.ts

@@ -158,13 +158,13 @@ export interface IClientConfig extends IBaseRequestConfig {
   forceReinitialize?: boolean;
 
   /** Configuration settings for the event dispatcher */
-  eventIngestionConfig?: {
+  eventTracking?: {
     /** Maximum number of events to send per delivery request. Defaults to 1000 events. */
     batchSize?: number;
     /** Number of milliseconds to wait between each batch delivery. Defaults to 10 seconds. */
     deliveryIntervalMs?: number;
-    /** Whether to disable event ingestion. Defaults to false. */
-    disabled?: boolean;
+    /** Whether to enable event ingestion. Defaults to false. */
+    enabled?: boolean;
     /**
      * Maximum number of events to queue in memory before starting to drop events.
      * Note: This is only used if localStorage is not available.

src/index.spec.ts

@@ -1451,7 +1451,8 @@ describe('EppoClient config', () => {
       forceReinitialize: true,
       apiKey: 'zCsQuoHJxVPp895.ZWg9MTIzNDU2LmUudGVzdGluZy5lcHBvLmNsb3Vk',
       assignmentLogger: td.object<IAssignmentLogger>(),
-      eventIngestionConfig: {
+      eventTracking: {
+        enabled: true,
         deliveryIntervalMs: 1,
         retryIntervalMs: 2,
         maxRetryDelayMs: 3,
@@ -1758,28 +1759,25 @@ describe('enableOverrides', () => {
     expect(assignment).toBe('override-value');
   });
 
-  describe('eventIngestionConfig', () => {
-    it('should not be used if eventIngestionConfig.disabled is true', async () => {
+  describe('eventTracking', () => {
+    it('should be disabled by default', async () => {
       const client = await init({
         apiKey,
         baseUrl: `http://127.0.0.1`,
         assignmentLogger: td.object<IAssignmentLogger>(),
         forceReinitialize: true,
-        eventIngestionConfig: {
-          disabled: true,
-        },
       });
       expect(client['eventDispatcher']).toEqual(NO_OP_EVENT_DISPATCHER);
     });
 
-    it('should be used if eventIngestionConfig.disabled is false', async () => {
+    it('should be used if eventTracking.enabled is true', async () => {
       const client = await init({
         apiKey,
         baseUrl: `http://127.0.0.1`,
         assignmentLogger: td.object<IAssignmentLogger>(),
         forceReinitialize: true,
-        eventIngestionConfig: {
-          disabled: false,
+        eventTracking: {
+          enabled: true,
         },
       });
       expect(client['eventDispatcher']).not.toEqual(NO_OP_EVENT_DISPATCHER);

src/index.ts

@@ -302,7 +302,7 @@ export class EppoJSClient extends EppoClient {
       pollAfterSuccessfulInitialization = false,
       pollAfterFailedInitialization = false,
       skipInitialRequest = false,
-      eventIngestionConfig,
+      eventTracking,
       enableOverrides = false,
     } = config;
     try {
@@ -386,7 +386,7 @@ export class EppoJSClient extends EppoClient {
         skipInitialPoll: skipInitialRequest,
       };
       this.setConfigurationRequestParameters(requestConfiguration);
-      this.setEventDispatcher(newEventDispatcher(apiKey, eventIngestionConfig));
+      this.setEventDispatcher(newEventDispatcher(apiKey, eventTracking));
 
       // 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
@@ -985,19 +985,19 @@ export function getPrecomputedInstance(): EppoPrecomputedClient {
 
 function newEventDispatcher(
   sdkKey: string,
-  config: IClientConfig['eventIngestionConfig'] = {},
+  config: IClientConfig['eventTracking'] = {},
 ): EventDispatcher {
   // initialize config with default values
   const {
     batchSize = 1_000,
     deliveryIntervalMs = 10_000,
-    disabled = false,
+    enabled = false,
     maxQueueSize = 10_000,
     maxRetries = 3,
     maxRetryDelayMs = 30_000,
     retryIntervalMs = 5_000,
   } = config;
-  if (disabled) {
+  if (!enabled) {
     return NO_OP_EVENT_DISPATCHER;
   }
   const eventQueue = hasWindowLocalStorage()