exception_handling 2.3.0 → 2.4.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d1c207f35c692b5d0bcd7bb605747c30222c7db
-  data.tar.gz: 34d368d277e241f4ae61cae3ecdd010aeb9e0832
+  metadata.gz: becd17dbab6068dab7abb6b81bd5af8d4d48b63b
+  data.tar.gz: 7be8edf728c439e0fbe3703a582c66523f6606ac
 SHA512:
-  metadata.gz: f897c084f3df5d5cb2b8ca91501d2a0af1956f3080f2f77e5b11216291cc5fbbe22f3081e6e35b49609a29c9e87e3ad1eef813c7c566c1bc3940e4ed9363bfd7
-  data.tar.gz: 1f3fa7be3cab1bb4022fe1900220333dd9133ceca05083c84bac5b5f34ff72d9621d3ce711fdbbdcd5611b6876d431067d78e6ae937a7c9dcf3c4f65d99f4202
+  metadata.gz: 520560299d17e85a2bf1e52e95d633401efc963e6cb505f1d644f8ee4826d49c72a808613e343fe86f6e09ad2b23cd092f040f9a116a9f19f7c123e35635e9ca
+  data.tar.gz: db6689caa551e772dd6686020e5885f2e9eefdc45d24b773b67a04619c3f8a9404fb77ae28345607260386dd298811b27c376c7b13351f09300341e14ba2c036

data/Gemfile.lock

@@ -8,7 +8,7 @@ GIT
 PATH
   remote: .
   specs:
-    exception_handling (2.3.0)
+    exception_handling (2.4.0.pre.1)
       actionmailer (~> 4.2)
       actionpack (~> 4.2)
       activesupport (~> 4.2)

data/exception_handling.gemspec

@@ -15,6 +15,10 @@ Gem::Specification.new do |spec|
   spec.name          = "exception_handling"
   spec.require_paths = ["lib"]
   spec.version       = ExceptionHandling::VERSION
+  spec.metadata    = {
+    "source_code_uri"   => "https://github.com/Invoca/exception_handling",
+    "allowed_push_host" => "https://rubygems.org"
+  }
 
   spec.add_dependency 'actionmailer',  '~> 4.2'
   spec.add_dependency 'actionpack',    '~> 4.2'

data/lib/exception_handling/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ExceptionHandling
-  VERSION = '2.3.0'
+  VERSION = '2.4.0.pre.1'
 end

data/lib/exception_handling.rb

@@ -180,15 +180,15 @@ module ExceptionHandling # never included
     # Functional Test Operation:
     #   Calls into handle_stub_log_error and returns. no log file. no honeybadger
     #
-    def log_error(exception_or_string, exception_context = '', controller = nil, treat_like_warning: false, **log_context, &data_callback)
+    def log_error(exception_or_string, exception_context = '', treat_like_warning: false, **log_context, &data_callback)
       ex = make_exception(exception_or_string)
       timestamp = set_log_error_timestamp
-      exception_info = ExceptionInfo.new(ex, exception_context, timestamp, controller || current_controller, data_callback)
+      exception_info = ExceptionInfo.new(ex, exception_context, timestamp, current_controller, data_callback)
 
       if stub_handler
         stub_handler.handle_stub_log_error(exception_info.data)
       else
-        write_exception_to_log(ex, exception_context, timestamp, **log_context)
+        write_exception_to_log(ex, exception_context, timestamp, log_context)
         external_notification_results = unless treat_like_warning || ex.is_a?(Warning)
                                           send_external_notifications(exception_info)
                                         end || {}
@@ -208,9 +208,9 @@ module ExceptionHandling # never included
     #
     # Write an exception out to the log file using our own custom format.
     #
-    def write_exception_to_log(ex, exception_context, timestamp, **log_context)
+    def write_exception_to_log(ex, exception_context, timestamp, log_context = {})
       ActiveSupport::Deprecation.silence do
-        ExceptionHandling.logger.fatal("\nExceptionHandlingError (Error:#{timestamp}) #{ex.class} #{exception_context} (#{encode_utf8(ex.message.to_s)}):\n  " + clean_backtrace(ex).join("\n  ") + "\n\n", **log_context)
+        ExceptionHandling.logger.fatal("\nExceptionHandlingError (Error:#{timestamp}) #{ex.class} #{exception_context} (#{encode_utf8(ex.message.to_s)}):\n  " + clean_backtrace(ex).join("\n  ") + "\n\n", log_context)
       end
     end
 
