optimizely-sdk 2.1.1 → 3.0.0

data/lib/optimizely/decision_service.rb

@@ -166,6 +166,7 @@ module Optimizely
         variation_id = get_variation(experiment_key, user_id, attributes)
 
         next unless variation_id
+
         variation = @config.variation_id_map[experiment_key][variation_id]
         @config.logger.log(
           Logger::INFO,
@@ -236,6 +237,7 @@ module Optimizely
         # Evaluate if user satisfies the traffic allocation for this rollout rule
         variation = @bucketer.bucket(rollout_rule, bucketing_id, user_id)
         return Decision.new(rollout_rule, variation, DECISION_SOURCE_ROLLOUT) unless variation.nil?
+
         break
       end
 
@@ -254,6 +256,7 @@ module Optimizely
       end
       variation = @bucketer.bucket(everyone_else_experiment, bucketing_id, user_id)
       return Decision.new(everyone_else_experiment, variation, DECISION_SOURCE_ROLLOUT) unless variation.nil?
+
       nil
     end
 
@@ -303,6 +306,7 @@ module Optimizely
 
       decision = user_profile[:experiment_bucket_map][experiment_id]
       return nil unless decision
+
       variation_id = decision[:variation_id]
       return variation_id if @config.variation_id_exists?(experiment_id, variation_id)
 
@@ -362,17 +366,18 @@ module Optimizely
       #
       # user_id - String user ID
       # attributes - Hash user attributes
-      # By default, the bucketing ID should be the user ID
-      bucketing_id = user_id
+      # Returns String representing bucketing ID if it is a String type in attributes else return user ID
 
-      # If the bucketing ID key is defined in attributes, then use that in place of the userID
-      if attributes && attributes[Optimizely::Helpers::Constants::CONTROL_ATTRIBUTES['BUCKETING_ID']].is_a?(String)
-        unless attributes[Optimizely::Helpers::Constants::CONTROL_ATTRIBUTES['BUCKETING_ID']].empty?
-          bucketing_id = attributes[Optimizely::Helpers::Constants::CONTROL_ATTRIBUTES['BUCKETING_ID']]
-          @config.logger.log(Logger::DEBUG, "Setting the bucketing ID '#{bucketing_id}'")
-        end
+      return user_id unless attributes
+
+      bucketing_id = attributes[Optimizely::Helpers::Constants::CONTROL_ATTRIBUTES['BUCKETING_ID']]
+
+      if bucketing_id
+        return bucketing_id if bucketing_id.is_a?(String)
+
+        @config.logger.log(Logger::WARN, 'Bucketing ID attribute is not a string. Defaulted to user ID.')
       end
-      bucketing_id
+      user_id
     end
   end
 end

data/lib/optimizely/event_builder.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-#    Copyright 2016-2018, Optimizely and contributors
+#    Copyright 2016-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.
@@ -15,10 +15,12 @@
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
 #
-require_relative './audience'
-require_relative './params'
-require_relative './version'
-require_relative '../optimizely/helpers/event_tag_utils'
+require_relative 'audience'
+require_relative 'helpers/constants'
+require_relative 'helpers/event_tag_utils'
+require_relative 'params'
+require_relative 'version'
+
 require 'securerandom'
 
 module Optimizely
@@ -74,9 +76,9 @@ module Optimizely
       visitor_attributes = []
 
       attributes&.keys&.each do |attribute_key|
-        # Omit null attribute values
+        # Omit attribute values that are not supported by the log endpoint.
         attribute_value = attributes[attribute_key]
-        unless attribute_value.nil?
+        if Helpers::Validator.attribute_valid?(attribute_key, attribute_value)
           attribute_id = @config.get_attribute_id attribute_key
           if attribute_id
             visitor_attributes.push(
@@ -111,6 +113,7 @@ module Optimizely
         anonymize_ip: @config.anonymize_ip,
         revision: @config.revision,
         client_name: CLIENT_ENGINE,
+        enrich_decisions: true,
         client_version: VERSION
       }
 
@@ -140,19 +143,18 @@ module Optimizely
       Event.new(:post, ENDPOINT, event_params, POST_HEADERS)
     end
 
-    def create_conversion_event(event_key, user_id, attributes, event_tags, experiment_variation_map)
+    def create_conversion_event(event, user_id, attributes, event_tags)
       # Create conversion Event to be sent to the logging endpoint.
       #
-      # event_key -                +String+ Event key representing the event which needs to be recorded.
+      # event -                    +Object+ Event which needs to be recorded.
       # user_id -                  +String+ ID for user.
       # attributes -               +Hash+ representing user attributes and values which need to be recorded.
       # event_tags -               +Hash+ representing metadata associated with the event.
-      # experiment_variation_map - +Map+ of experiment ID to the ID of the variation that the user is bucketed into.
       #
       # Returns +Event+ encapsulating the conversion event.
 
       event_params = get_common_params(user_id, attributes)
-      conversion_params = get_conversion_params(event_key, event_tags, experiment_variation_map)
+      conversion_params = get_conversion_params(event, event_tags)
       event_params[:visitors][0][:snapshots] = [conversion_params]
 
       Event.new(:post, ENDPOINT, event_params, POST_HEADERS)
@@ -188,31 +190,20 @@ module Optimizely
       impression_event_params
     end
 
-    def get_conversion_params(event_key, event_tags, experiment_variation_map)
+    def get_conversion_params(event, event_tags)
       # Creates object of params specific to conversion events
       #
-      # event_key -                +String+ Key representing the event which needs to be recorded
+      # event -                    +Object+ Event which needs to be recorded.
       # event_tags -               +Hash+ Values associated with the event.
-      # experiment_variation_map - +Hash+ Map of experiment IDs to bucketed variation IDs
       #
       # Returns +Hash+ Conversion event params
 
       single_snapshot = {}
-      single_snapshot[:decisions] = []
-      experiment_variation_map.each do |experiment_id, variation_id|
-        next unless variation_id
-        single_snapshot[:decisions].push(
-          campaign_id: @config.experiment_id_map[experiment_id]['layerId'],
-          experiment_id: experiment_id,
-          variation_id: variation_id
-        )
-      end
-
       event_object = {
-        entity_id: @config.event_key_map[event_key]['id'],
+        entity_id: event['id'],
         timestamp: create_timestamp,
         uuid: create_uuid,
-        key: event_key
+        key: event['key']
       }
 
       if event_tags

data/lib/optimizely/helpers/constants.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-#    Copyright 2016-2018, Optimizely and contributors
+#    Copyright 2016-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.
@@ -327,6 +327,31 @@ module Optimizely
         'v3' => '3',
         'v4' => '4'
       }.freeze
