fix(logs): Fixing log messages

src/Optimizely/Bucketer.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright 2016-2019, Optimizely
+ * Copyright 2016-2020, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -133,7 +133,7 @@ private function findBucket($bucketingId, $userId, $parentId, $trafficAllocation
      * Determine variation the user should be put in.
      *
      * @param $config ProjectConfigInterface Configuration for the project.
-     * @param $experiment Experiment Experiment in which user is to be bucketed.
+     * @param $experiment Experiment Experiment or Rollout rule in which user is to be bucketed.
      * @param $bucketingId string A customer-assigned value used to create the key for the murmur hash.
      * @param $userId string User identifier.
      *
@@ -146,6 +146,7 @@ public function bucket(ProjectConfigInterface $config, Experiment $experiment, $
         }
 
         // Determine if experiment is in a mutually exclusive group.
+        // This will not affect evaluation of rollout rules.
         if ($experiment->isInMutexGroup()) {
             $group = $config->getGroup($experiment->getGroupId());
 
@@ -188,19 +189,9 @@ public function bucket(ProjectConfigInterface $config, Experiment $experiment, $
         if (!empty($variationId)) {
             $variation = $config->getVariationFromId($experiment->getKey(), $variationId);
 
-            $this->_logger->log(
-                Logger::INFO,
-                sprintf(
-                    'User "%s" is in variation %s of experiment %s.',
-                    $userId,
-                    $variation->getKey(),
-                    $experiment->getKey()
-                )
-            );
             return $variation;
         }
 
-        $this->_logger->log(Logger::INFO, sprintf('User "%s" is in no variation.', $userId));
         return null;
     }
 }

src/Optimizely/DecisionService/DecisionService.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright 2017-2019, Optimizely Inc and Contributors
+ * Copyright 2017-2020, Optimizely Inc and Contributors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -152,7 +152,7 @@ public function getVariation(ProjectConfigInterface $projectConfig, Experiment $
             }
         }
 
