refactor: WIP moving VUID out of ODP

mikechu-optimizely · mikechu-optimizely · commit 9f1f6b85bbdd · 2024-10-15T15:38:34.000Z
diff --git a/lib/core/odp/odp_manager.ts b/lib/core/odp/odp_manager.ts
@@ -20,7 +20,7 @@ import { ERROR_MESSAGES, ODP_USER_KEY } from '../../utils/enums';
 
 import { VuidManager } from '../../plugins/vuid_manager';
 
-import { OdpConfig, OdpIntegrationConfig, odpIntegrationsAreEqual } from './odp_config';
+import { OdpIntegrationConfig, odpIntegrationsAreEqual } from './odp_config';
 import { IOdpEventManager } from './odp_event_manager';
 import { IOdpSegmentManager } from './odp_segment_manager';
 import { OptimizelySegmentOption } from './optimizely_segment_option';
@@ -47,10 +47,6 @@ export interface IOdpManager {
   identifyUser(userId?: string, vuid?: string): void;
 
   sendEvent({ type, action, identifiers, data }: OdpEvent): void;
-
-  isVuidEnabled(): boolean;
-
-  getVuid(): string | undefined;
 }
 
 export enum Status {
@@ -125,17 +121,10 @@ export abstract class OdpManager implements IOdpManager {
 
     const readinessDependencies: PromiseLike<unknown>[] = [this.configPromise];
 
-    if (this.isVuidEnabled()) {
-      readinessDependencies.push(this.initializeVuid());
-    }
-
     this.initPromise = Promise.all(readinessDependencies);
 
     this.onReady().then(() => {
       this.ready = true;
-      if (this.isVuidEnabled() && this.status === Status.Running) {
-        this.registerVuid();
-      }
     });
 
     if (odpIntegrationConfig) {
@@ -291,41 +280,4 @@ export abstract class OdpManager implements IOdpManager {
 
     this.eventManager.sendEvent(new OdpEvent(mType, action, identifiers, data));
   }
-
-  /**
-   * Identifies if the VUID feature is enabled
-   */
-  abstract isVuidEnabled(): boolean;
-
-  /**
-   * Returns VUID value if it exists
-   */
-  abstract getVuid(): string | undefined;
-
-  protected initializeVuid(): Promise<void> {
-    return Promise.resolve();
-  }
-
-  private registerVuid() {
-    if (!this.odpIntegrationConfig) {
-      this.logger.log(LogLevel.ERROR, ERROR_MESSAGES.ODP_CONFIG_NOT_AVAILABLE);
-      return;
-    }
-
-    if (!this.odpIntegrationConfig.integrated) {
-      this.logger.log(LogLevel.INFO, ERROR_MESSAGES.ODP_NOT_INTEGRATED);
-      return;
-    }
-
-    const vuid = this.getVuid();
-    if (!vuid) {
-      return;
-    }
-
-    try {
-      this.eventManager.registerVuid(vuid);
-    } catch (e) {
-      this.logger.log(LogLevel.ERROR, ERROR_MESSAGES.ODP_VUID_REGISTRATION_FAILED);
-    }
-  }
 }
diff --git a/lib/index.browser.ts b/lib/index.browser.ts
@@ -26,13 +26,15 @@ import * as loggerPlugin from './plugins/logger';
 import eventProcessorConfigValidator from './utils/event_processor_config_validator';
 import { createNotificationCenter } from './core/notification_center';
 import { default as eventProcessor } from './plugins/event_processor';
-import { OptimizelyDecideOption, Client, Config, OptimizelyOptions } from './shared_types';
+import { OptimizelyDecideOption, Client, Config, OptimizelyOptions, VuidManagerOptions } from './shared_types';
 import { createHttpPollingDatafileManager } from './plugins/datafile_manager/browser_http_polling_datafile_manager';
 import { BrowserOdpManager } from './plugins/odp_manager/index.browser';
 import Optimizely from './optimizely';
 import { IUserAgentParser } from './core/odp/user_agent_parser';
 import { getUserAgentParser } from './plugins/odp/user_agent_parser/index.browser';
 import * as commonExports from './common_exports';
+import { VuidManager } from './plugins/vuid_manager';
+import BrowserAsyncStorageCache from './plugins/key_value_cache/browserAsyncStorageCache';
 
 const logger = getLogger();
 logHelper.setLogHandler(loggerPlugin.createLogger());
@@ -51,7 +53,8 @@ let hasRetriedEvents = false;
  * @return {Client|null} the Optimizely client object
  *                           null on error
  */
-const createInstance = function(config: Config): Client | null {
+// TODO: @raju-opti I'm not sure how to handle async VuidManager.instance() making createInstance async
+const createInstance = async function(config: Config): Promise<Client | null> {
   try {
     // TODO warn about setting per instance errorHandler / logger / logLevel
     let isValidInstance = false;
@@ -133,6 +136,11 @@ const createInstance = function(config: Config): Client | null {
 
     const { clientEngine, clientVersion } = config;
 
+    const cache = new BrowserAsyncStorageCache();
+    const vuidManagerOptions: VuidManagerOptions = {
+      enableVuid: config.vuidManagerOptions?.enableVuid || false,
+    }
+
     const optimizelyOptions: OptimizelyOptions = {
       clientEngine: enums.JAVASCRIPT_CLIENT_ENGINE,
       ...config,
@@ -146,6 +154,7 @@ const createInstance = function(config: Config): Client | null {
       isValidInstance,
       odpManager: odpExplicitlyOff ? undefined
         : BrowserOdpManager.createInstance({ logger, odpOptions: config.odpOptions, clientEngine, clientVersion }),
+      vuidManager: await VuidManager.instance(cache, vuidManagerOptions),
     };
 
     const optimizely = new Optimizely(optimizelyOptions);
diff --git a/lib/index.react_native.ts b/lib/index.react_native.ts
@@ -24,11 +24,12 @@ import defaultEventDispatcher from './plugins/event_dispatcher/index.browser';
 import eventProcessorConfigValidator from './utils/event_processor_config_validator';
 import { createNotificationCenter } from './core/notification_center';
 import { createEventProcessor } from './plugins/event_processor/index.react_native';
-import { OptimizelyDecideOption, Client, Config } from './shared_types';
+import { OptimizelyDecideOption, Client, Config, VuidManagerOptions } from './shared_types';
 import { createHttpPollingDatafileManager } from './plugins/datafile_manager/react_native_http_polling_datafile_manager';
 import { BrowserOdpManager } from './plugins/odp_manager/index.browser';
 import * as commonExports from './common_exports';
-
+import BrowserAsyncStorageCache from './plugins/key_value_cache/browserAsyncStorageCache';
+import { VuidManager } from './plugins/vuid_manager';
 import 'fast-text-encoding';
 import 'react-native-get-random-values';
 
@@ -46,7 +47,7 @@ const DEFAULT_EVENT_MAX_QUEUE_SIZE = 10000;
  * @return {Client|null} the Optimizely client object
  *                           null on error
  */
-const createInstance = function(config: Config): Client | null {
+const createInstance = async function(config: Config): Promise<Client | null> {
   try {
     // TODO warn about setting per instance errorHandler / logger / logLevel
     let isValidInstance = false;
@@ -107,6 +108,11 @@ const createInstance = function(config: Config): Client | null {
     }
 
     const { clientEngine, clientVersion } = config;
+    
+    const cache = new BrowserAsyncStorageCache();
+    const vuidManagerOptions: VuidManagerOptions = {
+      enableVuid: config.vuidManagerOptions?.enableVuid || false,
+    }
 
     const optimizelyOptions = {
       clientEngine: enums.REACT_NATIVE_JS_CLIENT_ENGINE,
@@ -127,6 +133,7 @@ const createInstance = function(config: Config): Client | null {
       isValidInstance: isValidInstance,
       odpManager: odpExplicitlyOff ? undefined
         :BrowserOdpManager.createInstance({ logger, odpOptions: config.odpOptions, clientEngine, clientVersion }),
+      vuidManager: await VuidManager.instance(cache, vuidManagerOptions),
     };
 
     // If client engine is react, convert it to react native.
diff --git a/lib/optimizely/index.ts b/lib/optimizely/index.ts
@@ -68,6 +68,7 @@ import {
   FS_USER_ID_ALIAS,
   ODP_USER_KEY,
 } from '../utils/enums';
+import { IVuidManager } from '../plugins/vuid_manager';
 
 const MODULE_NAME = 'OPTIMIZELY';
 
@@ -95,6 +96,7 @@ export default class Optimizely implements Client {
   private eventProcessor: EventProcessor;
   private defaultDecideOptions: { [key: string]: boolean };
   protected odpManager?: IOdpManager;
+  protected vuidManager?: IVuidManager;
   public notificationCenter: NotificationCenter;
 
   constructor(config: OptimizelyOptions) {
@@ -1440,7 +1442,7 @@ export default class Optimizely implements Client {
    *                                       null if provided inputs are invalid
    */
   createUserContext(userId?: string, attributes?: UserAttributes): OptimizelyUserContext | null {
-    const userIdentifier = userId ?? this.odpManager?.getVuid();
+    const userIdentifier = userId ?? this.vuidManager?.vuid;
 
     if (userIdentifier === undefined || !this.validateInputs({ user_id: userIdentifier }, attributes)) {
       return null;
@@ -1754,20 +1756,14 @@ export default class Optimizely implements Client {
   }
 
   /**
-   * @returns {string|undefined}    Currently provisioned VUID from local ODP Manager or undefined if
-   *                                ODP Manager has not been instantiated yet for any reason.
+   * @returns {string|undefined}    Currently provisioned VUID from local ODP Manager or undefined
    */
   public getVuid(): string | undefined {
-    if (!this.odpManager) {
-      this.logger?.error('Unable to get VUID - ODP Manager is not instantiated yet.');
-      return undefined;
-    }
-
-    if (!this.odpManager.isVuidEnabled()) {
+    if (!this.vuidManager?.isVuidEnabled()) {
       this.logger.log(LOG_LEVEL.WARNING, 'getVuid() unavailable for this platform or was not explicitly enabled.', MODULE_NAME);
       return undefined;
     }
 
-    return this.odpManager.getVuid();
+    return this.vuidManager.vuid;
   }
 }
diff --git a/lib/plugins/odp_manager/index.browser.ts b/lib/plugins/odp_manager/index.browser.ts
@@ -16,24 +16,20 @@
 
 import {
   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, LogHandler } from '../../modules/logging';
 
 import { BrowserRequestHandler } from './../../utils/http_request_handler/browser_request_handler';
 
-import BrowserAsyncStorageCache from '../key_value_cache/browserAsyncStorageCache';
 import { BrowserLRUCache } from '../../utils/lru_cache';
 
 import { VuidManager } from './../vuid_manager/index';
 
 import { OdpManager } from '../../core/odp/odp_manager';
-import { OdpEvent } from '../../core/odp/odp_event';
-import { IOdpEventManager, OdpOptions, VuidManagerOptions } from '../../shared_types';
+import { IOdpEventManager, OdpOptions } from '../../shared_types';
 import { BrowserOdpEventApiManager } from '../odp/event_api_manager/index.browser';
 import { BrowserOdpEventManager } from '../odp/event_manager/index.browser';
 import { IOdpSegmentManager, OdpSegmentManager } from '../../core/odp/odp_segment_manager';
@@ -46,26 +42,21 @@ interface BrowserOdpManagerConfig {
   logger?: LogHandler;
   odpOptions?: OdpOptions;
   odpIntegrationConfig?: OdpIntegrationConfig;
-  vuidManagerOptions?: VuidManagerOptions;
 }
 
 // Client-side Browser Plugin for ODP Manager
 export class BrowserOdpManager extends OdpManager {
-  static cache = new BrowserAsyncStorageCache();
-  vuid?: string;
-
   constructor(options: {
     odpIntegrationConfig?: OdpIntegrationConfig;
     segmentManager: IOdpSegmentManager;
     eventManager: IOdpEventManager;
     logger: LogHandler;
-    vuidManagerOptions?: VuidManagerOptions;
   }) {
     super(options);
   }
 
   static createInstance({
-    logger, odpOptions, odpIntegrationConfig, clientEngine, clientVersion, vuidManagerOptions,
+    logger, odpOptions, odpIntegrationConfig, clientEngine, clientVersion,
   }: BrowserOdpManagerConfig): BrowserOdpManager {
     logger = logger || getLogger();
 
@@ -135,19 +126,9 @@ export class BrowserOdpManager extends OdpManager {
       segmentManager,
       eventManager,
       logger,
-      vuidManagerOptions,
     });
   }
 
-  /**
-   * @override
-   * accesses or creates new VUID from Browser cache
-   */
-  protected async initializeVuid(): Promise<void> {
-    const vuidManager = await VuidManager.instance(BrowserOdpManager.cache, this.vuidManagerOptions);
-    this.vuid = vuidManager.vuid;
-  }
-
   /**
    * @override
    * - Still identifies a user via the ODP Event Manager
@@ -165,35 +146,6 @@ export class BrowserOdpManager extends OdpManager {
       return;
     }
 
-    super.identifyUser(fsUserId, vuid || this.vuid);
-  }
-
-  /**
-   * @override
-   * - Sends an event to the ODP Server via the ODP Events API
-   * - Intercepts identifiers and injects VUID before sending event
-   * - Identifiers must contain at least one key-value pair
-   * @param {OdpEvent} odpEvent  > ODP Event to send to event manager
-   */
-  sendEvent({ type, action, identifiers, data }: OdpEvent): void {
-    const identifiersWithVuid = new Map<string, string>(identifiers);
-
-    if (!identifiers.has(ODP_USER_KEY.VUID)) {
-      if (this.vuid) {
-        identifiersWithVuid.set(ODP_USER_KEY.VUID, this.vuid);
-      } else {
-        throw new Error(ERROR_MESSAGES.ODP_SEND_EVENT_FAILED_VUID_MISSING);
-      }
-    }
-
-    super.sendEvent({ type, action, identifiers: identifiersWithVuid, data });
-  }
-
-  isVuidEnabled(): boolean {
-    return this.vuidManagerOptions?.enableVuid || false;
-  }
-
-  getVuid(): string | undefined {
-    return this.vuid;
+    super.identifyUser(fsUserId, vuid);
   }
 }
diff --git a/lib/plugins/odp_manager/index.node.ts b/lib/plugins/odp_manager/index.node.ts
@@ -18,7 +18,7 @@ import { NodeRequestHandler } from '../../utils/http_request_handler/node_reques
 
 import { ServerLRUCache } from './../../utils/lru_cache/server_lru_cache';
 
-import { getLogger, LogHandler, LogLevel } from '../../modules/logging';
+import { getLogger, LogHandler } from '../../modules/logging';
 import {
   NODE_CLIENT_ENGINE,
   CLIENT_VERSION,
@@ -133,12 +133,4 @@ export class NodeOdpManager extends OdpManager {
       logger,
     });
   }
-
-  public isVuidEnabled(): boolean {
-    return false;
-  }
-
-  public getVuid(): string | undefined {
-    return undefined;
-  }
 }
diff --git a/lib/plugins/vuid_manager/index.ts b/lib/plugins/vuid_manager/index.ts
@@ -53,8 +53,11 @@ export class VuidManager implements IVuidManager {
     return this._vuid;
   }
 
-  private constructor() {
+  private readonly options: VuidManagerOptions;
+
+  private constructor(options: VuidManagerOptions) {
     this._vuid = '';
+    this.options = options;
   }
 
   /**
@@ -69,14 +72,13 @@ export class VuidManager implements IVuidManager {
    * @param options Options for the VUID Manager
    * @returns An instance of VuidManager
    */
-  static async instance(cache: PersistentKeyValueCache, options?: VuidManagerOptions): Promise<VuidManager> {
+  static async instance(cache: PersistentKeyValueCache, options: VuidManagerOptions): Promise<VuidManager> {
     if (!this._instance) {
-      this._instance = new VuidManager();
-    }
+      this._instance = new VuidManager(options);
 
-    if (!options?.enableVuid) {
-      cache.remove(this._instance._keyForVuid);
-      return this._instance;
+      if (!this._instance.options.enableVuid) {
+        await cache.remove(this._instance._keyForVuid);
+      }
     }
 
     if (!this._instance._vuid) {
@@ -130,6 +132,10 @@ export class VuidManager implements IVuidManager {
     await cache.set(this._keyForVuid, vuid);
   }
 
+  static isVuidEnabled(): boolean {
+    return this._instance.options.enableVuid || false;
+  }
+
   /**
    * Validates the format of a Visitor Unique Identifier
    * @param vuid VistorId to check
diff --git a/lib/shared_types.ts b/lib/shared_types.ts
diff --git a/tests/odpManager.browser.spec.ts b/tests/odpManager.browser.spec.ts
diff --git a/tests/vuidManager.spec.ts b/tests/vuidManager.spec.ts