+
+      ATTRIBUTE_VALID_TYPES = [FalseClass, Float, Integer, String, TrueClass].freeze
+
+      FINITE_NUMBER_LIMIT = 2**53
+
+      AUDIENCE_EVALUATION_LOGS = {
+        'AUDIENCE_EVALUATION_RESULT' => "Audience '%s' evaluated to %s.",
+        'AUDIENCE_EVALUATION_RESULT_COMBINED' => "Audiences for experiment '%s' collectively evaluated to %s.",
+        'EVALUATING_AUDIENCE' => "Starting to evaluate audience '%s' with conditions: %s.",
+        'EVALUATING_AUDIENCES_COMBINED' => "Evaluating audiences for experiment '%s': %s.",
+        '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].",
+        'MISSING_ATTRIBUTE_VALUE' => 'Audience condition %s evaluated as UNKNOWN because no value ' \
+        "was passed for user attribute '%s'.",
+        'NULL_ATTRIBUTE_VALUE' => 'Audience condition %s evaluated to UNKNOWN because a nil value was passed ' \
+        "for user attribute '%s'.",
+        'UNEXPECTED_TYPE' => "Audience condition %s evaluated as UNKNOWN because a value of type '%s' " \
+        "was passed for user attribute '%s'.",
+        'UNKNOWN_CONDITION_TYPE' => 'Audience condition %s uses an unknown condition type. You may need ' \
+        'to upgrade to a newer release of the Optimizely SDK.',
+        'UNKNOWN_CONDITION_VALUE' => 'Audience condition %s has an unsupported condition value. You may need ' \
+        'to upgrade to a newer release of the Optimizely SDK.',
+        'UNKNOWN_MATCH_TYPE' => 'Audience condition %s uses an unknown match type. You may need ' \
+        'to upgrade to a newer release of the Optimizely SDK.'
+      }.freeze
     end
   end
 end

