refact: user context is cloned when passed to Decide APIs in Optimizely Class

.travis.yml

@@ -6,7 +6,7 @@ php:
   - '7.0'
   - '7.1'
   - '7.2'
-  - '7.3'
+  - '7.3.24' # revert it back to 7.3 once 7.3.25 latest build gets fixed.
 install: "composer install"
 script:
 - mkdir -p build/logs

src/Optimizely/Bucketer.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright 2016-2020, Optimizely
+ * Copyright 2016-2021, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -110,23 +110,26 @@ protected function generateBucketValue($bucketingKey)
      * @param $parentId mixed ID representing Experiment or Group.
      * @param $trafficAllocations array Traffic allocations for variation or experiment.
      *
-     * @return string ID representing experiment or variation.
+     * @return [ string, array ]  ID representing experiment or variation and array of log messages representing decision making.
      */
     private function findBucket($bucketingId, $userId, $parentId, $trafficAllocations)
     {
+        $decideReasons = [];
         // Generate the bucketing key based on combination of user ID and experiment ID or group ID.
         $bucketingKey = $bucketingId.$parentId;
         $bucketingNumber = $this->generateBucketValue($bucketingKey);
-        $this->_logger->log(Logger::DEBUG, sprintf('Assigned bucket %s to user "%s" with bucketing ID "%s".', $bucketingNumber, $userId, $bucketingId));
+        $message = sprintf('Assigned bucket %s to user "%s" with bucketing ID "%s".', $bucketingNumber, $userId, $bucketingId);
+        $this->_logger->log(Logger::DEBUG, $message);
+        $decideReasons[] = $message;
 
         foreach ($trafficAllocations as $trafficAllocation) {
             $currentEnd = $trafficAllocation->getEndOfRange();
             if ($bucketingNumber < $currentEnd) {
-                return $trafficAllocation->getEntityId();
+                return [$trafficAllocation->getEntityId(), $decideReasons];
             }
         }
 
-        return null;
+        return [null, $decideReasons];
     }
 
     /**
@@ -137,12 +140,14 @@ private function findBucket($bucketingId, $userId, $parentId, $trafficAllocation
      * @param $bucketingId string A customer-assigned value used to create the key for the murmur hash.
      * @param $userId string User identifier.
      *
-     * @return Variation Variation which will be shown to the user.
+     * @return [ Variation, array ]  Variation which will be shown to the user and array of log messages representing decision making.
      */
     public function bucket(ProjectConfigInterface $config, Experiment $experiment, $bucketingId, $userId)
     {
+        $decideReasons = [];
+
         if (is_null($experiment->getKey())) {
-            return null;
+            return [ null, $decideReasons ];
         }
 
         // Determine if experiment is in a mutually exclusive group.
@@ -151,47 +156,52 @@ public function bucket(ProjectConfigInterface $config, Experiment $experiment, $
             $group = $config->getGroup($experiment->getGroupId());
 
             if (is_null($group->getId())) {
-                return null;
+                return [ null, $decideReasons ];
             }
 
-            $userExperimentId = $this->findBucket($bucketingId, $userId, $group->getId(), $group->getTrafficAllocation());
+            list($userExperimentId, $reasons) = $this->findBucket($bucketingId, $userId, $group->getId(), $group->getTrafficAllocation());
+            $decideReasons = array_merge($decideReasons, $reasons);
+
             if (empty($userExperimentId)) {
-                $this->_logger->log(Logger::INFO, sprintf('User "%s" is in no experiment.', $userId));
-                return null;
+                $message = sprintf('User "%s" is in no experiment.', $userId);
+                $this->_logger->log(Logger::INFO, $message);
+                $decideReasons[] = $message;
+                return [ null, $decideReasons ];
             }
 
             if ($userExperimentId != $experiment->getId()) {
-                $this->_logger->log(
-                    Logger::INFO,
-                    sprintf(
-                        'User "%s" is not in experiment %s of group %s.',
-                        $userId,
-                        $experiment->getKey(),
-                        $experiment->getGroupId()
-                    )
-                );
-                return null;
-            }
-
-            $this->_logger->log(
-                Logger::INFO,
-                sprintf(
-                    'User "%s" is in experiment %s of group %s.',
+                $message = sprintf(
+                    'User "%s" is not in experiment %s of group %s.',
                     $userId,
                     $experiment->getKey(),
                     $experiment->getGroupId()
-                )
+                );
+
+                $this->_logger->log(Logger::INFO, $message);
+                $decideReasons[] = $message;
+                return [ null, $decideReasons ];
+            }
+
+            $message = sprintf(
+                'User "%s" is in experiment %s of group %s.',
+                $userId,
+                $experiment->getKey(),
+                $experiment->getGroupId()
             );
+
+            $this->_logger->log(Logger::INFO, $message);
+            $decideReasons[] = $message;
         }
 
         // Bucket user if not in whitelist and in group (if any).
-        $variationId = $this->findBucket($bucketingId, $userId, $experiment->getId(), $experiment->getTrafficAllocation());
+        list($variationId, $reasons) = $this->findBucket($bucketingId, $userId, $experiment->getId(), $experiment->getTrafficAllocation());
+        $decideReasons = array_merge($decideReasons, $reasons);
         if (!empty($variationId)) {
             $variation = $config->getVariationFromId($experiment->getKey(), $variationId);
 
-            return $variation;
+            return [ $variation, $decideReasons ];
         }
 
-        return null;
+        return [ null, $decideReasons ];
     }
 }

