break up log messages

Author: oakbani

src/Optimizely/Enums/AudienceEvaluationLogs.php renamed to src/Optimizely/Enums/CommonAudienceEvaluationLogs.php

@@ -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 %s collectively evaluated to %s.";
-    const EVALUATING_AUDIENCES_COMBINED = "Evaluating audiences for %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/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,8 @@
 use Monolog\Logger;
 use Optimizely\Config\ProjectConfigInterface;
 use Optimizely\Entity\Experiment;
-use Optimizely\Enums\AudienceEvaluationLogs;
+use Optimizely\Enums\ExperimentAudienceEvaluationLogs;
+use Optimizely\Enums\RolloutAudienceEvaluationLogs;
 use Optimizely\Logger\LoggerInterface;
 use Optimizely\Utils\ConditionTreeEvaluator;
 use Optimizely\Utils\CustomAttributeConditionEvaluator;
@@ -143,11 +144,12 @@ public static function areEventTagsValid($eventTags)
      */
     public static function doesUserMeetAudienceConditions($config, $experiment, $userAttributes, $logger, $isRollout = null, $rolloutRule = null)
     {
-
-        $loggingStr = "experiment \"{$experiment->getKey()}\"";
+        $loggingClass = 'Optimizely\Enums\ExperimentAudienceEvaluationLogs';
+        $loggingStr = $experiment->getKey();
 
         if ($isRollout) {
-            $loggingStr = "rule {$rolloutRule}";
+            $loggingClass = 'Optimizely\Enums\RolloutAudienceEvaluationLogs';
+            $loggingStr = $rolloutRule;
         }
 
         $audienceConditions = $experiment->getAudienceConditions();
@@ -156,15 +158,15 @@ public static function doesUserMeetAudienceConditions($config, $experiment, $use
         }
 
         $logger->log(Logger::DEBUG, sprintf(
-            AudienceEvaluationLogs::EVALUATING_AUDIENCES_COMBINED,
+            $loggingClass::EVALUATING_AUDIENCES_COMBINED,
             $loggingStr,
             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,
+                $loggingClass::AUDIENCE_EVALUATION_RESULT_COMBINED,
                 $loggingStr,
                 'TRUE'
             ));
@@ -180,14 +182,14 @@ public static function doesUserMeetAudienceConditions($config, $experiment, $use
             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())
             ));
@@ -197,7 +199,7 @@ public static function doesUserMeetAudienceConditions($config, $experiment, $use
             $resultStr = $result === null ? 'UNKNOWN' : strtoupper(var_export($result, true));
 
             $logger->log(Logger::DEBUG, sprintf(
-                AudienceEvaluationLogs::AUDIENCE_EVALUATION_RESULT,
+                $loggingClass::AUDIENCE_EVALUATION_RESULT,
                 $audienceId,
                 $resultStr
             ));
@@ -210,7 +212,7 @@ public static function doesUserMeetAudienceConditions($config, $experiment, $use
         $evalResult = $evalResult || false;
 
         $logger->log(Logger::INFO, sprintf(
-            AudienceEvaluationLogs::AUDIENCE_EVALUATION_RESULT_COMBINED,
+            $loggingClass::AUDIENCE_EVALUATION_RESULT_COMBINED,
             $loggingStr,
             strtoupper(var_export($evalResult, true))
         ));