feat (audience match types): Update audience evaluator and project config for new audience match types (#145)

Author: oakbani

src/Optimizely/ProjectConfig.php

@@ -214,13 +214,15 @@ public function __construct($datafile, $logger, $errorHandler)
         $events = $config['events'] ?: [];
         $attributes = $config['attributes'] ?: [];
         $audiences = $config['audiences'] ?: [];
+        $typedAudiences = isset($config['typedAudiences']) ? $config['typedAudiences']: [];
         $rollouts = isset($config['rollouts']) ? $config['rollouts'] : [];
         $featureFlags = isset($config['featureFlags']) ? $config['featureFlags']: [];
 
         $this->_groupIdMap = ConfigParser::generateMap($groups, 'id', Group::class);
         $this->_experimentKeyMap = ConfigParser::generateMap($experiments, 'key', Experiment::class);
         $this->_eventKeyMap = ConfigParser::generateMap($events, 'key', Event::class);
         $this->_attributeKeyMap = ConfigParser::generateMap($attributes, 'key', Attribute::class);
+        $typedAudienceIdMap = ConfigParser::generateMap($typedAudiences, 'id', Audience::class);
         $this->_audienceIdMap = ConfigParser::generateMap($audiences, 'id', Audience::class);
         $this->_rollouts = ConfigParser::generateMap($rollouts, null, Rollout::class);
         $this->_featureFlags = ConfigParser::generateMap($featureFlags, null, FeatureFlag::class);
@@ -249,12 +251,19 @@ public function __construct($datafile, $logger, $errorHandler)
             }
         }
 
-        $conditionDecoder = new ConditionDecoder();
         foreach (array_values($this->_audienceIdMap) as $audience) {
-            $conditionDecoder->deserializeAudienceConditions($audience->getConditions());
-            $audience->setConditionsList($conditionDecoder->getConditionsList());
+            $audience->setConditionsList(json_decode($audience->getConditions(), true));
         }
 
