refactor: WIP init VuidManager from opti client

Author: mikechu-optimizely

lib/index.browser.ts

@@ -53,8 +53,7 @@ let hasRetriedEvents = false;
  * @return {Client|null} the Optimizely client object
  *                           null on error
  */
-// 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> {
+const createInstance = function (config: Config): Client | null {
   try {
     // TODO warn about setting per instance errorHandler / logger / logLevel
     let isValidInstance = false;
@@ -154,7 +153,7 @@ const createInstance = async function(config: Config): Promise<Client | null> {
       isValidInstance,
       odpManager: odpExplicitlyOff ? undefined
         : BrowserOdpManager.createInstance({ logger, odpOptions: config.odpOptions, clientEngine, clientVersion }),
-      vuidManager: await VuidManager.instance(cache, vuidManagerOptions),
+      vuidManager: new VuidManager(cache, vuidManagerOptions, logger),
     };
 
     const optimizely = new Optimizely(optimizelyOptions);
@@ -183,7 +182,7 @@ const createInstance = async function(config: Config): Promise<Client | null> {
   }
 };
 
-const __internalResetRetryState = function(): void {
+const __internalResetRetryState = function (): void {
   hasRetriedEvents = false;
 };
 

lib/index.react_native.ts

@@ -47,7 +47,7 @@ const DEFAULT_EVENT_MAX_QUEUE_SIZE = 10000;
  * @return {Client|null} the Optimizely client object
  *                           null on error
  */
-const createInstance = async function(config: Config): Promise<Client | null> {
+const createInstance = function (config: Config): Client | null {
   try {
     // TODO warn about setting per instance errorHandler / logger / logLevel
     let isValidInstance = false;
@@ -108,7 +108,7 @@ const createInstance = async function(config: Config): Promise<Client | null> {
     }
 
     const { clientEngine, clientVersion } = config;
-    
+
     const cache = new BrowserAsyncStorageCache();
     const vuidManagerOptions: VuidManagerOptions = {
       enableVuid: config.vuidManagerOptions?.enableVuid || false,
@@ -132,8 +132,8 @@ const createInstance = async function(config: Config): Promise<Client | null> {
       notificationCenter,
       isValidInstance: isValidInstance,
       odpManager: odpExplicitlyOff ? undefined
-        :BrowserOdpManager.createInstance({ logger, odpOptions: config.odpOptions, clientEngine, clientVersion }),
-      vuidManager: await VuidManager.instance(cache, vuidManagerOptions),
+        : BrowserOdpManager.createInstance({ logger, odpOptions: config.odpOptions, clientEngine, clientVersion }),
+      vuidManager: new VuidManager(cache, vuidManagerOptions, logger),
     };
 
     // If client engine is react, convert it to react native.

lib/optimizely/index.ts

@@ -180,6 +180,7 @@ export default class Optimizely implements Client {
       projectConfigManagerReadyPromise,
       eventProcessorStartedPromise,
       config.odpManager ? config.odpManager.onReady() : Promise.resolve(),
+      this.vuidManager?.vuidEnabled ? this.vuidManager?.initialize() : Promise.resolve(),
     ]).then(promiseResults => {
       // Only return status from project config promise because event processor promise does not return any status.
       return promiseResults[0];
@@ -1413,8 +1414,8 @@ export default class Optimizely implements Client {
     };
 
     this.readyTimeouts[timeoutId] = {
-      readyTimeout: readyTimeout,
-      onClose: onClose,
+      readyTimeout,
+      onClose,
     };
 
     this.readyPromise.then(() => {
@@ -1423,13 +1424,12 @@ export default class Optimizely implements Client {
       resolveTimeoutPromise({
         success: true,
       });
+      this.vuidManager?.registerUser();
     });
 
     return Promise.race([this.readyPromise, timeoutPromise]);
   }
 
-  //============ decide ============//
-
   /**
    * Creates a context of the user for which decision APIs will be called.
    *
@@ -1445,6 +1445,7 @@ export default class Optimizely implements Client {
     const userIdentifier = userId ?? this.vuidManager?.vuid;
 
     if (userIdentifier === undefined || !this.validateInputs({ user_id: userIdentifier }, attributes)) {
+      this.logger.log(LOG_LEVEL.ERROR, '%s: Valid User ID or VUID not provided. User context not created.', MODULE_NAME);
       return null;
     }
 
@@ -1759,7 +1760,7 @@ export default class Optimizely implements Client {
    * @returns {string|undefined}    Currently provisioned VUID from local ODP Manager or undefined
    */
   public getVuid(): string | undefined {
-    if (!this.vuidManager?.isVuidEnabled()) {
+    if (!this.vuidManager?.vuidEnabled) {
       this.logger.log(LOG_LEVEL.WARNING, 'getVuid() unavailable for this platform or was not explicitly enabled.', MODULE_NAME);
       return undefined;
     }

lib/plugins/vuid_manager/index.ts

@@ -20,7 +20,21 @@ import { uuid } from '../../utils/fns';
 import PersistentKeyValueCache from '../key_value_cache/persistentKeyValueCache';
 
 export interface IVuidManager {
+  /**
+   * Current VUID value being used
+   * @returns Current VUID stored in the VuidManager
+   */
   readonly vuid: string | undefined;
+  /**
+   * Indicates whether the VUID use is enabled
+   * @returns *true* if the VUID use is enabled otherwise *false*
+   */
+  readonly vuidEnabled: boolean;
+  /**
+   * Initialize the VuidManager
+   * @returns Promise that resolves when the VuidManager is initialized
+   */
+  initialize(): Promise<void>;
 }
 
 /**
@@ -65,22 +79,28 @@ export class VuidManager implements IVuidManager {
   }
 
   /**
-   * The cache used to store the VUID
-   * @private
-   * @readonly
+   * Current state of the VUID use
+    * @private
+    */
+  private _vuidEnabled = false;
+
+  /**
+   * Indicates whether the VUID use is enabled
    */
-  private readonly cache: PersistentKeyValueCache;
+  get vuidEnabled(): boolean {
+    return this._vuidEnabled;
+  }
 
   /**
-   * The initalization options for the VuidManager
+   * The cache used to store the VUID
    * @private
    * @readonly
    */
-  private readonly options: VuidManagerOptions;
+  private readonly cache: PersistentKeyValueCache;
 
   constructor(cache: PersistentKeyValueCache, options: VuidManagerOptions, logger: LogHandler) {
     this.cache = cache;
-    this.options = options;
+    this._vuidEnabled = options.enableVuid;
     this.logger = logger;
   }
 
@@ -89,7 +109,7 @@ export class VuidManager implements IVuidManager {
    * @returns Promise that resolves when the VuidManager is initialized
    */
   async initialize(): Promise<void> {
-    if (!this.options.enableVuid) {
+    if (!this.vuidEnabled) {
       await this.cache.remove(this._keyForVuid);
     }
 
@@ -142,14 +162,6 @@ export class VuidManager implements IVuidManager {
     await cache.set(this._keyForVuid, vuid);
   }
 
-  /**
-   * Indicates whether the VUID use is enabled
-   * @returns *true* if enabled otherwise *false* for disabled
-   */
-  isVuidEnabled(): boolean {
-    return this.options.enableVuid || false;
-  }
-
   /**
    * Validates the format of a Visitor Unique Identifier (VUID)
    * @param vuid VistorId to check