optimizely-sdk 3.10.1 → 4.0.0

data/lib/optimizely/bucketer.rb

@@ -1,156 +1,156 @@
-# frozen_string_literal: true
-
-#
-#    Copyright 2016-2017, 2019-2021 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.
-#
-require 'murmurhash3'
-require_relative 'helpers/group'
-
-module Optimizely
-  class Bucketer
-    # Optimizely bucketing algorithm that evenly distributes visitors.
-
-    BUCKETING_ID_TEMPLATE = '%<bucketing_id>s%<entity_id>s'
-    HASH_SEED = 1
-    MAX_HASH_VALUE = 2**32
-    MAX_TRAFFIC_VALUE = 10_000
-    UNSIGNED_MAX_32_BIT_VALUE = 0xFFFFFFFF
-
-    def initialize(logger)
-      # Bucketer init method to set bucketing seed and logger.
-      # logger - Optional component which provides a log method to log messages.
-      @logger = logger
-      @bucket_seed = HASH_SEED
-    end
-
-    def bucket(project_config, experiment, bucketing_id, user_id)
-      # Determines ID of variation to be shown for a given experiment key and user ID.
-      #
-      # project_config - Instance of ProjectConfig
-      # experiment - Experiment or Rollout rule for which visitor is to be bucketed.
-      # bucketing_id - String A customer-assigned value used to generate the bucketing key
-      # user_id - String ID for user.
-      #
-      # Returns variation in which visitor with ID user_id has been placed. Nil if no variation.
-      return nil, [] if experiment.nil?
-
-      decide_reasons = []
-
-      # check if experiment is in a group; if so, check if user is bucketed into specified experiment
-      # this will not affect evaluation of rollout rules.
-      experiment_id = experiment['id']
-      experiment_key = experiment['key']
-      group_id = experiment['groupId']
-      if group_id
-        group = project_config.group_id_map.fetch(group_id)
-        if Helpers::Group.random_policy?(group)
-          traffic_allocations = group.fetch('trafficAllocation')
-          bucketed_experiment_id, find_bucket_reasons = find_bucket(bucketing_id, user_id, group_id, traffic_allocations)
-          decide_reasons.push(*find_bucket_reasons)
-
-          # return if the user is not bucketed into any experiment
-          unless bucketed_experiment_id
-            message = "User '#{user_id}' is in no experiment."
-            @logger.log(Logger::INFO, message)
-            decide_reasons.push(message)
-            return nil, decide_reasons
-          end
-
-          # return if the user is bucketed into a different experiment than the one specified
-          if bucketed_experiment_id != experiment_id
-            message = "User '#{user_id}' is not in experiment '#{experiment_key}' of group #{group_id}."
-            @logger.log(Logger::INFO, message)
-            decide_reasons.push(message)
-            return nil, decide_reasons
-          end
-
-          # continue bucketing if the user is bucketed into the experiment specified
-          message = "User '#{user_id}' is in experiment '#{experiment_key}' of group #{group_id}."
-          @logger.log(Logger::INFO, message)
-          decide_reasons.push(message)
-        end
-      end
-
-      traffic_allocations = experiment['trafficAllocation']
-      variation_id, find_bucket_reasons = find_bucket(bucketing_id, user_id, experiment_id, traffic_allocations)
-      decide_reasons.push(*find_bucket_reasons)
-
-      if variation_id && variation_id != ''
-        variation = project_config.get_variation_from_id_by_experiment_id(experiment_id, variation_id)
-        return variation, decide_reasons
-      end
-
-      # Handle the case when the traffic range is empty due to sticky bucketing
-      if variation_id == ''
-        message = 'Bucketed into an empty traffic range. Returning nil.'
-        @logger.log(Logger::DEBUG, message)
-        decide_reasons.push(message)
-      end
-
-      [nil, decide_reasons]
-    end
-
-    def find_bucket(bucketing_id, user_id, parent_id, traffic_allocations)
-      # Helper function to find the matching entity ID for a given bucketing value in a list of traffic allocations.
-      #
-      # bucketing_id - String A customer-assigned value user to generate bucketing key
-      # user_id - String ID for user
-      # parent_id - String entity ID to use for bucketing ID
-      # traffic_allocations - Array of traffic allocations
-      #
-      # Returns and array of two values where first value is the entity ID corresponding to the provided bucket value
-      # or nil if no match is found. The second value contains the array of reasons stating how the deicision was taken
-      decide_reasons = []
-      bucketing_key = format(BUCKETING_ID_TEMPLATE, bucketing_id: bucketing_id, entity_id: parent_id)
-      bucket_value = generate_bucket_value(bucketing_key)
-
-      message = "Assigned bucket #{bucket_value} to user '#{user_id}' with bucketing ID: '#{bucketing_id}'."
-      @logger.log(Logger::DEBUG, message)
-
-      traffic_allocations.each do |traffic_allocation|
-        current_end_of_range = traffic_allocation['endOfRange']
-        if bucket_value < current_end_of_range
-          entity_id = traffic_allocation['entityId']
-          return entity_id, decide_reasons
-        end
-      end
-
-      [nil, decide_reasons]
-    end
-
-    private
-
-    def generate_bucket_value(bucketing_key)
-      # Helper function to generate bucket value in half-closed interval [0, MAX_TRAFFIC_VALUE).
-      #
-      # bucketing_key - String - Value used to generate bucket value
-      #
-      # Returns bucket value corresponding to the provided bucketing key.
-
-      ratio = generate_unsigned_hash_code_32_bit(bucketing_key).to_f / MAX_HASH_VALUE
-      (ratio * MAX_TRAFFIC_VALUE).to_i
-    end
-
-    def generate_unsigned_hash_code_32_bit(bucketing_key)
-      # Helper function to retreive hash code
-      #
-      # bucketing_key - String - Value used for the key of the murmur hash
-      #
-      # Returns hash code which is a 32 bit unsigned integer.
-
-      MurmurHash3::V32.str_hash(bucketing_key, @bucket_seed) & UNSIGNED_MAX_32_BIT_VALUE
-    end
-  end
-end
+# frozen_string_literal: true
+
+#
+#    Copyright 2016-2017, 2019-2021 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.
+#
+require 'murmurhash3'
+require_relative 'helpers/group'
+
+module Optimizely
+  class Bucketer
+    # Optimizely bucketing algorithm that evenly distributes visitors.
+
+    BUCKETING_ID_TEMPLATE = '%<bucketing_id>s%<entity_id>s'
+    HASH_SEED = 1
+    MAX_HASH_VALUE = 2**32
+    MAX_TRAFFIC_VALUE = 10_000
+    UNSIGNED_MAX_32_BIT_VALUE = 0xFFFFFFFF
+
+    def initialize(logger)
+      # Bucketer init method to set bucketing seed and logger.
+      # logger - Optional component which provides a log method to log messages.
+      @logger = logger
+      @bucket_seed = HASH_SEED
+    end
+
+    def bucket(project_config, experiment, bucketing_id, user_id)
+      # Determines ID of variation to be shown for a given experiment key and user ID.
+      #
+      # project_config - Instance of ProjectConfig
+      # experiment - Experiment or Rollout rule for which visitor is to be bucketed.
+      # bucketing_id - String A customer-assigned value used to generate the bucketing key
+      # user_id - String ID for user.
+      #
+      # Returns variation in which visitor with ID user_id has been placed. Nil if no variation.
+      return nil, [] if experiment.nil?
+
+      decide_reasons = []
+
+      # check if experiment is in a group; if so, check if user is bucketed into specified experiment
+      # this will not affect evaluation of rollout rules.
+      experiment_id = experiment['id']
+      experiment_key = experiment['key']
+      group_id = experiment['groupId']
+      if group_id
+        group = project_config.group_id_map.fetch(group_id)
+        if Helpers::Group.random_policy?(group)
+          traffic_allocations = group.fetch('trafficAllocation')
+          bucketed_experiment_id, find_bucket_reasons = find_bucket(bucketing_id, user_id, group_id, traffic_allocations)
+          decide_reasons.push(*find_bucket_reasons)
+
+          # return if the user is not bucketed into any experiment
+          unless bucketed_experiment_id
+            message = "User '#{user_id}' is in no experiment."
+            @logger.log(Logger::INFO, message)
+            decide_reasons.push(message)
+            return nil, decide_reasons
+          end
+
+          # return if the user is bucketed into a different experiment than the one specified
+          if bucketed_experiment_id != experiment_id
+            message = "User '#{user_id}' is not in experiment '#{experiment_key}' of group #{group_id}."
+            @logger.log(Logger::INFO, message)
+            decide_reasons.push(message)
+            return nil, decide_reasons
+          end
+
+          # continue bucketing if the user is bucketed into the experiment specified
+          message = "User '#{user_id}' is in experiment '#{experiment_key}' of group #{group_id}."
+          @logger.log(Logger::INFO, message)
+          decide_reasons.push(message)
+        end
+      end
+
+      traffic_allocations = experiment['trafficAllocation']
+      variation_id, find_bucket_reasons = find_bucket(bucketing_id, user_id, experiment_id, traffic_allocations)
+      decide_reasons.push(*find_bucket_reasons)
+
+      if variation_id && variation_id != ''
+        variation = project_config.get_variation_from_id_by_experiment_id(experiment_id, variation_id)
+        return variation, decide_reasons
+      end
+
+      # Handle the case when the traffic range is empty due to sticky bucketing
+      if variation_id == ''
+        message = 'Bucketed into an empty traffic range. Returning nil.'
+        @logger.log(Logger::DEBUG, message)
+        decide_reasons.push(message)
+      end
+
+      [nil, decide_reasons]
+    end
+
+    def find_bucket(bucketing_id, user_id, parent_id, traffic_allocations)
+      # Helper function to find the matching entity ID for a given bucketing value in a list of traffic allocations.
+      #
+      # bucketing_id - String A customer-assigned value user to generate bucketing key
+      # user_id - String ID for user
+      # parent_id - String entity ID to use for bucketing ID
+      # traffic_allocations - Array of traffic allocations
+      #
+      # Returns and array of two values where first value is the entity ID corresponding to the provided bucket value
+      # or nil if no match is found. The second value contains the array of reasons stating how the deicision was taken
+      decide_reasons = []
+      bucketing_key = format(BUCKETING_ID_TEMPLATE, bucketing_id: bucketing_id, entity_id: parent_id)
+      bucket_value = generate_bucket_value(bucketing_key)
+
+      message = "Assigned bucket #{bucket_value} to user '#{user_id}' with bucketing ID: '#{bucketing_id}'."
+      @logger.log(Logger::DEBUG, message)
+
+      traffic_allocations.each do |traffic_allocation|
+        current_end_of_range = traffic_allocation['endOfRange']
+        if bucket_value < current_end_of_range
+          entity_id = traffic_allocation['entityId']
+          return entity_id, decide_reasons
+        end
+      end
+
+      [nil, decide_reasons]
+    end
+
+    private
+
+    def generate_bucket_value(bucketing_key)
+      # Helper function to generate bucket value in half-closed interval [0, MAX_TRAFFIC_VALUE).
+      #
+      # bucketing_key - String - Value used to generate bucket value
+      #
+      # Returns bucket value corresponding to the provided bucketing key.
+
+      ratio = generate_unsigned_hash_code_32_bit(bucketing_key).to_f / MAX_HASH_VALUE
+      (ratio * MAX_TRAFFIC_VALUE).to_i
+    end
+
+    def generate_unsigned_hash_code_32_bit(bucketing_key)
+      # Helper function to retreive hash code
+      #
+      # bucketing_key - String - Value used for the key of the murmur hash
+      #
+      # Returns hash code which is a 32 bit unsigned integer.
+
+      MurmurHash3::V32.str_hash(bucketing_key, @bucket_seed) & UNSIGNED_MAX_32_BIT_VALUE
+    end
+  end
+end

data/lib/optimizely/condition_tree_evaluator.rb

@@ -1,123 +1,123 @@
-# 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
-
-    OPERATORS = [AND_CONDITION, OR_CONDITION, NOT_CONDITION].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
+# frozen_string_literal: true
+
+#
+#    Copyright 2019, 2022, 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
+
+    OPERATORS = [AND_CONDITION, OR_CONDITION, NOT_CONDITION].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..]
+
+        # 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