+        // Conditions in typedAudiences are not expected to be string-encoded so they don't need
+        // to be decoded unlike audiences. 
+        foreach (array_values($typedAudienceIdMap) as $typedAudience) {
+            $typedAudience->setConditionsList($typedAudience->getConditions());
+        }
+
+        // Overwrite audiences by typedAudiences.
+        $this->_audienceIdMap = array_replace($this->_audienceIdMap, $typedAudienceIdMap);
+
         $rolloutVariationIdMap = [];
         $rolloutVariationKeyMap = [];
         foreach ($this->_rollouts as $rollout) {

src/Optimizely/Utils/ConditionDecoder.php

@@ -140,7 +140,7 @@ protected function notEvaluator(array $condition, callable $leafEvaluator)
      */
     public function evaluate($conditions, callable $leafEvaluator)
     {
-        if (is_array($conditions)) {
+        if (!Validator::doesArrayContainOnlyStringKeys($conditions)) {
 
             if(in_array($conditions[0], $this->getOperators())) {
                 $operator = array_shift($conditions);

src/Optimizely/Utils/ConditionTreeEvaluator.php

@@ -44,6 +44,21 @@ public function __construct(array $userAttributes)
         $this->userAttributes = $userAttributes;
     }
 
+    /**
+     * Sets null for missing keys in a leaf condition.
+     * 
+     * @param array $leafCondition The leaf condition node of an audience.
+     */
+    protected function setNullForMissingKeys(array $leafCondition)
+    {
+        $keys = ['type', 'match', 'value'];
+        foreach($keys as $key) {
+            $leafCondition[$key] = isset($leafCondition[$key]) ? $leafCondition[$key]: null;
+        }
+
+        return $leafCondition;
+    }
+
     /**
      * Gets the supported match types for condition evaluation.
      * 
@@ -103,8 +118,8 @@ protected function isValueValidForExactConditions($value)
      */
     protected function exactEvaluator($condition)
     {
-        $conditionName = $condition->{'name'};
-        $conditionValue = $condition->{'value'};
+        $conditionName = $condition['name'];
+        $conditionValue = $condition['value'];
         $userValue = isset($this->userAttributes[$conditionName]) ? $this->userAttributes[$conditionName]: null;
 
         if(!$this->isValueValidForExactConditions($userValue) ||
@@ -128,7 +143,7 @@ protected function exactEvaluator($condition)
      */
     protected function existsEvaluator($condition) 
     {
-        $conditionName = $condition->{'name'};
+        $conditionName = $condition['name'];
         return isset($this->userAttributes[$conditionName]);
     }
 
@@ -144,8 +159,8 @@ protected function existsEvaluator($condition)
      */
     protected function greaterThanEvaluator($condition)
     {
-        $conditionName = $condition->{'name'};
-        $conditionValue = $condition->{'value'};
+        $conditionName = $condition['name'];
+        $conditionValue = $condition['value'];
         $userValue = isset($this->userAttributes[$conditionName]) ? $this->userAttributes[$conditionName]: null;
 
         if(!Validator::isFiniteNumber($userValue) || !Validator::isFiniteNumber($conditionValue)) {
@@ -167,8 +182,8 @@ protected function greaterThanEvaluator($condition)
      */
     protected function lessThanEvaluator($condition)
     {
-        $conditionName = $condition->{'name'};
-        $conditionValue = $condition->{'value'};
+        $conditionName = $condition['name'];
+        $conditionValue = $condition['value'];
         $userValue = isset($this->userAttributes[$conditionName]) ? $this->userAttributes[$conditionName]: null;
 
         if(!Validator::isFiniteNumber($userValue) || !Validator::isFiniteNumber($conditionValue)) {
@@ -190,8 +205,8 @@ protected function lessThanEvaluator($condition)
      */
     protected function substringEvaluator($condition)
     {
-        $conditionName = $condition->{'name'};
-        $conditionValue = $condition->{'value'};
+        $conditionName = $condition['name'];
+        $conditionValue = $condition['value'];
         $userValue = isset($this->userAttributes[$conditionName]) ? $this->userAttributes[$conditionName]: null;
 
         if(!is_string($userValue) || !is_string($conditionValue)) {
@@ -211,14 +226,16 @@ protected function substringEvaluator($condition)
      */
     public function evaluate($leafCondition)
     {
-        if($leafCondition->{'type'} !== self::CUSTOM_ATTRIBUTE_CONDITION_TYPE) {
+        $leafCondition = $this->setNullForMissingKeys($leafCondition);
+
+        if($leafCondition['type'] !== self::CUSTOM_ATTRIBUTE_CONDITION_TYPE) {
             return null;
         }
 
-        if(!isset($leafCondition->{'match'})) {
+        if(($leafCondition['match']) === null) {
             $conditionMatch = self::EXACT_MATCH_TYPE;
         } else {
-            $conditionMatch = $leafCondition->{'match'};
+            $conditionMatch = $leafCondition['match'];
         }
 
         if(!in_array($conditionMatch, $this->getMatchTypes())) {

src/Optimizely/Utils/CustomAttributeConditionEvaluator.php

@@ -111,9 +111,8 @@ public static function isUserInExperiment($config, $experiment, $userAttributes)
             return true;
         }
 
-        // Return false if there is audience, but no user attributes.
-        if (empty($userAttributes)) {
-            return false;
+        if ($userAttributes == null) {
+            $userAttributes = [];
         }
 
         $customAttrCondEval = new CustomAttributeConditionEvaluator($userAttributes);
@@ -223,4 +222,18 @@ public static function areValuesSameType($firstVal, $secondVal)
 
         return $firstValType == $secondValType;
     }
+
+    /**
+     * Returns true only if given input is an array with all of it's keys of type string.
+     * @param  mixed $arr
+     * @return bool  True if array contains all string keys. Otherwise, false.
+     */
+    public static function doesArrayContainOnlyStringKeys($arr)
+    {
+        if(!is_array($arr) || empty($arr)) {
+            return false;
+        }
+
+        return count(array_filter(array_keys($arr), 'is_string')) == count(array_keys($arr));
+    }
 }

src/Optimizely/Utils/Validator.php

@@ -1138,7 +1138,7 @@ public function testGetVariationForFeatureRolloutWhenUserDoesNotQualifyForAnyTar
         $experiment2 = $rollout->getExperiments()[2];
 
         // Set an AudienceId for everyone else/last rule so that user does not qualify for audience
-        $experiment2->setAudienceIds(["11154"]);
+        $experiment2->setAudienceIds(["11155"]);
         $expected_variation = $experiment2->getVariations()[0];
 
         // Provide null attributes so that user does not qualify for audience