[FSSDK-9032] enhancement: Add VUID instantiation to browser client promise dependencies (#825)

Author: opti-jnguyen

packages/optimizely-sdk/lib/optimizely/index.ts

@@ -15,7 +15,7 @@
  ***************************************************************************/
 
 import { LoggerFacade, ErrorHandler } from '../modules/logging';
-import { sprintf, objectValues } from '../utils/fns';
+import { sprintf, objectValues, isBrowser } from '../utils/fns';
 import { NotificationCenter } from '../core/notification_center';
 import { EventProcessor } from '../modules/event_processor';
 
@@ -69,6 +69,8 @@ import {
   ODP_USER_KEY,
 } from '../utils/enums';
 
+import { BrowserOdpManager } from '../../lib/plugins/odp_manager/index.browser';
+
 const MODULE_NAME = 'OPTIMIZELY';
 
 const DEFAULT_ONREADY_TIMEOUT = 30000;
@@ -175,24 +177,20 @@ export default class Optimizely implements Client {
 
     const eventProcessorStartedPromise = this.eventProcessor.start();
 
-    // TODO: Look into making VUID Initialization a dependent promise for Browser Contexts
-
-    // let dependentPromises: Promise<any>[] = [projectConfigManagerReadyPromise];
-
-    // if (isBrowserContext()) {
-    //   const odpManagerVuidInitializedPromise = (config.odpManager as BrowserOdpManager).initPromise;
-    //   if (odpManagerVuidInitializedPromise) {
-    //     dependentPromises.push(odpManagerVuidInitializedPromise);
-    //   }
-    // }
-
-    // this.readyPromise = Promise.all(dependentPromises).then(promiseResults => {
-
-    this.readyPromise = Promise.all([
+    const dependentPromises: Array<Promise<any> | void> = [
       projectConfigManagerReadyPromise,
       eventProcessorStartedPromise,
-      // config.odpManager.initPromise,
-    ]).then(promiseResults => {
+    ];
+
+    // Adds VUID initialization promise as a dependency for Browser...
+    if (isBrowser()) {
+      const odpManagerVuidInitializedPromise = (config.odpManager as BrowserOdpManager).initPromise;
+      if (odpManagerVuidInitializedPromise) {
+        dependentPromises.push(odpManagerVuidInitializedPromise);
+      }
+    }
+
+    this.readyPromise = Promise.all(dependentPromises).then(promiseResults => {
       if (config.odpManager != null) {
         this.odpManager = config.odpManager;
         this.odpManager.eventManager?.start();

packages/optimizely-sdk/lib/plugins/odp/event_api_manager/index.browser.ts

@@ -1,6 +1,6 @@
-import { OdpEvent } from "../../../core/odp/odp_event";
-import { OdpEventApiManager } from "../../../core/odp/odp_event_api_manager";
-import { LogHandler, LogLevel } from '../../../modules/logging';
+import { OdpEvent } from '../../../core/odp/odp_event';
+import { OdpEventApiManager } from '../../../core/odp/odp_event_api_manager';
+import { LogLevel } from '../../../modules/logging';
 import { ODP_EVENT_BROWSER_ENDPOINT } from '../../../utils/enums';
 
 const EVENT_SENDING_FAILURE_MESSAGE = 'ODP event send failed';
@@ -14,15 +14,19 @@ export class BrowserOdpEventApiManager extends OdpEventApiManager {
     return false;
   }
 
-  protected generateRequestData(apiHost: string, apiKey: string, events: OdpEvent[]): { method: string; endpoint: string; headers: { [key: string]: string; }; data: string; } {
-    const method = 'GET'; 
+  protected generateRequestData(
+    apiHost: string,
+    apiKey: string,
+    events: OdpEvent[]
+  ): { method: string; endpoint: string; headers: { [key: string]: string }; data: string } {
+    const method = 'GET';
     const event = events[0];
     const url = new URL(ODP_EVENT_BROWSER_ENDPOINT);
-    event.identifiers.forEach((v, k) =>{
-        url.searchParams.append(k, v);
+    event.identifiers.forEach((v, k) => {
+      url.searchParams.append(k, v);
     });
-    event.data.forEach((v, k) =>{
-        url.searchParams.append(k, v as string);
+    event.data.forEach((v, k) => {
+      url.searchParams.append(k, v as string);
     });
     url.searchParams.append('tracker_id', apiKey);
     url.searchParams.append('event_type', event.type);
@@ -32,7 +36,7 @@ export class BrowserOdpEventApiManager extends OdpEventApiManager {
       method,
       endpoint,
       headers: {},
-      data: "",
+      data: '',
     };
   }
-}
+}

packages/optimizely-sdk/lib/plugins/odp/event_api_manager/index.node.ts

@@ -1,21 +1,25 @@
-import { OdpEvent } from "../../../core/odp/odp_event";
-import { OdpEventApiManager } from "../../../core/odp/odp_event_api_manager";
+import { OdpEvent } from '../../../core/odp/odp_event';
+import { OdpEventApiManager } from '../../../core/odp/odp_event_api_manager';
 
 export class NodeOdpEventApiManager extends OdpEventApiManager {
   protected shouldSendEvents(events: OdpEvent[]): boolean {
     return true;
   }
 
-  protected generateRequestData(apiHost: string, apiKey: string, events: OdpEvent[]): { method: string; endpoint: string; headers: { [key: string]: string; }; data: string; } {
+  protected generateRequestData(
+    apiHost: string,
+    apiKey: string,
+    events: OdpEvent[]
+  ): { method: string; endpoint: string; headers: { [key: string]: string }; data: string } {
     return {
       method: 'POST',
       endpoint: `${apiHost}/v3/events`,
       headers: {
-      'Content-Type': 'application/json',
-      'x-api-key': apiKey,
+        'Content-Type': 'application/json',
+        'x-api-key': apiKey,
       },
       data: JSON.stringify(events, this.replacer),
-    }
+    };
   }
 
   private replacer(_: unknown, value: unknown) {
@@ -25,4 +29,4 @@ export class NodeOdpEventApiManager extends OdpEventApiManager {
       return value;
     }
   }
-}
+}

packages/optimizely-sdk/lib/utils/fns/index.ts

@@ -51,7 +51,7 @@ function isSafeInteger(number: unknown): boolean {
 
 export function keyBy<K>(arr: K[], key: string): { [key: string]: K } {
   if (!arr) return {};
-  return keyByUtil(arr, function (item) {
+  return keyByUtil(arr, function(item) {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     return (item as any)[key];
   });
@@ -62,84 +62,84 @@ function isNumber(value: unknown): boolean {
 }
 
 export function uuid(): string {
-  return v4()
+  return v4();
 }
 
-export type Omit<T, K> = Pick<T, Exclude<keyof T, K>>
+export type Omit<T, K> = Pick<T, Exclude<keyof T, K>>;
 
 export function getTimestamp(): number {
-  return new Date().getTime()
+  return new Date().getTime();
 }
 
 /**
-* Validates a value is a valid TypeScript enum
-*
-* @export
-* @param {object} enumToCheck
-* @param {*} value
-* @returns {boolean}
-*/
+ * Validates a value is a valid TypeScript enum
+ *
+ * @export
+ * @param {object} enumToCheck
+ * @param {*} value
+ * @returns {boolean}
+ */
 // TODO[OASIS-6649]: Don't use any type
 // eslint-disable-next-line  @typescript-eslint/no-explicit-any
 export function isValidEnum(enumToCheck: { [key: string]: any }, value: number | string): boolean {
-  let found = false
+  let found = false;
 
-  const keys = Object.keys(enumToCheck)
+  const keys = Object.keys(enumToCheck);
   for (let index = 0; index < keys.length; index++) {
     if (value === enumToCheck[keys[index]]) {
-      found = true
-      break
+      found = true;
+      break;
     }
   }
-  return found
+  return found;
 }
 
 export function groupBy<K>(arr: K[], grouperFn: (item: K) => string): Array<K[]> {
-  const grouper: { [key: string]: K[] } = {}
+  const grouper: { [key: string]: K[] } = {};
 
   arr.forEach(item => {
-    const key = grouperFn(item)
-    grouper[key] = grouper[key] || []
-    grouper[key].push(item)
-  })
+    const key = grouperFn(item);
+    grouper[key] = grouper[key] || [];
+    grouper[key].push(item);
+  });
 
-  return objectValues(grouper)
+  return objectValues(grouper);
 }
 
 export function objectValues<K>(obj: { [key: string]: K }): K[] {
-  return Object.keys(obj).map(key => obj[key])
+  return Object.keys(obj).map(key => obj[key]);
 }
 
 export function objectEntries<K>(obj: { [key: string]: K }): [string, K][] {
-  return Object.keys(obj).map(key => [key, obj[key]])
+  return Object.keys(obj).map(key => [key, obj[key]]);
 }
 
 export function find<K>(arr: K[], cond: (arg: K) => boolean): K | undefined {
-  let found
+  let found;
 
   for (const item of arr) {
     if (cond(item)) {
-      found = item
-      break
+      found = item;
+      break;
     }
   }
 
-  return found
+  return found;
 }
 
 export function keyByUtil<K>(arr: K[], keyByFn: (item: K) => string): { [key: string]: K } {
-  const map: { [key: string]: K } = {}
+  const map: { [key: string]: K } = {};
   arr.forEach(item => {
-    const key = keyByFn(item)
-    map[key] = item
-  })
-  return map
+    const key = keyByFn(item);
+    map[key] = item;
+  });
+  return map;
 }
 
 // TODO[OASIS-6649]: Don't use any type
 // eslint-disable-next-line  @typescript-eslint/no-explicit-any
 export function sprintf(format: string, ...args: any[]): string {
-  let i = 0
+  let i = 0;
   return format.replace(/%s/g, function() {
     const arg = args[i++];
     const type = typeof arg;
@@ -150,11 +150,9 @@ export function sprintf(format: string, ...args: any[]): string {
     } else {
       return String(arg);
     }
-  })
+  });
 }
 
-
-
 /**
  * Checks two string arrays for equality.
  * @param arrayA First Array to be compared against.
@@ -165,6 +163,18 @@ export function checkArrayEquality(arrayA: string[], arrayB: string[]): boolean
   return arrayA.length === arrayB.length && arrayA.every((item, index) => item === arrayB[index]);
 }
 
+/**
+ * Checks the current running context
+ * @returns {boolean} True if window object exists.
+ */
+export function isBrowser(): boolean {
+  if (typeof window === 'object' && typeof process !== 'object' && typeof require !== 'function') {
+    return true;
+  }
+
+  return false;
+}
+
 export default {
   assign,
   checkArrayEquality,
@@ -181,4 +191,5 @@ export default {
   find,
   keyByUtil,
   sprintf,
+  isBrowser,
 };