refactor: handle registerVuid

Author: mikechu-optimizely

lib/core/odp/odp_manager.ts

@@ -46,7 +46,7 @@ export interface IOdpManager {
 
   sendEvent({ type, action, identifiers, data }: OdpEvent): void;
 
-  registerVuid(vuid: string): void;
+  registerVuid(vuid: string | undefined): void;
 }
 
 /**
@@ -87,7 +87,7 @@ export abstract class OdpManager implements IOdpManager {
    * ODP Event Manager which provides an interface to the remote ODP server (REST API) for events.
    * It will queue all pending events (persistent) and send them (in batches of up to 10 events) to the ODP server when possible.
    */
-  private eventManager: IOdpEventManager;
+  protected readonly eventManager: IOdpEventManager;
 
   /**
    * Handler for recording execution logs
@@ -133,7 +133,7 @@ export abstract class OdpManager implements IOdpManager {
    * Register a VUID with the ODP Manager in client side context
    * @param {string} vuid - Unique identifier of an anonymous vistor
    */
-  abstract registerVuid(vuid: string): void;
+  abstract registerVuid(vuid: string | undefined): void;
 
   /**
    * @returns {Status} The current status of the ODP Manager

lib/optimizely/index.ts

@@ -1424,7 +1424,7 @@ export default class Optimizely implements Client {
       resolveTimeoutPromise({
         success: true,
       });
-      this.vuidManager?.registerUser();
+      this.odpManager?.registerVuid(this.vuidManager?.vuid)
     });
 
     return Promise.race([this.readyPromise, timeoutPromise]);

lib/plugins/odp_manager/index.browser.ts

@@ -19,8 +19,9 @@ import {
   JAVASCRIPT_CLIENT_ENGINE,
   REQUEST_TIMEOUT_ODP_SEGMENTS_MS,
   REQUEST_TIMEOUT_ODP_EVENTS_MS,
+  ERROR_MESSAGES,
 } from '../../utils/enums';
-import { getLogger, LogHandler } from '../../modules/logging';
+import { getLogger, LogHandler, LogLevel } from '../../modules/logging';
 
 import { BrowserRequestHandler } from './../../utils/http_request_handler/browser_request_handler';
 
@@ -46,9 +47,6 @@ interface BrowserOdpManagerConfig {
 
 // Client-side Browser Plugin for ODP Manager
 export class BrowserOdpManager extends OdpManager {
-  registerVuid(vuid: string): void {
-    throw new Error('Method not implemented.');
-  }
   constructor(options: {
     odpIntegrationConfig?: OdpIntegrationConfig;
     segmentManager: IOdpSegmentManager;
@@ -151,4 +149,27 @@ export class BrowserOdpManager extends OdpManager {
 
     super.identifyUser(fsUserId, vuid);
   }
+
+  registerVuid(vuid: string | undefined): void {
+    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;
+    }
+
+    if (!vuid || !VuidManager.isVuid(vuid)) {
+      this.logger.log(LogLevel.ERROR, `The provided VUID ${vuid} is invalid.`);
+      return;
+    }
+
+    try {
+      this.eventManager.registerVuid(vuid);
+    } catch (e) {
+      this.logger.log(LogLevel.ERROR, ERROR_MESSAGES.ODP_VUID_REGISTRATION_FAILED);
+    }
+  }
 }

lib/plugins/odp_manager/index.node.ts

@@ -134,7 +134,7 @@ export class NodeOdpManager extends OdpManager {
     });
   }
 
-  registerVuid(vuid: string): void {
+  registerVuid(vuid: string | undefined): void {
     this.logger.log(LogLevel.ERROR, `Unable to registerVuid ${vuid || ''} in a node server context`);
   }
 }

lib/plugins/vuid_manager/index.ts

@@ -167,7 +167,7 @@ export class VuidManager implements IVuidManager {
    * @param vuid VistorId to check
    * @returns *true* if the VisitorId is valid otherwise *false* for invalid
    */
-  static isVuid = (vuid: string): boolean => vuid?.startsWith(VuidManager.vuid_prefix) || false;
+  static isVuid = (vuid: string | undefined): boolean => vuid?.startsWith(VuidManager.vuid_prefix) || false;
 
   /**
    * Function used in unit testing to reset the VuidManager