[FSSDK-10711] Make use of VUID as an opt-in

jest.config.js

@@ -2,7 +2,7 @@ module.exports = {
   "transform": {
     "^.+\\.(ts|tsx|js|jsx)$": "ts-jest",
   },
-  "testRegex": "(/tests/.*|(\\.|/)(test|spec))\\.tsx?$",
+  "testRegex": "(/tests/.*|(\\.|/)(test|spec|tests))\\.tsx?$",
   moduleNameMapper: {
     // Force module uuid to resolve with the CJS entry point, because Jest does not support package.json.exports. See https://github.com/uuidjs/uuid/issues/451
     "uuid": require.resolve('uuid'),

lib/core/notification_center/notification_registry.tests.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright 2023, Optimizely
+ * Copyright 2023-2024, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,9 +14,7 @@
  * limitations under the License.
  */
 
-import { describe, it } from 'mocha';
 import { expect } from 'chai';
-
 import { NotificationRegistry } from './notification_registry';
 
 describe('Notification Registry', () => {

lib/core/odp/odp_manager.ts

@@ -14,8 +14,7 @@
  * limitations under the License.
  */
 
-import { LOG_MESSAGES } from './../../utils/enums/index';
-import { getLogger, LogHandler, LogLevel } from '../../modules/logging';
+import { LogHandler, LogLevel } from '../../modules/logging';
 import { ERROR_MESSAGES, ODP_USER_KEY } from '../../utils/enums';
 
 import { VuidManager } from '../../plugins/vuid_manager';
@@ -46,8 +45,13 @@ export interface IOdpManager {
   identifyUser(userId?: string, vuid?: string): void;
 
   sendEvent({ type, action, identifiers, data }: OdpEvent): void;
+
+  registerVuid(vuid: string): void;
 }
 
+/**
+ * Possible statuses for the OdpManager
+ */
 export enum Status {
   Running,
   Stopped,
@@ -68,32 +72,40 @@ export abstract class OdpManager implements IOdpManager {
    */
   private configPromise: ResolvablePromise<void>;
 
-  status: Status = Status.Stopped;
+  /**
+   * The current status of the ODP Manager
+   */
+  private status: Status = Status.Stopped;
 
   /**
    * ODP Segment Manager which provides an interface to the remote ODP server (GraphQL API) for audience segments mapping.
    * It fetches all qualified segments for the given user context and manages the segments cache for all user contexts.
+   * @private
+   * @readonly
    */
-  private segmentManager: IOdpSegmentManager;
+  private readonly segmentManager: IOdpSegmentManager;
 
   /**
    * 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.
+   * @protected
+   * @readonly
    */
-  private eventManager: IOdpEventManager;
+  protected readonly eventManager: IOdpEventManager;
 
   /**
    * Handler for recording execution logs
    * @protected
+   * @readonly
    */
-  protected logger: LogHandler;
+  protected readonly logger: LogHandler;
 
   /**
    * ODP configuration settings for identifying the target API and segments
+   * @protected
    */
-  odpIntegrationConfig?: OdpIntegrationConfig;
+  protected odpIntegrationConfig?: OdpIntegrationConfig;
 
-  // TODO: Consider accepting logger as a parameter and initializing it in constructor instead
   constructor({
     odpIntegrationConfig,
     segmentManager,
@@ -123,10 +135,23 @@ export abstract class OdpManager implements IOdpManager {
     }
   }
 
-  public getStatus(): Status {
+  /**
+   * 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;
+
+  /**
+   * @returns {Status} The current status of the ODP Manager
+   */
+  getStatus(): Status {
     return this.status;
   }
 
+  /**
+   * Starts the ODP Manager
+   * @returns {Promise<void>} A promise that resolves when starting has completed
+   */
   async start(): Promise<void> {
     if (this.status === Status.Running) {
       return;
@@ -147,6 +172,10 @@ export abstract class OdpManager implements IOdpManager {
     return Promise.resolve();
   }
 
+  /**
+   * Stops the ODP Manager
+   * @returns A promise that resolves when stopping has completed
+   */
   async stop(): Promise<void> {
     if (this.status === Status.Stopped) {
       return;
@@ -218,7 +247,7 @@ export abstract class OdpManager implements IOdpManager {
   /**
    * Identifies a user via the ODP Event Manager
    * @param {string}  userId    (Optional) Custom unique identifier of a target user.
-   * @param {string}  vuid      (Optional) Secondary unique identifier of a target user, primarily used by client SDKs.
+   * @param {string}  vuid      (Optional) Secondary unique identifier of a target user, used by client SDKs.
    * @returns
    */
   identifyUser(userId?: string, vuid?: string): void {

lib/index.browser.tests.js

@@ -654,38 +654,6 @@ describe('javascript-sdk (Browser)', function() {
         sinon.assert.calledWith(logger.log, optimizelyFactory.enums.LOG_LEVEL.INFO, LOG_MESSAGES.ODP_DISABLED);
       });
 
-      it('should include the VUID instantation promise of Browser ODP Manager in the Optimizely client onReady promise dependency array', () => {
-        const client = optimizelyFactory.createInstance({
-          datafile: testData.getTestProjectConfigWithFeatures(),
-          errorHandler: fakeErrorHandler,
-          eventDispatcher: fakeEventDispatcher,
-          eventBatchSize: null,
-          logger,
-          odpManager: BrowserOdpManager.createInstance({
-            logger,
-          }),
-        });
-
-        client
-          .onReady()
-          .then(() => {
-            assert.isDefined(client.odpManager.initPromise);
-            client.odpManager.initPromise
-              .then(() => {
-                assert.isTrue(true);
-              })
-              .catch(() => {
-                assert.isTrue(false);
-              });
-            assert.isDefined(client.odpManager.getVuid());
-          })
-          .catch(() => {
-            assert.isTrue(false);
-          });
-
-        sinon.assert.neverCalledWith(logger.log, optimizelyFactory.enums.LOG_LEVEL.ERROR);
-      });
-
       it('should accept a valid custom cache size', () => {
         const client = optimizelyFactory.createInstance({
           datafile: testData.getTestProjectConfigWithFeatures(),

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

@@ -28,8 +28,8 @@ import { OptimizelyDecideOption, Client, Config, VuidManagerOptions } from './sh
 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 ReactNativeAsyncStorageCache from './plugins/key_value_cache/reactNativeAsyncStorageCache';
 import 'fast-text-encoding';
 import 'react-native-get-random-values';
 
@@ -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,8 +108,8 @@ const createInstance = async function(config: Config): Promise<Client | null> {
     }
 
     const { clientEngine, clientVersion } = config;
-    
-    const cache = new BrowserAsyncStorageCache();
+
+    const cache = new ReactNativeAsyncStorageCache();
     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(),
+      config.vuidManager?.vuidEnabled ? config.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,15 @@ export default class Optimizely implements Client {
       resolveTimeoutPromise({
         success: true,
       });
+      const vuid = this.vuidManager?.vuid;
+      if (vuid) {
+        this.odpManager?.registerVuid(vuid);
+      }
     });
 
     return Promise.race([this.readyPromise, timeoutPromise]);
   }
 
-  //============ decide ============//
-
   /**
    * Creates a context of the user for which decision APIs will be called.
    *
@@ -1445,6 +1448,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,11 +1763,10 @@ 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;
     }
 
-    return this.vuidManager.vuid;
+    return this.vuidManager?.vuid;
   }
 }

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';
 
@@ -148,4 +149,22 @@ export class BrowserOdpManager extends OdpManager {
 
     super.identifyUser(fsUserId, vuid);
   }
+
+  registerVuid(vuid: string): 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;
+    }
+
+    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

@@ -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 } from '../../modules/logging';
+import { getLogger, LogHandler, LogLevel } from '../../modules/logging';
 import {
   NODE_CLIENT_ENGINE,
   CLIENT_VERSION,
@@ -64,7 +64,7 @@ export class NodeOdpManager extends OdpManager {
     clientEngine = clientEngine || NODE_CLIENT_ENGINE;
     clientVersion = clientVersion || CLIENT_VERSION;
 
-    let odpConfig : OdpConfig | undefined = undefined;
+    let odpConfig: OdpConfig | undefined = undefined;
     if (odpIntegrationConfig?.integrated) {
       odpConfig = odpIntegrationConfig.odpConfig;
     }
@@ -87,10 +87,10 @@ export class NodeOdpManager extends OdpManager {
     } else {
       segmentManager = new OdpSegmentManager(
         odpOptions?.segmentsCache ||
-          new ServerLRUCache<string, string[]>({
-            maxSize: odpOptions?.segmentsCacheSize,
-            timeout: odpOptions?.segmentsCacheTimeout,
-          }),
+        new ServerLRUCache<string, string[]>({
+          maxSize: odpOptions?.segmentsCacheSize,
+          timeout: odpOptions?.segmentsCacheTimeout,
+        }),
         new OdpSegmentApiManager(customSegmentRequestHandler, logger),
         logger,
         odpConfig
@@ -133,4 +133,8 @@ export class NodeOdpManager extends OdpManager {
       logger,
     });
   }
+
+  registerVuid(vuid: string): void {
+    this.logger.log(LogLevel.ERROR, `Unable to registerVuid ${vuid} in a node server context`);
+  }
 }