optimizely-sdk 3.6.0 → 3.9.0

data/lib/optimizely/event/entity/decision.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-#    Copyright 2019, Optimizely and contributors
+#    Copyright 2019-2020, 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.
@@ -17,19 +17,21 @@
 #
 module Optimizely
   class Decision
-    attr_reader :campaign_id, :experiment_id, :variation_id
+    attr_reader :campaign_id, :experiment_id, :variation_id, :metadata
 
-    def initialize(campaign_id:, experiment_id:, variation_id:)
+    def initialize(campaign_id:, experiment_id:, variation_id:, metadata:)
       @campaign_id = campaign_id
       @experiment_id = experiment_id
       @variation_id = variation_id
+      @metadata = metadata
     end
 
     def as_json
       {
         campaign_id: @campaign_id,
         experiment_id: @experiment_id,
-        variation_id: @variation_id
+        variation_id: @variation_id,
+        metadata: @metadata
       }
     end
   end

data/lib/optimizely/event/entity/impression_event.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-#    Copyright 2019, Optimizely and contributors
+#    Copyright 2019-2020, 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.
@@ -19,7 +19,7 @@ require_relative 'user_event'
 require 'optimizely/helpers/date_time_utils'
 module Optimizely
   class ImpressionEvent < UserEvent
-    attr_reader :user_id, :experiment_layer_id, :experiment_id, :variation_id,
+    attr_reader :user_id, :experiment_layer_id, :experiment_id, :variation_id, :metadata,
                 :visitor_attributes, :bot_filtering
 
     def initialize(
@@ -28,6 +28,7 @@ module Optimizely
       experiment_layer_id:,
       experiment_id:,
       variation_id:,
+      metadata:,
       visitor_attributes:,
       bot_filtering:
     )
@@ -38,6 +39,7 @@ module Optimizely
       @experiment_layer_id = experiment_layer_id
       @experiment_id = experiment_id
       @variation_id = variation_id
+      @metadata = metadata
       @visitor_attributes = visitor_attributes
       @bot_filtering = bot_filtering
     end

data/lib/optimizely/event/event_factory.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-#    Copyright 2019, Optimizely and contributors
+#    Copyright 2019-2020, 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.
@@ -101,10 +101,11 @@ module Optimizely
       private
 
       def create_impression_event_visitor(impression_event)
-        decision = Optimizely::Decision.new(
+        decision = Decision.new(
           campaign_id: impression_event.experiment_layer_id,
           experiment_id: impression_event.experiment_id,
-          variation_id: impression_event.variation_id
+          variation_id: impression_event.variation_id,
+          metadata: impression_event.metadata
         )
 
         snapshot_event = Optimizely::SnapshotEvent.new(

data/lib/optimizely/event/user_event_factory.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-#    Copyright 2019, Optimizely and contributors
+#    Copyright 2019-2020, 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.
@@ -22,7 +22,7 @@ require_relative 'event_factory'
 module Optimizely
   class UserEventFactory
     # UserEventFactory builds ImpressionEvent and ConversionEvent objects from a given user_event.
-    def self.create_impression_event(project_config, experiment, variation_id, user_id, user_attributes)
+    def self.create_impression_event(project_config, experiment, variation_id, metadata, user_id, user_attributes)
       # Create impression Event to be sent to the logging endpoint.
       #
       # project_config - Instance of ProjectConfig
@@ -42,13 +42,14 @@ module Optimizely
       ).as_json
 
       visitor_attributes = Optimizely::EventFactory.build_attribute_list(user_attributes, project_config)
-      experiment_layer_id = project_config.experiment_key_map[experiment['key']]['layerId']
+      experiment_layer_id = experiment['layerId']
       Optimizely::ImpressionEvent.new(
         event_context: event_context,
         user_id: user_id,
         experiment_layer_id: experiment_layer_id,
         experiment_id: experiment['id'],
         variation_id: variation_id,
+        metadata: metadata,
         visitor_attributes: visitor_attributes,
         bot_filtering: project_config.bot_filtering
       )

data/lib/optimizely/helpers/constants.rb

@@ -369,6 +369,7 @@ module Optimizely
         'FEATURE' => 'feature',
         'FEATURE_TEST' => 'feature-test',
         'FEATURE_VARIABLE' => 'feature-variable',
+        'FLAG' => 'flag',
         'ALL_FEATURE_VARIABLES' => 'all-feature-variables'
       }.freeze
 

