optimizely-sdk 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6269e81defa38267703852ceb2e5d29de7ddad0
-  data.tar.gz: 2bd5d9f48a01e25dea810ca7b42bfc1c63c2bf40
+  metadata.gz: a5bbc06065e5e4e126182cea9c01e801f3f6c3e2
+  data.tar.gz: a7be551c6fabb0e6f93d85e531d3d0e360403194
 SHA512:
-  metadata.gz: a81f892eef13d1f9c28a17daf44dc320a6c075e43b24f89e70b7f5d58ef91a2db35013e86b5de2b9be90360dcf53fd8757e7c54652f30b5ded0c71e2fe2bb95d
-  data.tar.gz: 77570a8ef7bb7dcfcbed470742686603cb361dc8fb593d737525e6b93e330084833d4c3b277c535a3c93131d1e10cf18296db70e9bb1246e915ead1456b78af9
+  metadata.gz: 4f24e739480c517e98df5cf98cb0412716683045e389fc253f7e4270226a235ade6f54c7a83647c5c0c4b645f84aa496a3edea70653fd4c2186e7c044c4da6e7
+  data.tar.gz: 702fb0aa34bd14ef60aaea54180b8a0b06772c85413574f3218c9e7b2729e8e41062da49cf2e9a3d78ae709fa1cc8ff1fc636a1aa98199b2b8bab7c0a46e82ec

data/lib/optimizely.rb

@@ -137,18 +137,30 @@ module Optimizely
         }, @logger, Logger::ERROR
       )
 
+      experiment = @config.get_experiment_from_key(experiment_key)
+      return nil if experiment.nil?
+
       unless user_inputs_valid?(attributes)
         @logger.log(Logger::INFO, "Not activating user '#{user_id}.")
         return nil
       end
 
       variation_id = @decision_service.get_variation(experiment_key, user_id, attributes)
+      variation = @config.get_variation_from_id(experiment_key, variation_id) unless variation_id.nil?
+      variation_key = variation['key'] if variation
+      decision_notification_type = if @config.feature_experiment?(experiment['id'])
+                                     Helpers::Constants::DECISION_NOTIFICATION_TYPES['FEATURE_TEST']
+                                   else
+                                     Helpers::Constants::DECISION_NOTIFICATION_TYPES['AB_TEST']
+                                   end
+      @notification_center.send_notifications(
+        NotificationCenter::NOTIFICATION_TYPES[:DECISION],
+        decision_notification_type, user_id, (attributes || {}),
+        experiment_key: experiment_key,
+        variation_key: variation_key
+      )
 
-      unless variation_id.nil?
-        variation = @config.get_variation_from_id(experiment_key, variation_id)
-        return variation['key'] if variation
-      end
-      nil
+      variation_key
     end
 
     # Force a user into a variation for a given experiment.
@@ -257,30 +269,45 @@ module Optimizely
       end
 
       decision = @decision_service.get_variation_for_feature(feature_flag, user_id, attributes)
-      if decision.nil?
-        @logger.log(Logger::INFO,
-                    "Feature '#{feature_flag_key}' is not enabled for user '#{user_id}'.")
-        return false
-      end
 
-      variation = decision['variation']
-      if decision.source == Optimizely::DecisionService::DECISION_SOURCE_EXPERIMENT
-        # Send event if Decision came from an experiment.
-        send_impression(decision.experiment, variation['key'], user_id, attributes)
-      else
-        @logger.log(Logger::DEBUG,
-                    "The user '#{user_id}' is not being experimented on in feature '#{feature_flag_key}'.")
+      feature_enabled = false
+      source_string = Optimizely::DecisionService::DECISION_SOURCES['ROLLOUT']
+      if decision.is_a?(Optimizely::DecisionService::Decision)
+        variation = decision['variation']
+        feature_enabled = variation['featureEnabled']
+        if decision.source == Optimizely::DecisionService::DECISION_SOURCES['FEATURE_TEST']
+          source_string = Optimizely::DecisionService::DECISION_SOURCES['FEATURE_TEST']
+          source_info = {
+            experiment_key: decision.experiment['key'],
+            variation_key: variation['key']
+          }
+          # Send event if Decision came from an experiment.
+          send_impression(decision.experiment, variation['key'], user_id, attributes)
+        else
+          @logger.log(Logger::DEBUG,
+                      "The user '#{user_id}' is not being experimented on in feature '#{feature_flag_key}'.")
+        end
       end
 
