feat(events): Allow disabling event logging (#180)

Author: felipecsl

src/i-client-config.ts

@@ -159,22 +159,24 @@ export interface IClientConfig extends IBaseRequestConfig {
 
   /** Configuration settings for the event dispatcher */
   eventIngestionConfig?: {
-    /** Number of milliseconds to wait between each batch delivery. Defaults to 10 seconds. */
-    deliveryIntervalMs?: number;
-    /** Minimum amount of milliseconds to wait before retrying a failed delivery. Defaults to 5 seconds */
-    retryIntervalMs?: number;
-    /** Maximum amount of milliseconds to wait before retrying a failed delivery. Defaults to 30 seconds. */
-    maxRetryDelayMs?: number;
-    /** Maximum number of retry attempts before giving up on a batch delivery. Defaults to 3 retries. */
-    maxRetries?: number;
     /** 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;
     /**
      * Maximum number of events to queue in memory before starting to drop events.
      * Note: This is only used if localStorage is not available.
      * Defaults to 10000 events.
      */
     maxQueueSize?: number;
+    /** Maximum number of retry attempts before giving up on a batch delivery. Defaults to 3 retries. */
+    maxRetries?: number;
+    /** Maximum amount of milliseconds to wait before retrying a failed delivery. Defaults to 30 seconds. */
+    maxRetryDelayMs?: number;
+    /** Minimum amount of milliseconds to wait before retrying a failed delivery. Defaults to 5 seconds */
+    retryIntervalMs?: number;
   };
 
   /**

src/index.spec.ts

@@ -40,6 +40,7 @@ import {
   getPrecomputedInstance,
   IAssignmentLogger,
   init,
+  NO_OP_EVENT_DISPATCHER,
   offlineInit,
   offlinePrecomputedInit,
   precomputedInit,
@@ -1756,4 +1757,32 @@ describe('enableOverrides', () => {
     const assignment = client.getStringAssignment('test-flag', 'subject-1', {}, 'default-value');
     expect(assignment).toBe('override-value');
   });
+
+  describe('eventIngestionConfig', () => {
+    it('should not be used if eventIngestionConfig.disabled is true', 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 () => {
+      const client = await init({
+        apiKey,
+        baseUrl: `http://127.0.0.1`,
+        assignmentLogger: td.object<IAssignmentLogger>(),
+        forceReinitialize: true,
+        eventIngestionConfig: {
+          disabled: false,
+        },
+      });
+      expect(client['eventDispatcher']).not.toEqual(NO_OP_EVENT_DISPATCHER);
+    });
+  });
 });

src/index.ts

@@ -99,6 +99,13 @@ const flagConfigurationStore = configurationStorageFactory({
 const memoryOnlyPrecomputedFlagsStore = precomputedFlagsStorageFactory();
 const memoryOnlyPrecomputedBanditsStore = precomputedBanditStoreFactory();
 
+export const NO_OP_EVENT_DISPATCHER: EventDispatcher = {
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
+  attachContext: () => {},
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
+  dispatch: () => {},
+};
+
 /**
  * Client for assigning experiment variations.
  * @public
@@ -983,11 +990,15 @@ function newEventDispatcher(
   const {
     batchSize = 1_000,
     deliveryIntervalMs = 10_000,
-    retryIntervalMs = 5_000,
-    maxRetryDelayMs = 30_000,
-    maxRetries = 3,
+    disabled = false,
     maxQueueSize = 10_000,
+    maxRetries = 3,
+    maxRetryDelayMs = 30_000,
+    retryIntervalMs = 5_000,
   } = config;
+  if (disabled) {
+    return NO_OP_EVENT_DISPATCHER;
+  }
   const eventQueue = hasWindowLocalStorage()
     ? new LocalStorageBackedNamedEventQueue<Event>('events')
     : new BoundedEventQueue<Event>('events', [], maxQueueSize);