data/lib/optimizely/optimizely_config.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-#    Copyright 2019-2020, Optimizely and contributors
+#    Copyright 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.
@@ -16,53 +16,109 @@
 #
 
 module Optimizely
+  require 'json'
   class OptimizelyConfig
+    include Optimizely::ConditionTreeEvaluator
     def initialize(project_config)
       @project_config = project_config
+      @rollouts = @project_config.rollouts
+      @audiences = []
+      audience_id_lookup_dict = {}
+
+      @project_config.typed_audiences.each do |typed_audience|
+        @audiences.push(
+          'id' => typed_audience['id'],
+          'name' => typed_audience['name'],
+          'conditions' => typed_audience['conditions'].to_json
+        )
+        audience_id_lookup_dict[typed_audience['id']] = typed_audience['id']
+      end
+
+      @project_config.audiences.each do |audience|
+        next unless !audience_id_lookup_dict.key?(audience['id']) && (audience['id'] != '$opt_dummy_audience')
+
+        @audiences.push(
+          'id' => audience['id'],
+          'name' => audience['name'],
+          'conditions' => audience['conditions']
+        )
+      end
     end
 
     def config
       experiments_map_object = experiments_map
-      features_map = get_features_map(experiments_map_object)
-      {
+      features_map = get_features_map(experiments_id_map)
+      config = {
+        'sdkKey' => @project_config.sdk_key,
         'datafile' => @project_config.datafile,
+        # This experimentsMap is for experiments of legacy projects only.
+        # For flag projects, experiment keys are not guaranteed to be unique
+        # across multiple flags, so this map may not include all experiments
+        # when keys conflict. Use experimentRules and deliveryRules instead.
         'experimentsMap' => experiments_map_object,
         'featuresMap' => features_map,
-        'revision' => @project_config.revision
+        'revision' => @project_config.revision,
+        'attributes' => get_attributes_list(@project_config.attributes),
+        'audiences' => @audiences,
+        'events' => get_events_list(@project_config.events),
+        'environmentKey' => @project_config.environment_key
       }
+      config
     end
 
     private
 
-    def experiments_map
-      feature_variables_map = @project_config.feature_flags.reduce({}) do |result_map, feature|
-        result_map.update(feature['id'] => feature['variables'])
-      end
+    def experiments_id_map
+      feature_variables_map = feature_variable_map
+      audiences_id_map = audiences_map
       @project_config.experiments.reduce({}) do |experiments_map, experiment|
+        feature_id = @project_config.experiment_feature_map.fetch(experiment['id'], []).first
         experiments_map.update(
-          experiment['key'] => {
+          experiment['id'] => {
             'id' => experiment['id'],
             'key' => experiment['key'],
-            'variationsMap' => experiment['variations'].reduce({}) do |variations_map, variation|
-              variation_object = {
-                'id' => variation['id'],
-                'key' => variation['key'],
-                'variablesMap' => get_merged_variables_map(variation, experiment['id'], feature_variables_map)
-              }
-              variation_object['featureEnabled'] = variation['featureEnabled'] if @project_config.feature_experiment?(experiment['id'])
-              variations_map.update(variation['key'] => variation_object)
-            end
+            'variationsMap' => get_variation_map(feature_id, experiment, feature_variables_map),
+            'audiences' => replace_ids_with_names(experiment.fetch('audienceConditions', []), audiences_id_map) || ''
           }
         )
       end
     end
 
+    def audiences_map
+      @audiences.reduce({}) do |audiences_map, optly_audience|
+        audiences_map.update(optly_audience['id'] => optly_audience['name'])
+      end
+    end
+
+    def experiments_map
+      experiments_id_map.values.reduce({}) do |experiments_key_map, experiment|
+        experiments_key_map.update(experiment['key'] => experiment)
+      end
+    end
+
+    def feature_variable_map
+      @project_config.feature_flags.reduce({}) do |result_map, feature|
+        result_map.update(feature['id'] => feature['variables'])
+      end
+    end
+
+    def get_variation_map(feature_id, experiment, feature_variables_map)
+      experiment['variations'].reduce({}) do |variations_map, variation|
+        variation_object = {
+          'id' => variation['id'],
+          'key' => variation['key'],
+          'featureEnabled' => variation['featureEnabled'],
+          'variablesMap' => get_merged_variables_map(variation, feature_id, feature_variables_map)
+        }
+        variations_map.update(variation['key'] => variation_object)
+      end
+    end
+
     # Merges feature key and type from feature variables to variation variables.
-    def get_merged_variables_map(variation, experiment_id, feature_variables_map)
-      feature_ids = @project_config.experiment_feature_map[experiment_id]
-      return {} unless feature_ids
+    def get_merged_variables_map(variation, feature_id, feature_variables_map)
+      return {} unless feature_id
 
-      experiment_feature_variables = feature_variables_map[feature_ids[0]]
+      feature_variables = feature_variables_map[feature_id]
       # temporary variation variables map to get values to merge.
       temp_variables_id_map = {}
       if variation['variables']
@@ -75,7 +131,7 @@ module Optimizely
           )
         end
       end
-      experiment_feature_variables.reduce({}) do |variables_map, feature_variable|
+      feature_variables.reduce({}) do |variables_map, feature_variable|
         variation_variable = temp_variables_id_map[feature_variable['id']]
         variable_value = variation['featureEnabled'] && variation_variable ? variation_variable['value'] : feature_variable['defaultValue']
         variables_map.update(
@@ -91,13 +147,15 @@ module Optimizely
 
     def get_features_map(all_experiments_map)
       @project_config.feature_flags.reduce({}) do |features_map, feature|
+        delivery_rules = get_delivery_rules(@rollouts, feature['rolloutId'], feature['id'])
         features_map.update(
           feature['key'] => {
             'id' => feature['id'],
             'key' => feature['key'],
+            # This experimentsMap is deprecated. Use experimentRules and deliveryRules instead.
             'experimentsMap' => feature['experimentIds'].reduce({}) do |experiments_map, experiment_id|
               experiment_key = @project_config.experiment_id_map[experiment_id]['key']
-              experiments_map.update(experiment_key => all_experiments_map[experiment_key])
+              experiments_map.update(experiment_key => experiments_id_map[experiment_id])
             end,
             'variablesMap' => feature['variables'].reduce({}) do |variables, variable|
               variables.update(
@@ -108,10 +166,107 @@ module Optimizely
                   'value' => variable['defaultValue']
                 }
               )
-            end
+            end,
+            'experimentRules' => feature['experimentIds'].reduce([]) do |experiments_map, experiment_id|
+              experiments_map.push(all_experiments_map[experiment_id])
+            end,
+            'deliveryRules' => delivery_rules
           }
         )
       end
     end
+
+    def get_attributes_list(attributes)
+      attributes.map do |attribute|
+        {
+          'id' => attribute['id'],
+          'key' => attribute['key']
+        }
+      end
+    end
+
+    def get_events_list(events)
+      events.map do |event|
+        {
+          'id' => event['id'],
+          'key' => event['key'],
+          'experimentIds' => event['experimentIds']
+        }
+      end
+    end
+
+    def lookup_name_from_id(audience_id, audiences_map)
+      audiences_map[audience_id] || audience_id
+    end
+
+    def stringify_conditions(conditions, audiences_map)
+      operand = 'OR'
+      conditions_str = ''
+      length = conditions.length()
+      return '' if length.zero?
+      return '"' + lookup_name_from_id(conditions[0], audiences_map) + '"' if length == 1 && !OPERATORS.include?(conditions[0])
+
+      # Edge cases for lengths 0, 1 or 2
+      if length == 2 && OPERATORS.include?(conditions[0]) && !conditions[1].is_a?(Array) && !OPERATORS.include?(conditions[1])
+        return '"' + lookup_name_from_id(conditions[1], audiences_map) + '"' if conditions[0] != 'not'
+
+        return conditions[0].upcase + ' "' + lookup_name_from_id(conditions[1], audiences_map) + '"'
+
+      end
+      if length > 1
+        (0..length - 1).each do |n|
+          # Operand is handled here and made Upper Case
+          if OPERATORS.include?(conditions[n])
+            operand = conditions[n].upcase
+          # Check if element is a list or not
+          elsif conditions[n].is_a?(Array)
+            # Check if at the end or not to determine where to add the operand
+            # Recursive call to call stringify on embedded list
+            conditions_str += if n + 1 < length
+                                '(' + stringify_conditions(conditions[n], audiences_map) + ') '
+                              else
+                                operand + ' (' + stringify_conditions(conditions[n], audiences_map) + ')'
+                              end
+          # If the item is not a list, we process as an audience ID and retrieve the name
+          else
+            audience_name = lookup_name_from_id(conditions[n], audiences_map)
+            unless audience_name.nil?
+              # Below handles all cases for one ID or greater
+              conditions_str += if n + 1 < length - 1
+                                  '"' + audience_name + '" ' + operand + ' '
+                                elsif n + 1 == length
+                                  operand + ' "' + audience_name + '"'
+                                else
+                                  '"' + audience_name + '" '
+                                end
+            end
+          end
+        end
+      end
+      conditions_str || ''
+    end
+
+    def replace_ids_with_names(conditions, audiences_map)
+      !conditions.empty? ? stringify_conditions(conditions, audiences_map) : ''
+    end
+
+    def get_delivery_rules(rollouts, rollout_id, feature_id)
+      audiences_id_map = audiences_map
+      feature_variables_map = feature_variable_map
+      rollout = rollouts.select { |selected_rollout| selected_rollout['id'] == rollout_id }
+      if rollout.any?
+        rollout = rollout[0]
+        experiments = rollout['experiments']
+        return experiments.map do |experiment|
+          {
+            'id' => experiment['id'],
+            'key' => experiment['key'],
+            'variationsMap' => get_variation_map(feature_id, experiment, feature_variables_map),
+            'audiences' => replace_ids_with_names(experiment.fetch('audienceConditions', []), audiences_id_map) || ''
+          }
+        end
+      end
+      []
+    end
   end
 end

data/lib/optimizely/optimizely_user_context.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+#
+#    Copyright 2020, 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'
+
+module Optimizely
+  class OptimizelyUserContext
+    # Representation of an Optimizely User Context using which APIs are to be called.
+
+    attr_reader :user_id
+
+    def initialize(optimizely_client, user_id, user_attributes)
+      @attr_mutex = Mutex.new
+      @optimizely_client = optimizely_client
+      @user_id = user_id
+      @user_attributes = user_attributes.nil? ? {} : user_attributes.clone
+    end
+
+    def clone
+      OptimizelyUserContext.new(@optimizely_client, @user_id, user_attributes)
+    end
+
+    def user_attributes
+      @attr_mutex.synchronize { @user_attributes.clone }
+    end
+
+    # Set an attribute for a given key
+    #
+    # @param key - An attribute key
+    # @param value - An attribute value
+
+    def set_attribute(attribute_key, attribute_value)
+      @attr_mutex.synchronize { @user_attributes[attribute_key] = attribute_value }
+    end
+
+    # Returns a decision result (OptimizelyDecision) for a given flag key and a user context, which contains all data required to deliver the flag.
+    #
+    # If the SDK finds an error, it'll return a `decision` with nil for `variation_key`. The decision will include an error message in `reasons`
+    #
+    # @param key -A flag key for which a decision will be made
+    # @param options - A list of options for decision making.
+    #
+    # @return [OptimizelyDecision] A decision result
+
+    def decide(key, options = nil)
+      @optimizely_client&.decide(clone, key, options)
+    end
+
+    # Returns a hash of decision results (OptimizelyDecision) for multiple flag keys and a user context.
+    #
+    # If the SDK finds an error for a key, the response will include a decision for the key showing `reasons` for the error.
+    # The SDK will always return hash of decisions. When it can not process requests, it'll return an empty hash after logging the errors.
+    #
+    # @param keys - A list of flag keys for which the decisions will be made.
+    # @param options - A list of options for decision making.
+    #
+    # @return - Hash of decisions containing flag keys as hash keys and corresponding decisions as their values.
+
+    def decide_for_keys(keys, options = nil)
+      @optimizely_client&.decide_for_keys(clone, keys, options)
+    end
+
+    # Returns a hash of decision results (OptimizelyDecision) for all active flag keys.
+    #
+    # @param options - A list of options for decision making.
+    #
+    # @return - Hash of decisions containing flag keys as hash keys and corresponding decisions as their values.
+
+    def decide_all(options = nil)
+      @optimizely_client&.decide_all(clone, options)
+    end
+
+    # Track an event
+    #
+    # @param event_key - Event key representing the event which needs to be recorded.
+
+    def track_event(event_key, event_tags = nil)
+      @optimizely_client&.track(event_key, @user_id, user_attributes, event_tags)
+    end
+
+    def as_json
+      {
+        user_id: @user_id,
+        attributes: @user_attributes
+      }
+    end
+
+    def to_json(*args)
+      as_json.to_json(*args)
+    end
+  end
+end