-      if variation['featureEnabled'] == true
+      @notification_center.send_notifications(
+        NotificationCenter::NOTIFICATION_TYPES[:DECISION],
+        Helpers::Constants::DECISION_NOTIFICATION_TYPES['FEATURE'],
+        user_id, (attributes || {}),
+        feature_key: feature_flag_key,
+        feature_enabled: feature_enabled,
+        source: source_string,
+        source_info: source_info || {}
+      )
+
+      if feature_enabled == true
         @logger.log(Logger::INFO,
                     "Feature '#{feature_flag_key}' is enabled for user '#{user_id}'.")
         return true
-      else
-        @logger.log(Logger::INFO,
-                    "Feature '#{feature_flag_key}' is not enabled for user '#{user_id}'.")
-        return false
       end
+
+      @logger.log(Logger::INFO,
+                  "Feature '#{feature_flag_key}' is not enabled for user '#{user_id}'.")
+      false
     end
 
     # Gets keys of all feature flags which are enabled for the user.
@@ -461,25 +488,40 @@ module Optimizely
       # Error message logged in ProjectConfig- get_feature_flag_from_key
       return nil if variable.nil?
 
+      feature_enabled = false
       # Returns nil if type differs
       if variable['type'] != variable_type
         @logger.log(Logger::WARN,
                     "Requested variable as type '#{variable_type}' but variable '#{variable_key}' is of type '#{variable['type']}'.")
         return nil
       else
+        source_string = Optimizely::DecisionService::DECISION_SOURCES['ROLLOUT']
         decision = @decision_service.get_variation_for_feature(feature_flag, user_id, attributes)
         variable_value = variable['defaultValue']
         if decision
           variation = decision['variation']
-          variation_variable_usages = @config.variation_id_to_variable_usage_map[variation['id']]
-          variable_id = variable['id']
-          if variation_variable_usages&.key?(variable_id)
-            variable_value = variation_variable_usages[variable_id]['value']
-            @logger.log(Logger::INFO,
-                        "Got variable value '#{variable_value}' for variable '#{variable_key}' of feature flag '#{feature_flag_key}'.")
+          if decision['source'] == Optimizely::DecisionService::DECISION_SOURCES['FEATURE_TEST']
+            source_info = {
+              experiment_key: decision.experiment['key'],
+              variation_key: variation['key']
+            }
+            source_string = Optimizely::DecisionService::DECISION_SOURCES['FEATURE_TEST']
+          end
+          feature_enabled = variation['featureEnabled']
+          if feature_enabled == true
+            variation_variable_usages = @config.variation_id_to_variable_usage_map[variation['id']]
+            variable_id = variable['id']
+            if variation_variable_usages&.key?(variable_id)
+              variable_value = variation_variable_usages[variable_id]['value']
+              @logger.log(Logger::INFO,
+                          "Got variable value '#{variable_value}' for variable '#{variable_key}' of feature flag '#{feature_flag_key}'.")
+            else
+              @logger.log(Logger::DEBUG,
+                          "Variable '#{variable_key}' is not used in variation '#{variation['key']}'. Returning the default variable value '#{variable_value}'.")
+            end
           else
             @logger.log(Logger::DEBUG,
-                        "Variable '#{variable_key}' is not used in variation '#{variation['key']}'. Returning the default variable value '#{variable_value}'.")
+                        "Feature '#{feature_flag_key}' for variation '#{variation['key']}' is not enabled. Returning the default variable value '#{variable_value}'.")
           end
         else
           @logger.log(Logger::INFO,
@@ -489,6 +531,18 @@ module Optimizely
 
       variable_value = Helpers::VariableType.cast_value_to_type(variable_value, variable_type, @logger)
 
+      @notification_center.send_notifications(
+        NotificationCenter::NOTIFICATION_TYPES[:DECISION],
+        Helpers::Constants::DECISION_NOTIFICATION_TYPES['FEATURE_VARIABLE'], user_id, (attributes || {}),
+        feature_key: feature_flag_key,
+        feature_enabled: feature_enabled,
+        source: source_string,
+        variable_key: variable_key,
+        variable_type: variable_type,
+        variable_value: variable_value,
+        source_info: source_info || {}
+      )
+
       variable_value
     end
 

data/lib/optimizely/decision_service.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-#    Copyright 2017-2018, Optimizely and contributors
+#    Copyright 2017-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.
@@ -35,8 +35,11 @@ module Optimizely
     attr_reader :config
 
     Decision = Struct.new(:experiment, :variation, :source)
-    DECISION_SOURCE_EXPERIMENT = 'experiment'
-    DECISION_SOURCE_ROLLOUT = 'rollout'
+
+    DECISION_SOURCES = {
+      'FEATURE_TEST' => 'feature-test',
+      'ROLLOUT' => 'rollout'
+    }.freeze
 
     def initialize(config, user_profile_service = nil)
       @config = config
@@ -172,7 +175,7 @@ module Optimizely
           Logger::INFO,
           "The user '#{user_id}' is bucketed into experiment '#{experiment_key}' of feature '#{feature_flag_key}'."
         )
