refactor event tracking config options for clarity. disabled by default (#103)

Author: petzel

docs/node-server-sdk.iclientconfig.eventingestionconfig.md renamed to docs/node-server-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/node-server-sdk](./node-server-sdk.md) &gt; [IClientConfig](./node-server-sdk.iclientconfig.md) &gt; [eventIngestionConfig](./node-server-sdk.iclientconfig.eventingestionconfig.md)
+[Home](./index.md) &gt; [@eppo/node-server-sdk](./node-server-sdk.md) &gt; [IClientConfig](./node-server-sdk.iclientconfig.md) &gt; [eventTracking](./node-server-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/node-server-sdk.iclientconfig.md

@@ -20,7 +20,7 @@ export interface IClientConfig
 |  [assignmentLogger](./node-server-sdk.iclientconfig.assignmentlogger.md) |  | IAssignmentLogger | Provide a logging implementation to send variation assignments to your data warehouse. |
 |  [banditLogger?](./node-server-sdk.iclientconfig.banditlogger.md) |  | IBanditLogger | _(Optional)_ Logging implementation to send bandit actions to your data warehouse |
 |  [baseUrl?](./node-server-sdk.iclientconfig.baseurl.md) |  | string | _(Optional)_ Base URL of the Eppo API. Clients should use the default setting in most cases. |
-|  [eventIngestionConfig?](./node-server-sdk.iclientconfig.eventingestionconfig.md) |  | { batchSize?: number; deliveryIntervalMs?: number; disabled?: boolean; maxQueueSize?: number; maxRetries?: number; maxRetryDelayMs?: number; retryIntervalMs?: number; } | _(Optional)_ Configuration settings for the event dispatcher |
+|  [eventTracking?](./node-server-sdk.iclientconfig.eventtracking.md) |  | { batchSize?: number; deliveryIntervalMs?: number; enabled?: boolean; maxQueueSize?: number; maxRetries?: number; maxRetryDelayMs?: number; retryIntervalMs?: number; } | _(Optional)_ Configuration settings for the event dispatcher |
 |  [numInitialRequestRetries?](./node-server-sdk.iclientconfig.numinitialrequestretries.md) |  | number | _(Optional)_ Number of additional times the initial configuration request will be attempted if it fails. This is the request servers typically synchronously wait for completion. A small wait will be done between requests. (Default: 1) |
 |  [numPollRequestRetries?](./node-server-sdk.iclientconfig.numpollrequestretries.md) |  | number | _(Optional)_ Number of additional times polling for updated configurations will be attempted before giving up. Polling is done after a successful initial request. Subsequent attempts are done using an exponential backoff. (Default: 7) |
 |  [pollAfterFailedInitialization?](./node-server-sdk.iclientconfig.pollafterfailedinitialization.md) |  | boolean | _(Optional)_ Poll for new configurations even if the initial configuration request failed. (default: false) |

node-server-sdk.api.md

@@ -49,10 +49,10 @@ export interface IClientConfig {
     assignmentLogger: IAssignmentLogger;
     banditLogger?: IBanditLogger;
     baseUrl?: string;
-    eventIngestionConfig?: {
+    eventTracking?: {
         batchSize?: number;
         deliveryIntervalMs?: number;
-        disabled?: boolean;
+        enabled?: boolean;
         maxQueueSize?: number;
         maxRetries?: number;
         maxRetryDelayMs?: number;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eppo/node-server-sdk",
-  "version": "3.9.3",
+  "version": "3.10.0",
   "description": "Eppo node server SDK",
   "main": "dist/index.js",
   "files": [

src/i-client-config.ts

@@ -47,13 +47,13 @@ export interface IClientConfig {
   pollingIntervalMs?: number;
 
   /** 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 tracking. 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

@@ -608,26 +608,23 @@ describe('EppoClient E2E test', () => {
     });
   });
 
-  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:${TEST_SERVER_PORT}`,
         assignmentLogger: mockLogger,
-        eventIngestionConfig: {
-          disabled: true,
-        },
       });
       expect(client['eventDispatcher']).toEqual(NO_OP_EVENT_DISPATCHER);
     });
 
-    it('should be used if eventIngestionConfig.disabled is false', async () => {
+    it('should be enabled if eventTracking.enabled is true', async () => {
       const client = await init({
         apiKey,
         baseUrl: `http://127.0.0.1:${TEST_SERVER_PORT}`,
         assignmentLogger: mockLogger,
-        eventIngestionConfig: {
-          disabled: false,
+        eventTracking: {
+          enabled: true
         },
       });
       expect(client['eventDispatcher']).not.toEqual(NO_OP_EVENT_DISPATCHER);
@@ -655,8 +652,8 @@ describe('EppoClient E2E test', () => {
           apiKey,
           baseUrl: `http://127.0.0.1:${TEST_SERVER_PORT}`,
           assignmentLogger: mockLogger,
-          eventIngestionConfig: {
-            disabled: false,
+          eventTracking: {
+            enabled: true,
           },
         });
 
@@ -676,8 +673,8 @@ describe('EppoClient E2E test', () => {
           apiKey,
           baseUrl: `http://127.0.0.1:${TEST_SERVER_PORT}`,
           assignmentLogger: mockLogger,
-          eventIngestionConfig: {
-            disabled: false,
+          eventTracking: {
+            enabled: true,
           },
         });
 
@@ -698,8 +695,8 @@ describe('EppoClient E2E test', () => {
           apiKey,
           baseUrl: `http://127.0.0.1:${TEST_SERVER_PORT}`,
           assignmentLogger: mockLogger,
-          eventIngestionConfig: {
-            disabled: false,
+          eventTracking: {
+            enabled: true,
           },
         });
 

src/index.ts

@@ -65,7 +65,7 @@ export async function init(config: IClientConfig): Promise<EppoClient> {
     pollingIntervalMs,
     throwOnFailedInitialization = true,
     pollAfterFailedInitialization = false,
-    eventIngestionConfig,
+    eventTracking,
   } = config;
   if (!apiKey) {
     throw new Error('API key is required');
@@ -89,7 +89,7 @@ export async function init(config: IClientConfig): Promise<EppoClient> {
   const flagConfigurationStore = new MemoryOnlyConfigurationStore<Flag>();
   const banditVariationConfigurationStore = new MemoryOnlyConfigurationStore<BanditVariation[]>();
   const banditModelConfigurationStore = new MemoryOnlyConfigurationStore<BanditParameters>();
-  const eventDispatcher = newEventDispatcher(apiKey, eventIngestionConfig);
+  const eventDispatcher = newEventDispatcher(apiKey, eventTracking);
 
   clientInstance = new EppoClient({
     flagConfigurationStore,
@@ -146,18 +146,18 @@ export function getInstance(): EppoClient {
 
 function newEventDispatcher(
   sdkKey: string,
-  config: IClientConfig['eventIngestionConfig'] = {},
+  config: IClientConfig['eventTracking'] = {},
 ): EventDispatcher {
   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;
   }
   let eventQueue: NamedEventQueue<Event>;