fix: Checking variation in flagvariation map instead of checking it only in experiment (#729)

* Removed getflagVariationByKey from optimizely and moved it to project config also instead of getting variation from rule

* fix

* Added unit test

* Fixed unit test

Co-authored-by: mnoman09 <m.nomanshoaib09@gmail.com>
Co-authored-by: msohailhussain <mirza.sohailhussain@gmail.com>

Author: 3 people

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

@@ -31,6 +31,7 @@ import {
   getExperimentAudienceConditions,
   getExperimentFromId,
   getExperimentFromKey,
+  getFlagVariationByKey,
   getTrafficAllocation,
   getVariationIdFromExperimentAndVariationKey,
   getVariationFromId,
@@ -614,7 +615,11 @@ export class DecisionService {
           decideReasons.push(...decisionVariation.reasons);
           variationKey = decisionVariation.result;
           if (variationKey) {
-            const variation = experiment.variationKeyMap[variationKey];
+            let variation = null;
+            variation = experiment.variationKeyMap[variationKey];
+            if (!variation) {
+              variation = getFlagVariationByKey(configObj, feature.key, variationKey);
+            }
             variationForFeatureExperiment = {
               experiment: experiment,
               variation: variation,
@@ -1016,7 +1021,7 @@ export class DecisionService {
     const decideReasons: (string | number)[][] = [];
 
     // check forced decision first
-    const forcedDecisionResponse = user.findValidatedForcedDecision(flagKey, rule.key);
+    const forcedDecisionResponse = user.findValidatedForcedDecision(configObj, flagKey, rule.key);
     decideReasons.push(...forcedDecisionResponse.reasons);
 
     const forcedVariaton = forcedDecisionResponse.result;
@@ -1048,7 +1053,7 @@ export class DecisionService {
 
     // check forced decision first
     const rule = rules[ruleIndex];
-    const forcedDecisionResponse = user.findValidatedForcedDecision(flagKey, rule.key);
+    const forcedDecisionResponse = user.findValidatedForcedDecision(configObj, flagKey, rule.key);
     decideReasons.push(...forcedDecisionResponse.reasons);
 
     const forcedVariaton = forcedDecisionResponse.result;

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

@@ -508,6 +508,26 @@ export const getExperimentFromId = function(
   return null;
 };
 
+/**
+* Returns flag variation for specified flagKey and variationKey
+* @param  {flagKey}        string
+* @param  {variationKey}   string
+* @return {Variation|null}
+*/
+export const getFlagVariationByKey = function(projectConfig: ProjectConfig, flagKey: string, variationKey: string): Variation | null {
+  if (!projectConfig) {
+    return null;
+  }
+
+  const variations = projectConfig.flagVariationsMap[flagKey];
+  const result = find(variations, item => item.key === variationKey)
+  if (result) {
+    return result;
+  }
+
+  return null;
+};
+
 /**
  * Get feature from provided feature key. Log an error if no feature exists in
  * the project config with the given key.
@@ -817,6 +837,7 @@ export default {
   getExperimentFromKey,
   getTrafficAllocation,
   getExperimentFromId,
+  getFlagVariationByKey,
   getFeatureFromKey,
   getVariableForFeature,
   getVariableValueForVariation,

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

@@ -1481,7 +1481,7 @@ export default class Optimizely {
 
     const allDecideOptions = this.getAllDecideOptions(options);
 
-    const forcedDecisionResponse = user.findValidatedForcedDecision(key);
+    const forcedDecisionResponse = user.findValidatedForcedDecision(configObj, key);
     reasons.push(...forcedDecisionResponse.reasons);
     const variation = forcedDecisionResponse.result;
     if (variation) {
@@ -1672,24 +1672,4 @@ export default class Optimizely {
     return this.decideForKeys(user, allFlagKeys, options);
   }
 
-  /**
-   * Returns flag variation for specified flagKey and variationKey
-   * @param  {flagKey}        string
-   * @param  {variationKey}   string
-   * @return {OptimizelyVariation|null}
-   */
-  getFlagVariationByKey(flagKey: string, variationKey: string): OptimizelyVariation | null {
-    const configObj = this.projectConfigManager.getConfig();
-    if (!configObj) {
-      return null;
-    }
-
-    const variations = configObj.flagVariationsMap[flagKey];
-    const result = find(variations, item => item.key === variationKey)
-    if (result) {
-      return result;
-    }
-
-    return null;
-  }
 }

packages/optimizely-sdk/lib/optimizely_user_context/index.tests.js

@@ -176,7 +176,7 @@ describe('lib/optimizely_user_context', function() {
         );
         assert.deepEqual(decision, fakeDecision);
       });
-    });
+  });
 
     describe('#decideForKeys', function() {
       it('should return an expected decision results object', function() {
@@ -381,6 +381,23 @@ describe('lib/optimizely_user_context', function() {
           optlyInstance.notificationCenter.sendNotifications.restore();
         });
 
+        it('should return an expected decision object when forced decision is called and variation of different experiment but same flag key', function() {
+          var flagKey = 'feature_1';
+          var ruleKey = 'exp_with_audience';
+          var variationKey = '3324490633';
+  
+          var user = optlyInstance.createUserContext(userId);
+          user.setForcedDecision({ flagKey: flagKey, ruleKey }, { variationKey });
+          var decision = user.decide(flagKey, options);
+          
+          assert.equal(decision.variationKey, variationKey);
+          assert.equal(decision.ruleKey, ruleKey);
+          assert.equal(decision.enabled, true);
+          assert.equal(decision.userContext.getUserId(), userId);
+          assert.deepEqual(decision.userContext.getAttributes(), {});
+          assert.deepEqual(Object.keys(decision.userContext.forcedDecisionsMap).length, 1);
+        });
+
         it('should return forced decision object when forced decision is set for a flag and do NOT dispatch an event with DISABLE_DECISION_EVENT passed in decide options', function() {
           var user = optlyInstance.createUserContext(userId);
           var featureKey = 'feature_1';

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

@@ -26,6 +26,10 @@ import {
   UserAttributes,
   Variation
 } from '../../lib/shared_types';
+import {
+  getFlagVariationByKey,
+  ProjectConfig,
+} from '../core/project_config';
 import { LOG_MESSAGES, CONTROL_ATTRIBUTES } from '../utils/enums';
 
 const logger = getLogger();
@@ -211,22 +215,24 @@ export default class OptimizelyUserContext {
 
   /**
    * Finds a validated forced decision for specific flagKey and optional ruleKey.
+   * @param     {ProjectConfig}config               A projectConfig.
    * @param     {string}       flagKey              A flagKey.
    * @param     {ruleKey}      ruleKey              A ruleKey (optional).
    * @return    {DecisionResponse<Variation|null>}  DecisionResponse object containing valid variation object and decide reasons.
    */
   findValidatedForcedDecision(
+    config: ProjectConfig,
     flagKey: string,
-    ruleKey?: string
+    ruleKey?: string,
   ): DecisionResponse<Variation | null> {
 
     const decideReasons: (string | number)[][] = [];
     const forcedDecision = this.findForcedDecision({ flagKey, ruleKey });
     let variation = null;
     let variationKey;
-    if (forcedDecision) {
+    if (config && forcedDecision) {
       variationKey = forcedDecision.variationKey;
-      variation = this.optimizely.getFlagVariationByKey(flagKey, variationKey);
+      variation = getFlagVariationByKey(config, flagKey, variationKey);
       if (variation) {
         if (ruleKey) {
           logger.info(

packages/optimizely-sdk/lib/shared_types.ts

@@ -18,6 +18,8 @@ import { EventProcessor } from '@optimizely/js-sdk-event-processor';
 
 import { NotificationCenter } from '@optimizely/js-sdk-utils';
 
+import { ProjectConfig } from './core/project_config';
+
 export interface BucketerParams {
   experimentId: string;
   experimentKey: string;
@@ -381,8 +383,9 @@ export interface OptimizelyUserContext {
   ): { [key: string]: OptimizelyDecision };
   trackEvent(eventName: string, eventTags?: EventTags): void;
   findValidatedForcedDecision(
+    config: ProjectConfig,
     flagKey: string,
-    ruleKey?: string,
+    ruleKey?: string
   ): DecisionResponse<Variation | null>;
   setForcedDecision(context: OptimizelyDecisionContext, decision: OptimizelyForcedDecision): boolean;
   getForcedDecision(context: OptimizelyDecisionContext): OptimizelyForcedDecision | null;