feat(ForcedDecisions): add forced-decisions APIs to OptimizelyUserContext

src/Optimizely/Config/DatafileProjectConfig.php

@@ -245,6 +245,13 @@ class DatafileProjectConfig implements ProjectConfigInterface
      */
     private $_sendFlagDecisions;
 
+    /**
+     * Map indicating variations of flag decisions
+     *
+     * @return map
+     */
+    private $_flagVariationsMap;
+
     /**
      * DatafileProjectConfig constructor to load and set project configuration data.
      *
@@ -376,7 +383,19 @@ public function __construct($datafile, $logger, $errorHandler)
                 }
             }
         }
+        $this->_flagVariationsMap = array();
+        foreach ($this->_featureFlags as $flag) {
+            $variations = array();
+            $flagRules = $this->getAllRulesForFlag($flag);
+
+            foreach ($flagRules as $rule) {
+                $variations = array_merge($variations, array_filter(array_values($rule->getVariations()), function ($variation) use ($variations) {
+                    return !in_array($variation->getId(), $variations);
+                }));
+            }
 
+            $this->_flagVariationsMap[$flag->getKey()] = $variations;
+        }
         // Add variations for rollout experiments to variationIdMap and variationKeyMap
         $this->_variationIdMap = $this->_variationIdMap + $rolloutVariationIdMap;
         $this->_variationKeyMap = $this->_variationKeyMap + $rolloutVariationKeyMap;
@@ -404,6 +423,18 @@ public function __construct($datafile, $logger, $errorHandler)
         }
     }
 
+    private function getAllRulesForFlag(FeatureFlag $flag)
+    {
+        $rules = array();
+        foreach ($flag->getExperimentIds() as $experimentId) {
+            array_push($rules, $this->_experimentIdMap[$experimentId]);
+        }
+        if ($this->_rolloutIdMap && key_exists($flag->getRolloutId(), $this->_rolloutIdMap)) {
+            $rollout = $this->_rolloutIdMap[$flag->getRolloutId()];
+            $rules = array_merge($rules, $rollout->getExperiments());
+        }
+        return $rules;
+    }
     /**
      * Create ProjectConfig based on datafile string.
      *
@@ -614,6 +645,26 @@ public function getExperimentFromId($experimentId)
         return new Experiment();
     }
 
+    /**
+     * Gets the variation associated with experiment or rollout in instance of given feature flag key
+     *
+     * @param string Feature flag key
+     * @param string variation key
+     *
+     * @return Variation / null
+     */
+    public function getFlagVariationByKey($flagKey, $variationKey)
+    {
+        if (array_key_exists($flagKey, $this->_flagVariationsMap)) {
+            foreach ($this->_flagVariationsMap[$flagKey] as $variation) {
+                if ($variation->getKey() == $variationKey) {
+                    return $variation;
+                }
+            }
+        }
+        return null;
+    }
+
     /**
      * @param String $featureKey Key of the feature flag
      *
@@ -868,6 +919,16 @@ public function isFeatureExperiment($experimentId)
         return array_key_exists($experimentId, $this->_experimentFeatureMap);
     }
 
+    /**
+     * Returns map array of Flag key as key and Variations as value
+     *
+     * @return array
+     */
+    public function getFlagVariationsMap()
+    {
+        return $this->_flagVariationsMap;
+    }
+
     /**
      * Returns if flag decisions should be sent to server or not
      *

src/Optimizely/Config/ProjectConfigInterface.php

@@ -199,7 +199,23 @@ public function getVariationFromKeyByExperimentId($experimentId, $variationKey);
      * @return FeatureVariable / null
      */
     public function getFeatureVariableFromKey($featureFlagKey, $variableKey);