@@ -275,33 +275,33 @@ module ExceptionHandling # never included
       end
     end
 
-    def log_warning(message, **log_context)
+    def log_warning(message, log_context = {})
       warning = Warning.new(message)
       warning.set_backtrace([])
       log_error(warning, **log_context)
     end
 
-    def log_info(message, **log_context)
-      ExceptionHandling.logger.info(message, **log_context)
+    def log_info(message, log_context = {})
+      ExceptionHandling.logger.info(message, log_context)
     end
 
-    def log_debug(message, **log_context)
-      ExceptionHandling.logger.debug(message, **log_context)
+    def log_debug(message, log_context = {})
+      ExceptionHandling.logger.debug(message, log_context)
     end
 
-    def ensure_safe(exception_context = "", **log_context)
+    def ensure_safe(exception_context = "", log_context = {})
       yield
     rescue => ex
-      log_error ex, exception_context, **log_context
+      log_error(ex, exception_context, **log_context)
       nil
     end
 
-    def ensure_completely_safe(exception_context = "", **log_context)
+    def ensure_completely_safe(exception_context = "", log_context = {})
       yield
     rescue SystemExit, SystemStackError, NoMemoryError, SecurityError, SignalException
       raise
     rescue Exception => ex
-      log_error ex, exception_context, log_context
+      log_error(ex, exception_context, **log_context)
       nil
     end
 
@@ -311,26 +311,26 @@ module ExceptionHandling # never included
       escalate(email_subject, ex, last_exception_timestamp, production_support_recipients)
     end
 
-    def escalate_error(exception_or_string, email_subject, custom_recipients = nil, **log_context)
+    def escalate_error(exception_or_string, email_subject, custom_recipients = nil, log_context = {})
       ex = make_exception(exception_or_string)
       log_error(ex, **log_context)
       escalate(email_subject, ex, last_exception_timestamp, custom_recipients)
     end
 
-    def escalate_warning(message, email_subject, custom_recipients = nil, **log_context)
+    def escalate_warning(message, email_subject, custom_recipients = nil, log_context = {})
       ex = Warning.new(message)
       log_error(ex, **log_context)
       escalate(email_subject, ex, last_exception_timestamp, custom_recipients)
     end
 
-    def ensure_escalation(email_subject, custom_recipients = nil, **log_context)
+    def ensure_escalation(email_subject, custom_recipients = nil, log_context = {})
       yield
     rescue => ex
-      escalate_error(ex, email_subject, custom_recipients, **log_context)
+      escalate_error(ex, email_subject, custom_recipients, log_context)
       nil
     end
 
-    def alert_warning(exception_or_string, alert_name, exception_context, **log_context)
+    def alert_warning(exception_or_string, alert_name, exception_context, log_context)
       ex = make_exception(exception_or_string)
       log_error(ex, exception_context, **log_context)
       begin
@@ -340,10 +340,10 @@ module ExceptionHandling # never included
       end
     end
 
-    def ensure_alert(alert_name, exception_context, **log_context)
+    def ensure_alert(alert_name, exception_context, log_context = {})
       yield
     rescue => ex
-      alert_warning(ex, alert_name, exception_context, **log_context)
+      alert_warning(ex, alert_name, exception_context, log_context)
       nil
     end
 
@@ -360,7 +360,7 @@ module ExceptionHandling # never included
       result
     end
 
-    def log_periodically(exception_key, interval, message, **log_context)
+    def log_periodically(exception_key, interval, message, log_context = {})
       self.periodic_exception_intervals ||= {}
       last_logged = self.periodic_exception_intervals[exception_key]
       if !last_logged || ((last_logged + interval) < Time.now)
@@ -447,7 +447,7 @@ module ExceptionHandling # never included
         yield
       end
     rescue StandardError, MailerTimeout => ex
-      log_error(ex, "ExceptionHandling::safe_email_deliver", nil, treat_like_warning: true)
+      log_error(ex, "ExceptionHandling::safe_email_deliver", treat_like_warning: true)
     end
 
     def make_exception(exception_or_string)

data/test/test_helper.rb

@@ -27,15 +27,15 @@ class LoggerStub
     clear
   end
 
-  def info(message, **log_context)
+  def info(message, log_context = {})
     logged << { message: message, context: log_context }
   end
 
-  def warn(message, **log_context)
+  def warn(message, log_context = {})
     logged << { message: message, context: log_context }
   end
 