data/lib/optimizely/helpers/validator.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-#    Copyright 2016-2018, Optimizely and contributors
+#    Copyright 2016-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.
@@ -34,6 +34,21 @@ module Optimizely
         attributes.is_a?(Hash)
       end
 
+      def attribute_valid?(attribute_key, attribute_value)
+        # Determines if provided attribute_key and attribute_value are valid.
+        #
+        # attribute_key - Variable which needs to be validated.
+        # attribute_value - Variable which needs to be validated.
+        #
+        # Returns boolean depending on validity of attribute_key and attribute_value.
+
+        return false unless attribute_key.is_a?(String) || attribute_key.is_a?(Symbol)
+
+        return true if (boolean? attribute_value) || (attribute_value.is_a? String)
+
+        finite_number?(attribute_value)
+      end
+
       def event_tags_valid?(event_tags)
         # Determines if provided event tags are valid.
         #
@@ -106,16 +121,54 @@ module Optimizely
         # Returns boolean True if all of the values are valid, False otherwise.
 
         return false unless variables.respond_to?(:each) && !variables.empty?
+
         is_valid = true
+        if variables.include? :user_id
+          # Empty str is a valid user ID.
+          unless variables[:user_id].is_a?(String)
+            is_valid = false
+            logger.log(level, "#{Constants::INPUT_VARIABLES['USER_ID']} is invalid")
+          end
+          variables.delete :user_id
+        end
+
         variables.each do |key, value|
           next if value.is_a?(String) && !value.empty?
+
           is_valid = false
-          if logger_valid?(logger) && level
-            logger.log(level, "#{Optimizely::Helpers::Constants::INPUT_VARIABLES[key.to_s.upcase]} is invalid")
-          end
+          next unless logger_valid?(logger) && level
+
+          logger.log(level, "#{Constants::INPUT_VARIABLES[key.to_s.upcase]} is invalid")
         end
         is_valid
       end
+
+      def boolean?(value)
+        # Returns true if given value type is boolean.
+        #         false otherwise.
+
+        value.is_a?(TrueClass) || value.is_a?(FalseClass)
+      end
+
+      def same_types?(value_1, value_2)
+        # Returns true if given values are of same types.
+        #         false otherwise.
+        # Numeric values are considered as same type.
+
+        return true if value_1.is_a?(Numeric) && value_2.is_a?(Numeric)
+
+        return true if boolean?(value_1) && boolean?(value_2)
+
+        value_1.class == value_2.class
+      end
+
+      def finite_number?(value)
+        # Returns true if the given value is a number, enforces
+        #   absolute limit of 2^53 and restricts NaN, Infinity, -Infinity.
+        #   false otherwise.
+
+        value.is_a?(Numeric) && value.to_f.finite? && value.abs <= Constants::FINITE_NUMBER_LIMIT
+      end
     end
   end
 end

data/lib/optimizely/notification_center.rb

@@ -42,6 +42,7 @@ module Optimizely
 
     def add_notification_listener(notification_type, notification_callback)
       return nil unless notification_type_valid?(notification_type)
+
       unless notification_callback
         @logger.log Logger::ERROR, 'Callback can not be empty.'
         return nil

