fix: errors being raised without required args (#250)

Co-authored-by: Tom Zurkan <thomas.zurkan@optimizely.com>

Author: oakbani

lib/optimizely/config/datafile_project_config.rb

@@ -170,8 +170,9 @@ def self.create(datafile, logger, error_handler, skip_json_validation)
         config = new(datafile, logger, error_handler)
       rescue StandardError => e
         default_logger = SimpleLogger.new
-        error_msg = e.class == InvalidDatafileVersionError ? e.message : InvalidInputError.new('datafile').message
-        error_to_handle = e.class == InvalidDatafileVersionError ? InvalidDatafileVersionError : InvalidInputError
+        error_to_handle = e.class == InvalidDatafileVersionError ? e : InvalidInputError.new('datafile')
+        error_msg = error_to_handle.message
+
         default_logger.log(Logger::ERROR, error_msg)
         error_handler.handle_error error_to_handle
         return nil

lib/optimizely/config_manager/http_project_config_manager.rb

@@ -284,17 +284,19 @@ def get_datafile_url(sdk_key, url, url_template)
       #               SDK key to determine URL from which to fetch the datafile.
       # Returns String representing URL to fetch datafile from.
       if sdk_key.nil? && url.nil?
-        @logger.log(Logger::ERROR, 'Must provide at least one of sdk_key or url.')
-        @error_handler.handle_error(InvalidInputsError)
+        error_msg = 'Must provide at least one of sdk_key or url.'
+        @logger.log(Logger::ERROR, error_msg)
+        @error_handler.handle_error(InvalidInputsError.new(error_msg))
       end
 
       unless url
         url_template ||= Helpers::Constants::CONFIG_MANAGER['DATAFILE_URL_TEMPLATE']
         begin
           return (url_template % sdk_key)
         rescue
-          @logger.log(Logger::ERROR, "Invalid url_template #{url_template} provided.")
-          @error_handler.handle_error(InvalidInputsError)
+          error_msg = "Invalid url_template #{url_template} provided."
+          @logger.log(Logger::ERROR, error_msg)
+          @error_handler.handle_error(InvalidInputsError.new(error_msg))
         end
       end
 

lib/optimizely/exceptions.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-#    Copyright 2016-2019, Optimizely and contributors
+#    Copyright 2016-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.
@@ -81,14 +81,6 @@ def initialize(msg = 'Provided variation is not in datafile.')
     end
   end
 
-  class InvalidDatafileError < Error
-    # Raised when a public method fails due to an invalid datafile
-
-    def initialize(aborted_method)
-      super("Provided datafile is in an invalid format. Aborting #{aborted_method}.")
-    end
-  end
-
   class InvalidDatafileVersionError < Error
     # Raised when a datafile with an unsupported version is provided
 

spec/config_manager/http_project_config_manager_spec.rb

@@ -24,7 +24,7 @@
 require 'optimizely/logger'
 describe Optimizely::HTTPProjectConfigManager do
   let(:config_body_JSON) { OptimizelySpec::VALID_CONFIG_BODY_JSON }
-  let(:error_handler) { Optimizely::NoOpErrorHandler.new }
+  let(:error_handler) { Optimizely::RaiseErrorHandler.new }
   let(:spy_logger) { spy('logger') }
 
   before(:context) do
@@ -324,16 +324,30 @@
 
   describe '#get_datafile_url' do
     it 'should log an error when both sdk key and url are nil' do
-      expect(error_handler).to receive(:handle_error).once.with(Optimizely::InvalidInputsError)
+      expect do
+        @http_project_config_manager = Optimizely::HTTPProjectConfigManager.new(
+          sdk_key: nil,
+          url: nil,
+          error_handler: error_handler,
+          logger: spy_logger
+        )
+      end.to raise_error(Optimizely::InvalidInputsError, 'Must provide at least one of sdk_key or url.')
 
-      @http_project_config_manager = Optimizely::HTTPProjectConfigManager.new(
-        sdk_key: nil,
-        url: nil,
-        error_handler: error_handler,
-        logger: spy_logger
-      )
       expect(spy_logger).to have_received(:log).once.with(Logger::ERROR, 'Must provide at least one of sdk_key or url.')
     end
+
+    it 'should log an error when invalid url_template is given' do
+      expect do
+        @http_project_config_manager = Optimizely::HTTPProjectConfigManager.new(
+          sdk_key: 'valid_sdk_key',
+          url_template: 'https://cdn.optimizely.com/datafiles/%d.json',
+          error_handler: error_handler,
+          logger: spy_logger
+        )
+      end.to raise_error(Optimizely::InvalidInputsError, 'Invalid url_template https://cdn.optimizely.com/datafiles/%d.json provided.')
+
+      expect(spy_logger).to have_received(:log).once.with(Logger::ERROR, 'Invalid url_template https://cdn.optimizely.com/datafiles/%d.json provided.')
+    end
   end
 
   describe '.polling_interval' do

spec/project_spec.rb

@@ -130,9 +130,8 @@ class InvalidErrorHandler; end
     it 'should log and raise an error when provided a datafile of unsupported version' do
       config_body_invalid_json = JSON.parse(config_body_invalid_JSON)
       expect_any_instance_of(Optimizely::SimpleLogger).to receive(:log).once.with(Logger::ERROR, "This version of the Ruby SDK does not support the given datafile version: #{config_body_invalid_json['version']}.")
-      expect_any_instance_of(Optimizely::RaiseErrorHandler).to receive(:handle_error).once.with(Optimizely::InvalidDatafileVersionError)
 
-      Optimizely::Project.new(config_body_invalid_JSON, nil, nil, Optimizely::RaiseErrorHandler.new, true)
+      expect { Optimizely::Project.new(config_body_invalid_JSON, nil, nil, Optimizely::RaiseErrorHandler.new, true) }.to raise_error(Optimizely::InvalidDatafileVersionError, 'This version of the Ruby SDK does not support the given datafile version: 5.')
     end
   end