Merge branch 'master' into junaed/fssdk-11403-readme-update

Author: junaed-optimizely

.github/workflows/javascript.yml

@@ -40,30 +40,30 @@ jobs:
       CI_USER_TOKEN: ${{ secrets.CI_USER_TOKEN }}
       TRAVIS_COM_TOKEN: ${{ secrets.TRAVIS_COM_TOKEN }}
 
-  crossbrowser_and_umd_unit_tests:
-    runs-on: ubuntu-latest
-    env:
-      BROWSER_STACK_USERNAME: ${{ secrets.BROWSERSTACK_USERNAME }}
-      BROWSER_STACK_ACCESS_KEY: ${{ secrets.BROWSERSTACK_ACCESS_KEY }}
-    steps:
-    - uses: actions/checkout@v3
-    - name: Set up Node
-      uses: actions/setup-node@v3
-      with:
-        node-version: 16
-        cache: 'npm'
-        cache-dependency-path: ./package-lock.json
-    - name: Cross-browser and umd unit tests
-      working-directory: .
-      run: |
-        npm install
-        npm run test-ci
+  # crossbrowser_and_umd_unit_tests:
+  #   runs-on: ubuntu-latest
+  #   env:
+  #     BROWSER_STACK_USERNAME: ${{ secrets.BROWSERSTACK_USERNAME }}
+  #     BROWSER_STACK_ACCESS_KEY: ${{ secrets.BROWSERSTACK_ACCESS_KEY }}
+  #   steps:
+  #   - uses: actions/checkout@v3
+  #   - name: Set up Node
+  #     uses: actions/setup-node@v3
+  #     with:
+  #       node-version: 16
+  #       cache: 'npm'
+  #       cache-dependency-path: ./package-lock.json
+  #   - name: Cross-browser and umd unit tests
+  #     working-directory: .
+  #     run: |
+  #       npm install
+  #       npm run test-ci
 
   unit_tests:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: ['16', '18', '20', '22']
+        node: ['18', '20', '22']
     steps:
     - uses: actions/checkout@v3
     - name: Set up Node ${{ matrix.node }}

CHANGELOG.md