-        return Decision.new(experiment, variation, DECISION_SOURCE_EXPERIMENT)
+        return Decision.new(experiment, variation, DECISION_SOURCES['FEATURE_TEST'])
       end
 
       @config.logger.log(
@@ -236,7 +239,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?
+        return Decision.new(rollout_rule, variation, DECISION_SOURCES['ROLLOUT']) unless variation.nil?
 
         break
       end
@@ -255,7 +258,7 @@ module Optimizely
         return nil
       end
       variation = @bucketer.bucket(everyone_else_experiment, bucketing_id, user_id)
-      return Decision.new(everyone_else_experiment, variation, DECISION_SOURCE_ROLLOUT) unless variation.nil?
+      return Decision.new(everyone_else_experiment, variation, DECISION_SOURCES['ROLLOUT']) unless variation.nil?
 
       nil
     end

data/lib/optimizely/helpers/constants.rb

@@ -352,6 +352,13 @@ module Optimizely
         '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
+
+      DECISION_NOTIFICATION_TYPES = {
+        'AB_TEST' => 'ab-test',
+        'FEATURE' => 'feature',
+        'FEATURE_TEST' => 'feature-test',
+        'FEATURE_VARIABLE' => 'feature-variable'
+      }.freeze
     end
   end
 end

data/lib/optimizely/notification_center.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-#    Copyright 2017-2018, Optimizely and contributors
+#    Copyright 2017-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.
@@ -21,7 +21,9 @@ module Optimizely
     attr_reader :notifications, :notification_id
 
     NOTIFICATION_TYPES = {
+      # DEPRECATED: ACTIVATE notification type is deprecated since relase 3.1.0.
       ACTIVATE: 'ACTIVATE: experiment, user_id, attributes, variation, event',
+      DECISION: 'DECISION: type, user_id, attributes, decision_info',
       TRACK: 'TRACK: event_key, user_id, attributes, event_tags, event'
     }.freeze
 

data/lib/optimizely/project_config.rb

@@ -47,6 +47,7 @@ module Optimizely
     attr_reader :attribute_key_map
     attr_reader :audience_id_map
     attr_reader :event_key_map
+    attr_reader :experiment_feature_map
     attr_reader :experiment_id_map
     attr_reader :experiment_key_map
     attr_reader :feature_flag_key_map
@@ -140,9 +141,13 @@ module Optimizely
         @variation_key_map[key] = generate_key_map(variations, 'key')
       end
       @feature_flag_key_map = generate_key_map(@feature_flags, 'key')
+      @experiment_feature_map = {}
       @feature_variable_key_map = {}
       @feature_flag_key_map.each do |key, feature_flag|
         @feature_variable_key_map[key] = generate_key_map(feature_flag['variables'], 'key')
+        feature_flag['experimentIds'].each do |experiment_id|
+          @experiment_feature_map[experiment_id] = [feature_flag['id']]
+        end
       end
     end
 
@@ -451,6 +456,16 @@ module Optimizely
       nil
     end
 
+    def feature_experiment?(experiment_id)
+      # Determines if given experiment is a feature test.
+      #
+      # experiment_id - String experiment ID
+      #
+      # Returns true if experiment belongs to  any feature,
+      #              false otherwise.
+      @experiment_feature_map.key?(experiment_id)
+    end
+
     private
 
     def generate_key_map(array, key)

data/lib/optimizely/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: optimizely-sdk
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Optimizely
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-08 00:00:00.000000000 Z
+date: 2019-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -184,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby SDK for Optimizely's testing framework