-        if (!Validator::isUserInExperiment($projectConfig, $experiment, $attributes, $this->_logger)) {
+        if (!Validator::doesUserMeetAudienceConditions($projectConfig, $experiment, $attributes, $this->_logger)) {
             $this->_logger->log(
                 Logger::INFO,
                 sprintf('User "%s" does not meet conditions to be in experiment "%s".', $userId, $experiment->getKey())
@@ -161,9 +161,21 @@ public function getVariation(ProjectConfigInterface $projectConfig, Experiment $
         }
 
         $variation = $this->_bucketer->bucket($projectConfig, $experiment, $bucketingId, $userId);
-        if (!is_null($variation)) {
+        if ($variation === null) {
+            $this->_logger->log(Logger::INFO, sprintf('User "%s" is in no variation.', $userId));
+        } else {
             $this->saveVariation($experiment, $variation, $userProfile);
+            $this->_logger->log(
+                Logger::INFO,
+                sprintf(
+                    'User "%s" is in variation %s of experiment %s.',
+                    $userId,
+                    $variation->getKey(),
+                    $experiment->getKey()
+                )
+            );
         }
+
         return $variation;
     }
 
@@ -298,40 +310,40 @@ public function getVariationForFeatureRollout(ProjectConfigInterface $projectCon
 
         // Evaluate all rollout rules except for last one
         for ($i = 0; $i < sizeof($rolloutRules) - 1; $i++) {
-            $experiment = $rolloutRules[$i];
+            $rolloutRule = $rolloutRules[$i];
 
             // Evaluate if user meets the audience condition of this rollout rule
-            if (!Validator::isUserInExperiment($projectConfig, $experiment, $userAttributes, $this->_logger)) {
+            if (!Validator::doesUserMeetAudienceConditions($projectConfig, $rolloutRule, $userAttributes, $this->_logger, 'Optimizely\Enums\RolloutAudienceEvaluationLogs', $i + 1)) {
                 $this->_logger->log(
                     Logger::DEBUG,
-                    sprintf("User '%s' did not meet the audience conditions to be in rollout rule '%s'.", $userId, $experiment->getKey())
+                    sprintf("User '%s' does not meet conditions for targeting rule %s.", $userId, $i+1)
                 );
                 // Evaluate this user for the next rule
                 continue;
             }
 
             // Evaluate if user satisfies the traffic allocation for this rollout rule
-            $variation = $this->_bucketer->bucket($projectConfig, $experiment, $bucketing_id, $userId);
+            $variation = $this->_bucketer->bucket($projectConfig, $rolloutRule, $bucketing_id, $userId);
             if ($variation && $variation->getKey()) {
-                return new FeatureDecision($experiment, $variation, FeatureDecision::DECISION_SOURCE_ROLLOUT);
+                return new FeatureDecision($rolloutRule, $variation, FeatureDecision::DECISION_SOURCE_ROLLOUT);
             }
             break;
         }
         // Evaluate Everyone Else Rule / Last Rule now
-        $experiment = $rolloutRules[sizeof($rolloutRules)-1];
+        $rolloutRule = $rolloutRules[sizeof($rolloutRules) - 1];
 
         // Evaluate if user meets the audience condition of Everyone Else Rule / Last Rule now
-        if (!Validator::isUserInExperiment($projectConfig, $experiment, $userAttributes, $this->_logger)) {
+        if (!Validator::doesUserMeetAudienceConditions($projectConfig, $rolloutRule, $userAttributes, $this->_logger, 'Optimizely\Enums\RolloutAudienceEvaluationLogs', 'Everyone Else')) {
             $this->_logger->log(
                 Logger::DEBUG,
-                sprintf("User '%s' did not meet the audience conditions to be in rollout rule '%s'.", $userId, $experiment->getKey())
+                sprintf("User '%s' does not meet conditions for targeting rule 'Everyone Else'.", $userId)
             );
             return null;
         }
 
-        $variation = $this->_bucketer->bucket($projectConfig, $experiment, $bucketing_id, $userId);
+        $variation = $this->_bucketer->bucket($projectConfig, $rolloutRule, $bucketing_id, $userId);
         if ($variation && $variation->getKey()) {
-            return new FeatureDecision($experiment, $variation, FeatureDecision::DECISION_SOURCE_ROLLOUT);
+            return new FeatureDecision($rolloutRule, $variation, FeatureDecision::DECISION_SOURCE_ROLLOUT);
         }
         return null;
     }

src/Optimizely/Enums/AudienceEvaluationLogs.php → src/Optimizely/Enums/CommonAudienceEvaluationLogs.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright 2019, Optimizely
+ * Copyright 2019-2020, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,11 +17,9 @@
 
 namespace Optimizely\Enums;
 
-class AudienceEvaluationLogs
+class CommonAudienceEvaluationLogs
 {
     const AUDIENCE_EVALUATION_RESULT = "Audience \"%s\" evaluated to %s.";
-    const AUDIENCE_EVALUATION_RESULT_COMBINED = "Audiences for experiment \"%s\" collectively evaluated to %s.";
-    const EVALUATING_AUDIENCES_COMBINED = "Evaluating audiences for experiment \"%s\": %s.";
     const EVALUATING_AUDIENCE = "Starting to evaluate audience \"%s\" with conditions: %s.";
     const INFINITE_ATTRIBUTE_VALUE = "Audience condition %s evaluated to UNKNOWN because the number value for user attribute \"%s\" is not in the range [-2^53, +2^53].";
     const MISSING_ATTRIBUTE_VALUE = "Audience condition %s evaluated to UNKNOWN because no value was passed for user attribute \"%s\".";

src/Optimizely/Enums/ExperimentAudienceEvaluationLogs.php

@@ -0,0 +1,24 @@
+<?php
+/**
+ * Copyright 2020, 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\Enums;
+
+class ExperimentAudienceEvaluationLogs extends CommonAudienceEvaluationLogs
+{
+    const AUDIENCE_EVALUATION_RESULT_COMBINED = "Audiences for experiment \"%s\" collectively evaluated to %s.";
+    const EVALUATING_AUDIENCES_COMBINED = "Evaluating audiences for experiment \"%s\": %s.";
+}

src/Optimizely/Enums/RolloutAudienceEvaluationLogs.php

@@ -0,0 +1,24 @@
+<?php
+/**
+ * Copyright 2020, 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\Enums;
+
+class RolloutAudienceEvaluationLogs extends CommonAudienceEvaluationLogs
+{
+    const AUDIENCE_EVALUATION_RESULT_COMBINED = "Audiences for rule %s collectively evaluated to %s.";
+    const EVALUATING_AUDIENCES_COMBINED = "Evaluating audiences for rule %s: %s.";
+}

src/Optimizely/Optimizely.php

@@ -931,7 +931,7 @@ private function getFeatureVariableValueFromVariation($featureFlagKey, $variable
         if ($variation === null) {
             $this->_logger->log(
                 Logger::INFO,
-                "User '{$userId}'is not in any variation, ".
+                "User '{$userId}' is not in experiment or rollout, ".
                 "returning default value '{$variableValue}'."
             );
         } else {
@@ -941,21 +941,20 @@ private function getFeatureVariableValueFromVariation($featureFlagKey, $variable
                     $variableValue = $variableUsage->getValue();
                     $this->_logger->log(
                         Logger::INFO,
-                        "Returning variable value '{$variableValue}' for variation '{$variation->getKey()}' ".
-                        "of feature flag '{$featureFlagKey}'"
+                        "Returning variable value '{$variableValue}' for variable key '{$variableKey}' ".
+                        "of feature flag '{$featureFlagKey}'."
                     );
                 } else {
                     $this->_logger->log(
                         Logger::INFO,
-                        "Variable '{$variableKey}' is not used in variation '{$variation->getKey()}', ".
-                        "returning default value '{$variableValue}'."
+                        "Variable value is not defined. Returning the default variable value '{$variableValue}'."
                     );
                 }
             } else {
                 $this->_logger->log(
                     Logger::INFO,
-                    "Feature '{$featureFlagKey}' for variation '{$variation->getKey()}' is not enabled, ".
-                    "returning default value '{$variableValue}'."
+                    "Feature '{$featureFlagKey}' is not enabled for user '{$userId}'. ".
+                    "Returning the default variable value '{$variableValue}'."
                 );
             }
         }

src/Optimizely/Utils/CustomAttributeConditionEvaluator.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright 2018-2019, Optimizely
+ * Copyright 2018-2020, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,7 +18,7 @@
 namespace Optimizely\Utils;
 
 use Monolog\Logger;
-use Optimizely\Enums\AudienceEvaluationLogs as logs;
+use Optimizely\Enums\CommonAudienceEvaluationLogs as logs;
 use Optimizely\Utils\Validator;
 
 class CustomAttributeConditionEvaluator

src/Optimizely/Utils/Validator.php

@@ -20,7 +20,6 @@
 use Monolog\Logger;
 use Optimizely\Config\ProjectConfigInterface;
 use Optimizely\Entity\Experiment;
-use Optimizely\Enums\AudienceEvaluationLogs;
 use Optimizely\Logger\LoggerInterface;
 use Optimizely\Utils\ConditionTreeEvaluator;
 use Optimizely\Utils\CustomAttributeConditionEvaluator;
@@ -133,30 +132,40 @@ public static function areEventTagsValid($eventTags)
 
     /**
      * @param $config ProjectConfigInterface Configuration for the project.
-     * @param $experiment Experiment Entity representing the experiment.
+     * @param $experiment Experiment Entity representing the experiment or rollout rule.
      * @param $userAttributes array Attributes of the user.
      * @param $logger LoggerInterface.
+     * @param $loggingClass String Class holding log strings with placeholders.
+     * @param $loggingKey String Identifier of an experiment/rollout rule.
      *
      * @return boolean Representing whether user meets audience conditions to be in experiment or not.
      */
-    public static function isUserInExperiment($config, $experiment, $userAttributes, $logger)
+    public static function doesUserMeetAudienceConditions($config, $experiment, $userAttributes, $logger, $loggingClass = null, $loggingKey = null)
     {
+        if ($loggingClass === null) {
+            $loggingClass = 'Optimizely\Enums\ExperimentAudienceEvaluationLogs';
+        }
+
+        if ($loggingKey === null) {
+            $loggingKey = $experiment->getKey();
+        }
+
         $audienceConditions = $experiment->getAudienceConditions();
         if ($audienceConditions === null) {
             $audienceConditions = $experiment->getAudienceIds();
         }
 
         $logger->log(Logger::DEBUG, sprintf(
-            AudienceEvaluationLogs::EVALUATING_AUDIENCES_COMBINED,
-            $experiment->getKey(),
+            $loggingClass::EVALUATING_AUDIENCES_COMBINED,
+            $loggingKey,
             json_encode($audienceConditions)
         ));
 
         // Return true if experiment is not targeted to any audience.
         if (empty($audienceConditions)) {
             $logger->log(Logger::INFO, sprintf(
-                AudienceEvaluationLogs::AUDIENCE_EVALUATION_RESULT_COMBINED,
-                $experiment->getKey(),
+                $loggingClass::AUDIENCE_EVALUATION_RESULT_COMBINED,
+                $loggingKey,
                 'TRUE'
             ));
             return true;
@@ -171,14 +180,14 @@ public static function isUserInExperiment($config, $experiment, $userAttributes,
             return $customAttrCondEval->evaluate($leafCondition);
         };
 
-        $evaluateAudience = function ($audienceId) use ($config, $evaluateCustomAttr, $logger) {
+        $evaluateAudience = function ($audienceId) use ($config, $evaluateCustomAttr, $logger, $loggingClass) {
             $audience = $config->getAudience($audienceId);
             if ($audience === null) {
                 return null;
             }
 
             $logger->log(Logger::DEBUG, sprintf(
-                AudienceEvaluationLogs::EVALUATING_AUDIENCE,
+                $loggingClass::EVALUATING_AUDIENCE,
                 $audienceId,
                 json_encode($audience->getConditionsList())
             ));
@@ -188,7 +197,7 @@ public static function isUserInExperiment($config, $experiment, $userAttributes,
             $resultStr = $result === null ? 'UNKNOWN' : strtoupper(var_export($result, true));
 
             $logger->log(Logger::DEBUG, sprintf(
-                AudienceEvaluationLogs::AUDIENCE_EVALUATION_RESULT,
+                $loggingClass::AUDIENCE_EVALUATION_RESULT,
                 $audienceId,
                 $resultStr
             ));
@@ -201,8 +210,8 @@ public static function isUserInExperiment($config, $experiment, $userAttributes,
         $evalResult = $evalResult || false;
 
         $logger->log(Logger::INFO, sprintf(
-            AudienceEvaluationLogs::AUDIENCE_EVALUATION_RESULT_COMBINED,
-            $experiment->getKey(),
+            $loggingClass::AUDIENCE_EVALUATION_RESULT_COMBINED,
+            $loggingKey,
             strtoupper(var_export($evalResult, true))
         ));