@@ -5,6 +5,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [5.3.5] - Jan 29, 2025
+
+### Bug Fixes
+
+- Rollout experiment key exclusion from activate method([#949](https://github.com/optimizely/javascript-sdk/pull/949))
+- Using optimizely.readyPromise instead of optimizely.onReady to avoid setTimeout call in edge environments. ([#995](https://github.com/optimizely/javascript-sdk/pull/995))
+
+## [4.10.1] - November 18, 2024
+
+### Changed
+- update uuid module improt and usage ([#961](https://github.com/optimizely/javascript-sdk/pull/961))
+
+
 ## [5.3.4] - Jun 28, 2024
 
 ### Changed

lib/common_exports.ts

@@ -19,10 +19,10 @@ export { createStaticProjectConfigManager } from './project_config/config_manage
 export { LogLevel } from './logging/logger';
 
 export {
-  DebugLog,
-  InfoLog,
-  WarnLog,
-  ErrorLog,
+  DEBUG,
+  INFO,
+  WARN,
+  ERROR,
 } from './logging/logger_factory';
 
 export { createLogger } from './logging/logger_factory';

lib/core/decision_service/cmab/cmab_service.ts

@@ -18,7 +18,7 @@ import { LoggerFacade } from "../../../logging/logger";
 import { IOptimizelyUserContext } from "../../../optimizely_user_context";
 import { ProjectConfig } from "../../../project_config/project_config"
 import { OptimizelyDecideOption, UserAttributes } from "../../../shared_types"
-import { Cache } from "../../../utils/cache/cache";
+import { Cache, CacheWithRemove } from "../../../utils/cache/cache";
 import { CmabClient } from "./cmab_client";
 import { v4 as uuidV4 } from 'uuid';
 import murmurhash from "murmurhash";
@@ -53,12 +53,12 @@ export type CmabCacheValue = {
 
 export type CmabServiceOptions = {
   logger?: LoggerFacade;
-  cmabCache: Cache<CmabCacheValue>;
+  cmabCache: CacheWithRemove<CmabCacheValue>;
   cmabClient: CmabClient;
 }
 
 export class DefaultCmabService implements CmabService {
-  private cmabCache: Cache<CmabCacheValue>;
+  private cmabCache: CacheWithRemove<CmabCacheValue>;
   private cmabClient: CmabClient;
   private logger?: LoggerFacade;
 
@@ -81,7 +81,7 @@ export class DefaultCmabService implements CmabService {
     }
 
     if (options[OptimizelyDecideOption.RESET_CMAB_CACHE]) {
-      this.cmabCache.clear();
+      this.cmabCache.reset();
     }
 
     const cacheKey = this.getCacheKey(userContext.getUserId(), ruleId);
@@ -90,7 +90,7 @@ export class DefaultCmabService implements CmabService {
       this.cmabCache.remove(cacheKey);
     }
 
-    const cachedValue = await this.cmabCache.get(cacheKey);
+    const cachedValue = await this.cmabCache.lookup(cacheKey);
 
     const attributesJson = JSON.stringify(filteredAttributes, Object.keys(filteredAttributes).sort());
     const attributesHash = String(murmurhash.v3(attributesJson));
@@ -104,7 +104,7 @@ export class DefaultCmabService implements CmabService {
     }
 
     const variation = await this.fetchDecision(ruleId, userContext.getUserId(), filteredAttributes);
-    this.cmabCache.set(cacheKey, { 
+    this.cmabCache.save(cacheKey, { 
       attributesHash,
       variationId: variation.variationId,
       cmabUuid: variation.cmabUuid,

lib/core/decision_service/index.spec.ts

@@ -14,13 +14,13 @@
  * limitations under the License.
  */
 import { describe, it, expect, vi, MockInstance, beforeEach } from 'vitest';
-import { CMAB_FETCH_FAILED, DecisionService } from '.';
+import { CMAB_DUMMY_ENTITY_ID, CMAB_FETCH_FAILED, DecisionService } from '.';
 import { getMockLogger } from '../../tests/mock/mock_logger';
 import OptimizelyUserContext from '../../optimizely_user_context';
 import { bucket } from '../bucketer';
 import { getTestProjectConfig, getTestProjectConfigWithFeatures } from '../../tests/test_data';
 import { createProjectConfig, ProjectConfig } from '../../project_config/project_config';
-import { BucketerParams, Experiment, OptimizelyDecideOption, UserProfile } from '../../shared_types';
+import { BucketerParams, Experiment, OptimizelyDecideOption, UserAttributes, UserProfile } from '../../shared_types';
 import { CONTROL_ATTRIBUTES, DECISION_SOURCES } from '../../utils/enums';
 import { getDecisionTestDatafile } from '../../tests/decision_test_datafile';
 import { Value } from '../../utils/promise/operation_value';
@@ -140,10 +140,18 @@ const verifyBucketCall = (
     variationIdMap,
     bucketingId,
   } = mockBucket.mock.calls[call][0];
+  let expectedTrafficAllocation = experiment.trafficAllocation;
+  if (experiment.cmab) {
+    expectedTrafficAllocation = [{
+      endOfRange: experiment.cmab.trafficAllocation,
+      entityId: CMAB_DUMMY_ENTITY_ID,
+    }];
+  }
+
   expect(experimentId).toBe(experiment.id);
   expect(experimentKey).toBe(experiment.key);
   expect(userId).toBe(user.getUserId());
-  expect(trafficAllocationConfig).toBe(experiment.trafficAllocation);
+  expect(trafficAllocationConfig).toEqual(expectedTrafficAllocation);
   expect(experimentKeyMap).toBe(projectConfig.experimentKeyMap);
   expect(experimentIdMap).toBe(projectConfig.experimentIdMap);
   expect(groupIdMap).toBe(projectConfig.groupIdMap);
@@ -336,7 +344,7 @@ describe('DecisionService', () => {
       const config = createProjectConfig(cloneDeep(testData)); 
       const experiment = config.experimentIdMap['111127'];
 
-      const attributes: any = {
+      const attributes: UserAttributes = {
         $opt_experiment_bucket_map: {
           '111127': {
             variation_id: '111129', // ID of the 'variation' variation
@@ -674,7 +682,7 @@ describe('DecisionService', () => {
         const config = createProjectConfig(cloneDeep(testData));
         const experiment = config.experimentIdMap['111127'];
 
-        const attributes: any = {
+        const attributes: UserAttributes = {
           $opt_experiment_bucket_map: {
             '111127': {
               variation_id: '111129', // ID of the 'variation' variation
@@ -707,7 +715,7 @@ describe('DecisionService', () => {
         const config = createProjectConfig(cloneDeep(testData));
         const experiment = config.experimentIdMap['111127'];
 
-        const attributes: any = {
+        const attributes: UserAttributes = {
           $opt_experiment_bucket_map: {
             '122227': {
               variation_id: '111129', // ID of the 'variation' variation
@@ -740,7 +748,7 @@ describe('DecisionService', () => {
         const config = createProjectConfig(cloneDeep(testData));
         const experiment = config.experimentIdMap['111127'];
 
-        const attributes: any = {
+        const attributes: UserAttributes = {
           $opt_experiment_bucket_map: {
             '111127': {
               variation_id: '111129', // ID of the 'variation' variation
@@ -766,7 +774,7 @@ describe('DecisionService', () => {
         const config = createProjectConfig(cloneDeep(testData));
         const experiment = config.experimentIdMap['111127'];
 
-        const attributes: any = {
+        const attributes: UserAttributes = {
           $opt_experiment_bucket_map: {
             '111127': {
               variation_id: '111129', // ID of the 'variation' variation
@@ -1327,7 +1335,8 @@ describe('DecisionService', () => {
       });
     });
 
-    it('should get decision from the cmab service if the experiment is a cmab experiment', async () => {
+    it('should not return variation and should not call cmab service \
+        for cmab experiment if user is not bucketed into it', async () => {
       const { decisionService, cmabService } = getDecisionService();
       const config = createProjectConfig(getDecisionTestDatafile());
 
@@ -1340,6 +1349,57 @@ describe('DecisionService', () => {
         },
       });
 
+      mockBucket.mockImplementation((param: BucketerParams) => {
+        const ruleKey = param.experimentKey;
+        if (ruleKey == 'default-rollout-key') {
+          return { result: param.trafficAllocationConfig[0].entityId, reasons: [] }
+        }
+        return {
+          result: null,
+          reasons: [],
+        }
+      });
+
+      const feature = config.featureKeyMap['flag_1'];
+      const value = decisionService.resolveVariationsForFeatureList('async', config, [feature], user, {}).get();
+      expect(value).toBeInstanceOf(Promise);
+
+      const variation = (await value)[0];
+      expect(variation.result).toEqual({
+        experiment: config.experimentKeyMap['default-rollout-key'],
+        variation: config.variationIdMap['5007'],
+        decisionSource: DECISION_SOURCES.ROLLOUT,
+      });
+
+      verifyBucketCall(0, config, config.experimentKeyMap['exp_3'], user);
+      expect(cmabService.getDecision).not.toHaveBeenCalled();
+    });
+
+    it('should get decision from the cmab service if the experiment is a cmab experiment \
+        and user is bucketed into it', async () => {
+      const { decisionService, cmabService } = getDecisionService();
+      const config = createProjectConfig(getDecisionTestDatafile());
+
+      const user = new OptimizelyUserContext({
+        optimizely: {} as any,
+        userId: 'tester',
+        attributes: {
+          country: 'BD',
+          age: 80, // should satisfy audience condition for exp_3 which is cmab and not others
+        },
+      });
+
+      mockBucket.mockImplementation((param: BucketerParams) => {
+        const ruleKey = param.experimentKey;
+        if (ruleKey == 'exp_3') {
+          return { result: param.trafficAllocationConfig[0].entityId, reasons: [] }
+        }
+        return {
+          result: null,
+          reasons: [],
+        }
+      });
+
       cmabService.getDecision.mockResolvedValue({
         variationId: '5003',
         cmabUuid: 'uuid-test',
@@ -1357,6 +1417,8 @@ describe('DecisionService', () => {
         decisionSource: DECISION_SOURCES.FEATURE_TEST,
       });
 
+      verifyBucketCall(0, config, config.experimentKeyMap['exp_3'], user);
+
       expect(cmabService.getDecision).toHaveBeenCalledTimes(1);
       expect(cmabService.getDecision).toHaveBeenCalledWith(
         config,
@@ -1379,6 +1441,17 @@ describe('DecisionService', () => {
         },
       });
 
+      mockBucket.mockImplementation((param: BucketerParams) => {
+        const ruleKey = param.experimentKey;
+        if (ruleKey == 'exp_3') {
+          return { result: param.trafficAllocationConfig[0].entityId, reasons: [] }
+        }
+        return {
+          result: null,
+          reasons: [],
+        }
+      });
+
       cmabService.getDecision.mockResolvedValue({
         variationId: '5003',
         cmabUuid: 'uuid-test',
@@ -1424,6 +1497,17 @@ describe('DecisionService', () => {
         },
       });
 
+      mockBucket.mockImplementation((param: BucketerParams) => {
+        const ruleKey = param.experimentKey;
+        if (ruleKey == 'exp_3') {
+          return { result: param.trafficAllocationConfig[0].entityId, reasons: [] }
+        }
+        return {
+          result: null,
+          reasons: [],
+        }
+      });
+
       cmabService.getDecision.mockRejectedValue(new Error('I am an error'));
 
       const feature = config.featureKeyMap['flag_1'];
@@ -1474,6 +1558,17 @@ describe('DecisionService', () => {
 
       userProfileServiceAsync?.save.mockImplementation(() => Promise.resolve());
 
+      mockBucket.mockImplementation((param: BucketerParams) => {
+        const ruleKey = param.experimentKey;
+        if (ruleKey == 'exp_3') {
+          return { result: param.trafficAllocationConfig[0].entityId, reasons: [] }
+        }
+        return {
+          result: null,
+          reasons: [],
+        }
+      });
+
       cmabService.getDecision.mockResolvedValue({
         variationId: '5003',
         cmabUuid: 'uuid-test',
@@ -1552,6 +1647,17 @@ describe('DecisionService', () => {
 
       userProfileServiceAsync?.save.mockImplementation(() => Promise.resolve());
 
+      mockBucket.mockImplementation((param: BucketerParams) => {
+        const ruleKey = param.experimentKey;
+        if (ruleKey == 'exp_3') {
+          return { result: param.trafficAllocationConfig[0].entityId, reasons: [] }
+        }
+        return {
+          result: null,
+          reasons: [],
+        }
+      });
+
       cmabService.getDecision.mockResolvedValue({
         variationId: '5003',
         cmabUuid: 'uuid-test',
@@ -1605,6 +1711,16 @@ describe('DecisionService', () => {
 
       userProfileServiceAsync?.save.mockRejectedValue(new Error('I am an error'));
 
+      mockBucket.mockImplementation((param: BucketerParams) => {
+        const ruleKey = param.experimentKey;
+        if (ruleKey == 'exp_3') {
+          return { result: param.trafficAllocationConfig[0].entityId, reasons: [] }
+        }
+        return {
+          result: null,
+          reasons: [],
+        }
+      });
 
       cmabService.getDecision.mockResolvedValue({
         variationId: '5003',
@@ -1669,6 +1785,16 @@ describe('DecisionService', () => {
       userProfileServiceAsync?.lookup.mockResolvedValue(null);
       userProfileServiceAsync?.save.mockResolvedValue(null);
 
+      mockBucket.mockImplementation((param: BucketerParams) => {
+        const ruleKey = param.experimentKey;
+        if (ruleKey == 'exp_3') {
+          return { result: param.trafficAllocationConfig[0].entityId, reasons: [] }
+        }
+        return {
+          result: null,
+          reasons: [],
+        }
+      });
 
       cmabService.getDecision.mockResolvedValue({
         variationId: '5003',