optimizely-sdk 3.8.1 → 3.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5751701cecb265d27a62c72b268fcb01bb5a37f8696f97a6f56ad29776b226cc
-  data.tar.gz: 32533f70bdd2861e2250b3c1b8e274d61f04395dd4ff5cf7ff0776d5f49c2a90
+  metadata.gz: 3502b43c8fae064fda3e1b237786a0285103d4ce9383a9d64cfc7b34f3f8c849
+  data.tar.gz: 9b843fc3a7999e640f329812aeeb8e26474b5b85f29d27c0647ba7c3685cb73f
 SHA512:
-  metadata.gz: f7258d91de18c854b91f1d938c4624bf227307a2f01aec82aa23d1f2978ca8510209171f4dc62a3d2dcc606784a741dd9f6572d7c6a81475e2b791e70b7e45be
-  data.tar.gz: 1471cf812fbebc51fe2207e599f44b60597c3e6e15209af400d4ecabe0333bcd285269b3b421ad80f043c33012aecc54d3d41e59c53dffe64b09b93039b36254
+  metadata.gz: a244307de60cf4a7e9b4e90bd0282e071e310701c09b4314a5f011f9f97a1f638205dc9e3de59611c247315314bfd58a0521690bbc3fa876575f3ef8fa917306
+  data.tar.gz: b68df42eef86c3a4e1fd22f2b1b4cd3060df4ade0c9125862443164735778a16415af958a4002fba7adcdf078d1552a5ffef446bac22e7a269a5984445d1fd50

data/lib/optimizely/condition_tree_evaluator.rb

@@ -28,6 +28,8 @@ module Optimizely
       NOT_CONDITION => :not_evaluator
     }.freeze
 
+    OPERATORS = [AND_CONDITION, OR_CONDITION, NOT_CONDITION].freeze
+
     module_function
 
     def evaluate(conditions, leaf_evaluator)

data/lib/optimizely/config/datafile_project_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.
@@ -38,6 +38,8 @@ module Optimizely
     attr_reader :anonymize_ip
     attr_reader :bot_filtering
     attr_reader :revision
+    attr_reader :sdk_key
+    attr_reader :environment_key
     attr_reader :rollouts
     attr_reader :version
     attr_reader :send_flag_decisions
@@ -85,6 +87,8 @@ module Optimizely
       @anonymize_ip = config.key?('anonymizeIP') ? config['anonymizeIP'] : false
       @bot_filtering = config['botFiltering']
       @revision = config['revision']
+      @sdk_key = config.fetch('sdkKey', '')
+      @environment_key = config.fetch('environmentKey', '')
       @rollouts = config.fetch('rollouts', [])
       @send_flag_decisions = config.fetch('sendFlagDecisions', false)
 
@@ -478,6 +482,16 @@ module Optimizely
       @experiment_feature_map.key?(experiment_id)
     end
 
+    def rollout_experiment?(experiment_id)
+      # Determines if given experiment is a rollout test.
+      #
+      # experiment_id - String experiment ID
+      #
+      # Returns true if experiment belongs to  any rollout,
+      #              false otherwise.
+      @rollout_experiment_id_map.key?(experiment_id)
+    end
+
     private
 
     def generate_key_map(array, key)

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/project_config.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-#    Copyright 2016-2020, Optimizely and contributors
+#    Copyright 2016-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.
@@ -46,6 +46,10 @@ module Optimizely
 
     def revision; end
 
+    def sdk_key; end
+
+    def environment_key; end
+
     def send_flag_decisions; end
 
     def rollouts; end

data/lib/optimizely/version.rb

@@ -17,5 +17,5 @@
 #
 module Optimizely
   CLIENT_ENGINE = 'ruby-sdk'
-  VERSION = '3.8.1'
+  VERSION = '3.9.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: optimizely-sdk
 version: !ruby/object:Gem::Version
-  version: 3.8.1
+  version: 3.9.0
 platform: ruby
 authors:
 - Optimizely
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-02 00:00:00.000000000 Z
+date: 2021-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler