[FSSDK-10198] making isOdpIntegrated public (#930)

junaed-optimizely · mikechu-optimizely · web-flow · commit 01b50a2c50da · 2024-05-20T22:06:53.000+06:00
* odp not integrated log level change from error to info

* odp not integrated log level back to prev state, except identifyUser

* making isOdpIntegrated public

* Adding JSDoc to newly exposed isODPIntegrated method

* registerVuid method ODP integration log change from error to info

* Update lib/optimizely/index.ts

Co-authored-by: Mike Chu &lt;104384559+mikechu-optimizely@users.noreply.github.com&gt;

---------

Co-authored-by: Mike Chu &lt;104384559+mikechu-optimizely@users.noreply.github.com&gt;
diff --git a/lib/core/odp/odp_manager.ts b/lib/core/odp/odp_manager.ts
@@ -65,7 +65,6 @@ export abstract class OdpManager implements IOdpManager {
    * Promise that returns when the OdpManager is finished initializing
    */
   private initPromise: Promise<unknown>;
-  
   private ready = false;
 
   /**
@@ -126,7 +125,7 @@ export abstract class OdpManager implements IOdpManager {
 
     this.onReady().then(() => {
       this.ready = true;
-      if(this.isVuidEnabled() && this.status === Status.Running) {
+      if (this.isVuidEnabled() && this.status === Status.Running) {
         this.registerVuid();
       }
     });
@@ -146,7 +145,7 @@ export abstract class OdpManager implements IOdpManager {
     }
 
     if (!this.odpIntegrationConfig) {
-      return Promise.reject(new Error('cannot start without ODP config'));      
+      return Promise.reject(new Error('cannot start without ODP config'));
     }
 
     if (!this.odpIntegrationConfig.integrated) {
@@ -211,21 +210,21 @@ export abstract class OdpManager implements IOdpManager {
    * @returns {Promise<string[] | null>}      A promise holding either a list of qualified segments or null.
    */
   async fetchQualifiedSegments(userId: string, options: Array<OptimizelySegmentOption> = []): Promise<string[] | null> {
-     if (!this.odpIntegrationConfig) {
-       this.logger.log(LogLevel.ERROR, ERROR_MESSAGES.ODP_CONFIG_NOT_AVAILABLE);
+    if (!this.odpIntegrationConfig) {
+      this.logger.log(LogLevel.ERROR, ERROR_MESSAGES.ODP_CONFIG_NOT_AVAILABLE);
       return null;
     }
 
     if (!this.odpIntegrationConfig.integrated) {
-       this.logger.log(LogLevel.ERROR, ERROR_MESSAGES.ODP_NOT_INTEGRATED);
+      this.logger.log(LogLevel.ERROR, ERROR_MESSAGES.ODP_NOT_INTEGRATED);
       return null;
     }
 
     if (VuidManager.isVuid(userId)) {
       return this.segmentManager.fetchQualifiedSegments(ODP_USER_KEY.VUID, userId, options);
     }
 
-    return this.segmentManager.fetchQualifiedSegments(ODP_USER_KEY.FS_USER_ID, userId, options);   
+    return this.segmentManager.fetchQualifiedSegments(ODP_USER_KEY.FS_USER_ID, userId, options);
   }
 
   /**
@@ -241,7 +240,7 @@ export abstract class OdpManager implements IOdpManager {
     }
 
     if (!this.odpIntegrationConfig.integrated) {
-      this.logger.log(LogLevel.ERROR, ERROR_MESSAGES.ODP_NOT_INTEGRATED);
+      this.logger.log(LogLevel.INFO, ERROR_MESSAGES.ODP_NOT_INTEGRATED);
       return;
     }
 
@@ -306,7 +305,7 @@ export abstract class OdpManager implements IOdpManager {
     }
 
     if (!this.odpIntegrationConfig.integrated) {
-      this.logger.log(LogLevel.ERROR, ERROR_MESSAGES.ODP_NOT_INTEGRATED);
+      this.logger.log(LogLevel.INFO, ERROR_MESSAGES.ODP_NOT_INTEGRATED);
       return;
     }
 
diff --git a/lib/optimizely/index.ts b/lib/optimizely/index.ts
@@ -188,9 +188,8 @@ export default class Optimizely implements Client {
     this.nextReadyTimeoutId = 0;
   }
 
-
   /**
-   * Returns the project configuration retrieved from projectConfigManager 
+   * Returns the project configuration retrieved from projectConfigManager
    * @return {projectConfig.ProjectConfig}
    */
   getProjectConfig(): projectConfig.ProjectConfig | null {
@@ -1444,10 +1443,7 @@ export default class Optimizely implements Client {
   createUserContext(userId?: string, attributes?: UserAttributes): OptimizelyUserContext | null {
     const userIdentifier = userId ?? this.odpManager?.getVuid();
 
-    if (
-      userIdentifier === undefined ||
-      !this.validateInputs({ user_id: userIdentifier }, attributes)
-    ) {
+    if (userIdentifier === undefined || !this.validateInputs({ user_id: userIdentifier }, attributes)) {
       return null;
     }
 
@@ -1671,7 +1667,7 @@ export default class Optimizely implements Client {
     }
 
     if (this.odpManager) {
-      this.odpManager.updateSettings(projectConfig.odpIntegrationConfig)
+      this.odpManager.updateSettings(projectConfig.odpIntegrationConfig);
     }
   }
 
@@ -1722,8 +1718,11 @@ export default class Optimizely implements Client {
       this.logger.error(ERROR_MESSAGES.ODP_EVENT_FAILED, e);
     }
   }
-
-  private isOdpIntegrated(): boolean {
+  /**
+   * Checks if ODP (Optimizely Data Platform) is integrated into the project.
+   * @returns { boolean } `true` if ODP settings were found in the datafile otherwise `false`
+   */
+  public isOdpIntegrated(): boolean {
     return this.projectConfigManager.getConfig()?.odpIntegrationConfig?.integrated ?? false;
   }
 
@@ -1751,7 +1750,7 @@ export default class Optimizely implements Client {
     if (!this.odpManager) {
       return null;
     }
-  
+
     return await this.odpManager.fetchQualifiedSegments(userId, options);
   }
 
diff --git a/lib/shared_types.ts b/lib/shared_types.ts
@@ -335,7 +335,12 @@ export interface Client {
   getForcedVariation(experimentKey: string, userId: string): string | null;
   isFeatureEnabled(featureKey: string, userId: string, attributes?: UserAttributes): boolean;
   getEnabledFeatures(userId: string, attributes?: UserAttributes): string[];
-  getFeatureVariable(featureKey: string, variableKey: string, userId: string, attributes?: UserAttributes): FeatureVariableValue;
+  getFeatureVariable(
+    featureKey: string,
+    variableKey: string,
+    userId: string,
+    attributes?: UserAttributes
+  ): FeatureVariableValue;
   getFeatureVariableBoolean(
     featureKey: string,
     variableKey: string,
@@ -371,6 +376,7 @@ export interface Client {
   close(): Promise<{ success: boolean; reason?: string }>;
   sendOdpEvent(action: string, type?: string, identifiers?: Map<string, string>, data?: Map<string, unknown>): void;
   getProjectConfig(): ProjectConfig | null;
+  isOdpIntegrated(): boolean;
 }
 
 export interface ActivateListenerPayload extends ListenerPayload {

Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,6 @@ export abstract class OdpManager implements IOdpManager {`
`65`	`65`	`* Promise that returns when the OdpManager is finished initializing`
`66`	`66`	`*/`
`67`	`67`	`private initPromise: Promise<unknown>;`
`68`		`-`
`69`	`68`	`private ready = false;`
`70`	`69`
`71`	`70`	`/**`
`@@ -126,7 +125,7 @@ export abstract class OdpManager implements IOdpManager {`
`126`	`125`
`127`	`126`	`this.onReady().then(() => {`
`128`	`127`	`this.ready = true;`
`129`		`- if(this.isVuidEnabled() && this.status === Status.Running) {`
	`128`	`+ if (this.isVuidEnabled() && this.status === Status.Running) {`
`130`	`129`	`this.registerVuid();`
`131`	`130`	`}`
`132`	`131`	`});`
`@@ -146,7 +145,7 @@ export abstract class OdpManager implements IOdpManager {`
`146`	`145`	`}`
`147`	`146`
`148`	`147`	`if (!this.odpIntegrationConfig) {`
`149`		`- return Promise.reject(new Error('cannot start without ODP config'));`
	`148`	`+ return Promise.reject(new Error('cannot start without ODP config'));`
`150`	`149`	`}`
`151`	`150`
`152`	`151`	`if (!this.odpIntegrationConfig.integrated) {`
`@@ -211,21 +210,21 @@ export abstract class OdpManager implements IOdpManager {`
`211`	`210`	`* @returns {Promise<string[] \| null>} A promise holding either a list of qualified segments or null.`
`212`	`211`	`*/`
`213`	`212`	`async fetchQualifiedSegments(userId: string, options: Array<OptimizelySegmentOption> = []): Promise<string[] \| null> {`
`214`		`- if (!this.odpIntegrationConfig) {`
`215`		`- this.logger.log(LogLevel.ERROR, ERROR_MESSAGES.ODP_CONFIG_NOT_AVAILABLE);`
	`213`	`+ if (!this.odpIntegrationConfig) {`
	`214`	`+ this.logger.log(LogLevel.ERROR, ERROR_MESSAGES.ODP_CONFIG_NOT_AVAILABLE);`
`216`	`215`	`return null;`
`217`	`216`	`}`
`218`	`217`
`219`	`218`	`if (!this.odpIntegrationConfig.integrated) {`
`220`		`- this.logger.log(LogLevel.ERROR, ERROR_MESSAGES.ODP_NOT_INTEGRATED);`
	`219`	`+ this.logger.log(LogLevel.ERROR, ERROR_MESSAGES.ODP_NOT_INTEGRATED);`
`221`	`220`	`return null;`
`222`	`221`	`}`
`223`	`222`
`224`	`223`	`if (VuidManager.isVuid(userId)) {`
`225`	`224`	`return this.segmentManager.fetchQualifiedSegments(ODP_USER_KEY.VUID, userId, options);`
`226`	`225`	`}`
`227`	`226`
`228`		`- return this.segmentManager.fetchQualifiedSegments(ODP_USER_KEY.FS_USER_ID, userId, options);`
	`227`	`+ return this.segmentManager.fetchQualifiedSegments(ODP_USER_KEY.FS_USER_ID, userId, options);`
`229`	`228`	`}`
`230`	`229`
`231`	`230`	`/**`
`@@ -241,7 +240,7 @@ export abstract class OdpManager implements IOdpManager {`
`241`	`240`	`}`
`242`	`241`
`243`	`242`	`if (!this.odpIntegrationConfig.integrated) {`
`244`		`- this.logger.log(LogLevel.ERROR, ERROR_MESSAGES.ODP_NOT_INTEGRATED);`
	`243`	`+ this.logger.log(LogLevel.INFO, ERROR_MESSAGES.ODP_NOT_INTEGRATED);`
`245`	`244`	`return;`
`246`	`245`	`}`
`247`	`246`
`@@ -306,7 +305,7 @@ export abstract class OdpManager implements IOdpManager {`
`306`	`305`	`}`
`307`	`306`
`308`	`307`	`if (!this.odpIntegrationConfig.integrated) {`
`309`		`- this.logger.log(LogLevel.ERROR, ERROR_MESSAGES.ODP_NOT_INTEGRATED);`
	`308`	`+ this.logger.log(LogLevel.INFO, ERROR_MESSAGES.ODP_NOT_INTEGRATED);`
`310`	`309`	`return;`
`311`	`310`	`}`
`312`	`311`
Original file line number	Diff line number	Diff line change
`@@ -188,9 +188,8 @@ export default class Optimizely implements Client {`
`188`	`188`	`this.nextReadyTimeoutId = 0;`
`189`	`189`	`}`
`190`	`190`
`191`		`-`
`192`	`191`	`/**`
`193`		`- * Returns the project configuration retrieved from projectConfigManager`
	`192`	`+ * Returns the project configuration retrieved from projectConfigManager`
`194`	`193`	`* @return {projectConfig.ProjectConfig}`
`195`	`194`	`*/`
`196`	`195`	`getProjectConfig(): projectConfig.ProjectConfig \| null {`
`@@ -1444,10 +1443,7 @@ export default class Optimizely implements Client {`
`1444`	`1443`	`createUserContext(userId?: string, attributes?: UserAttributes): OptimizelyUserContext \| null {`
`1445`	`1444`	`const userIdentifier = userId ?? this.odpManager?.getVuid();`
`1446`	`1445`
`1447`		`- if (`
`1448`		`- userIdentifier === undefined \|\|`
`1449`		`- !this.validateInputs({ user_id: userIdentifier }, attributes)`
`1450`		`- ) {`
	`1446`	`+ if (userIdentifier === undefined \|\| !this.validateInputs({ user_id: userIdentifier }, attributes)) {`
`1451`	`1447`	`return null;`
`1452`	`1448`	`}`
`1453`	`1449`
`@@ -1671,7 +1667,7 @@ export default class Optimizely implements Client {`
`1671`	`1667`	`}`
`1672`	`1668`
`1673`	`1669`	`if (this.odpManager) {`
`1674`		`- this.odpManager.updateSettings(projectConfig.odpIntegrationConfig)`
	`1670`	`+ this.odpManager.updateSettings(projectConfig.odpIntegrationConfig);`
`1675`	`1671`	`}`
`1676`	`1672`	`}`
`1677`	`1673`
`@@ -1722,8 +1718,11 @@ export default class Optimizely implements Client {`
`1722`	`1718`	`this.logger.error(ERROR_MESSAGES.ODP_EVENT_FAILED, e);`
`1723`	`1719`	`}`
`1724`	`1720`	`}`
`1725`		`-`
`1726`		`- private isOdpIntegrated(): boolean {`
	`1721`	`+ /**`
	`1722`	`+ * Checks if ODP (Optimizely Data Platform) is integrated into the project.`
	`1723`	+ * @returns { boolean } `true` if ODP settings were found in the datafile otherwise `false`
	`1724`	`+ */`
	`1725`	`+ public isOdpIntegrated(): boolean {`
`1727`	`1726`	`return this.projectConfigManager.getConfig()?.odpIntegrationConfig?.integrated ?? false;`
`1728`	`1727`	`}`
`1729`	`1728`
`@@ -1751,7 +1750,7 @@ export default class Optimizely implements Client {`
`1751`	`1750`	`if (!this.odpManager) {`
`1752`	`1751`	`return null;`
`1753`	`1752`	`}`
`1754`		`-`
	`1753`	`+`
`1755`	`1754`	`return await this.odpManager.fetchQualifiedSegments(userId, options);`
`1756`	`1755`	`}`
`1757`	`1756`