src/Optimizely/Decide/OptimizelyDecideOption.php

@@ -0,0 +1,27 @@
+<?php
+/**
+ * Copyright 2021, Optimizely
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace Optimizely\Decide;
+
+class OptimizelyDecideOption
+{
+    const DISABLE_DECISION_EVENT = 'DISABLE_DECISION_EVENT';
+    const ENABLED_FLAGS_ONLY = 'ENABLED_FLAGS_ONLY';
+    const IGNORE_USER_PROFILE_SERVICE = 'IGNORE_USER_PROFILE_SERVICE';
+    const INCLUDE_REASONS = 'INCLUDE_REASONS';
+    const EXCLUDE_VARIABLES = 'EXCLUDE_VARIABLES';
+}

src/Optimizely/Decide/OptimizelyDecision.php

@@ -0,0 +1,88 @@
+<?php
+/**
+ * Copyright 2021, Optimizely
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace Optimizely\Decide;
+
+class OptimizelyDecision implements \JsonSerializable
+{
+    private $variationKey;
+    private $enabled;
+    private $variables;
+    private $ruleKey;
+    private $flagKey;
+    private $userContext;
+    private $reasons;
+
+
+    public function __construct(
+        $variationKey = null,
+        $enabled = null,
+        $variables = null,
+        $ruleKey = null,
+        $flagKey = null,
+        $userContext = null,
+        $reasons = null
+    ) {
+        $this->variationKey = $variationKey;
+        $this->enabled = $enabled === null ? false : $enabled;
+        $this->variables = $variables === null ? [] : $variables;
+        $this->ruleKey = $ruleKey;
+        $this->flagKey = $flagKey;
+        $this->userContext = $userContext;
+        $this->reasons = $reasons === null ? [] : $reasons;
+    }
+
+    public function getVariationKey()
+    {
+        return $this->variationKey;
+    }
+
+    public function getEnabled()
+    {
+        return $this->enabled;
+    }
+
+    public function getVariables()
+    {
+        return $this->variables;
+    }
+
+    public function getRuleKey()
+    {
+        return $this->ruleKey;
+    }
+
+    public function getFlagKey()
+    {
+        return $this->flagKey;
+    }
+
+    public function getUserContext()
+    {
+        return $this->userContext;
+    }
+
+    public function getReasons()
+    {
+        return $this->reasons;
+    }
+
+    public function jsonSerialize()
+    {
+        return get_object_vars($this);
+    }
+}

src/Optimizely/Decide/OptimizelyDecisionMessage.php

@@ -0,0 +1,25 @@
+<?php
+/**
+ * Copyright 2021, Optimizely
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace Optimizely\Decide;
+
+class OptimizelyDecisionMessage
+{
+    const SDK_NOT_READY = 'Optimizely SDK not configured properly yet.';
+    const FLAG_KEY_INVALID = 'No flag was found for key "%s".';
+    const VARIABLE_VALUE_INVALID = 'Variable value for key "%s" is invalid or wrong type.';
+}