feat(events): Allow providing a maxQueueSize configuration (#137)

Author: felipecsl

src/i-client-config.ts

@@ -123,15 +123,21 @@ 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. */
+    /** 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 */
+    /** 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. */
+    /** 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. */
+    /** 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. */
+    /** Maximum number of events to send per delivery request. Defaults to 1000 events. */
     batchSize?: number;
+    /**
+     * 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;
   };
 }

src/index.ts

@@ -619,22 +619,23 @@ function newEventDispatcher(
   sdkKey: string,
   config: IClientConfig['eventIngestionConfig'] = {},
 ): EventDispatcher {
-  const eventQueue = hasWindowLocalStorage()
-    ? 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;
   // initialize config with default values
   const {
     batchSize = 1_000,
     deliveryIntervalMs = 10_000,
     retryIntervalMs = 5_000,
     maxRetryDelayMs = 30_000,
     maxRetries = 3,
+    maxQueueSize = 10_000,
   } = config;
+  const eventQueue = hasWindowLocalStorage()
+    ? new LocalStorageBackedNamedEventQueue<Event>('events')
+    : new BoundedEventQueue<Event>('events', [], maxQueueSize);
+  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, batchSize, {
     deliveryIntervalMs,
     retryIntervalMs,