fix: PR requested updates

Author: mikechu-optimizely

lib/core/odp/odp_manager.ts

@@ -27,7 +27,7 @@ import { OptimizelySegmentOption } from './optimizely_segment_option';
 import { invalidOdpDataFound } from './odp_utils';
 import { OdpEvent } from './odp_event';
 import { resolvablePromise, ResolvablePromise } from '../../utils/promise/resolvablePromise';
-import { OdpOptions } from '../../shared_types';
+import { VuidManagerOptions } from '../../shared_types';
 
 /**
  * Manager for handling internal all business logic related to
@@ -99,28 +99,28 @@ export abstract class OdpManager implements IOdpManager {
   odpIntegrationConfig?: OdpIntegrationConfig;
 
   /**
-   * ODP initialization options
+   * Options for handling VUID Manager
    */
-  protected odpOptions?: OdpOptions;
+  protected vuidManagerOptions?: VuidManagerOptions;
 
   // TODO: Consider accepting logger as a parameter and initializing it in constructor instead
   constructor({
     odpIntegrationConfig,
     segmentManager,
     eventManager,
     logger,
-    odpOptions,
+    vuidManagerOptions,
   }: {
     odpIntegrationConfig?: OdpIntegrationConfig;
     segmentManager: IOdpSegmentManager;
     eventManager: IOdpEventManager;
     logger: LogHandler;
-    odpOptions?: OdpOptions;
+    vuidManagerOptions?: VuidManagerOptions;
   }) {
     this.segmentManager = segmentManager;
     this.eventManager = eventManager;
     this.logger = logger;
-    this.odpOptions = odpOptions;
+    this.vuidManagerOptions = vuidManagerOptions;
     this.configPromise = resolvablePromise();
 
     const readinessDependencies: PromiseLike<unknown>[] = [this.configPromise];

lib/plugins/odp_manager/index.browser.ts

@@ -33,7 +33,7 @@ import { VuidManager } from './../vuid_manager/index';
 
 import { OdpManager } from '../../core/odp/odp_manager';
 import { OdpEvent } from '../../core/odp/odp_event';
-import { IOdpEventManager, OdpOptions } from '../../shared_types';
+import { IOdpEventManager, OdpOptions, VuidManagerOptions } 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,25 +46,26 @@ 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 = "";
+  vuid?: string;
 
   constructor(options: {
     odpIntegrationConfig?: OdpIntegrationConfig;
     segmentManager: IOdpSegmentManager;
     eventManager: IOdpEventManager;
     logger: LogHandler;
-    odpOptions?: OdpOptions;
+    vuidManagerOptions?: VuidManagerOptions;
   }) {
     super(options);
   }
 
   static createInstance({
-    logger, odpOptions, odpIntegrationConfig, clientEngine, clientVersion
+    logger, odpOptions, odpIntegrationConfig, clientEngine, clientVersion, vuidManagerOptions,
   }: BrowserOdpManagerConfig): BrowserOdpManager {
     logger = logger || getLogger();
 
@@ -134,7 +135,7 @@ export class BrowserOdpManager extends OdpManager {
       segmentManager,
       eventManager,
       logger,
-      odpOptions,
+      vuidManagerOptions,
     });
   }
 
@@ -143,7 +144,7 @@ export class BrowserOdpManager extends OdpManager {
    * accesses or creates new VUID from Browser cache
    */
   protected async initializeVuid(): Promise<void> {
-    const vuidManager = await VuidManager.instance(BrowserOdpManager.cache, this.odpOptions);
+    const vuidManager = await VuidManager.instance(BrowserOdpManager.cache, this.vuidManagerOptions);
     this.vuid = vuidManager.vuid;
   }
 
@@ -189,7 +190,7 @@ export class BrowserOdpManager extends OdpManager {
   }
 
   isVuidEnabled(): boolean {
-    return this.odpOptions?.enableVuid || false;
+    return this.vuidManagerOptions?.enableVuid || false;
   }
 
   getVuid(): string | undefined {

lib/plugins/vuid_manager/index.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { OdpOptions } from '../../shared_types';
+import { VuidManagerOptions } from '../../shared_types';
 import { uuid } from '../../utils/fns';
 import PersistentKeyValueCache from '../key_value_cache/persistentKeyValueCache';
 
@@ -44,7 +44,7 @@ export class VuidManager implements IVuidManager {
    * Current VUID value being used
    * @private
    */
-  private _vuid = '';
+  private _vuid: string;
 
   /**
    * Get the current VUID value being used
@@ -53,7 +53,9 @@ export class VuidManager implements IVuidManager {
     return this._vuid;
   }
 
-  private constructor() { }
+  private constructor() {
+    this._vuid = '';
+  }
 
   /**
    * Instance of the VUID Manager
@@ -63,10 +65,11 @@ export class VuidManager implements IVuidManager {
 
   /**
    * Gets the current instance of the VUID Manager, initializing if needed
-   * @param cache Caching mechanism to use for persisting the VUID outside working memory   *
+   * @param cache Caching mechanism to use for persisting the VUID outside working memory
+   * @param options Options for the VUID Manager
    * @returns An instance of VuidManager
    */
-  static async instance(cache: PersistentKeyValueCache, options?: OdpOptions): Promise<VuidManager> {
+  static async instance(cache: PersistentKeyValueCache, options?: VuidManagerOptions): Promise<VuidManager> {
     if (!this._instance) {
       this._instance = new VuidManager();
     }

lib/shared_types.ts

@@ -96,7 +96,6 @@ export interface DatafileOptions {
 
 export interface OdpOptions {
   disabled?: boolean;
-  enableVuid?: boolean;
   segmentsCache?: ICache<string, string[]>;
   segmentsCacheSize?: number;
   segmentsCacheTimeout?: number;
@@ -112,6 +111,10 @@ export interface OdpOptions {
   userAgentParser?: IUserAgentParser;
 }
 
+export type VuidManagerOptions = {
+  enableVuid: boolean;
+}
+
 export interface ListenerPayload {
   userId: string;
   attributes?: UserAttributes;

tests/odpManager.browser.spec.ts

@@ -107,28 +107,26 @@ describe('OdpManager', () => {
     resetCalls(mockSegmentManager);
   });
 
-  it('should have an empty string for VUID on BrowserOdpManager initialization', async () => {
+  it('should have undefined VUID on BrowserOdpManager initialization', async () => {
     const browserOdpManager = BrowserOdpManager.createInstance({
       odpOptions: {
         eventManager: fakeEventManager,
         segmentManager: fakeSegmentManager,
-        // enableVuid: false, // Note: VUID is not explicitly enabled
-      },
+      }
     });
 
-    const vuidManager = await VuidManager.instance(BrowserOdpManager.cache);
-
-    expect(vuidManager.vuid).toBe("");
-    expect(browserOdpManager.vuid).toBe("")
+    expect(browserOdpManager.vuid).toBeUndefined();
   });
 
   it('should create VUID automatically on BrowserOdpManager initialization if VUID is explicitly enabled', async () => {
     const browserOdpManager = BrowserOdpManager.createInstance({
       odpOptions: {
         eventManager: fakeEventManager,
         segmentManager: fakeSegmentManager,
-        enableVuid: true,
       },
+      vuidManagerOptions: {
+        enableVuid: true,
+      }
     });
 
     const vuidManager = await VuidManager.instance(BrowserOdpManager.cache, {enableVuid: true});