data/lib/optimizely/project_config.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-#    Copyright 2016-2018, Optimizely and contributors
+#    Copyright 2016-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.
@@ -31,6 +31,7 @@ module Optimizely
     attr_reader :account_id
     attr_reader :attributes
     attr_reader :audiences
+    attr_reader :typed_audiences
     attr_reader :events
     attr_reader :experiments
     attr_reader :feature_flags
@@ -79,6 +80,7 @@ module Optimizely
       @account_id = config['accountId']
       @attributes = config.fetch('attributes', [])
       @audiences = config.fetch('audiences', [])
+      @typed_audiences = config.fetch('typedAudiences', [])
       @events = config.fetch('events', [])
       @experiments = config['experiments']
       @feature_flags = config.fetch('featureFlags', [])
@@ -102,6 +104,7 @@ module Optimizely
       @experiment_key_map = generate_key_map(@experiments, 'key')
       @experiment_id_map = generate_key_map(@experiments, 'id')
       @audience_id_map = generate_key_map(@audiences, 'id')
+      @audience_id_map = @audience_id_map.merge(generate_key_map(@typed_audiences, 'id')) unless @typed_audiences.empty?
       @variation_id_map = {}
       @variation_key_map = {}
       @forced_variation_map = {}
@@ -129,9 +132,9 @@ module Optimizely
           variation_id = variation['id']
           variation['featureEnabled'] = variation['featureEnabled'] == true
           variation_variables = variation['variables']
-          unless variation_variables.nil?
-            @variation_id_to_variable_usage_map[variation_id] = generate_key_map(variation_variables, 'id')
-          end
+          next if variation_variables.nil?
+
+          @variation_id_to_variable_usage_map[variation_id] = generate_key_map(variation_variables, 'id')
         end
         @variation_id_map[key] = generate_key_map(variations, 'id')
         @variation_key_map[key] = generate_key_map(variations, 'key')
@@ -161,6 +164,7 @@ module Optimizely
 
       experiment = @experiment_key_map[experiment_key]
       return experiment if experiment
+
       @logger.log Logger::ERROR, "Experiment key '#{experiment_key}' is not in datafile."
       @error_handler.handle_error InvalidExperimentError
       nil
@@ -175,23 +179,25 @@ module Optimizely
 
       experiment = @experiment_id_map[experiment_id]
       return experiment['key'] unless experiment.nil?
+
       @logger.log Logger::ERROR, "Experiment id '#{experiment_id}' is not in datafile."
       @error_handler.handle_error InvalidExperimentError
       nil
     end
 
-    def get_experiment_ids_for_event(event_key)
-      # Get experiment IDs for the provided event key.
+    def get_event_from_key(event_key)
+      # Get event for the provided event key.
       #
-      # event_key - Event key for which experiment IDs are to be retrieved.
+      # event_key - Event key for which event is to be determined.
       #
-      # Returns array of all experiment IDs for the event.
+      # Returns Event corresponding to the provided event key.
 
       event = @event_key_map[event_key]
-      return event['experimentIds'] if event
+      return event if event
+
       @logger.log Logger::ERROR, "Event '#{event_key}' is not in datafile."
       @error_handler.handle_error InvalidEventError
-      []
+      nil
     end
 
     def get_audience_from_id(audience_id)
@@ -203,6 +209,7 @@ module Optimizely
 
       audience = @audience_id_map[audience_id]
       return audience if audience
+
       @logger.log Logger::ERROR, "Audience '#{audience_id}' is not in datafile."
       @error_handler.handle_error InvalidAudienceError
       nil
@@ -220,6 +227,7 @@ module Optimizely
       if variation_id_map
         variation = variation_id_map[variation_id]
         return variation if variation
+
         @logger.log Logger::ERROR, "Variation id '#{variation_id}' is not in datafile."
         @error_handler.handle_error InvalidVariationError
         return nil
