optimizely-sdk 5.0.0 → 5.0.1

data/lib/optimizely/audience.rb

@@ -1,127 +1,127 @@
-# frozen_string_literal: true
-
-#
-#    Copyright 2016-2017, 2019-2020, 2023, 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 'json'
-require_relative './user_condition_evaluator'
-require_relative 'condition_tree_evaluator'
-require_relative 'helpers/constants'
-
-module Optimizely
-  module Audience
-    module_function
-
-    def user_meets_audience_conditions?(config, experiment, user_context, logger, logging_hash = nil, logging_key = nil)
-      # Determine for given experiment/rollout rule if user satisfies the audience conditions.
-      #
-      # config - Representation of the Optimizely project config.
-      # experiment - Experiment/Rollout rule in which user is to be bucketed.
-      # user_context - Optimizely user context instance
-      # logger - Provides a logger instance.
-      # logging_hash - Optional string representing logs hash inside Helpers::Constants.
-      #                This defaults to 'EXPERIMENT_AUDIENCE_EVALUATION_LOGS'.
-      # logging_key - Optional string to be logged as an identifier of experiment under evaluation.
-      #               This defaults to experiment['key'].
-      #
-      # Returns boolean representing if user satisfies audience conditions for the audiences or not.
-      decide_reasons = []
-      logging_hash ||= 'EXPERIMENT_AUDIENCE_EVALUATION_LOGS'
-      logging_key ||= experiment['key']
-
-      logs_hash = Object.const_get "Optimizely::Helpers::Constants::#{logging_hash}"
-
-      audience_conditions = experiment['audienceConditions'] || experiment['audienceIds']
-
-      message = format(logs_hash['EVALUATING_AUDIENCES_COMBINED'], logging_key, audience_conditions)
-      logger.log(Logger::DEBUG, message)
-
-      # Return true if there are no audiences
-      if audience_conditions.empty?
-        message = format(logs_hash['AUDIENCE_EVALUATION_RESULT_COMBINED'], logging_key, 'TRUE')
-        logger.log(Logger::INFO, message)
-        decide_reasons.push(message)
-        return true, decide_reasons
-      end
-
-      user_condition_evaluator = UserConditionEvaluator.new(user_context, logger)
-
-      evaluate_user_conditions = lambda do |condition|
-        user_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']
-        message = format(logs_hash['EVALUATING_AUDIENCE'], audience_id, audience_conditions)
-        logger.log(Logger::DEBUG, message)
-        decide_reasons.push(message)
-
-        audience_conditions = JSON.parse(audience_conditions) if audience_conditions.is_a?(String)
-        result = ConditionTreeEvaluator.evaluate(audience_conditions, evaluate_user_conditions)
-        result_str = result.nil? ? 'UNKNOWN' : result.to_s.upcase
-        message = format(logs_hash['AUDIENCE_EVALUATION_RESULT'], audience_id, result_str)
-        logger.log(Logger::DEBUG, message)
-        decide_reasons.push(message)
-
-        result
-      end
-
-      eval_result = ConditionTreeEvaluator.evaluate(audience_conditions, evaluate_audience)
-      eval_result ||= false
-
-      message = format(logs_hash['AUDIENCE_EVALUATION_RESULT_COMBINED'], logging_key, eval_result.to_s.upcase)
-      logger.log(Logger::INFO, message)
-      decide_reasons.push(message)
-
-      [eval_result, decide_reasons]
-    end
-
-    def get_segments(conditions)
-      # Return any audience segments from provided conditions.
-      #
-      # conditions - Nested array of and/or conditions.
-      #              Example: ['and', operand_1, ['or', operand_2, operand_3]]
-      #
-      # Returns unique array of segment names.
-      conditions = JSON.parse(conditions) if conditions.is_a?(String)
-      @parse_segments.call(conditions).uniq
-    end
-
-    @parse_segments = lambda { |conditions|
-      # Return any audience segments from provided conditions.
-      # Helper function for get_segments.
-      #
-      # conditions - Nested array of and/or conditions.
-      #              Example: ['and', operand_1, ['or', operand_2, operand_3]]
-      #
-      # Returns array of segment names.
-      segments = []
-
-      case conditions
-      when Hash
-        segments.push(conditions['value']) if conditions.fetch('match', nil) == 'qualified'
-      when Array
-        conditions.each do |condition|
-          segments.concat @parse_segments.call(condition)
-        end
-      end
-
-      segments
-    }
-  end
-end
+# frozen_string_literal: true
+
+#
+#    Copyright 2016-2017, 2019-2020, 2023, 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 'json'
+require_relative './user_condition_evaluator'
+require_relative 'condition_tree_evaluator'
+require_relative 'helpers/constants'
+
+module Optimizely
+  module Audience
+    module_function
+
+    def user_meets_audience_conditions?(config, experiment, user_context, logger, logging_hash = nil, logging_key = nil)
+      # Determine for given experiment/rollout rule if user satisfies the audience conditions.
+      #
+      # config - Representation of the Optimizely project config.
+      # experiment - Experiment/Rollout rule in which user is to be bucketed.
+      # user_context - Optimizely user context instance
+      # logger - Provides a logger instance.
+      # logging_hash - Optional string representing logs hash inside Helpers::Constants.
+      #                This defaults to 'EXPERIMENT_AUDIENCE_EVALUATION_LOGS'.
+      # logging_key - Optional string to be logged as an identifier of experiment under evaluation.
+      #               This defaults to experiment['key'].
+      #
+      # Returns boolean representing if user satisfies audience conditions for the audiences or not.
+      decide_reasons = []
+      logging_hash ||= 'EXPERIMENT_AUDIENCE_EVALUATION_LOGS'
+      logging_key ||= experiment['key']
+
+      logs_hash = Object.const_get "Optimizely::Helpers::Constants::#{logging_hash}"
+
+      audience_conditions = experiment['audienceConditions'] || experiment['audienceIds']
+
+      message = format(logs_hash['EVALUATING_AUDIENCES_COMBINED'], logging_key, audience_conditions)
+      logger.log(Logger::DEBUG, message)
+
+      # Return true if there are no audiences
+      if audience_conditions.empty?
+        message = format(logs_hash['AUDIENCE_EVALUATION_RESULT_COMBINED'], logging_key, 'TRUE')
+        logger.log(Logger::INFO, message)
+        decide_reasons.push(message)
+        return true, decide_reasons
+      end
+
+      user_condition_evaluator = UserConditionEvaluator.new(user_context, logger)
+
+      evaluate_user_conditions = lambda do |condition|
+        user_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']
+        message = format(logs_hash['EVALUATING_AUDIENCE'], audience_id, audience_conditions)
+        logger.log(Logger::DEBUG, message)
+        decide_reasons.push(message)
+
+        audience_conditions = JSON.parse(audience_conditions) if audience_conditions.is_a?(String)
+        result = ConditionTreeEvaluator.evaluate(audience_conditions, evaluate_user_conditions)
+        result_str = result.nil? ? 'UNKNOWN' : result.to_s.upcase
+        message = format(logs_hash['AUDIENCE_EVALUATION_RESULT'], audience_id, result_str)
+        logger.log(Logger::DEBUG, message)
+        decide_reasons.push(message)
+
+        result
+      end
+
+      eval_result = ConditionTreeEvaluator.evaluate(audience_conditions, evaluate_audience)
+      eval_result ||= false
+
+      message = format(logs_hash['AUDIENCE_EVALUATION_RESULT_COMBINED'], logging_key, eval_result.to_s.upcase)
+      logger.log(Logger::INFO, message)
+      decide_reasons.push(message)
+
+      [eval_result, decide_reasons]
+    end
+
+    def get_segments(conditions)
+      # Return any audience segments from provided conditions.
+      #
+      # conditions - Nested array of and/or conditions.
+      #              Example: ['and', operand_1, ['or', operand_2, operand_3]]
+      #
+      # Returns unique array of segment names.
+      conditions = JSON.parse(conditions) if conditions.is_a?(String)
+      @parse_segments.call(conditions).uniq
+    end
+
+    @parse_segments = lambda { |conditions|
+      # Return any audience segments from provided conditions.
+      # Helper function for get_segments.
+      #
+      # conditions - Nested array of and/or conditions.
+      #              Example: ['and', operand_1, ['or', operand_2, operand_3]]
+      #
+      # Returns array of segment names.
+      segments = []
+
+      case conditions
+      when Hash
+        segments.push(conditions['value']) if conditions.fetch('match', nil) == 'qualified'
+      when Array
+        conditions.each do |condition|
+          segments.concat @parse_segments.call(condition)
+        end
+      end
+
+      segments
+    }
+  end
+end

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 an 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 decision 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 an 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 decision 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