Merge branch 'master' into farhan-anjum/FSSDK-11073-GHA-publish-to-GPR

Author: FarhanAnjum-opti

lib/core/decision_service/index.spec.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright 2017-2022, 2024, Optimizely
+ * Copyright 2017-2022, 2024-2025, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -110,7 +110,7 @@ export interface DecisionObj {
 }
 
 interface DecisionServiceOptions {
-  userProfileService: UserProfileService | null;
+  userProfileService?: UserProfileService;
   logger?: LoggerFacade;
   UNSTABLE_conditionEvaluators: unknown;
 }
@@ -143,13 +143,13 @@ export class DecisionService {
   private logger?: LoggerFacade;
   private audienceEvaluator: AudienceEvaluator;
   private forcedVariationMap: { [key: string]: { [id: string]: string } };
-  private userProfileService: UserProfileService | null;
+  private userProfileService?: UserProfileService;
 
   constructor(options: DecisionServiceOptions) {
     this.logger = options.logger;
     this.audienceEvaluator = createAudienceEvaluator(options.UNSTABLE_conditionEvaluators, this.logger);
     this.forcedVariationMap = {};
-    this.userProfileService = options.userProfileService || null;
+    this.userProfileService = options.userProfileService;
   }
 
   /**
@@ -170,18 +170,22 @@ export class DecisionService {
   ): DecisionResponse<string | null> { 
     const userId = user.getUserId();
     const attributes = user.getAttributes();
+
     // by default, the bucketing ID should be the user ID
     const bucketingId = this.getBucketingId(userId, attributes);
-    const decideReasons: (string | number)[][] = [];
     const experimentKey = experiment.key;
-    if (!this.checkIfExperimentIsActive(configObj, experimentKey)) {
+
+    const decideReasons: (string | number)[][] = [];
+
+    if (!isActive(configObj, experimentKey)) {
       this.logger?.info(EXPERIMENT_NOT_RUNNING, experimentKey);
       decideReasons.push([EXPERIMENT_NOT_RUNNING, experimentKey]);
       return {
         result: null,
         reasons: decideReasons,
       };
     }
+
     const decisionForcedVariation = this.getForcedVariation(configObj, experimentKey, userId);
     decideReasons.push(...decisionForcedVariation.reasons);
     const forcedVariationKey = decisionForcedVariation.result;
@@ -192,6 +196,7 @@ export class DecisionService {
         reasons: decideReasons,
       };
     }
+
     const decisionWhitelistedVariation = this.getWhitelistedVariation(experiment, userId);
     decideReasons.push(...decisionWhitelistedVariation.reasons);
     let variation = decisionWhitelistedVariation.result;
@@ -202,7 +207,6 @@ export class DecisionService {
       };
     }
 
-
     // check for sticky bucketing if decide options do not include shouldIgnoreUPS
     if (!shouldIgnoreUPS) {
       variation = this.getStoredVariation(configObj, experiment, userId, userProfileTracker.userProfile);
@@ -349,16 +353,6 @@ export class DecisionService {
     return { ...userProfile.experiment_bucket_map, ...attributeExperimentBucketMap as any };
   }
 
-  /**
-   * Checks whether the experiment is running
-   * @param  {ProjectConfig}  configObj     The parsed project configuration object
-   * @param  {string}         experimentKey Key of experiment being validated
-   * @return {boolean}        True if experiment is running
-   */
-  private checkIfExperimentIsActive(configObj: ProjectConfig, experimentKey: string): boolean {
-    return isActive(configObj, experimentKey);
-  }
-
   /**
    * Checks if user is whitelisted into any variation and return that variation if so
    * @param  {Experiment}                                 experiment
@@ -621,7 +615,7 @@ export class DecisionService {
       isProfileUpdated: false,
       userProfile: null,
     }
-    const shouldIgnoreUPS = options[OptimizelyDecideOption.IGNORE_USER_PROFILE_SERVICE];
+    const shouldIgnoreUPS = !!options[OptimizelyDecideOption.IGNORE_USER_PROFILE_SERVICE];
 
     if(!shouldIgnoreUPS) {
       userProfileTracker.userProfile = this.resolveExperimentBucketMap(userId, attributes);
@@ -661,10 +655,10 @@ export class DecisionService {
     }
 
     if(!shouldIgnoreUPS) {
-      this.saveUserProfile(userId, userProfileTracker)
+      this.saveUserProfile(userId, userProfileTracker);
     }
 
-    return decisions
+    return decisions;
 
   }
 
@@ -968,7 +962,7 @@ export class DecisionService {
    * @param  {string} experimentKey  Key representing the experiment id
    * @throws If the user id is not valid or not in the forced variation map
    */
-  removeForcedVariation(userId: string, experimentId: string, experimentKey: string): void {
+  private removeForcedVariation(userId: string, experimentId: string, experimentKey: string): void {
     if (!userId) {
       throw new OptimizelyError(INVALID_USER_ID);
     }
@@ -1176,7 +1170,7 @@ export class DecisionService {
     }
   }
 
-  getVariationFromExperimentRule(
+  private getVariationFromExperimentRule(
     configObj: ProjectConfig,
     flagKey: string,
     rule: Experiment,
@@ -1207,7 +1201,7 @@ export class DecisionService {
     };
   }
 
-  getVariationFromDeliveryRule(
+  private getVariationFromDeliveryRule(
     configObj: ProjectConfig,
     flagKey: string,
     rules: Experiment[],

lib/core/decision_service/index.tests.js

@@ -68,13 +68,13 @@ export type Entrypoint = {
   eventDispatcher: EventDispatcher;
   getSendBeaconEventDispatcher: () => EventDispatcher;
   createForwardingEventProcessor: (eventDispatcher?: EventDispatcher) => OpaqueEventProcessor;
-  createBatchEventProcessor: (options: BatchEventProcessorOptions) => OpaqueEventProcessor;
+  createBatchEventProcessor: (options?: BatchEventProcessorOptions) => OpaqueEventProcessor;
 
   // odp manager related exports
-  createOdpManager: (options: OdpManagerOptions) => OpaqueOdpManager;
+  createOdpManager: (options?: OdpManagerOptions) => OpaqueOdpManager;
 
   // vuid manager related exports
-  createVuidManager: (options: VuidManagerOptions) => OpaqueVuidManager;
+  createVuidManager: (options?: VuidManagerOptions) => OpaqueVuidManager;
 
   // logger related exports
   LogLevel: typeof LogLevel;

lib/core/decision_service/index.ts

@@ -25,6 +25,10 @@ export class OptimizelyError extends Error {
     this.name = 'OptimizelyError';
     this.baseMessage = baseMessage;
     this.params = params;
+
+    // this is needed cause instanceof doesn't work for
+    // custom Errors when TS is compiled to es5
+    Object.setPrototypeOf(this, OptimizelyError.prototype);
   }
 
   getMessage(resolver?: MessageResolver): string {

lib/entrypoint.test-d.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright 2024, Optimizely
+ * Copyright 2024-2025, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -39,7 +39,7 @@ export const createForwardingEventProcessor = (
 const identity = <T>(v: T): T => v;
 
 export const createBatchEventProcessor = (
-  options: BatchEventProcessorOptions
+  options: BatchEventProcessorOptions = {}
 ): OpaqueEventProcessor => {
   const localStorageCache = new LocalStorageCache<EventWithId>();
   const eventStore = new SyncPrefixCache<EventWithId, EventWithId>(

lib/error/optimizly_error.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright 2024, Optimizely
+ * Copyright 2024-2025, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -32,7 +32,7 @@ export const createForwardingEventProcessor = (
 };
 
 export const createBatchEventProcessor = (
-  options: BatchEventProcessorOptions
+  options: BatchEventProcessorOptions = {}
 ): OpaqueEventProcessor => {
   const eventStore = options.eventStore ? getPrefixEventStore(options.eventStore) : undefined;
 

lib/event_processor/event_processor_factory.browser.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright 2024, Optimizely
+ * Copyright 2024-2025, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -53,7 +53,7 @@ const getDefaultEventStore = () => {
 }
 
 export const createBatchEventProcessor = (
-  options: BatchEventProcessorOptions
+  options: BatchEventProcessorOptions = {}
 ): OpaqueEventProcessor => {
   const eventStore = options.eventStore ? getPrefixEventStore(options.eventStore) : getDefaultEventStore();
 

lib/event_processor/event_processor_factory.node.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright 2024, Optimizely
+ * Copyright 2024-2025, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,7 +21,7 @@ import { getOpaqueOdpManager, OdpManagerOptions, OpaqueOdpManager } from './odp_
 
 export const BROWSER_DEFAULT_API_TIMEOUT = 10_000;
 
-export const createOdpManager = (options: OdpManagerOptions): OpaqueOdpManager => {
+export const createOdpManager = (options: OdpManagerOptions = {}): OpaqueOdpManager => {
   const segmentRequestHandler = new BrowserRequestHandler({ 
     timeout: options.segmentsApiTimeout || BROWSER_DEFAULT_API_TIMEOUT,
   });

lib/event_processor/event_processor_factory.react_native.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright 2024, Optimizely
+ * Copyright 2024-2025, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -23,7 +23,7 @@ export const NODE_DEFAULT_API_TIMEOUT = 10_000;
 export const NODE_DEFAULT_BATCH_SIZE = 10;
 export const NODE_DEFAULT_FLUSH_INTERVAL = 1000;
 
-export const createOdpManager = (options: OdpManagerOptions): OpaqueOdpManager => {
+export const createOdpManager = (options: OdpManagerOptions = {}): OpaqueOdpManager => {
   const segmentRequestHandler = new NodeRequestHandler({ 
     timeout: options.segmentsApiTimeout || NODE_DEFAULT_API_TIMEOUT,
   });