Update OdpOptions to handle additional granular configuration options for ODP Segment and Event Managers (#805)

Author: opti-jnguyen

packages/optimizely-sdk/lib/core/odp/odp_event_manager.ts

@@ -143,6 +143,7 @@ export class OdpEventManager implements IOdpEventManager {
     let defaultQueueSize = DEFAULT_BROWSER_QUEUE_SIZE;
 
     try {
+      // TODO: Consider refactoring to use typeof process and combine w/above line
       if (process) {
         defaultQueueSize = DEFAULT_SERVER_QUEUE_SIZE;
       }

packages/optimizely-sdk/lib/core/odp/odp_manager.ts

@@ -19,7 +19,7 @@ import { getLogger, LogHandler, LogLevel } from '../../modules/logging';
 import { ERROR_MESSAGES, ODP_USER_KEY } from '../../utils/enums';
 
 import { RequestHandler } from './../../utils/http_request_handler/http';
-import { BrowserLRUCache } from './../../utils/lru_cache/browser_lru_cache';
+
 import { LRUCache } from './../../utils/lru_cache/lru_cache';
 
 import { VuidManager } from '../../plugins/vuid_manager';
@@ -32,26 +32,25 @@ import { OdpEventApiManager } from './odp_event_api_manager';
 import { OptimizelySegmentOption } from './optimizely_segment_option';
 import { invalidOdpDataFound } from './odp_utils';
 import { OdpEvent } from './odp_event';
+import { OdpOptions } from '../../shared_types';
 
 /**
- * @param {boolean}                     disable Flag for disabling ODP Manager.
- * @param {RequestHandler}              requestHandler HTTP request handler that will be used by Segment and Event Managers.
+ * @param {LRUCache<string, string>[]}  segmentLRUCache Cache to be used for storing segments.
+ * @param {RequestHandler}              segmentRequestHandler HTTP request handler that will be used by the ODP Segment Manager.
+ * @param {RequestHandler}              eventRequestHandler HTTP request handler that will be used by the ODP Event Manager.
  * @param {LogHandler}                  logger (Optional) Accepts custom LogHandler. Defaults to the default global LogHandler.
  * @param {string}                      clientEngine (Optional) String denoting specific client engine being used. Defaults to 'javascript-sdk'.
  * @param {string}                      clientVersion (Optional) String denoting specific client version. Defaults to current version value from package.json.
- * @param {LRUCache<string, string[]>}  segmentsCache (Optional) Accepts a custom LRUCache. Defaults to BrowserLRUCache.
- * @param {OdpEventManager}             eventManager (Optional) Accepts a custom ODPEventManager.
- * @param {OdpSegmentManager}           segmentManager (Optional) Accepts a custom ODPSegmentManager.
+ * @param {OdpOptions}                  odpOptions (Optional) Configuration settings for various ODP options from segment cache size to event flush interval.
  */
 interface OdpManagerConfig {
-  disable: boolean;
-  requestHandler: RequestHandler;
+  segmentLRUCache: LRUCache<string, string[]>;
+  segmentRequestHandler: RequestHandler;
+  eventRequestHandler: RequestHandler;
   logger?: LogHandler;
   clientEngine?: string;
   clientVersion?: string;
-  segmentsCache?: LRUCache<string, string[]>;
-  eventManager?: OdpEventManager;
-  segmentManager?: OdpSegmentManager;
+  odpOptions?: OdpOptions;
 }
 
 /**
@@ -75,16 +74,15 @@ export class OdpManager {
   public eventManager: OdpEventManager | undefined;
 
   constructor({
-    disable,
-    requestHandler,
+    segmentLRUCache,
+    segmentRequestHandler,
+    eventRequestHandler,
     logger,
     clientEngine,
     clientVersion,
-    segmentsCache,
-    eventManager,
-    segmentManager,
+    odpOptions,
   }: OdpManagerConfig) {
-    this.enabled = !disable;
+    this.enabled = !odpOptions?.disabled;
     this.logger = logger || getLogger();
 
     if (!this.enabled) {
@@ -93,28 +91,31 @@ export class OdpManager {
     }
 
     // Set up Segment Manager (Audience Segments GraphQL API Interface)
-    if (segmentManager) {
-      this.segmentManager = segmentManager;
+    if (odpOptions?.segmentManager) {
+      this.segmentManager = odpOptions.segmentManager;
       this.segmentManager.updateSettings(this.odpConfig);
     } else {
       this.segmentManager = new OdpSegmentManager(
         this.odpConfig,
-        segmentsCache || new BrowserLRUCache<string, string[]>(),
-        new OdpSegmentApiManager(requestHandler, this.logger)
+        segmentLRUCache,
+        new OdpSegmentApiManager(segmentRequestHandler, this.logger)
       );
     }
 
     // Set up Events Manager (Events REST API Interface)
-    if (eventManager) {
-      this.eventManager = eventManager;
+    if (odpOptions?.eventManager) {
+      this.eventManager = odpOptions.eventManager;
       this.eventManager.updateSettings(this.odpConfig);
     } else {
       this.eventManager = new OdpEventManager({
         odpConfig: this.odpConfig,
-        apiManager: new OdpEventApiManager(requestHandler, this.logger),
+        apiManager: new OdpEventApiManager(eventRequestHandler, this.logger),
         logger: this.logger,
         clientEngine: clientEngine || 'javascript-sdk',
         clientVersion: clientVersion || BROWSER_CLIENT_VERSION,
+        flushInterval: odpOptions?.eventFlushInterval,
+        batchSize: odpOptions?.eventBatchSize,
+        queueSize: odpOptions?.eventQueueSize,
       });
     }
 

packages/optimizely-sdk/lib/index.browser.tests.js

@@ -25,11 +25,9 @@ import optimizelyFactory from './index.browser';
 import configValidator from './utils/config_validator';
 import eventProcessorConfigValidator from './utils/event_processor_config_validator';
 import OptimizelyUserContext from './optimizely_user_context';
-import { LOG_MESSAGES, ODP_DEFAULT_EVENT_TYPE, ODP_EVENT_ACTION } from './utils/enums';
-import { BrowserLRUCache } from './utils/lru_cache';
-import { OdpConfig } from './core/odp/odp_config';
+import { LOG_MESSAGES, ODP_EVENT_ACTION } from './utils/enums';
 import { BrowserOdpManager } from './plugins/odp_manager/index.browser';
-import { OdpEvent } from './core/odp/odp_event';
+import { OdpConfig } from './core/odp/odp_config';
 
 var LocalStoragePendingEventsDispatcher = eventProcessor.LocalStoragePendingEventsDispatcher;
 
@@ -612,7 +610,7 @@ describe('javascript-sdk (Browser)', function() {
           eventDispatcher: fakeEventDispatcher,
           eventBatchSize: null,
           logger,
-          odpManager: BrowserOdpManager.createBrowserOdpManager({
+          odpManager: new BrowserOdpManager({
             logger,
             odpOptions: {
               disabled: true,
@@ -630,7 +628,7 @@ describe('javascript-sdk (Browser)', function() {
           eventDispatcher: fakeEventDispatcher,
           eventBatchSize: null,
           logger,
-          odpManager: BrowserOdpManager.createBrowserOdpManager({
+          odpManager: new BrowserOdpManager({
             logger,
             odpOptions: {
               segmentsCacheSize: 10,
@@ -652,7 +650,7 @@ describe('javascript-sdk (Browser)', function() {
           eventDispatcher: fakeEventDispatcher,
           eventBatchSize: null,
           logger,
-          odpManager: BrowserOdpManager.createBrowserOdpManager({
+          odpManager: new BrowserOdpManager({
             logger,
             odpOptions: {
               segmentsCacheTimeout: 10,
@@ -674,7 +672,7 @@ describe('javascript-sdk (Browser)', function() {
           eventDispatcher: fakeEventDispatcher,
           eventBatchSize: null,
           logger,
-          odpManager: BrowserOdpManager.createBrowserOdpManager({
+          odpManager: new BrowserOdpManager({
             logger,
             odpOptions: {
               segmentsCacheSize: 10,
@@ -696,7 +694,8 @@ describe('javascript-sdk (Browser)', function() {
         );
       });
 
-      it('should accept a valid custom odp segment manager', () => {
+      // TODO: Patch VUID Promise Pattern (@Andy)
+      it('should accept a valid custom odp segment manager', async () => {
         const fakeSegmentManager = {
           fetchQualifiedSegments: sinon.spy(),
           updateSettings: sinon.spy(),
@@ -708,17 +707,26 @@ describe('javascript-sdk (Browser)', function() {
           eventDispatcher: fakeEventDispatcher,
           eventBatchSize: null,
           logger,
-          odpManager: BrowserOdpManager.createBrowserOdpManager({
+          odpManager: new BrowserOdpManager({
             logger,
             odpOptions: {
               segmentManager: fakeSegmentManager,
             },
           }),
         });
 
-        client.fetchQualifiedSegments(testVuid);
+        sinon.assert.called(fakeSegmentManager.updateSettings);
+
+        try {
+          const readyData = await client.onReady();
+          assert.equal(readyData.success, true);
+          assert.isEmpty(readyData.reason);
+
+          await client.fetchQualifiedSegments(testVuid);
 
-        sinon.assert.calledWith(fakeSegmentManager.updateSettings, new OdpConfig());
+          sinon.assert.notCalled(logger.error);
+          sinon.assert.called(fakeSegmentManager.fetchQualifiedSegments);
+        } catch (e) {}
       });
 
       it('should accept a valid custom odp event manager', () => {
@@ -738,7 +746,7 @@ describe('javascript-sdk (Browser)', function() {
           eventDispatcher: fakeEventDispatcher,
           eventBatchSize: null,
           logger,
-          odpManager: BrowserOdpManager.createBrowserOdpManager({
+          odpManager: new BrowserOdpManager({
             logger,
             odpOptions: {
               eventManager: fakeEventManager,
@@ -749,7 +757,7 @@ describe('javascript-sdk (Browser)', function() {
         sinon.assert.called(fakeEventManager.start);
       });
 
-      // TODO: Finish this test
+      // TODO: Patch VUID Promise Pattern (@Andy)
       it('should send an odp event with sendOdpEvent', async () => {
         const fakeOdpManager = {
           sendEvent: sinon.spy(),
@@ -780,15 +788,15 @@ describe('javascript-sdk (Browser)', function() {
         } catch (e) {}
       });
 
-      // TODO: Finish this test
+      // TODO: Patch VUID Promise Pattern (@Andy)
       it('should log an error when attempting to send an odp event when odp is disabled', async () => {
         const client = optimizelyFactory.createInstance({
           datafile: testData.getTestProjectConfigWithFeatures(),
           errorHandler: fakeErrorHandler,
           eventDispatcher: fakeEventDispatcher,
           eventBatchSize: null,
           logger,
-          odpManager: BrowserOdpManager.createBrowserOdpManager({
+          odpManager: new BrowserOdpManager({
             logger,
             odpOptions: {
               disabled: true,

packages/optimizely-sdk/lib/index.browser.ts

@@ -125,7 +125,7 @@ const createInstance = function(config: Config): Client | null {
         : undefined,
       notificationCenter,
       isValidInstance: isValidInstance,
-      odpManager: BrowserOdpManager.createBrowserOdpManager({ logger, odpOptions: config.odpOptions }),
+      odpManager: new BrowserOdpManager({ logger, odpOptions: config.odpOptions }),
     };
 
     const optimizely = new BrowserOptimizely(optimizelyOptions);

packages/optimizely-sdk/lib/optimizely/index.tests.js

@@ -17,7 +17,6 @@ import { assert, expect } from 'chai';
 import sinon from 'sinon';
 import { sprintf } from '../utils/fns';
 import { NOTIFICATION_TYPES } from '../utils/enums';
-import eventProcessor from '../plugins/event_processor';
 import * as logging from '../modules/logging';
 
 import Optimizely from './';
@@ -40,8 +39,7 @@ import { createForwardingEventProcessor } from '../plugins/event_processor/forwa
 import { createEventProcessor } from '../plugins/event_processor';
 import { createNotificationCenter } from '../core/notification_center';
 import { createHttpPollingDatafileManager } from '../plugins/datafile_manager/http_polling_datafile_manager';
-import { OdpManager } from '../core/odp/odp_manager';
-import { getLogger } from '../modules/logging';
+import { NodeOdpManager } from '../plugins/odp_manager/index.node';
 
 var ERROR_MESSAGES = enums.ERROR_MESSAGES;
 var LOG_LEVEL = enums.LOG_LEVEL;
@@ -10088,6 +10086,7 @@ describe('lib/optimizely', function() {
     });
   });
 
+  // Note: /lib/index.browser.tests.js contains relevant Opti Client x Browser ODP Tests
   // TODO: Finish these tests in ODP Node.js Implementation
   describe('odp', () => {
     var optlyInstanceWithOdp;
@@ -10112,9 +10111,7 @@ describe('lib/optimizely', function() {
         eventBatchSize: 1,
         eventProcessor,
         notificationCenter,
-        odpManager: new OdpManager({
-          disable: false,
-        }),
+        odpManager: new NodeOdpManager({}),
       });
 
       bucketStub = sinon.stub(bucketer, 'bucket');
@@ -10142,9 +10139,11 @@ describe('lib/optimizely', function() {
         eventBatchSize: 1,
         eventProcessor,
         notificationCenter,
-        odpManager: new OdpManager({
-          disable: true,
+        odpManager: new NodeOdpManager({
           logger: createdLogger,
+          odpOptions: {
+            disabled: true,
+          },
         }),
       });
 

packages/optimizely-sdk/lib/optimizely/index.ts

@@ -1663,7 +1663,7 @@ export default class Optimizely {
    * Sends an action as an ODP Event with optional custom parameters including type, identifiers, and data
    * Note: Since this depends on this.odpManager, it must await Optimizely client's onReady() promise resolution.
    * @param {Object} odpEvent
-   * @param {ODP_EVENT_ACTION}    odpEvent.action         Subcategory of the event type (i.e. "client_initialized", or "")
+   * @param {ODP_EVENT_ACTION}    odpEvent.action         Subcategory of the event type (i.e. "client_initialized", or "identified")
    * @param {string}              odpEvent.type           (Optional) Type of event (Defaults to "fullstack")
    * @param {Map<string, string>} odpEvent.identifiers    (Optional) Key-value map of user identifiers
    * @param {Map<string, string>} odpEvent.data           (Optional) Event data in a key-value map.