feat: include object id/key in invalid object errors

- Include object `id`/`key` in errors when objects not found in datafile
- Modifies invalid object `id`/`key` log messages to make them consistent

Include object `id`/`key` in errors when an object is not found makes them available to the user or the custom error handler.

One example of why this is useful is that the `key` of an experiment could be used within a custom error handler to fetch the details of the experiment. This would indicate whether the experiment has been paused (in which case the error could be ignored) or archived (in which case the code referencing the experiment should be removed from the application).

Author: stoneman

lib/optimizely/config/datafile_project_config.rb

@@ -238,7 +238,7 @@ def get_experiment_from_key(experiment_key)
       return experiment if experiment
 
       @logger.log Logger::ERROR, "Experiment key '#{experiment_key}' is not in datafile."
-      @error_handler.handle_error InvalidExperimentError
+      @error_handler.handle_error InvalidExperimentError.new("Experiment key '#{experiment_key}' is not in datafile.")
       nil
     end
 
@@ -253,7 +253,7 @@ def get_experiment_from_id(experiment_id)
       return experiment if experiment
 
       @logger.log Logger::ERROR, "Experiment id '#{experiment_id}' is not in datafile."
-      @error_handler.handle_error InvalidExperimentError
+      @error_handler.handle_error InvalidExperimentError.new("Experiment id '#{experiment_id}' is not in datafile.")
       nil
     end
 
