[FSSDK-9562] refactor odp event api manager to handle odp config (optimizely#844)

Author: raju-opti

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

@@ -17,14 +17,17 @@
 import { LogHandler, LogLevel } from '../../modules/logging';
 import { OdpEvent } from './odp_event';
 import { RequestHandler } from '../../utils/http_request_handler/http';
+import { OdpConfig } from './odp_config';
 
 const EVENT_SENDING_FAILURE_MESSAGE = 'ODP event send failed';
+export const ODP_CONFIG_NOT_READY_MESSAGE = 'ODP config not ready';
 
 /**
  * Manager for communicating with the Optimizely Data Platform REST API
  */
 export interface IOdpEventApiManager {
-  sendEvents(apiKey: string, apiHost: string, events: OdpEvent[]): Promise<boolean>;
+  sendEvents(events: OdpEvent[]): Promise<boolean>;
+  updateSettings(odpConfig: OdpConfig): void;
 }
 
 /**
@@ -43,6 +46,11 @@ export abstract class OdpEventApiManager implements IOdpEventApiManager {
    */
   private readonly requestHandler: RequestHandler;
 
+  /**
+   * ODP configuration settings for identifying the target API and segments
+   */
+  protected odpConfig?: OdpConfig;
+
   /**
    * Creates instance to access Optimizely Data Platform (ODP) REST API
    * @param requestHandler Desired request handler for testing
@@ -53,22 +61,28 @@ export abstract class OdpEventApiManager implements IOdpEventApiManager {
     this.logger = logger;
   }
 
+  /**
+   * Updates odpConfig of the api manager instance
+   * @param odpConfig 
+   */
+  updateSettings(odpConfig: OdpConfig): void {
+    this.odpConfig = odpConfig;
+  }
+
   getLogger(): LogHandler {
     return this.logger;
   }
 
   /**
    * Service for sending ODP events to REST API
-   * @param apiKey ODP public key
-   * @param apiHost Host of ODP endpoint
    * @param events ODP events to send
    * @returns Retry is true - if network or server error (5xx), otherwise false
    */
-  async sendEvents(apiKey: string, apiHost: string, events: OdpEvent[]): Promise<boolean> {
+  async sendEvents(events: OdpEvent[]): Promise<boolean> {
     let shouldRetry = false;
 
-    if (!apiKey || !apiHost) {
-      this.logger.log(LogLevel.ERROR, `${EVENT_SENDING_FAILURE_MESSAGE} (Parameters apiKey or apiHost invalid)`);
+    if (!this.odpConfig?.isReady()) {
+      this.logger.log(LogLevel.ERROR, `${EVENT_SENDING_FAILURE_MESSAGE} (${ODP_CONFIG_NOT_READY_MESSAGE})`);
       return shouldRetry;
     }
 
@@ -81,7 +95,7 @@ export abstract class OdpEventApiManager implements IOdpEventApiManager {
       return shouldRetry;
     }
 
-    const { method, endpoint, headers, data } = this.generateRequestData(apiHost, apiKey, events);
+    const { method, endpoint, headers, data } = this.generateRequestData(events);
 
     let statusCode = 0;
     try {
@@ -111,8 +125,6 @@ export abstract class OdpEventApiManager implements IOdpEventApiManager {
   protected abstract shouldSendEvents(events: OdpEvent[]): boolean;
 
   protected abstract generateRequestData(
-    apiHost: string,
-    apiKey: string,
     events: OdpEvent[]
   ): {
     method: string;

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

@@ -149,6 +149,8 @@ export abstract class OdpEventManager implements IOdpEventManager {
     this.clientVersion = clientVersion;
     this.initParams(batchSize, queueSize, flushInterval);
     this.state = STATE.STOPPED;
+
+    this.apiManager.updateSettings(odpConfig);
   }
 
   protected abstract initParams(
@@ -163,6 +165,7 @@ export abstract class OdpEventManager implements IOdpEventManager {
    */
   updateSettings(newConfig: OdpConfig): void {
     this.odpConfig = newConfig;
+    this.apiManager.updateSettings(newConfig);
   }
 
   /**
@@ -340,7 +343,7 @@ export abstract class OdpEventManager implements IOdpEventManager {
    */
   private makeAndSend1Batch(): void {
     const batch = new Array<OdpEvent>();
-
+    
     // remove a batch from the queue
     for (let count = 0; count < this.batchSize; count += 1) {
       const event = this.queue.shift();
@@ -357,7 +360,7 @@ export abstract class OdpEventManager implements IOdpEventManager {
         let shouldRetry: boolean;
         let attemptNumber = 0;
         do {
-          shouldRetry = await this.apiManager.sendEvents(this.odpConfig.apiKey, this.odpConfig.apiHost, batch);
+          shouldRetry = await this.apiManager.sendEvents(batch);
           attemptNumber += 1;
         } while (shouldRetry && attemptNumber < MAX_RETRIES);
       });

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

@@ -1111,7 +1111,7 @@ describe('javascript-sdk (Browser)', function() {
 
         clock.tick(100);
 
-        const [, , events] = apiManager.sendEvents.getCall(0).args;
+        const [events] = apiManager.sendEvents.getCall(0).args;
         const [firstEvent] = events;
         assert.equal(firstEvent.action, 'client_initialized');
         assert.equal(firstEvent.type, 'fullstack');

packages/optimizely-sdk/lib/plugins/odp/event_api_manager/index.browser.ts

@@ -2,6 +2,7 @@ import { OdpEvent } from '../../../core/odp/odp_event';
 import { OdpEventApiManager } from '../../../core/odp/odp_event_api_manager';
 import { LogLevel } from '../../../modules/logging';
 import { ODP_EVENT_BROWSER_ENDPOINT } from '../../../utils/enums';
+import { ODP_CONFIG_NOT_READY_MESSAGE } from '../../../core/odp/odp_event_api_manager';
 
 const EVENT_SENDING_FAILURE_MESSAGE = 'ODP event send failed';
 
@@ -15,10 +16,15 @@ export class BrowserOdpEventApiManager extends OdpEventApiManager {
   }
 
   protected generateRequestData(
-    apiHost: string,
-    apiKey: string,
     events: OdpEvent[]
   ): { method: string; endpoint: string; headers: { [key: string]: string }; data: string } {
+    // the caller should ensure odpConfig is ready before calling
+    if (!this.odpConfig?.isReady()) {
+      this.getLogger().log(LogLevel.ERROR, ODP_CONFIG_NOT_READY_MESSAGE);
+      throw new Error(ODP_CONFIG_NOT_READY_MESSAGE);
+    }
+
+    const apiKey = this.odpConfig.apiKey;
     const method = 'GET';
     const event = events[0];
     const url = new URL(ODP_EVENT_BROWSER_ENDPOINT);

packages/optimizely-sdk/lib/plugins/odp/event_api_manager/index.node.ts

@@ -1,16 +1,24 @@
 import { OdpEvent } from '../../../core/odp/odp_event';
 import { OdpEventApiManager } from '../../../core/odp/odp_event_api_manager';
-
+import { LogLevel } from '../../../modules/logging';
+import { ODP_CONFIG_NOT_READY_MESSAGE } from '../../../core/odp/odp_event_api_manager';
 export class NodeOdpEventApiManager extends OdpEventApiManager {
   protected shouldSendEvents(events: OdpEvent[]): boolean {
     return true;
   }
 
   protected generateRequestData(
-    apiHost: string,
-    apiKey: string,
     events: OdpEvent[]
   ): { method: string; endpoint: string; headers: { [key: string]: string }; data: string } {
+    // the caller should ensure odpConfig is ready before calling
+    if (!this.odpConfig?.isReady()) {
+      this.getLogger().log(LogLevel.ERROR, ODP_CONFIG_NOT_READY_MESSAGE);
+      throw new Error(ODP_CONFIG_NOT_READY_MESSAGE);
+    }
+    
+    const apiHost = this.odpConfig.apiHost;
+    const apiKey = this.odpConfig.apiKey;
+    
     return {
       method: 'POST',
       endpoint: `${apiHost}/v3/events`,

packages/optimizely-sdk/tests/jsconfig.json

@@ -0,0 +1,7 @@
+{
+    "typeAcquisition": {
+        "include": [
+            "jest"
+        ]
+    }
+}

packages/optimizely-sdk/tests/odpEventApiManager.spec.ts

@@ -16,14 +16,13 @@
 
 /// <reference types="jest" />
 
-import { anyString, anything, instance, mock, resetCalls, verify, when } from 'ts-mockito';
+import { anyString, anything, capture, instance, mock, resetCalls, verify, when } from 'ts-mockito';
 import { LogHandler, LogLevel } from '../lib/modules/logging';
 import { NodeOdpEventApiManager } from '../lib/plugins/odp/event_api_manager/index.node';
 import { OdpEvent } from '../lib/core/odp/odp_event';
 import { RequestHandler } from '../lib/utils/http_request_handler/http';
+import { OdpConfig } from '../lib/core/odp/odp_config';
 
-const VALID_ODP_PUBLIC_KEY = 'not-real-api-key';
-const ODP_REST_API_HOST = 'https://events.example.com/v2/api';
 const data1 = new Map<string, unknown>();
 data1.set('key11', 'value-1');
 data1.set('key12', true);
@@ -36,6 +35,11 @@ const ODP_EVENTS = [
   new OdpEvent('t2', 'a2', new Map([['id-key-2', 'id-value-2']]), data2),
 ];
 
+const API_KEY = 'test-api-key';
+const API_HOST = 'https://odp.example.com';
+
+const odpConfig = new OdpConfig(API_KEY, API_HOST, []);
+
 describe('NodeOdpEventApiManager', () => {
   let mockLogger: LogHandler;
   let mockRequestHandler: RequestHandler;
@@ -50,7 +54,12 @@ describe('NodeOdpEventApiManager', () => {
     resetCalls(mockRequestHandler);
   });
 
-  const managerInstance = () => new NodeOdpEventApiManager(instance(mockRequestHandler), instance(mockLogger));
+  const managerInstance = () => {
+    const manager = new NodeOdpEventApiManager(instance(mockRequestHandler), instance(mockLogger));
+    manager.updateSettings(odpConfig);
+    return manager;
+  }
+
   const abortableRequest = (statusCode: number, body: string) => {
     return {
       abort: () => {},
@@ -68,7 +77,7 @@ describe('NodeOdpEventApiManager', () => {
     );
     const manager = managerInstance();
 
-    const shouldRetry = await manager.sendEvents(VALID_ODP_PUBLIC_KEY, ODP_REST_API_HOST, ODP_EVENTS);
+    const shouldRetry = await manager.sendEvents(ODP_EVENTS);
 
     expect(shouldRetry).toBe(false);
     verify(mockLogger.log(anything(), anyString())).never();
@@ -80,7 +89,7 @@ describe('NodeOdpEventApiManager', () => {
     );
     const manager = managerInstance();
 
-    const shouldRetry = await manager.sendEvents(VALID_ODP_PUBLIC_KEY, ODP_REST_API_HOST, ODP_EVENTS);
+    const shouldRetry = await manager.sendEvents(ODP_EVENTS);
 
     expect(shouldRetry).toBe(false);
     verify(mockLogger.log(LogLevel.ERROR, 'ODP event send failed (400)')).once();
@@ -92,7 +101,7 @@ describe('NodeOdpEventApiManager', () => {
     );
     const manager = managerInstance();
 
-    const shouldRetry = await manager.sendEvents(VALID_ODP_PUBLIC_KEY, ODP_REST_API_HOST, ODP_EVENTS);
+    const shouldRetry = await manager.sendEvents(ODP_EVENTS);
 
     expect(shouldRetry).toBe(true);
     verify(mockLogger.log(LogLevel.ERROR, 'ODP event send failed (500)')).once();
@@ -105,9 +114,37 @@ describe('NodeOdpEventApiManager', () => {
     });
     const manager = managerInstance();
 
-    const shouldRetry = await manager.sendEvents(VALID_ODP_PUBLIC_KEY, ODP_REST_API_HOST, ODP_EVENTS);
+    const shouldRetry = await manager.sendEvents(ODP_EVENTS);
 
     expect(shouldRetry).toBe(true);
     verify(mockLogger.log(LogLevel.ERROR, 'ODP event send failed (Request timed out)')).once();
   });
+
+  it('should send events to updated host on settings update', async () => {
+    when(mockRequestHandler.makeRequest(anything(), anything(), anything(), anything())).thenReturn({
+      abort: () => {},
+      responsePromise: Promise.reject(new Error('Request timed out')),
+    });
+
+    const manager = managerInstance();
+
+    await manager.sendEvents(ODP_EVENTS);
+
+    const updatedOdpConfig = new OdpConfig(
+      'updated-key',
+      'https://updatedhost.test',
+      ['updated-seg'],
+    )
+    
+    manager.updateSettings(updatedOdpConfig);
+    await manager.sendEvents(ODP_EVENTS);
+
+    verify(mockRequestHandler.makeRequest(anything(), anything(), anything(), anything())).twice();
+
+    const [initUrl] = capture(mockRequestHandler.makeRequest).first();
+    expect(initUrl).toEqual(`${API_HOST}/v3/events`);
+
+    const [finalUrl] = capture(mockRequestHandler.makeRequest).last();
+    expect(finalUrl).toEqual(`${updatedOdpConfig.apiHost}/v3/events`);
+  });
 });