Merge branch 'master' into aleap/switch_odp_event_rest_endpoint

Author: andrewleap-optimizely

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

@@ -142,19 +142,28 @@ export class OdpEventManager implements IOdpEventManager {
     this.clientEngine = clientEngine;
     this.clientVersion = clientVersion;
 
-    let defaultQueueSize = DEFAULT_BROWSER_QUEUE_SIZE;
-    // browser only accepts batchSize = 1
-    this.batchSize = 1
+    const isBrowser = browserMode();
 
-    if (!browserMode()) {
-      defaultQueueSize = DEFAULT_SERVER_QUEUE_SIZE;
-      this.batchSize = batchSize || DEFAULT_BATCH_SIZE;
-    } else if (typeof batchSize !== 'undefined' && batchSize !== 1) {
-      this.logger.log(LogLevel.WARNING, 'ODP event batch size must be 1 in the browser.');
+    const defaultQueueSize = isBrowser ? DEFAULT_BROWSER_QUEUE_SIZE : DEFAULT_SERVER_QUEUE_SIZE;
+    this.queueSize = queueSize || defaultQueueSize;
+    this.batchSize = batchSize || DEFAULT_BATCH_SIZE;
+
+    if (flushInterval === 0 || isBrowser) {
+      // disable event batching
+      this.batchSize = 1;
+      this.flushInterval = 0;
+    } else {
+      this.flushInterval = flushInterval || DEFAULT_FLUSH_INTERVAL_MSECS;
     }
 
-    this.queueSize = queueSize || defaultQueueSize;
-    this.flushInterval = flushInterval || DEFAULT_FLUSH_INTERVAL_MSECS;
+    if (isBrowser) {
+      if (typeof batchSize !== 'undefined' && batchSize !== 1) {
+        this.logger.log(LogLevel.WARNING, 'ODP event batch size must be 1 in the browser.');
+      }
+      if (typeof flushInterval !== 'undefined' && flushInterval !== 0) {
+        this.logger.log(LogLevel.WARNING, 'ODP event flush interval must be 0 in the browser.');
+      }
+    }
 
     this.state = STATE.STOPPED;
   }

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

@@ -14,7 +14,14 @@
  * limitations under the License.
  */
 
-import { BROWSER_CLIENT_VERSION, ERROR_MESSAGES, JAVASCRIPT_CLIENT_ENGINE, ODP_USER_KEY } from '../../utils/enums';
+import { 
+  BROWSER_CLIENT_VERSION, 
+  ERROR_MESSAGES, 
+  JAVASCRIPT_CLIENT_ENGINE, 
+  ODP_USER_KEY, 
+  REQUEST_TIMEOUT_ODP_SEGMENTS_MS, 
+  REQUEST_TIMEOUT_ODP_EVENTS_MS 
+} from '../../utils/enums';
 import { getLogger, LoggerFacade, LogHandler, LogLevel } from '../../modules/logging';
 
 import { BrowserRequestHandler } from './../../utils/http_request_handler/browser_request_handler';
@@ -50,16 +57,22 @@ export class BrowserOdpManager extends OdpManager {
 
     if (odpOptions?.segmentsRequestHandler) {
       customSegmentRequestHandler = odpOptions.segmentsRequestHandler;
-    } else if (odpOptions?.segmentsApiTimeout) {
-      customSegmentRequestHandler = new BrowserRequestHandler(browserLogger, odpOptions.segmentsApiTimeout);
+    } else {
+      customSegmentRequestHandler = new BrowserRequestHandler(
+        browserLogger, 
+        odpOptions?.segmentsApiTimeout || REQUEST_TIMEOUT_ODP_SEGMENTS_MS
+      );
     }
 
     let customEventRequestHandler;
 
     if (odpOptions?.eventRequestHandler) {
       customEventRequestHandler = odpOptions.eventRequestHandler;
-    } else if (odpOptions?.eventApiTimeout) {
-      customEventRequestHandler = new BrowserRequestHandler(browserLogger, odpOptions.eventApiTimeout);
+    } else {
+      customEventRequestHandler = new BrowserRequestHandler(
+        browserLogger, 
+        odpOptions?.eventApiTimeout || REQUEST_TIMEOUT_ODP_EVENTS_MS
+      );
     }
 
     super({
@@ -69,8 +82,8 @@ export class BrowserOdpManager extends OdpManager {
           maxSize: odpOptions?.segmentsCacheSize,
           timeout: odpOptions?.segmentsCacheTimeout,
         }),
-      segmentRequestHandler: customSegmentRequestHandler || new BrowserRequestHandler(browserLogger),
-      eventRequestHandler: customEventRequestHandler || new BrowserRequestHandler(browserLogger),
+      segmentRequestHandler: customSegmentRequestHandler,
+      eventRequestHandler: customEventRequestHandler,
       logger: browserLogger,
       clientEngine: browserClientEngine,
       clientVersion: browserClientVersion,

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

@@ -337,6 +337,8 @@ export enum NOTIFICATION_TYPES {
  * Default milliseconds before request timeout
  */
 export const REQUEST_TIMEOUT_MS = 60 * 1000; // 1 minute
+export const REQUEST_TIMEOUT_ODP_SEGMENTS_MS = 10 * 1000;  // 10 secs
+export const REQUEST_TIMEOUT_ODP_EVENTS_MS = 10 * 1000;  // 10 secs
 
 /**
  * ODP User Key Options

packages/optimizely-sdk/tests/odpManager.browser.spec.ts

@@ -336,6 +336,13 @@ describe('OdpManager', () => {
       expect(browserOdpManager.segmentManager.odpSegmentApiManager.requestHandler.timeout).toBe(4000);
     });
 
+    it('Browser default Segments API Request Handler timeout should be used when odpOptions does not include segmentsApiTimeout', () => {
+      const browserOdpManager = new BrowserOdpManager({});
+
+      // @ts-ignore
+      expect(browserOdpManager.segmentManager.odpSegmentApiManager.requestHandler.timeout).toBe(10000);
+    });
+
     it('Custom odpOptions.segmentsRequestHandler overrides default Segment API Request Handler', () => {
       const odpOptions: OdpOptions = {
         segmentsRequestHandler: new BrowserRequestHandler(fakeLogger, 4000),
@@ -431,6 +438,18 @@ describe('OdpManager', () => {
       expect(browserOdpManager.eventManager.apiManager.requestHandler.timeout).toBe(4000);
     });
 
+    it('Browser default Events API Request Handler timeout should be used when odpOptions does not include eventsApiTimeout', () => {
+      const odpOptions: OdpOptions = {
+      };
+
+      const browserOdpManager = new BrowserOdpManager({
+        odpOptions,
+      });
+
+      // @ts-ignore
+      expect(browserOdpManager.eventManager.apiManager.requestHandler.timeout).toBe(10000);
+    });
+
     it('Custom odpOptions.eventFlushInterval overrides default Event Manager flush interval', () => {
       const odpOptions: OdpOptions = {
         eventFlushInterval: 4000,
@@ -444,6 +463,33 @@ describe('OdpManager', () => {
       expect(browserOdpManager.eventManager.flushInterval).toBe(4000);
     });
 
+    it('Default ODP event flush interval is used when odpOptions does not include eventFlushInterval', () => {
+      const odpOptions: OdpOptions = {};
+
+      const browserOdpManager = new BrowserOdpManager({
+        odpOptions,
+      });
+
+      // @ts-ignore
+      expect(browserOdpManager.eventManager.flushInterval).toBe(1000);
+    });
+
+    it('ODP event batch size set to one when odpOptions.eventFlushInterval set to 0', () => {
+      const odpOptions: OdpOptions = {
+        eventFlushInterval: 0,
+      };
+
+      const browserOdpManager = new BrowserOdpManager({
+        odpOptions,
+      });
+
+      // @ts-ignore
+      expect(browserOdpManager.eventManager.flushInterval).toBe(0);
+
+      // @ts-ignore
+      expect(browserOdpManager.eventManager.batchSize).toBe(1);
+    });
+
     it('Custom odpOptions.eventBatchSize overrides default Event Manager batch size', () => {
       const odpOptions: OdpOptions = {
         eventBatchSize: 2,