@@ -268,7 +268,7 @@ def get_experiment_key(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
+      @error_handler.handle_error InvalidExperimentError.new("Experiment id '#{experiment_id}' is not in datafile.")
       nil
     end
 
@@ -282,8 +282,8 @@ def get_event_from_key(event_key)
       event = @event_key_map[event_key]
       return event if event
 
-      @logger.log Logger::ERROR, "Event '#{event_key}' is not in datafile."
-      @error_handler.handle_error InvalidEventError
+      @logger.log Logger::ERROR, "Event key '#{event_key}' is not in datafile."
+      @error_handler.handle_error InvalidEventError.new("Event key '#{event_key}' is not in datafile.")
       nil
     end
 
@@ -297,8 +297,8 @@ def get_audience_from_id(audience_id)
       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
+      @logger.log Logger::ERROR, "Audience id '#{audience_id}' is not in datafile."
+      @error_handler.handle_error InvalidAudienceError.new("Audience id '#{audience_id}' is not in datafile.")
       nil
     end
 
@@ -323,12 +323,12 @@ def get_variation_from_id(experiment_key, variation_id)
         return variation if variation
 
         @logger.log Logger::ERROR, "Variation id '#{variation_id}' is not in datafile."
-        @error_handler.handle_error InvalidVariationError
+        @error_handler.handle_error InvalidVariationError.new("Variation id '#{variation_id}' is not in datafile.")
         return nil
       end
 
       @logger.log Logger::ERROR, "Experiment key '#{experiment_key}' is not in datafile."
-      @error_handler.handle_error InvalidExperimentError
+      @error_handler.handle_error InvalidExperimentError.new("Experiment key '#{experiment_key}' is not in datafile.")
       nil
     end
 
@@ -346,12 +346,12 @@ def get_variation_from_id_by_experiment_id(experiment_id, variation_id)
         return variation if variation
 
         @logger.log Logger::ERROR, "Variation id '#{variation_id}' is not in datafile."
-        @error_handler.handle_error InvalidVariationError
+        @error_handler.handle_error InvalidVariationError.new("Variation id '#{variation_id}' is not in datafile.")
         return nil
       end
 
       @logger.log Logger::ERROR, "Experiment id '#{experiment_id}' is not in datafile."
-      @error_handler.handle_error InvalidExperimentError
+      @error_handler.handle_error InvalidExperimentError.new("Experiment id '#{experiment_id}' is not in datafile.")
       nil
     end
 
@@ -369,12 +369,12 @@ def get_variation_id_from_key_by_experiment_id(experiment_id, variation_key)
         return variation['id'] if variation
 
         @logger.log Logger::ERROR, "Variation key '#{variation_key}' is not in datafile."
-        @error_handler.handle_error InvalidVariationError
+        @error_handler.handle_error InvalidVariationError.new("Variation key '#{variation_key}' is not in datafile.")
         return nil
       end
 
       @logger.log Logger::ERROR, "Experiment id '#{experiment_id}' is not in datafile."
-      @error_handler.handle_error InvalidExperimentError
+      @error_handler.handle_error InvalidExperimentError.new("Experiment id '#{experiment_id}' is not in datafile.")
       nil
     end
 
@@ -392,12 +392,12 @@ def get_variation_id_from_key(experiment_key, variation_key)
         return variation['id'] if variation
 
         @logger.log Logger::ERROR, "Variation key '#{variation_key}' is not in datafile."
-        @error_handler.handle_error InvalidVariationError
+        @error_handler.handle_error InvalidVariationError.new("Variation key '#{variation_key}' is not in datafile.")
         return nil
       end
 
       @logger.log Logger::ERROR, "Experiment key '#{experiment_key}' is not in datafile."
-      @error_handler.handle_error InvalidExperimentError
+      @error_handler.handle_error InvalidExperimentError.new("Experiment key '#{experiment_key}' is not in datafile.")
       nil
     end
 
@@ -411,8 +411,8 @@ def get_whitelisted_variations(experiment_id)
       experiment = @experiment_id_map[experiment_id]
       return experiment['forcedVariations'] if experiment
 
-      @logger.log Logger::ERROR, "Experiment ID '#{experiment_id}' is not in datafile."
-      @error_handler.handle_error InvalidExperimentError
+      @logger.log Logger::ERROR, "Experiment id '#{experiment_id}' is not in datafile."
+      @error_handler.handle_error InvalidExperimentError.new("Experiment id '#{experiment_id}' is not in datafile.")
     end
 
     def get_attribute_id(attribute_key)
@@ -435,7 +435,7 @@ def get_attribute_id(attribute_key)
       return attribute_key if has_reserved_prefix
 
       @logger.log Logger::ERROR, "Attribute key '#{attribute_key}' is not in datafile."
-      @error_handler.handle_error InvalidAttributeError
+      @error_handler.handle_error InvalidAttributeError.new("Attribute key '#{attribute_key}' is not in datafile.")
       nil
     end
 
@@ -454,7 +454,7 @@ def variation_id_exists?(experiment_id, variation_id)
         return true if variation
 
         @logger.log Logger::ERROR, "Variation ID '#{variation_id}' is not in datafile."
-        @error_handler.handle_error InvalidVariationError
+        @error_handler.handle_error InvalidVariationError.new("Variation ID '#{variation_id}' is not in datafile.")
       end
 
       false

spec/config/datafile_project_config_spec.rb

@@ -808,14 +808,14 @@
     describe 'get_event_from_key' do
       it 'should log a message when provided event key is invalid' do
         config.get_event_from_key('invalid_key')
-        expect(spy_logger).to have_received(:log).with(Logger::ERROR, "Event 'invalid_key' is not in datafile.")
+        expect(spy_logger).to have_received(:log).with(Logger::ERROR, "Event key 'invalid_key' is not in datafile.")
       end
     end
 
     describe 'get_audience_from_id' do
       it 'should log a message when provided audience ID is invalid' do
         config.get_audience_from_id('invalid_id')
-        expect(spy_logger).to have_received(:log).with(Logger::ERROR, "Audience 'invalid_id' is not in datafile.")
+        expect(spy_logger).to have_received(:log).with(Logger::ERROR, "Audience id 'invalid_id' is not in datafile.")
       end
     end
 
@@ -919,7 +919,7 @@
       it 'should log a message when there is no experiment key map for the experiment' do
         config.get_whitelisted_variations('invalid_key')
         expect(spy_logger).to have_received(:log).with(Logger::ERROR,
-                                                       "Experiment ID 'invalid_key' is not in datafile.")
+                                                       "Experiment id 'invalid_key' is not in datafile.")
       end
     end