-  def fatal(message, **log_context)
+  def fatal(message, log_context = {})
     logged << { message: message, context: log_context }
   end
 

data/test/unit/exception_handling_test.rb

@@ -110,7 +110,14 @@ class ExceptionHandlingTest < ActiveSupport::TestCase
     end
 
     context "#log_error" do
-      should "take in additional keyword args as logging context and pass them to the logger" do
+      should "take in additional keyword args as logging context and pass them to the logger (using preferrred log_context:)" do
+        ExceptionHandling.log_error('This is an Error', 'This is the prefix context', service_name: 'exception_handling')
+        assert_match(/This is an Error/, logged_excluding_reload_filter.last[:message])
+        assert_not_empty logged_excluding_reload_filter.last[:context]
+        assert_equal({ service_name: 'exception_handling' }, logged_excluding_reload_filter.last[:context])
+      end
+
+      should "take in additional keyword args as logging context and pass them to the logger (using **)" do
         ExceptionHandling.log_error('This is an Error', 'This is the prefix context', service_name: 'exception_handling')
         assert_match(/This is an Error/, logged_excluding_reload_filter.last[:message])
         assert_not_empty logged_excluding_reload_filter.last[:context]
@@ -196,7 +203,7 @@ class ExceptionHandlingTest < ActiveSupport::TestCase
 
       should "include logging context in the exception data" do
         ExceptionHandling.post_log_error_hook = method(:log_error_callback_config)
-        ExceptionHandling.log_error(StandardError.new("Some Exception"), "mooo", nil, treat_like_warning: true, log_context_test: "contextual_logging")
+        ExceptionHandling.log_error(StandardError.new("Some Exception"), "mooo", treat_like_warning: true, log_context_test: "contextual_logging")
 
         expected_log_context = {
           "log_context_test" => "contextual_logging"
@@ -543,6 +550,10 @@ class ExceptionHandlingTest < ActiveSupport::TestCase
         end
 
         context "with Honeybadger defined" do
+          teardown do
+            ExceptionHandling.current_controller = nil
+          end
+
           should "not send_exception_to_honeybadger when log_warning is executed" do
             dont_allow(ExceptionHandling).send_exception_to_honeybadger
             ExceptionHandling.log_warning("This should not go to honeybadger")
@@ -581,7 +592,7 @@ class ExceptionHandlingTest < ActiveSupport::TestCase
             parameters = { advertiser_id: 435, controller: "some_controller" }
             session = { username: "jsmith" }
             request_uri = "host/path"
-            controller = create_dummy_controller(env, parameters, session, request_uri)
+            ExceptionHandling.current_controller = create_dummy_controller(env, parameters, session, request_uri)
             stub(ExceptionHandling).server_name { "invoca_fe98" }
 
             exception = StandardError.new("Some Exception")
@@ -595,7 +606,7 @@ class ExceptionHandlingTest < ActiveSupport::TestCase
             mock(Honeybadger).notify.with_any_args do |data|
               honeybadger_data = data
             end
-            ExceptionHandling.log_error(exception, exception_context, controller) do |data|
+            ExceptionHandling.log_error(exception, exception_context) do |data|
               data[:scm_revision] = "5b24eac37aaa91f5784901e9aabcead36fd9df82"
               data[:user_details] = { username: "jsmith" }
               data[:event_response] = "Event successfully received"
@@ -1042,10 +1053,10 @@ class ExceptionHandlingTest < ActiveSupport::TestCase
         Time.now_override = nil
       end
 
-      should "take in additional key word args as logging context and pass them to the logger" do
+      should "take in additional logging context and pass them to the logger" do
         ExceptionHandling.log_periodically(:test_context_with_periodic, 30.minutes, "this will be written", service_name: 'exception_handling')
         assert_not_empty logged_excluding_reload_filter.last[:context]
-        assert_equal logged_excluding_reload_filter.last[:context], service_name: 'exception_handling'
+        assert_equal({ service_name: 'exception_handling' }, logged_excluding_reload_filter.last[:context])
       end
 
       should "log immediately when we are expected to log" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exception_handling
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0.pre.1
 platform: ruby
 authors:
 - Colin Kelley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-05 00:00:00.000000000 Z
+date: 2020-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -154,7 +154,9 @@ files:
 - views/exception_handling/mailer/log_parser_exception_notification.html.erb
 homepage: https://github.com/Invoca/exception_handling
 licenses: []
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/Invoca/exception_handling
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -166,9 +168,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.13