Add decide for keys; update other decide classes

optimizely · Mat001 · Jun 26, 2023 · May 30, 2023 · May 30, 2023 · May 30, 2023
commit 626c7d4a6f3bad28a45626657810c695e3a37907
diff --git a/bug-bash/Decide.php b/bug-bash/Decide.php
@@ -65,7 +65,7 @@ public function testWithVariationsOfDecideOptions(): void
     // verify in logs that impression event of this decision was dispatched
     public function verifyLogsImpressionsEventsDispatched(): void
     {
-        // Create a new flag with an A/B Test eg "product_version"
+        // 💡️ Create a new flag with an A/B Test eg "product_version"
         $featureFlagKey = 'product_version';
         $logger = new DefaultLogger(Logger::DEBUG);
         $localOptimizelyClient = new Optimizely(datafile: null, logger: $logger, sdkKey: SDK_KEY);
@@ -79,15 +79,15 @@ public function verifyLogsImpressionsEventsDispatched(): void
     // verify on Results page that impression even was created
     public function verifyResultsPageInYourProjectShowsImpressionEvent(): void
     {
-        print "Go to your project's results page and verify decisions events are showing (might be a 5 min delay)";
+        print "Go to your project's results page and verify decisions events are showing (5 min delay)";
     }
 
     // verify that decision listener contains correct information
     public function verifyDecisionListenerWasCalled(): void
     {
         // Check that this was called during the...
         $onDecision = function ($type, $userId, $attributes, $decisionInfo) {
-            print ">>> [NotificationCenter] OnDecision:
+            print ">>> [$this->outputTag] OnDecision:
             type: $type,
             userId: $userId,
             attributes: " . print_r($attributes, true) . "
@@ -117,6 +117,7 @@ public function verifyAnInvalidFlagKeyIsHandledCorrectly(): void
     private Optimizely $optimizelyClient;
     private string $userId;
     private ?OptimizelyUserContext $userContext;
+    private string $outputTag = "Decide";
 
     public function __construct()
     {
@@ -131,7 +132,7 @@ private function printDecision($decision, $message): void
     {
         $enabled = $decision->getEnabled() ? "true" : "false";
 
-        print ">>> [Decision] $message: 
+        print ">>> [$this->outputTag] $message: 
             enabled: $enabled, 
             flagKey: {$decision->getFlagKey()}, 
             ruleKey: {$decision->getRuleKey()}, 

diff --git a/bug-bash/DecideAll.php b/bug-bash/DecideAll.php
@@ -63,14 +63,14 @@ public function testWithVariousCombinationsOfOptions(): void
     // verify in logs that impression event of this decision was dispatched
     public function verifyLogImpressionEventDispatched(): void
     {
-        // *** Be sure you have >=1 of your project's flags has an EXPERIMENT type
+        // 💡️ Be sure you have >=1 of your project's flags has an EXPERIMENT type
         $logger = new DefaultLogger(Logger::DEBUG);
         $localOptimizelyClient = new Optimizely(datafile: null, logger: $logger, sdkKey: SDK_KEY);
         $localUserContext = $localOptimizelyClient->createUserContext($this->userId);
 
         // review the DEBUG output, ensuring you see an impression log for each *EXPERIMENT* with a message like
         // "Dispatching impression event to URL https://logx.optimizely.com/v1/events with params..."
-        // Rollout flag types will not dispatch and impression event
+        // ⚠️ Rollout flag types should not dispatch and impression event
         $localUserContext->decideAll();
     }
 
@@ -85,7 +85,7 @@ public function verifyDecisionListenerContainsCorrectInformation(): void
     {
         // Check that this was called for each of your project flag keys
         $onDecision = function ($type, $userId, $attributes, $decisionInfo) {
-            print ">>> [NotificationCenter] OnDecision:
+            print ">>> [$this->outputTag] OnDecision:
             type: $type,
             userId: $userId,
             attributes: " . print_r($attributes, true) . "
@@ -102,6 +102,7 @@ public function verifyDecisionListenerContainsCorrectInformation(): void
     private Optimizely $optimizelyClient;
     private string $userId;
     private ?OptimizelyUserContext $userContext;
+    private string $outputTag = "Decide All";
 
     public function __construct()
     {
@@ -118,7 +119,7 @@ private function printDecisions($decisions, $message): void
         foreach ($decisions as $decision) {
             $enabled = $decision->getEnabled() ? "true" : "false";
 
-            print ">>> [Decision #$count] $message: 
+            print ">>> [$this->outputTag #$count] $message: 
                 enabled: $enabled, 
                 flagKey: {$decision->getFlagKey()}, 
                 ruleKey: {$decision->getRuleKey()}, 

diff --git a/bug-bash/DecideForKeys.php b/bug-bash/DecideForKeys.php
@@ -17,13 +17,18 @@
 const SDK_KEY = 'K4UmaV5Pk7cEh2hbcjgwe';
 
 // 2. Check that you have 3+ flag keys in your project and add them here
-const FLAG_KEYS = ['product_sort', 'marketing_banner'];
+const FLAG_KEYS = ['product_sort', 'marketing_banner', 'product_version'];
 
 // 3. Uncomment each scenario 1 by 1 modifying the contents of the method
 // to test additional scenarios.
 
 $test = new DecideForKeysTests();
-
+$test->verifyDecisionProperties();
+ $test->testWithVariationsOfDecideOptions();
+ $test->verifyLogsImpressionsEventsDispatched();
+ $test->verifyResultsPageInYourProjectShowsImpressionEvent();
+ $test->verifyDecisionListenerWasCalled();
+ $test->verifyAnInvalidFlagKeyIsHandledCorrectly();
 
 // 4. Change the current folder into the bug-bash directory if you've not already
 // cd bug-bash/
@@ -34,9 +39,86 @@
 class DecideForKeysTests
 {
 
+    // verify decision return properties with default DecideOptions
+    public function verifyDecisionProperties(): void
+    {
+        $decision = $this->userContext->decideForKeys(FLAG_KEYS);
+
+        $this->printDecisions($decision, "Check that the following decisions' properties are expected");
+    }
+
+    // test decide w all options: DISABLE_DECISION_EVENT, ENABLED_FLAGS_ONLY, IGNORE_USER_PROFILE_SERVICE, INCLUDE_REASONS, EXCLUDE_VARIABLES (will need to add variables)
+    public function testWithVariationsOfDecideOptions(): void
+    {
+        $options = [
+            OptimizelyDecideOption::INCLUDE_REASONS,
+            // OptimizelyDecideOption::DISABLE_DECISION_EVENT,
+            // OptimizelyDecideOption::ENABLED_FLAGS_ONLY,   //  ⬅️ Disable some of your flags
+            // OptimizelyDecideOption::IGNORE_USER_PROFILE_SERVICE,
+            // OptimizelyDecideOption::EXCLUDE_VARIABLES,
+        ];
+
+        $decision = $this->userContext->decideForKeys(FLAG_KEYS, $options);
+
+        $this->printDecisions($decision, "Modify the OptimizelyDecideOptions and check all the decisions' are as expected");
+    }
+
+    // verify in logs that impression event of this decision was dispatched
+    public function verifyLogsImpressionsEventsDispatched(): void
+    {
+        // 💡️ Be sure that your FLAG_KEYS array above includes A/B Test eg "product_version"
+        $logger = new DefaultLogger(Logger::DEBUG);
+        $localOptimizelyClient = new Optimizely(datafile: null, logger: $logger, sdkKey: SDK_KEY);
+        $localUserContext = $localOptimizelyClient->createUserContext($this->userId);
+
+        // review the DEBUG output, ensuring you see an impression log for each experiment type in your FLAG_KEYS
+        // "Dispatching impression event to URL https://logx.optimizely.com/v1/events with params..."
+        // ⚠️ Your Rollout type flags should not have impression events
+        $localUserContext->decideForKeys(FLAG_KEYS);
+    }
+
+    // verify on Results page that impression even was created
+    public function verifyResultsPageInYourProjectShowsImpressionEvent(): void
+    {
+        print "Go to your project's results page and verify decisions events are showing (5 min delay)";
+    }
+
+    // verify that decision listener contains correct information
+    public function verifyDecisionListenerWasCalled(): void
+    {
+        // Check that this was called during the...
+        $onDecision = function ($type, $userId, $attributes, $decisionInfo) {
+            print ">>> [$this->outputTag] OnDecision:
+            type: $type,
+            userId: $userId,
+            attributes: " . print_r($attributes, true) . "
+            decisionInfo: " . print_r($decisionInfo, true) . "\r\n";
+        };
+        $this->optimizelyClient->notificationCenter->addNotificationListener(
+            NotificationType::DECISION,
+            $onDecision
+        );
+
+        // ...decide.
+        $this->userContext->decide(FLAG_KEY);
+    }
+
+    // verify that invalid flag key is handled correctly
+    public function verifyAnInvalidFlagKeyIsHandledCorrectly(): void
+    {
+        $logger = new DefaultLogger(Logger::ERROR);
+        $localOptimizelyClient = new Optimizely(datafile: null, logger: $logger, sdkKey: SDK_KEY);
+        $userId = 'user-' . mt_rand(10, 99);
+        $localUserContext = $localOptimizelyClient->createUserContext($userId);
+
+        // ensure you see an error -- Optimizely.ERROR: FeatureFlag Key "a_key_not_in_the_project" is not in datafile.
+        $localUserContext->decide("a_key_not_in_the_project");
+    }
+
     private Optimizely $optimizelyClient;
     private string $userId;
     private ?OptimizelyUserContext $userContext;
+    private string $outputTag = "Decide For Keys";
 
     public function __construct()
     {
@@ -53,7 +135,7 @@ private function printDecisions($decisions, $message): void
         foreach ($decisions as $decision) {
             $enabled = $decision->getEnabled() ? "true" : "false";
 
-            print ">>> [Decision #$count] $message: 
+            print ">>> [$this->outputTag #$count] $message: 
                 enabled: $enabled, 
                 flagKey: {$decision->getFlagKey()}, 
                 ruleKey: {$decision->getRuleKey()},