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

src/Optimizely/DecisionService/DecisionService.php

@@ -407,7 +407,7 @@ public function getVariationFromDeliveryRule(ProjectConfigInterface $projectConf
         $skipToEveryoneElse = false;
         // check forced-decision first
         $rule = $rules[$ruleIndex];
-        list($forcedDecisionResponse, $reasons) = $user->findValidatedForcedDecision($flagKey, $rule->getKey(), $options);
+        list($forcedDecisionResponse, $reasons) = $user->findValidatedForcedDecision($flagKey, $rule->getKey());
 
         $decideReasons = array_merge($decideReasons, $reasons);
         if ($forcedDecisionResponse) {

src/Optimizely/Optimizely.php

@@ -353,8 +353,7 @@ public function decide(OptimizelyUserContext $userContext, $key, array $decideOp
         // get decision
         $decision = null;
         // check forced-decisions first
-        list($forcedDecisionResponse, $reasons) = $userContext->findValidatedForcedDecision($flagKey, $ruleKey, $decideOptions);
-        $decideReasons = array_merge($decideReasons, $reasons);
+        list($forcedDecisionResponse, $reasons) = $userContext->findValidatedForcedDecision($flagKey, $ruleKey);
         if ($forcedDecisionResponse) {
             $decision = new FeatureDecision(null, $forcedDecisionResponse, FeatureDecision::DECISION_SOURCE_FEATURE_TEST, $decideReasons);
         } else {
@@ -366,8 +365,8 @@ public function decide(OptimizelyUserContext $userContext, $key, array $decideOp
                 $decideOptions
             );
         }
-
-        $decideReasons = $decision->getReasons();
+        $decideReasons = array_merge($decideReasons, $reasons);
+        $decideReasons = array_merge($decideReasons, $decision->getReasons());
         $variation = $decision->getVariation();
 
         if ($variation) {
@@ -1263,7 +1262,14 @@ private function getFeatureVariableValueFromVariation($featureFlagKey, $variable
      */
     public function isValid()
     {
-        return $this->getConfig() !== null;
+        if (!$this->getConfig()) {
+            $this->_logger->log(
+                Logger::ERROR,
+                "Optimizely SDK not configured properly yet."
+            );
+            return false;
+        }
+        return true;
     }
 
     /**

src/Optimizely/OptimizelyUserContext.php

@@ -35,77 +35,76 @@ public function __construct(Optimizely $optimizelyClient, $userId, array $attrib
         $this->forcedDecisions = $forcedDecisions;
     }
 
-    public function removeForcedDecision($flagKey, $ruleKey = null)
+    public function setForcedDecision($flagKey, $ruleKey, $variationKey)
     {
         // check if SDK is ready
         if (!$this->optimizelyClient->isValid()) {
             return false;
         }
+        if (empty($flagKey)) {
+            return false;
+        }
         $index = $this->findExistingRuleAndFlagKey($flagKey, $ruleKey);
         if ($index != -1) {
-            array_splice($this->forcedDecisions, $index, 1);
-            return true;
+            $this->forcedDecisions[$index]->setVariationKey($variationKey);
+        } else {
+            if (!$this->forcedDecisions) {
+                $this->forcedDecisions = array();
+            }
+            array_push($this->forcedDecisions, new ForcedDecision($flagKey, $ruleKey, $variationKey));
         }
-        return false;
+        return true;
     }
 
-    public function removeAllForcedDecisions()
+    public function getForcedDecision($flagKey, $ruleKey = null)
     {
         // check if SDK is ready
         if (!$this->optimizelyClient->isValid()) {
-            return false;
+            return null;
         }
-
-        $this->forcedDecisions = [];
-        return true;
+        return $this->findForcedDecision($flagKey, $ruleKey);
     }
 
-    public function setForcedDecision($flagKey, $variationKey, $ruleKey = null)
+    public function removeForcedDecision($flagKey, $ruleKey = null)
     {
         // check if SDK is ready
         if (!$this->optimizelyClient->isValid()) {
             return false;
         }
-        if (empty($flagKey)) {
-            return false;
-        }
         $index = $this->findExistingRuleAndFlagKey($flagKey, $ruleKey);
         if ($index != -1) {
-            $this->forcedDecisions[$index]->setVariationKey($variationKey);
-        } else {
-            if (!$this->forcedDecisions) {
-                $this->forcedDecisions = array();
-            }
-            array_push($this->forcedDecisions, new ForcedDecision($flagKey, $ruleKey, $variationKey));
+            array_splice($this->forcedDecisions, $index, 1);
+            return true;
         }
-        return true;
+        return false;
     }
 
-    public function getForcedDecision($flagKey, $ruleKey = null)
+    public function removeAllForcedDecisions()
     {
         // check if SDK is ready
         if (!$this->optimizelyClient->isValid()) {
-            return null;
+            return false;
         }
-        return $this->findForcedDecision($flagKey, $ruleKey);
+
+        $this->forcedDecisions = [];
+        return true;
     }
 
-    public function findValidatedForcedDecision($flagKey, $ruleKey, array $options = [])
+    public function findValidatedForcedDecision($flagKey, $ruleKey)
     {
         $decideReasons = [];
         $variationKey = $this->findForcedDecision($flagKey, $ruleKey);
+        $variation = null;
         if ($variationKey) {
             $variation = $this->optimizelyClient->getFlagVariationByKey($flagKey, $variationKey);
-            $message = sprintf('Variation "%s" is mapped to %s and user "%s" in the forced decision map.', $variationKey, $ruleKey? 'flag "'.$flagKey.'", rule "'.$ruleKey.'"': 'flag "'.$flagKey.'"', $this->userId);
-
-            $decideReasons[] = $message;
-            return [$variation, $decideReasons];
-        } else {
-            $message = sprintf('Invalid variation is mapped to %s and user "%s" in the forced decision map.', $ruleKey? 'flag "'.$flagKey.'", rule "'.$ruleKey.'"': 'flag "'.$flagKey.'"', $this->userId);
-
-            $decideReasons[] = $message;
+            if ($variation) {
+                array_push($decideReasons, 'Decided by forced decision.');
+                array_push($decideReasons, sprintf('Variation "%s" is mapped to %s and user "%s" in the forced decision map.', $variationKey, $ruleKey? 'flag "'.$flagKey.'", rule "'.$ruleKey.'"': 'flag "'.$flagKey.'"', $this->userId));
+            } else {
+                array_push($decideReasons, sprintf('Invalid variation is mapped to %s and user "%s" in the forced decision map.', $ruleKey? 'flag "'.$flagKey.'", rule "'.$ruleKey.'"': 'flag "'.$flagKey.'"', $this->userId));
+            }
         }
-        return [null, $decideReasons];
+        return [$variation, $decideReasons];
     }
 
     private function findExistingRuleAndFlagKey($flagKey, $ruleKey)
@@ -123,7 +122,10 @@ private function findExistingRuleAndFlagKey($flagKey, $ruleKey)
     public function findForcedDecision($flagKey, $ruleKey)
     {
         $foundVariationKey = null;
-        if ($this->forcedDecisions && count($this->forcedDecisions) == 0) {
+        if (!$this->forcedDecisions) {
+            return null;
+        }
+        if (count($this->forcedDecisions) == 0) {
             return null;
         }
         $index = $this->findExistingRuleAndFlagKey($flagKey, $ruleKey);

tests/ConfigTests/DatafileProjectConfigTest.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright 2016-2020,2021, Optimizely
+ * Copyright 2016-2020, 2021, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

tests/DecisionServiceTests/DecisionServiceTest.php

@@ -1080,11 +1080,9 @@ public function testGetVariationForFeatureRolloutWhenUserIsNotBucketedInTheTarge
             $expected_variation,
             FeatureDecision::DECISION_SOURCE_ROLLOUT,
             [
-                'Invalid variation is mapped to flag "boolean_single_variable_feature", rule "rollout_1_exp_1" and user "user_1" in the forced decision map.',
                 'Audiences for rule 1 collectively evaluated to TRUE.',
                 'User "user_1" meets condition for targeting rule "1".',
                 'User "user_1" is not in the traffic group for targeting rule "1". Checking Everyone Else rule now.',
-                'Invalid variation is mapped to flag "boolean_single_variable_feature", rule "rollout_1_exp_3" and user "user_1" in the forced decision map.',
                 'Audiences for rule Everyone Else collectively evaluated to TRUE.',
                 'User "user_1" meets condition for targeting rule "Everyone Else".',
                 'User "user_1" is in the traffic group of targeting rule "Everyone Else".'
@@ -1168,13 +1166,10 @@ public function testGetVariationForFeatureRolloutWhenUserDoesNotQualifyForAnyTar
             $expected_variation,
             FeatureDecision::DECISION_SOURCE_ROLLOUT,
             [
-                'Invalid variation is mapped to flag "boolean_single_variable_feature", rule "rollout_1_exp_1" and user "user_1" in the forced decision map.',
                 'Audiences for rule 1 collectively evaluated to FALSE.' ,
                 'User "user_1" does not meet conditions for targeting rule "1".',
-                'Invalid variation is mapped to flag "boolean_single_variable_feature", rule "rollout_1_exp_2" and user "user_1" in the forced decision map.',
                 'Audiences for rule 2 collectively evaluated to FALSE.',
                 'User "user_1" does not meet conditions for targeting rule "2".',
-                'Invalid variation is mapped to flag "boolean_single_variable_feature", rule "rollout_1_exp_3" and user "user_1" in the forced decision map.',
                 'Audiences for rule Everyone Else collectively evaluated to TRUE.',
                 'User "user_1" meets condition for targeting rule "Everyone Else".',
                 'User "user_1" is in the traffic group of targeting rule "Everyone Else".'
@@ -1262,13 +1257,10 @@ public function testGetVariationForFeatureRolloutLogging()
             $expected_variation,
             FeatureDecision::DECISION_SOURCE_ROLLOUT,
             [
-                'Invalid variation is mapped to flag "boolean_single_variable_feature", rule "rollout_1_exp_1" and user "user_1" in the forced decision map.',
                 'Audiences for rule 1 collectively evaluated to FALSE.',
                 'User "user_1" does not meet conditions for targeting rule "1".',
-                'Invalid variation is mapped to flag "boolean_single_variable_feature", rule "rollout_1_exp_2" and user "user_1" in the forced decision map.',
                 'Audiences for rule 2 collectively evaluated to FALSE.',
                 'User "user_1" does not meet conditions for targeting rule "2".',
-                'Invalid variation is mapped to flag "boolean_single_variable_feature", rule "rollout_1_exp_3" and user "user_1" in the forced decision map.',
                 'Audiences for rule Everyone Else collectively evaluated to TRUE.',
                 'User "user_1" meets condition for targeting rule "Everyone Else".',
                 'User "user_1" is in the traffic group of targeting rule "Everyone Else".'

tests/OptimizelyTest.php

@@ -551,7 +551,7 @@ public function testSetForcedDecisionExperimentRuleToDecisionSendImpressionAndNo
 
         $optimizelyMock->notificationCenter = $this->notificationCenterMock;
 
-        $this->assertTrue($userContext->setForcedDecision('double_single_variable_feature', 'variation', 'test_experiment_double_feature'));
+        $this->assertTrue($userContext->setForcedDecision('double_single_variable_feature', 'test_experiment_double_feature', 'variation'));
         $optimizelyDecision = $optimizelyMock->decide($userContext, 'double_single_variable_feature');
         $expectedOptimizelyDecision = new OptimizelyDecision(
             'variation',
@@ -642,7 +642,7 @@ public function testSetForcedDecisionDeliveryRuleToDecisionSendImpressionAndNoti
 
         $optimizelyMock->notificationCenter = $this->notificationCenterMock;
 
-        $this->assertTrue($userContext->setForcedDecision('boolean_single_variable_feature', '177773', 'rollout_1_exp_2'));
+        $this->assertTrue($userContext->setForcedDecision('boolean_single_variable_feature', 'rollout_1_exp_2', '177773'));
         $optimizelyDecision = $optimizelyMock->decide($userContext, 'boolean_single_variable_feature');
         $expectedOptimizelyDecision = new OptimizelyDecision(
             '177773',
@@ -722,7 +722,7 @@ public function testSetForcedDecisionFlagToDecisionSendImpressionAndNotification
 
         $optimizelyMock->notificationCenter = $this->notificationCenterMock;
 
-        $this->assertTrue($userContext->setForcedDecision('double_single_variable_feature', 'variation'));
+        $this->assertTrue($userContext->setForcedDecision('double_single_variable_feature', null, 'variation'));
         $optimizelyDecision = $optimizelyMock->decide($userContext, 'double_single_variable_feature');
         $expectedOptimizelyDecision = new OptimizelyDecision(
             'variation',
@@ -1914,7 +1914,6 @@ public function testDecideOptionIncludeReasons()
             ->getMock();
 
         $expectedReasons = [
-            'Invalid variation is mapped to flag "double_single_variable_feature", rule "test_experiment_double_feature" and user "test_user" in the forced decision map.',
             'Audiences for experiment "test_experiment_double_feature" collectively evaluated to TRUE.',
             'Assigned bucket 4513 to user "test_user" with bucketing ID "test_user".',
             'User "test_user" is in variation control of experiment test_experiment_double_feature.',
@@ -1987,7 +1986,6 @@ public function testDecideLogsWhenAudienceEvalFails()
             ->getMock();
 
         $expectedReasons = [
-            'Invalid variation is mapped to flag "multi_variate_feature", rule "test_experiment_multivariate" and user "test_user" in the forced decision map.',
             'Audiences for experiment "test_experiment_multivariate" collectively evaluated to FALSE.',
             'User "test_user" does not meet conditions to be in experiment "test_experiment_multivariate".',
             "The user 'test_user' is not bucketed into any of the experiments using the feature 'multi_variate_feature'.",