feat (audience match types): Condition Evaluator, Project Config, and Audience combinations PRs consolidation. (#150)

Author: rashidsp

.travis.yml

@@ -2,11 +2,14 @@ branch:
   only:
     - master
 language: ruby
+cache: bundler
 rvm:
   - 2.3.7
   - 2.4.4
   - 2.5.1
-before_install: gem install bundler
+before_install:
+  - gem update --system
+  - gem install bundler
 install:
   - bundle install
 script: "bundle exec rake spec"

lib/optimizely/audience.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-#    Copyright 2016-2017, Optimizely and contributors
+#    Copyright 2016-2017, 2019, Optimizely and contributors
 #
 #    Licensed under the Apache License, Version 2.0 (the "License");
 #    you may not use this file except in compliance with the License.
@@ -16,7 +16,8 @@
 #    limitations under the License.
 #
 require 'json'
-require_relative './condition'
+require_relative './custom_attribute_condition_evaluator'
+require_relative 'condition_tree_evaluator'
 
 module Optimizely
   module Audience
@@ -30,25 +31,32 @@ def user_in_experiment?(config, experiment, attributes)
       # attributes - Hash representing user attributes which will be used in determining if
       #              the audience conditions are met.
       #
-      # Returns boolean representing if user satisfies audience conditions for any of the audiences or not.
+      # Returns boolean representing if user satisfies audience conditions for the audiences or not.
 
-      audience_ids = experiment['audienceIds']
+      audience_conditions = experiment['audienceConditions'] || experiment['audienceIds']
 
       # Return true if there are no audiences
-      return true if audience_ids.empty?
+      return true if audience_conditions.empty?
 
-      # Return false if there are audiences but no attributes
-      return false unless attributes
+      attributes ||= {}
 
-      # Return true if any one of the audience conditions are met
-      @condition_evaluator = ConditionEvaluator.new(attributes)
-      audience_ids.each do |audience_id|
+      custom_attr_condition_evaluator = CustomAttributeConditionEvaluator.new(attributes)
+
+      evaluate_custom_attr = lambda do |condition|
+        return custom_attr_condition_evaluator.evaluate(condition)
+      end
+
+      evaluate_audience = lambda do |audience_id|
         audience = config.get_audience_from_id(audience_id)
+        return nil unless audience
+
         audience_conditions = audience['conditions']
-        audience_conditions = JSON.parse(audience_conditions)
-        return true if @condition_evaluator.evaluate(audience_conditions)
+        audience_conditions = JSON.parse(audience_conditions) if audience_conditions.is_a?(String)
+        return ConditionTreeEvaluator.evaluate(audience_conditions, evaluate_custom_attr)
       end
 
+      return true if ConditionTreeEvaluator.evaluate(audience_conditions, evaluate_audience)
+
       false
     end
   end

lib/optimizely/condition.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+#
+#    Copyright 2019, Optimizely and contributors
+#
+#    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.
+#
+module Optimizely
+  module ConditionTreeEvaluator
+    # Operator types
+    AND_CONDITION = 'and'
+    OR_CONDITION = 'or'
+    NOT_CONDITION = 'not'
+
+    EVALUATORS_BY_OPERATOR_TYPE = {
+      AND_CONDITION => :and_evaluator,
+      OR_CONDITION => :or_evaluator,
+      NOT_CONDITION => :not_evaluator
+    }.freeze
+
+    module_function
+
+    def evaluate(conditions, leaf_evaluator)
+      # Top level method to evaluate audience conditions.
+      #
+      # conditions - Nested array of and/or conditions.
+      #              Example: ['and', operand_1, ['or', operand_2, operand_3]]
+      #
+      # leaf_evaluator - Function which will be called to evaluate leaf condition values.
+      #
+      # Returns boolean if the given user attributes match/don't match the given conditions,
+      #         nil if the given conditions are invalid or can't be evaluated.
+
+      if conditions.is_a? Array
+        first_operator =  conditions[0]
+        rest_of_conditions = conditions[1..-1]
+
+        # Operator to apply is not explicit - assume 'or'
+        unless EVALUATORS_BY_OPERATOR_TYPE.include?(conditions[0])
+          first_operator = OR_CONDITION
+          rest_of_conditions = conditions
+        end
+
+        return send(EVALUATORS_BY_OPERATOR_TYPE[first_operator], rest_of_conditions, leaf_evaluator)
+      end
+
+      leaf_evaluator.call(conditions)
+    end
+
+    def and_evaluator(conditions, leaf_evaluator)
+      # Evaluates an array of conditions as if the evaluator had been applied
+      # to each entry and the results AND-ed together.
+      #
+      # conditions - Array of conditions ex: [operand_1, operand_2]
+      #
+      # leaf_evaluator - Function which will be called to evaluate leaf condition values.
+      #
+      # Returns boolean if the user attributes match/don't match the given conditions,
+      #         nil if the user attributes and conditions can't be evaluated.
+
+      found_nil = false
+      conditions.each do |condition|
+        result = evaluate(condition, leaf_evaluator)
+        return result if result == false
+
+        found_nil = true if result.nil?
+      end
+
+      found_nil ? nil : true
+    end
+
+    def not_evaluator(single_condition, leaf_evaluator)
+      # Evaluates an array of conditions as if the evaluator had been applied
+      # to a single entry and NOT was applied to the result.
+      #
+      # single_condition - Array of a single condition ex: [operand_1]
+      #
+      # leaf_evaluator - Function which will be called to evaluate leaf condition values.
+      #
+      # Returns boolean if the user attributes match/don't match the given conditions,
+      #         nil if the user attributes and conditions can't be evaluated.
+
+      return nil if single_condition.empty?
+
+      result = evaluate(single_condition[0], leaf_evaluator)
+      result.nil? ? nil : !result
+    end
+
+    def or_evaluator(conditions, leaf_evaluator)
+      # Evaluates an array of conditions as if the evaluator had been applied
+      # to each entry and the results OR-ed together.
+      #
+      # conditions - Array of conditions ex: [operand_1, operand_2]
+      #
+      # leaf_evaluator - Function which will be called to evaluate leaf condition values.
+      #
+      # Returns boolean if the user attributes match/don't match the given conditions,
+      #         nil if the user attributes and conditions can't be evaluated.
+
+      found_nil = false
+      conditions.each do |condition|
+        result = evaluate(condition, leaf_evaluator)
+        return result if result == true
+
+        found_nil = true if result.nil?
+      end
+
+      found_nil ? nil : false
+    end
+  end
+end