Refactor experiment key map (#55)

Author: mikeproeng37

lib/optimizely.rb

@@ -108,7 +108,8 @@ def activate(experiment_key, user_id, attributes = nil)
 
       # Create and dispatch impression event
       variation_id = @config.get_variation_id_from_key(experiment_key, variation_key)
-      impression_event = @event_builder.create_impression_event(experiment_key, variation_id, user_id, attributes)
+      experiment = @config.get_experiment_from_key(experiment_key)
+      impression_event = @event_builder.create_impression_event(experiment, variation_id, user_id, attributes)
       @logger.log(Logger::INFO,
                   'Dispatching impression event to URL %s with params %s.' % [impression_event.url,
                                                                               impression_event.params])

lib/optimizely/audience.rb

@@ -20,17 +20,17 @@ module Optimizely
   module Audience
     module_function
 
-    def user_in_experiment?(config, experiment_key, attributes)
+    def user_in_experiment?(config, experiment, attributes)
       # Determine for given experiment if user satisfies the audiences for the experiment.
       #
       # config - Representation of the Optimizely project config.
-      # experiment_key - Key representing experiment for which visitor is to be bucketed.
+      # experiment - Experiment for which visitor is to be bucketed.
       # attributes - Hash representing user attributes which will be used in determining if
       #              the audience conditions are met.
       #
       # Returns boolean representing if user satisfies audience conditions for any of the audiences or not.
 
-      audience_ids = config.get_audience_ids_for_experiment(experiment_key)
+      audience_ids = experiment['audienceIds']
 
       # Return true if there are no audiences
       return true if audience_ids.empty?

lib/optimizely/bucketer.rb

@@ -35,17 +35,18 @@ def initialize(config)
       @config = config
     end
 
-    def bucket(experiment_key, user_id)
+    def bucket(experiment, user_id)
       # Determines ID of variation to be shown for a given experiment key and user ID.
       #
-      # experiment_key - String Key representing experiment for which visitor is to be bucketed.
+      # experiment - Experiment for which visitor is to be bucketed.
       # user_id - String ID for user.
       #
       # Returns String variation ID in which visitor with ID user_id has been placed. Nil if no variation.
 
       # check if experiment is in a group; if so, check if user is bucketed into specified experiment
-      experiment_id = @config.get_experiment_id(experiment_key)
-      group_id = @config.get_experiment_group_id(experiment_key)
+      experiment_id = experiment['id']
+      experiment_key = experiment['key']
+      group_id = experiment['groupId']
       if group_id
         group = @config.group_key_map.fetch(group_id)
         if Helpers::Group.random_policy?(group)
@@ -78,11 +79,9 @@ def bucket(experiment_key, user_id)
         end
       end
 
-      bucketing_id = sprintf(BUCKETING_ID_TEMPLATE, user_id: user_id, entity_id: experiment_id)
-      bucket_value = generate_bucket_value(bucketing_id)
-      @config.logger.log(Logger::DEBUG, "Assigned variation bucket #{bucket_value} to user '#{user_id}'.")
-      traffic_allocations = @config.get_traffic_allocation(experiment_key)
-      variation_id = find_bucket(bucket_value, traffic_allocations)
+      traffic_allocations = experiment['trafficAllocation']
+      variation_id = find_bucket(user_id, experiment_id, traffic_allocations)
+
       if variation_id && variation_id != ''
         variation_key = @config.get_variation_key_from_id(experiment_key, variation_id)
         @config.logger.log(
@@ -103,14 +102,19 @@ def bucket(experiment_key, user_id)
 
     private
 
-    def find_bucket(bucket_value, traffic_allocations)
+    def find_bucket(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.
       #
-      # bucket_value - Integer bucket value
+      # user_id - String ID for user
+      # parent_id - String entity ID to use for bucketing ID
       # traffic_allocations - Array of traffic allocations
       #
       # Returns entity ID corresponding to the provided bucket value or nil if no match is found.
 
+      bucketing_id = sprintf(BUCKETING_ID_TEMPLATE, user_id: user_id, entity_id: parent_id)
+      bucket_value = generate_bucket_value(bucketing_id)
+      @config.logger.log(Logger::DEBUG, "Assigned bucket #{bucket_value} to user '#{user_id}'.")
+
       traffic_allocations.each do |traffic_allocation|
         current_end_of_range = traffic_allocation['endOfRange']
         if bucket_value < current_end_of_range

lib/optimizely/decision_service.rb

@@ -47,12 +47,16 @@ def get_variation(experiment_key, user_id, attributes = nil)
       # Returns variation ID where visitor will be bucketed (nil if experiment is inactive or user does not meet audience conditions)
 
       # Check to make sure experiment is active
-      unless @config.experiment_running?(experiment_key)
-        @config.logger.log(Logger::INFO, "Experiment '#{experiment_key}' is not running.")
+      experiment = @config.get_experiment_from_key(experiment_key)
+      if experiment.nil?
         return nil
       end
 
-      experiment_id = @config.get_experiment_id(experiment_key)
+      experiment_id = experiment['id']
+      unless @config.experiment_running?(experiment)
+        @config.logger.log(Logger::INFO, "Experiment '#{experiment_key}' is not running.")
+        return nil
+      end
 
       # Check if user is in a forced variation
       forced_variation_id = get_forced_variation_id(experiment_key, user_id)
@@ -70,7 +74,7 @@ def get_variation(experiment_key, user_id, attributes = nil)
       end
 
       # Check audience conditions
-      unless Audience.user_in_experiment?(@config, experiment_key, attributes)
+      unless Audience.user_in_experiment?(@config, experiment, attributes)
         @config.logger.log(
           Logger::INFO,
           "User '#{user_id}' does not meet the conditions to be in experiment '#{experiment_key}'."
@@ -79,7 +83,7 @@ def get_variation(experiment_key, user_id, attributes = nil)
       end
 
       # Bucket normally
-      variation_id = @bucketer.bucket(experiment_key, user_id)
+      variation_id = @bucketer.bucket(experiment, user_id)
 
       # Persist bucketing decision
       save_user_profile(user_profile, experiment_id, variation_id)

lib/optimizely/event_builder.rb

@@ -71,10 +71,10 @@ class EventBuilder < BaseEventBuilder
     IMPRESSION_EVENT_ENDPOINT = 'https://logx.optimizely.com/log/decision'
     POST_HEADERS = { 'Content-Type' => 'application/json' }
 
-    def create_impression_event(experiment_key, variation_id, user_id, attributes)
+    def create_impression_event(experiment, variation_id, user_id, attributes)
       # Create conversion Event to be sent to the logging endpoint.
       #
-      # experiment_key - Experiment for which impression needs to be recorded.
+      # experiment - Experiment for which impression needs to be recorded.
       # variation_id - ID for variation which would be presented to user.
       # user_id - ID for user.
       # attributes - Hash representing user attributes and values which need to be recorded.
@@ -83,7 +83,7 @@ def create_impression_event(experiment_key, variation_id, user_id, attributes)
 
       @params = {}
       add_common_params(user_id, attributes)
-      add_decision(experiment_key, variation_id)
+      add_decision(experiment, variation_id)
       add_attributes(attributes)
       Event.new(:post, IMPRESSION_EVENT_ENDPOINT, @params, POST_HEADERS)
     end
@@ -151,8 +151,9 @@ def add_attributes(attributes)
       end
     end
 
-    def add_decision(experiment_key, variation_id)
-      experiment_id = @config.get_experiment_id(experiment_key)
+    def add_decision(experiment, variation_id)
+      experiment_key = experiment['key']
+      experiment_id = experiment['id']
       @params['layerId'] = @config.experiment_key_map[experiment_key]['layerId']
       @params['decision'] = {
         'variationId' => variation_id,

lib/optimizely/project_config.rb

@@ -100,28 +100,24 @@ def initialize(datafile, logger, error_handler)
       @parsing_succeeded = true
     end
 
-    def experiment_running?(experiment_key)
+    def experiment_running?(experiment)
       # Determine if experiment corresponding to given key is running
       #
-      # experiment_key - String key representing the experiment
+      # experiment - Experiment
       #
       # Returns true if experiment is running
-      experiment = @experiment_key_map[experiment_key]
-      return RUNNING_EXPERIMENT_STATUS.include?(experiment['status']) if experiment
-      @logger.log Logger::ERROR, "Experiment key '#{experiment_key}' is not in datafile."
-      @error_handler.handle_error InvalidExperimentError
-      nil
+      return RUNNING_EXPERIMENT_STATUS.include?(experiment['status'])
     end
 
-    def get_experiment_id(experiment_key)
+    def get_experiment_from_key(experiment_key)
       # Retrieves experiment ID for a given key
       #
       # experiment_key - String key representing the experiment
       #
-      # Returns String ID
+      # Returns Experiment
 
       experiment = @experiment_key_map[experiment_key]
-      return experiment['id'] if experiment
+      return experiment if experiment
       @logger.log Logger::ERROR, "Experiment key '#{experiment_key}' is not in datafile."
       @error_handler.handle_error InvalidExperimentError
       nil
@@ -155,34 +151,6 @@ def get_experiment_ids_for_event(event_key)
       []
     end
 
-    def get_traffic_allocation(experiment_key)
-      # Retrieves traffic allocation for a given experiment Key
-      #
-      # experiment_key - String Key representing the experiment
-      #
-      # Returns traffic allocation for the experiment or nil
-
-      experiment = @experiment_key_map[experiment_key]
-      return experiment['trafficAllocation'] if experiment
-      @logger.log Logger::ERROR, "Experiment key '#{experiment_key}' is not in datafile."
-      @error_handler.handle_error InvalidExperimentError
-      nil
-    end
-
-    def get_audience_ids_for_experiment(experiment_key)
-      # Get audience IDs for the experiment
-      #
-      # experiment_key - Experiment key for which audience IDs are to be determined
-      #
-      # Returns audience IDs corresponding to the experiment.
-
-      experiment = @experiment_key_map[experiment_key]
-      return experiment['audienceIds'] if experiment
-      @logger.log Logger::ERROR, "Experiment key '#{experiment_key}' is not in datafile."
-      @error_handler.handle_error InvalidExperimentError
-      nil
-    end
-
     def get_audience_conditions_from_id(audience_id)
       # Get audience conditions for the provided audience ID
       #
@@ -254,13 +222,6 @@ def get_forced_variations(experiment_key)
       @error_handler.handle_error InvalidExperimentError
     end
 
-    def get_experiment_group_id(experiment_key)
-      experiment = @experiment_key_map[experiment_key]
-      return experiment['groupId'] if experiment
-      @logger.log Logger::ERROR, "Experiment key '#{experiment_key}' is not in datafile."
-      @error_handler.handle_error InvalidExperimentError
-    end
-
     def get_attribute_id(attribute_key)
       attribute = @attribute_key_map[attribute_key]
       return attribute['id'] if attribute
@@ -269,19 +230,6 @@ def get_attribute_id(attribute_key)
       nil
     end
 
-    def user_in_forced_variation?(experiment_key, user_id)
-      # Determines if a given user is in a forced variation
-      #
-      # experiment_key - String experiment key
-      # user_id - String user ID
-      #
-      # Returns true if user is in a forced variation
-
-      forced_variations = get_forced_variations(experiment_key)
-      return forced_variations.include?(user_id) if forced_variations
-      false
-    end
-
     def parsing_succeeded?
       # Helper method to determine if parsing the datafile was successful.
       #
@@ -308,8 +256,6 @@ def variation_id_exists?(experiment_id, variation_id)
         return false
       end
 
-      @logger.log Logger::ERROR, "Experiment ID '#{experiment_id}' is not in datafile."
-      @error_handler.handle_error InvalidExperimentError
       false
     end
 

spec/audience_spec.rb

@@ -26,27 +26,26 @@
   end
 
   it 'should return true for user_in_experiment? if there are no audiences and no attributes' do
-    expect(@project_instance.config).to receive(:get_audience_ids_for_experiment)
-                                       .with('test_experiment').and_return([])
+    experiment = @project_instance.config.experiment_key_map['test_experiment']
     expect(Optimizely::Audience.user_in_experiment?(@project_instance.config,
-                                                   'test_experiment',
+                                                    experiment,
                                                     nil)).to be true
   end
 
   it 'should return true for user_in_experiment? if there are no audiences and there are attributes' do
-    expect(@project_instance.config).to receive(:get_audience_ids_for_experiment)
-                                       .with('test_experiment').and_return([])
+    experiment = @project_instance.config.experiment_key_map['test_experiment']
     user_attributes = {
       'browser_type' => 'firefox'
     }
     expect(Optimizely::Audience.user_in_experiment?(@project_instance.config,
-                                                   'test_experiment',
+                                                   experiment,
                                                    user_attributes)).to be true
   end
 
   it 'should return false for user_in_experiment? if there are audiences but no attributes' do
+    experiment = @project_instance.config.experiment_key_map['test_experiment_with_audience']
     expect(Optimizely::Audience.user_in_experiment?(@project_instance.config,
-                                                   'test_experiment_with_audience',
+                                                   experiment,
                                                    nil)).to be false
   end
 
@@ -55,18 +54,19 @@
       'browser_type' => 'firefox'
     }
 
+    experiment = @project_instance.config.experiment_key_map['test_experiment_with_audience']
     expect(Optimizely::Audience.user_in_experiment?(@project_instance.config,
-                                                   'test_experiment_with_audience',
+                                                   experiment,
                                                    user_attributes)).to be true
   end
 
   it 'should return false for user_in_experiment? if the audience conditions are not met' do
     user_attributes = {
       'browser_type' => 'chrome'
     }
-
+    experiment = @project_instance.config.experiment_key_map['test_experiment_with_audience']
     expect(Optimizely::Audience.user_in_experiment?(@project_instance.config,
-                                                   'test_experiment_with_audience',
+                                                   experiment,
                                                    user_attributes)).to be false
   end
 end