@@ -242,6 +250,7 @@ module Optimizely
       if variation_key_map
         variation = variation_key_map[variation_key]
         return variation['id'] if variation
+
         @logger.log Logger::ERROR, "Variation key '#{variation_key}' is not in datafile."
         @error_handler.handle_error InvalidVariationError
         return nil
@@ -261,6 +270,7 @@ module Optimizely
 
       experiment = @experiment_key_map[experiment_key]
       return experiment['forcedVariations'] if experiment
+
       @logger.log Logger::ERROR, "Experiment key '#{experiment_key}' is not in datafile."
       @error_handler.handle_error InvalidExperimentError
     end
@@ -322,12 +332,9 @@ module Optimizely
       #
       # Returns a boolean value that indicates if the set completed successfully.
 
-      return false unless Optimizely::Helpers::Validator.inputs_valid?(
-        {
-          user_id: user_id,
-          experiment_key: experiment_key
-        }, @logger, Logger::DEBUG
-      )
+      input_values = {experiment_key: experiment_key, user_id: user_id}
+      input_values[:variation_key] = variation_key unless variation_key.nil?
+      return false unless Optimizely::Helpers::Validator.inputs_valid?(input_values, @logger, Logger::DEBUG)
 
       experiment = get_experiment_from_key(experiment_key)
       experiment_id = experiment['id'] if experiment
@@ -335,7 +342,7 @@ module Optimizely
       return false if experiment_id.nil? || experiment_id.empty?
 
       #  clear the forced variation if the variation key is null
-      if variation_key.nil? || variation_key.empty?
+      if variation_key.nil?
         @forced_variation_map[user_id].delete(experiment_id) if @forced_variation_map.key? user_id
         @logger.log(Logger::DEBUG, "Variation mapped to experiment '#{experiment_key}' has been removed for user "\
                     "'#{user_id}'.")
@@ -350,9 +357,7 @@ module Optimizely
         return false
       end
 
-      unless @forced_variation_map.key? user_id
-        @forced_variation_map[user_id] = {}
-      end
+      @forced_variation_map[user_id] = {} unless @forced_variation_map.key? user_id
       @forced_variation_map[user_id][experiment_id] = variation_id
       @logger.log(Logger::DEBUG, "Set variation '#{variation_id}' for experiment '#{experiment_id}' and "\
                   "user '#{user_id}' in the forced variation map.")
@@ -377,6 +382,7 @@ module Optimizely
         return attribute['id']
       end
       return attribute_key if has_reserved_prefix
+
       @logger.log Logger::ERROR, "Attribute key '#{attribute_key}' is not in datafile."
       @error_handler.handle_error InvalidAttributeError
       nil
@@ -395,6 +401,7 @@ module Optimizely
       if variation_id_map
         variation = variation_id_map[variation_id]
         return true if variation
+
         @logger.log Logger::ERROR, "Variation ID '#{variation_id}' is not in datafile."
         @error_handler.handle_error InvalidVariationError
       end
@@ -410,6 +417,7 @@ module Optimizely
       # Returns feature flag if found, otherwise nil
       feature_flag = @feature_flag_key_map[feature_flag_key]
       return feature_flag if feature_flag
+
       @logger.log Logger::ERROR, "Feature flag key '#{feature_flag_key}' is not in datafile."
       nil
     end
@@ -424,6 +432,7 @@ module Optimizely
       feature_flag_key = feature_flag['key']
       variable = @feature_variable_key_map[feature_flag_key][variable_key]
       return variable if variable
+
       @logger.log Logger::ERROR, "No feature variable was found for key '#{variable_key}' in feature flag "\
                   "'#{feature_flag_key}'."
       nil
@@ -437,6 +446,7 @@ module Optimizely
       # Returns the rollout if found, otherwise nil
       rollout = @rollout_id_map[rollout_id]
       return rollout if rollout
+
       @logger.log Logger::ERROR, "Rollout with ID '#{rollout_id}' is not in the datafile."
       nil
     end