-
+
+    /**
+     * Gets the variation associated with experiment or rollout in instance of given feature flag key
+     *
+     * @param string Feature flag key
+     * @param string variation key
+     *
+     * @return Variation / null
+     */
+    public function getFlagVariationByKey($flagKey, $variationKey);
+
+    /**
+     * Returns map array of Flag key as key and Variations as value
+     *
+     * @return array
+     */
+    public function getFlagVariationsMap();
     /**
      * Determines if given experiment is a feature test.
      *

src/Optimizely/Event/Builder/EventBuilder.php

@@ -27,6 +27,7 @@
 use Optimizely\Utils\EventTagUtils;
 use Optimizely\Utils\GeneratorUtils;
 use Optimizely\Utils\Validator;
+use phpDocumentor\Reflection\Types\This;
 
 class EventBuilder
 {
@@ -139,18 +140,28 @@ private function getCommonParams($config, $userId, $attributes)
      * Helper function to get parameters specific to impression event.
      *
      * @param $experiment Experiment Experiment being activated.
-     * @param $variationId String ID representing the variation for the user.
+     * @param $variation Variation representing the variation for the user is allocated.
+     * @param $flagKey string feature flag key.
+     * @param $ruleKey string feature or rollout experiment key.
+     * @param $ruleType string feature or rollout experiment source type.
+     * @param $enabled Boolean feature enabled.
      *
      * @return array Hash representing parameters particular to impression event.
      */
     private function getImpressionParams(Experiment $experiment, $variation, $flagKey, $ruleKey, $ruleType, $enabled)
     {
         $variationKey = $variation->getKey() ? $variation->getKey() : '';
+        $experimentID = '';
+        $campaignID = '';
+        if ($experiment->getId()) {
+            $experimentID = $experiment->getId();
+            $campaignID = $experiment->getLayerId();
+        }
         $impressionParams = [
             DECISIONS => [
                 [
-                    CAMPAIGN_ID => $experiment->getLayerId(),
-                    EXPERIMENT_ID => $experiment->getId(),
+                    CAMPAIGN_ID => $campaignID,
+                    EXPERIMENT_ID => $experimentID,
                     VARIATION_ID => $variation->getId(),
                     METADATA => [
                         FLAG_KEY => $flagKey,
@@ -232,9 +243,14 @@ private function getConversionParams($eventEntity, $eventTags)
     public function createImpressionEvent($config, $experimentId, $variationKey, $flagKey, $ruleKey, $ruleType, $enabled, $userId, $attributes)
     {
         $eventParams = $this->getCommonParams($config, $userId, $attributes);
-
         $experiment = $config->getExperimentFromId($experimentId);
-        $variation = $config->getVariationFromKeyByExperimentId($experimentId, $variationKey);
+
+        if (empty($experimentId)) {
+            $variation = $config->getFlagVariationByKey($flagKey, $variationKey);
+        } else {
+            $variation = $config->getVariationFromKeyByExperimentId($experimentId, $variationKey);
+        }
+
         $impressionParams = $this->getImpressionParams($experiment, $variation, $flagKey, $ruleKey, $ruleType, $enabled);
 
         $eventParams[VISITORS][0][SNAPSHOTS][] = $impressionParams;

src/Optimizely/Optimizely.php

@@ -201,11 +201,15 @@ private function validateUserInputs($attributes, $eventTags = null)
     }
 
     /**
+     * @param  DatafileProjectConfig DatafileProjectConfig instance
      * @param  string        Experiment ID
      * @param  string        Variation key
+     * @param  string        Flag key
+     * @param  string        Rule key
+     * @param  string        Rule type
+     * @param  boolean       Feature enabled
      * @param  string        User ID
      * @param  array         Associative array of user attributes
-     * @param  DatafileProjectConfig DatafileProjectConfig instance
      */
     protected function sendImpressionEvent($config, $experimentId, $variationKey, $flagKey, $ruleKey, $ruleType, $enabled, $userId, $attributes)
     {
@@ -347,22 +351,32 @@ public function decide(OptimizelyUserContext $userContext, $key, array $decideOp
         $decisionEventDispatched = false;
 
         // get decision
-        $decision = $this->_decisionService->getVariationForFeature(
-            $config,
-            $featureFlag,
-            $userId,
-            $userAttributes,
-            $decideOptions
-        );
+        $decision = null;
+        // check forced-decisions first
+        list($forcedDecisionResponse, $reasons) = $userContext->findValidatedForcedDecision($flagKey, $ruleKey, $decideOptions);
+        $decideReasons = array_merge($decideReasons, $reasons);
+        if ($forcedDecisionResponse) {
+            $decision = new FeatureDecision(null, $forcedDecisionResponse, FeatureDecision::DECISION_SOURCE_FEATURE_TEST, $decideReasons);
+        } else {
+            // regular decision
+            $decision = $this->_decisionService->getVariationForFeature(
+                $config,
+                $featureFlag,
+                $userContext,
+                $decideOptions
+            );
+        }
 
         $decideReasons = $decision->getReasons();
         $variation = $decision->getVariation();
 
         if ($variation) {
             $variationKey = $variation->getKey();
             $featureEnabled = $variation->getFeatureEnabled();
-            $ruleKey = $decision->getExperiment()->getKey();
-            $experimentId = $decision->getExperiment()->getId();
+            if ($decision->getExperiment()) {
+                $ruleKey = $decision->getExperiment()->getKey();
+                $experimentId = $decision->getExperiment()->getId();
+            }
         } else {
             $variationKey = null;
             $ruleKey = null;
@@ -687,7 +701,8 @@ public function getVariation($experimentKey, $userId, $attributes = null)
             return null;
         }
 
-        list($variation, $reasons) = $this->_decisionService->getVariation($config, $experiment, $userId, $attributes);
+        $userContext = $this->createUserContext($userId, $attributes ? $attributes : []);
+        list($variation, $reasons) = $this->_decisionService->getVariation($config, $experiment, $userContext);
         $variationKey = ($variation === null) ? null : $variation->getKey();
 
         if ($config->isFeatureExperiment($experiment->getId())) {
@@ -815,7 +830,8 @@ public function isFeatureEnabled($featureFlagKey, $userId, $attributes = null)
         }
 
         $featureEnabled = false;
-        $decision = $this->_decisionService->getVariationForFeature($config, $featureFlag, $userId, $attributes);
+        $userContext = $this->createUserContext($userId, $attributes?: []);
+        $decision = $this->_decisionService->getVariationForFeature($config, $featureFlag, $userContext);
         $variation = $decision->getVariation();
 
         if ($config->getSendFlagDecisions() && ($decision->getSource() == FeatureDecision::DECISION_SOURCE_ROLLOUT || !$variation)) {
@@ -948,8 +964,8 @@ public function getFeatureVariableValueForType(
             // Error logged in DatafileProjectConfig - getFeatureFlagFromKey
             return null;
         }
-
-        $decision = $this->_decisionService->getVariationForFeature($config, $featureFlag, $userId, $attributes);
+        $userContext = $this->createUserContext($userId, $attributes? $attributes : []);
+        $decision = $this->_decisionService->getVariationForFeature($config, $featureFlag, $userContext);
         $variation = $decision->getVariation();
         $experiment = $decision->getExperiment();
         $featureEnabled = $variation !== null ? $variation->getFeatureEnabled() : false;
@@ -1124,7 +1140,7 @@ public function getAllFeatureVariables($featureFlagKey, $userId, $attributes = n
             return null;
         }
 
-        $decision = $this->_decisionService->getVariationForFeature($config, $featureFlag, $userId, $attributes);
+        $decision = $this->_decisionService->getVariationForFeature($config, $featureFlag, $this->createUserContext($userId, $attributes));
         $variation = $decision->getVariation();
         $experiment = $decision->getExperiment();
         $featureEnabled = $variation !== null ? $variation->getFeatureEnabled() : false;
@@ -1281,4 +1297,17 @@ protected function validateInputs(array $values, $logLevel = Logger::ERROR)
 
         return $isValid;
     }
+
+    /**
+     * Gets the variation associated with experiment or rollout in instance of given feature flag key
+     *
+     * @param string Feature flag key
+     * @param string variation key
+     *
+     * @return Variation / null
+     */
+    public function getFlagVariationByKey($flagKey, $variationKey)
+    {
+        return $this->getConfig()->getFlagVariationByKey($flagKey, $variationKey);
+    }
 }