exception_handling 2.5.0.pre.1 → 2.7.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 267155818260bd0971adcfb3f325ce559c70b47fd362a8f80a2f92fc81117bf7
-  data.tar.gz: 52532fdf7184f79c85bbd384340ce99d753cd3b964ea9e1808da77091c5827b1
+  metadata.gz: 3794611262e09346bab80e7a683f4ce1d78d6ba04b46fa15fa4bc84ac087e41e
+  data.tar.gz: 36f96bed7f2b3375df4730d35ee5ec96cdf70e7c07f4ba589e187c75275c1736
 SHA512:
-  metadata.gz: cf6315b8cf9c5bf2d1bae4732571ee0cc4609e57179c0935775b2b7435ebc44739ed3f61eb84f35adc22a59a7f643892f392f4d2e069ef672a17aa23c1753a67
-  data.tar.gz: d61c96173c88073a5be405480aeadd9a997749bc0b811534abe9b549c281f07b64e096123822a8268c0deb78f8eff139debd4ed93f78576305ae3ebc9e533cc8
+  metadata.gz: 2d1dad10749b867696c0f4dcacedcfb4af466ba792fa0c98ae307ee4bbeda10657f172fc95ff3c9b0162d1787d39c3c2a15a220fa6c6f4a7f7b10d857dad5eec
+  data.tar.gz: 8b28f2829a1e34787d7de51fdee4d0fe5a39356584d6d910c106edac2fe5d8ebcf0f3f5f1e9e1b7e4e7b0c36dd62035885214248072e47a7fdec7d1e4a854f94

data/CHANGELOG.md

@@ -4,11 +4,34 @@ Inspired by [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 Note: this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [2.5.0] - Unreleased
+## [2.7.0] - Unreleased
+### Added
+- Added `LoggingMethods` as a replacement for `Methods` without setting controller or checking for long controller action.
+### Deprecated
+- Deprecated `Methods` in favor of `LoggingMethods`.
+
+## [2.6.1] - Unreleased
+### Fixed
+- Fixed honeybadger_context_data to always merge `current_context_for_thread`, even if `log_context:` is passed as `nil`.
+
+## [2.6.0] - 2020-08-26
+### Changed
+- Calling `log_warning` will now log with Severity::WARNING rather than FATAL.
+- Reordered the logging to put the exception class next to the message.
+
+## [2.5.0] - 2020-08-19
 ### Added
 - The `**log_context` passed to `log_error`/`log_warning`/`log_info` is now
   passed into `Honeybadger.notify()`, in `context: { log_context: ... }`.
 
+### Fixed
+- Silenced test warning noise by no longer running ruby -w.
+- Renamed a constant to ALLOWLIST.
+
+## [2.4.4] - 2020-08-10
+### Fixed
+- `ExceptionHandling.logger = nil` no longer displays an "implicit extend" deprecation warning.
+
 ## [2.4.3] - 2020-05-14
 ### Deprecated
 - In `ExceptionHandling.logger=`, implicit `logger.extend ContextualLogger::LoggerMixin` is now deprecated.
@@ -29,7 +52,11 @@ Note: this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0
 ### Changed
 - No longer depends on hobo_support. Uses invoca-utils 0.3 instead.
 
-[2.5.0]: https://github.com/Invoca/exception_handling/compare/v2.4.3...v2.5.0
+[2.7.0]: https://github.com/Invoca/exception_handling/compare/v2.6.1...v2.7.0
+[2.6.1]: https://github.com/Invoca/exception_handling/compare/v2.6.0...v2.6.1
+[2.6.0]: https://github.com/Invoca/exception_handling/compare/v2.5.0...v2.6.0
+[2.5.0]: https://github.com/Invoca/exception_handling/compare/v2.4.4...v2.5.0
+[2.4.4]: https://github.com/Invoca/exception_handling/compare/v2.4.3...v2.4.4
 [2.4.3]: https://github.com/Invoca/exception_handling/compare/v2.4.2...v2.4.3
 [2.4.2]: https://github.com/Invoca/exception_handling/compare/v2.4.1...v2.4.2
 [2.4.1]: https://github.com/Invoca/exception_handling/compare/v2.4.0...v2.4.1

data/Gemfile.lock

@@ -8,7 +8,7 @@ GIT
 PATH
   remote: .
   specs:
-    exception_handling (2.5.0.pre.1)
+    exception_handling (2.7.0.pre.1)
       actionmailer (>= 4.2, < 7.0)
       actionpack (>= 4.2, < 7.0)
       activesupport (>= 4.2, < 7.0)
@@ -55,7 +55,7 @@ GEM
     builder (3.2.3)
     coderay (1.1.2)
     concurrent-ruby (1.1.5)
-    contextual_logger (0.8.0)
+    contextual_logger (0.11.0)
       activesupport
       json
     crass (1.0.6)
@@ -68,7 +68,7 @@ GEM
     invoca-utils (0.4.1)
     jaro_winkler (1.5.3)
     json (2.3.1)
-    loofah (2.6.0)
+    loofah (2.7.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)

data/lib/exception_handling.rb

@@ -29,6 +29,8 @@ module ExceptionHandling # never included
   AUTHENTICATION_HEADERS = ['HTTP_AUTHORIZATION', 'X-HTTP_AUTHORIZATION', 'X_HTTP_AUTHORIZATION', 'REDIRECT_X_HTTP_AUTHORIZATION'].freeze
   HONEYBADGER_STATUSES   = [:success, :failure, :skipped].freeze
 
+  Deprecation3_0 = ActiveSupport::Deprecation.new('3.0', 'exception_handling')
+
   class << self
 
     #
@@ -54,10 +56,8 @@ module ExceptionHandling # never included
       @logger or raise ArgumentError, "You must assign a value to #{name}.logger"
     end
 
-    Deprecation3_0 = ActiveSupport::Deprecation.new('3.0', 'exception_handling')
-
     def logger=(logger)
-      @logger = if logger.is_a?(ContextualLogger::LoggerMixin)
+      @logger = if logger.nil? || logger.is_a?(ContextualLogger::LoggerMixin)
                   logger
                 else
                   Deprecation3_0.deprecation_warning('implicit extend with ContextualLogger::LoggerMixin', 'extend your logger instance or include into your logger class first')
@@ -222,7 +222,13 @@ module ExceptionHandling # never included
     #
     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)
+        log_message = "#{exception_context}\n#{ex.class}: (#{encode_utf8(ex.message.to_s)}):\n  " + clean_backtrace(ex).join("\n  ") + "\n\n"
+
+        if ex.is_a?(Warning)
+          ExceptionHandling.logger.warn("\nExceptionHandlingWarning (Warning:#{timestamp}) #{log_message}", log_context)
+        else
+          ExceptionHandling.logger.fatal("\nExceptionHandlingError (Error:#{timestamp}) #{log_message}", log_context)
+        end
       end
     end
 

data/lib/exception_handling/exception_info.rb

@@ -57,7 +57,8 @@ module ExceptionHandling
       @timestamp = timestamp
       @controller = controller || controller_from_context(exception_context)
       @data_callback = data_callback
-      @log_context = log_context
+      # merge into the surrounding context just like ContextualLogger does when logging
+      @merged_log_context = ExceptionHandling.logger.current_context_for_thread.deep_merge(log_context || {})
     end
 
     def data
@@ -269,15 +270,13 @@ module ExceptionHandling
       data = enhanced_data.dup
       data[:server] = ExceptionHandling.server_name
       data[:exception_context] = deep_clean_hash(@exception_context) if @exception_context.present?
-      data[:log_context] = @log_context
+      data[:log_context] = @merged_log_context
       unstringify_sections(data)
-      context_data = HONEYBADGER_CONTEXT_SECTIONS.reduce({}) do |context, section|
+      HONEYBADGER_CONTEXT_SECTIONS.each_with_object({}) do |section, context|
         if data[section].present?
           context[section] = data[section]
         end
-        context
       end
-      context_data
     end
   end
 end

data/lib/exception_handling/logging_methods.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+require 'active_support/core_ext/module/delegation.rb'
+
+module ExceptionHandling
+  module LoggingMethods # included on models and controllers
+    extend ActiveSupport::Concern
+
+    protected
+
+    delegate :log_error_rack, :log_warning, :log_info, :log_debug, :escalate_error, :escalate_warning, :ensure_escalation, :alert_warning, to: ExceptionHandling
+
+    # TODO: delegate log_error as well
+    def log_error(exception_or_string, exception_context = '')
+      controller = self if respond_to?(:request) && respond_to?(:session)
+      ExceptionHandling.log_error(exception_or_string, exception_context, controller)
+    end
+
+    def ensure_safe(exception_context = "")
+      yield
+    rescue => ex
+      log_error ex, exception_context
+      nil
+    end
+
+    def ensure_alert(*args)
+      ExceptionHandling.ensure_alert(*args) do
+        yield
+      end
+    end
+  end
+end

data/lib/exception_handling/methods.rb

@@ -1,65 +1,15 @@
 # frozen_string_literal: true
 
 require 'active_support/concern'
+require_relative 'logging_methods'
 
 module ExceptionHandling
   module Methods # included on models and controllers
     extend ActiveSupport::Concern
+    include ExceptionHandling::LoggingMethods
 
     protected
 
-    def log_error(exception_or_string, exception_context = '')
-      controller = self if respond_to?(:request) && respond_to?(:session)
-      ExceptionHandling.log_error(exception_or_string, exception_context, controller)
-    end
-
-    def log_error_rack(exception_or_string, exception_context = '', rack_filter = '')
-      ExceptionHandling.log_error_rack(exception_or_string, exception_context, rack_filter)
-    end
-
-    def log_warning(message)
-      ExceptionHandling.log_warning(message)
-    end
-
-    def log_info(message)
-      ExceptionHandling.logger.info(message)
-    end
-
-    def log_debug(message)
-      ExceptionHandling.logger.debug(message)
-    end
-
-    def ensure_safe(exception_context = "")
-      yield
-    rescue => ex
-      log_error ex, exception_context
-      nil
-    end
-
-    def escalate_error(exception_or_string, email_subject)
-      ExceptionHandling.escalate_error(exception_or_string, email_subject)
-    end
-
-    def escalate_warning(message, email_subject)
-      ExceptionHandling.escalate_warning(message, email_subject)
-    end
-
-    def ensure_escalation(*args)
-      ExceptionHandling.ensure_escalation(*args) do
-        yield
-      end
-    end
-
-    def alert_warning(*args)
-      ExceptionHandling.alert_warning(*args)
-    end
-
-    def ensure_alert(*args)
-      ExceptionHandling.ensure_alert(*args) do
-        yield
-      end
-    end
-
     def long_controller_action_timeout
       if defined?(Rails) && Rails.respond_to?(:env) && Rails.env == 'test'
         300
@@ -88,7 +38,10 @@ module ExceptionHandling
     end
 
     included do
-      around_filter :set_current_controller if respond_to? :around_filter
+      Deprecation3_0.deprecation_warning('ExceptionHandling::Methods', 'include LoggingMethods; in controllers, set your own around_filter to set logging context')
+      if respond_to? :around_filter
+        around_filter :set_current_controller
+      end
     end
 
     class_methods do

data/lib/exception_handling/testing.rb

@@ -4,7 +4,7 @@
 
 module ExceptionHandling
   module Testing
-    class ControllerStub
+    class ControllerStubBase
 
       class Request
         attr_accessor :parameters, :protocol, :host, :request_uri, :env, :session_options
@@ -25,7 +25,7 @@ module ExceptionHandling
         attr_accessor :around_filter_method
 
         def around_filter(method)
-          ControllerStub.around_filter_method = method
+          self.around_filter_method = method
         end
       end
 
@@ -44,14 +44,6 @@ module ExceptionHandling
           end
       end
 
-      def simulate_around_filter(&block)
-        set_current_controller(&block)
-      end
-
-      def controller_name
-        "ControllerStub"
-      end
-
       def action_name
         "test_action"
       end
@@ -59,9 +51,27 @@ module ExceptionHandling
       def complete_request_uri
         "#{@request.protocol}#{@request.host}#{@request.request_uri}"
       end
+    end
+
+    class LoggingMethodsControllerStub < ControllerStubBase
+      include ExceptionHandling::LoggingMethods
+
+      def controller_name
+        "LoggingMethodsControllerStub"
+      end
+    end
 
+    class MethodsControllerStub < ControllerStubBase
       include ExceptionHandling::Methods
       set_long_controller_action_timeout 2
+
+      def simulate_around_filter(&block)
+        set_current_controller(&block)
+      end
+
+      def controller_name
+        "MethodsControllerStub"
+      end
     end
   end
 end

data/lib/exception_handling/version.rb

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

data/test/rake_test_warning_false.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Rake 11+ has a misfeature where @warning = true by default
+# See https://github.com/ruby/rake/pull/97/files
+# This causes all tests to be run with `ruby -w`, causing a huge number of warnings
+# from gems we don't control and overwhelming our test output.
+# This patch reverts that.
+
+_ = Rake::TestTask
+
+class Rake::TestTask
+  module SetWarningFalseMixin
+    def initialize(*args)
+      super
+      self.warning = false
+    end
+  end
+
+  prepend SetWarningFalseMixin
+end

data/test/test_helper.rb

@@ -33,16 +33,20 @@ class LoggerStub
     clear
   end
 
+  def debug(message, log_context = {})
+    logged << { message: message, context: log_context, severity: 'DEBUG' }
+  end
+
   def info(message, log_context = {})
-    logged << { message: message, context: log_context }
+    logged << { message: message, context: log_context, severity: 'INFO' }
   end
 
   def warn(message, log_context = {})
-    logged << { message: message, context: log_context }
+    logged << { message: message, context: log_context, severity: 'WARN' }
   end
 
   def fatal(message, log_context = {})
-    logged << { message: message, context: log_context }
+    logged << { message: message, context: log_context, severity: 'FATAL' }
   end
 
   def clear

data/test/unit/exception_handling/exception_info_test.rb

@@ -417,6 +417,26 @@ module ExceptionHandling
     end
 
     context "honeybadger_context_data" do
+      setup do
+        stub(ExceptionHandling.logger).current_context_for_thread { { cuid: 'ABCD' } }
+      end
+
+      should "include thread_context when log_context: is nil" do
+        exception_with_nil_message = RuntimeError.new(nil)
+        stub(exception_with_nil_message).message { nil }
+        exception_info = ExceptionInfo.new(exception_with_nil_message, @exception_context, @timestamp)
+        honeybadger_context_data = exception_info.honeybadger_context_data
+        assert_equal({ "cuid" => 'ABCD' }, honeybadger_context_data[:log_context])
+      end
+
+      should "include thread context merged with log_context:" do
+        exception_with_nil_message = RuntimeError.new(nil)
+        stub(exception_with_nil_message).message { nil }
+        exception_info = ExceptionInfo.new(exception_with_nil_message, @exception_context, @timestamp, log_context: { url: 'http://example.com' })
+        honeybadger_context_data = exception_info.honeybadger_context_data
+        assert_equal({ "cuid" => 'ABCD', "url" => 'http://example.com' }, honeybadger_context_data[:log_context])
+      end
+
       should "return the error details and relevant context data to be used as honeybadger notification context while filtering sensitive data" do
         env = { server: "fe98" }
         parameters = { advertiser_id: 435 }
@@ -464,7 +484,8 @@ module ExceptionHandling
             "test/unit/exception_handling_test.rb:847:in `exception_1'",
             "test/unit/exception_handling_test.rb:455:in `block (4 levels) in <class:ExceptionHandlingTest>'"
           ],
-          event_response: "Event successfully received"
+          event_response: "Event successfully received",
+          log_context: { "cuid" => "ABCD" }
         }
         assert_equal_with_diff expected_data, exception_info.honeybadger_context_data
       end

data/test/unit/exception_handling/logging_methods_test.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative '../../test_helper'
+require_relative '../../helpers/exception_helpers'
+
+require "exception_handling/testing"
+
+module ExceptionHandling
+  class LoggingMethodsTest < ActiveSupport::TestCase
+    include ExceptionHelpers
+
+    def dont_stub_log_error
+      true
+    end
+
+    context "ExceptionHandling::LoggingMethods" do
+      setup do
+        @controller = Testing::LoggingMethodsControllerStub.new
+        ExceptionHandling.stub_handler = nil
+      end
+
+      context "#log_warning" do
+        should "be available to the controller" do
+          klass = Class.new
+          klass.include ExceptionHandling::LoggingMethods
+          instance = klass.new
+          assert instance.methods.include?(:log_warning)
+        end
+
+        should "call ExceptionHandling#log_warning" do
+          mock(ExceptionHandling).log_warning("Hi mom")
+          @controller.send(:log_warning, "Hi mom")
+        end
+      end
+    end
+  end
+end

data/test/unit/exception_handling/methods_test.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-require File.expand_path('../../test_helper',  __dir__)
+require_relative '../../test_helper'
+require_relative '../../helpers/exception_helpers'
 
 require "exception_handling/testing"
 
@@ -12,14 +13,14 @@ module ExceptionHandling
       true
     end
 
-    context "ExceptionHandling.Methods" do
+    context "ExceptionHandling::Methods" do
       setup do
-        @controller = Testing::ControllerStub.new
+        @controller = Testing::MethodsControllerStub.new
         ExceptionHandling.stub_handler = nil
       end
 
       should "set the around filter" do
-        assert_equal :set_current_controller, Testing::ControllerStub.around_filter_method
+        assert_equal :set_current_controller, Testing::MethodsControllerStub.around_filter_method
         assert_nil ExceptionHandling.current_controller
         @controller.simulate_around_filter do
           assert_equal @controller, ExceptionHandling.current_controller
@@ -70,15 +71,35 @@ module ExceptionHandling
 
       context "#log_warning" do
         should "be available to the controller" do
-          assert_equal true, @controller.methods.include?(:log_warning)
+          assert @controller.methods.include?(:log_warning)
         end
+      end
+    end
+
+    context  "included deprecation" do
+      setup do
+        mock_deprecation_3_0
+      end
 
-        should "call ExceptionHandling#log_warning" do
-          mock(ExceptionHandling).log_warning("Hi mom")
-          @controller.send(:log_warning, "Hi mom")
+      should "deprecate when no around_filter in included hook" do
+        k = Class.new
+        k.include ExceptionHandling::Methods
+      end
+
+      should "deprecate controller around_filter in included hook" do
+        controller = Class.new
+        class << controller
+          def around_filter(*)
+          end
         end
+        controller.include ExceptionHandling::Methods
       end
     end
 
+    private
+
+    def mock_deprecation_3_0
+      mock(STDERR).puts(/DEPRECATION WARNING: ExceptionHandling::Methods is deprecated and will be removed from exception_handling 3\.0/)
+    end
   end
 end

data/test/unit/exception_handling_test.rb

@@ -126,6 +126,11 @@ class ExceptionHandlingTest < ActiveSupport::TestCase
         assert_equal ancestors, ExceptionHandling.logger.singleton_class.ancestors.*.name
       end
 
+      should "allow logger = nil (no deprecation warning)" do
+        mock(STDERR).puts(/DEPRECATION WARNING/).never
+        ExceptionHandling.logger = nil
+      end
+
       should "[deprecated] mix in ContextualLogger::Mixin if not there" do
         mock(STDERR).puts(/DEPRECATION WARNING: implicit extend with ContextualLogger::LoggerMixin is deprecated and will be removed from exception_handling 3\.0/)
         logger = Logger.new('/dev/null')
@@ -144,6 +149,11 @@ class ExceptionHandlingTest < ActiveSupport::TestCase
         assert_not_empty logged_excluding_reload_filter.last[:context]
         assert_equal logged_excluding_reload_filter.last[:context], service_name: 'exception_handling'
       end
+
+      should "log with Severity::FATAL" do
+        ExceptionHandling.log_error('This is a Warning', service_name: 'exception_handling')
+        assert_equal logged_excluding_reload_filter.last[:severity], 'FATAL'
+      end
     end
 
     context "#log_warning" do
@@ -160,24 +170,53 @@ class ExceptionHandlingTest < ActiveSupport::TestCase
         assert_not_empty logged_excluding_reload_filter.last[:context]
         assert_equal logged_excluding_reload_filter.last[:context], service_name: 'exception_handling'
       end
+
+      should "log with Severity::WARN" do
+        ExceptionHandling.log_warning('This is a Warning', service_name: 'exception_handling')
+        assert_equal logged_excluding_reload_filter.last[:severity], 'WARN'
+      end
     end
 
     context "#log_info" do
       should "take in additional key word args as logging context and pass them to the logger" do
-        ExceptionHandling.log_warning('This is an Info', service_name: 'exception_handling')
+        ExceptionHandling.log_info('This is an Info', service_name: 'exception_handling')
         assert_match(/This is an Info/, logged_excluding_reload_filter.last[:message])
         assert_not_empty logged_excluding_reload_filter.last[:context]
         assert_equal logged_excluding_reload_filter.last[:context], service_name: 'exception_handling'
       end
+
+      should "log with Severity::INFO" do
+        ExceptionHandling.log_info('This is a Warning', service_name: 'exception_handling')
+        assert_equal logged_excluding_reload_filter.last[:severity], 'INFO'
+      end
     end
 
     context "#log_debug" do
       should "take in additional key word args as logging context and pass them to the logger" do
-        ExceptionHandling.log_warning('This is a Debug', service_name: 'exception_handling')
+        ExceptionHandling.log_debug('This is a Debug', service_name: 'exception_handling')
         assert_match(/This is a Debug/, logged_excluding_reload_filter.last[:message])
         assert_not_empty logged_excluding_reload_filter.last[:context]
         assert_equal logged_excluding_reload_filter.last[:context], service_name: 'exception_handling'
       end
+
+      should "log with Severity::DEBUG" do
+        ExceptionHandling.log_debug('This is a Warning', service_name: 'exception_handling')
+        assert_equal logged_excluding_reload_filter.last[:severity], 'DEBUG'
+      end
+    end
+
+    context "#write_exception_to_log" do
+      should "log warnings with Severity::WARN" do
+        warning = ExceptionHandling::Warning.new('This is a Warning')
+        ExceptionHandling.write_exception_to_log(warning, '', Time.now.to_i, service_name: 'exception_handling')
+        assert_equal logged_excluding_reload_filter.last[:severity], 'WARN'
+      end
+
+      should "log everything else with Severity::FATAL" do
+        error = RuntimeError.new('This is a runtime error')
+        ExceptionHandling.write_exception_to_log(error, '', Time.now.to_i, service_name: 'exception_handling')
+        assert_equal logged_excluding_reload_filter.last[:severity], 'FATAL'
+      end
     end
 
     context "configuration with custom_data_hook or post_log_error_hook" do
@@ -334,7 +373,7 @@ class ExceptionHandlingTest < ActiveSupport::TestCase
 
         if ActionView::VERSION::MAJOR >= 5
           should "log an exception with call stack if an ActionView template exception is raised." do
-            mock(ExceptionHandling.logger).fatal(/\(Error:\d+\) ActionView::Template::Error  \(blah\):\n /, anything)
+            mock(ExceptionHandling.logger).fatal(/\(Error:\d+\) \nActionView::Template::Error: \(blah\):\n /, anything)
             ExceptionHandling.ensure_safe do
               begin
                 # Rails 5 made the switch from ActionView::TemplateError taking in the original exception
@@ -347,7 +386,7 @@ class ExceptionHandlingTest < ActiveSupport::TestCase
           end
         else
           should "log an exception with call stack if an ActionView template exception is raised." do
-            mock(ExceptionHandling.logger).fatal(/\(Error:\d+\) ActionView::Template::Error  \(blah\):\n /, anything)
+            mock(ExceptionHandling.logger).fatal(/\(Error:\d+\) \nActionView::Template::Error: \(blah\):\n /, anything)
             ExceptionHandling.ensure_safe { raise ActionView::TemplateError.new({}, ArgumentError.new("blah")) }
           end
         end
@@ -370,7 +409,7 @@ class ExceptionHandlingTest < ActiveSupport::TestCase
         end
 
         should "allow a message to be appended to the error when logged." do
-          mock(ExceptionHandling.logger).fatal(/mooo \(blah\):\n.*exception_handling_test\.rb/, anything)
+          mock(ExceptionHandling.logger).fatal(/mooo\nArgumentError: \(blah\):\n.*exception_handling_test\.rb/, anything)
           b = ExceptionHandling.ensure_safe("mooo") { raise ArgumentError, "blah" }
           assert_nil b
         end
@@ -378,7 +417,7 @@ class ExceptionHandlingTest < ActiveSupport::TestCase
         should "only rescue StandardError and descendents" do
           assert_raise(Exception) { ExceptionHandling.ensure_safe("mooo") { raise Exception } }
 
-          mock(ExceptionHandling.logger).fatal(/mooo \(blah\):\n.*exception_handling_test\.rb/, anything)
+          mock(ExceptionHandling.logger).fatal(/mooo\nStandardError: \(blah\):\n.*exception_handling_test\.rb/, anything)
 
           b = ExceptionHandling.ensure_safe("mooo") { raise StandardError, "blah" }
           assert_nil b
@@ -409,7 +448,7 @@ class ExceptionHandlingTest < ActiveSupport::TestCase
         end
 
         should "allow a message to be appended to the error when logged." do
-          mock(ExceptionHandling.logger).fatal(/mooo \(blah\):\n.*exception_handling_test\.rb/, anything)
+          mock(ExceptionHandling.logger).fatal(/mooo\nArgumentError: \(blah\):\n.*exception_handling_test\.rb/, anything)
           b = ExceptionHandling.ensure_completely_safe("mooo") { raise ArgumentError, "blah" }
           assert_nil b
         end
@@ -466,7 +505,7 @@ class ExceptionHandlingTest < ActiveSupport::TestCase
           ExceptionHandling.ensure_escalation("ensure context") { raise ArgumentError, "first_test_exception" }
 
           assert_match(/ArgumentError.*first_test_exception/, log_fatals[0].first)
-          assert_match(/safe_email_deliver.*Delivery Error/, log_fatals[1].first)
+          assert_match(/safe_email_deliver.*Delivery Error/m, log_fatals[1].first)
 
           assert_equal 2, log_fatals.size, log_fatals.inspect
 
@@ -536,7 +575,7 @@ class ExceptionHandlingTest < ActiveSupport::TestCase
         should "include the timestamp when the exception is logged" do
           capture_notifications
 
-          mock(ExceptionHandling.logger).fatal(/\(Error:517033020\) ArgumentError context \(blah\):\n.*exception_handling_test\.rb/, anything)
+          mock(ExceptionHandling.logger).fatal(/\(Error:517033020\) context\nArgumentError: \(blah\):\n.*exception_handling_test\.rb/, anything)
           b = ExceptionHandling.ensure_safe("context") { raise ArgumentError, "blah" }
           assert_nil b
 
@@ -616,68 +655,122 @@ class ExceptionHandlingTest < ActiveSupport::TestCase
             ExceptionHandling.log_error(exception_with_nil_message)
           end
 
-          should "send error details and relevant context data to Honeybadger" do
-            Time.now_override = Time.now
-            env = { server: "fe98" }
-            parameters = { advertiser_id: 435, controller: "some_controller" }
-            session = { username: "jsmith" }
-            request_uri = "host/path"
-            controller = create_dummy_controller(env, parameters, session, request_uri)
-            stub(ExceptionHandling).server_name { "invoca_fe98" }
-
-            exception = StandardError.new("Some Exception")
-            exception.set_backtrace([
-                                      "test/unit/exception_handling_test.rb:847:in `exception_1'",
-                                      "test/unit/exception_handling_test.rb:455:in `block (4 levels) in <class:ExceptionHandlingTest>'"
-                                    ])
-            exception_context = { "SERVER_NAME" => "exceptional.com" }
-
-            honeybadger_data = nil
-            mock(Honeybadger).notify.with_any_args do |data|
-              honeybadger_data = data
+          context "with stubbed values" do
+            setup do
+              Time.now_override = Time.now
+              @env = { server: "fe98" }
+              @parameters = { advertiser_id: 435, controller: "some_controller" }
+              @session = { username: "jsmith" }
+              @request_uri = "host/path"
+              @controller = create_dummy_controller(@env, @parameters, @session, @request_uri)
+              stub(ExceptionHandling).server_name { "invoca_fe98" }
+
+              @exception = StandardError.new("Some Exception")
+              @exception.set_backtrace([
+                                         "test/unit/exception_handling_test.rb:847:in `exception_1'",
+                                         "test/unit/exception_handling_test.rb:455:in `block (4 levels) in <class:ExceptionHandlingTest>'"
+                                       ])
+              @exception_context = { "SERVER_NAME" => "exceptional.com" }
             end
-            log_context = { log_source: "gem/listen", cuid: "AA12BC34DE" }
-            ExceptionHandling.log_error(exception, exception_context, controller, **log_context) do |data|
-              data[:scm_revision] = "5b24eac37aaa91f5784901e9aabcead36fd9df82"
-              data[:user_details] = { username: "jsmith" }
-              data[:event_response] = "Event successfully received"
-              data[:other_section] = "This should not be included in the response"
+
+            should "send error details and relevant context data to Honeybadger with log_context" do
+              honeybadger_data = nil
+              mock(Honeybadger).notify.with_any_args do |data|
+                honeybadger_data = data
+              end
+              ExceptionHandling.logger.global_context = { service_name: "rails", region: "AWS-us-east-1" }
+              log_context = { log_source: "gem/listen", service_name: "bin/console" }
+              ExceptionHandling.log_error(@exception, @exception_context, @controller, **log_context) do |data|
+                data[:scm_revision] = "5b24eac37aaa91f5784901e9aabcead36fd9df82"
+                data[:user_details] = { username: "jsmith" }
+                data[:event_response] = "Event successfully received"
+                data[:other_section] = "This should not be included in the response"
+              end
+
+              expected_data = {
+                error_class: :"Test Exception",
+                error_message: "Some Exception",
+                controller: "some_controller",
+                exception: @exception,
+                context: {
+                  timestamp: Time.now.to_i,
+                  error_class: "StandardError",
+                  server: "invoca_fe98",
+                  exception_context: { "SERVER_NAME" => "exceptional.com" },
+                  scm_revision: "5b24eac37aaa91f5784901e9aabcead36fd9df82",
+                  notes: "this is used by a test",
+                  user_details: { "username" => "jsmith" },
+                  request: {
+                    "params" => { "advertiser_id" => 435, "controller" => "some_controller" },
+                    "rails_root" => "Rails.root not defined. Is this a test environment?",
+                    "url" => "host/path"
+                  },
+                  session: {
+                    "key" => nil,
+                    "data" => { "username" => "jsmith" }
+                  },
+                  environment: {
+                    "SERVER_NAME" => "exceptional.com"
+                  },
+                  backtrace: [
+                    "test/unit/exception_handling_test.rb:847:in `exception_1'",
+                    "test/unit/exception_handling_test.rb:455:in `block (4 levels) in <class:ExceptionHandlingTest>'"
+                  ],
+                  event_response: "Event successfully received",
+                  log_context: { "service_name" => "bin/console", "region" => "AWS-us-east-1", "log_source" => "gem/listen" }
+                }
+              }
+              assert_equal_with_diff expected_data, honeybadger_data
             end
 
-            expected_data = {
-              error_class: :"Test Exception",
-              error_message: "Some Exception",
-              controller: "some_controller",
-              exception: exception,
-              context: {
-                timestamp: Time.now.to_i,
-                error_class: "StandardError",
-                server: "invoca_fe98",
-                exception_context: { "SERVER_NAME" => "exceptional.com" },
-                scm_revision: "5b24eac37aaa91f5784901e9aabcead36fd9df82",
-                notes: "this is used by a test",
-                user_details: { "username" => "jsmith" },
-                request: {
-                  "params" => { "advertiser_id" => 435, "controller" => "some_controller" },
-                  "rails_root" => "Rails.root not defined. Is this a test environment?",
-                  "url" => "host/path"
-                },
-                session: {
-                  "key" => nil,
-                  "data" => { "username" => "jsmith" }
-                },
-                environment: {
-                  "SERVER_NAME" => "exceptional.com"
-                },
-                backtrace: [
-                  "test/unit/exception_handling_test.rb:847:in `exception_1'",
-                  "test/unit/exception_handling_test.rb:455:in `block (4 levels) in <class:ExceptionHandlingTest>'"
-                ],
-                event_response: "Event successfully received",
-                log_context: { "log_source" => "gem/listen", "cuid" => "AA12BC34DE" }
+            should "send error details and relevant context data to Honeybadger with empty log_context" do
+              honeybadger_data = nil
+              mock(Honeybadger).notify.with_any_args do |data|
+                honeybadger_data = data
+              end
+              ExceptionHandling.logger.global_context = {}
+              log_context = {}
+              ExceptionHandling.log_error(@exception, @exception_context, @controller, **log_context) do |data|
+                data[:scm_revision] = "5b24eac37aaa91f5784901e9aabcead36fd9df82"
+                data[:user_details] = { username: "jsmith" }
+                data[:event_response] = "Event successfully received"
+                data[:other_section] = "This should not be included in the response"
+              end
+
+              expected_data = {
+                error_class: :"Test Exception",
+                error_message: "Some Exception",
+                controller: "some_controller",
+                exception: @exception,
+                context: {
+                  timestamp: Time.now.to_i,
+                  error_class: "StandardError",
+                  server: "invoca_fe98",
+                  exception_context: { "SERVER_NAME" => "exceptional.com" },
+                  scm_revision: "5b24eac37aaa91f5784901e9aabcead36fd9df82",
+                  notes: "this is used by a test",
+                  user_details: { "username" => "jsmith" },
+                  request: {
+                    "params" => { "advertiser_id" => 435, "controller" => "some_controller" },
+                    "rails_root" => "Rails.root not defined. Is this a test environment?",
+                    "url" => "host/path"
+                  },
+                  session: {
+                    "key" => nil,
+                    "data" => { "username" => "jsmith" }
+                  },
+                  environment: {
+                    "SERVER_NAME" => "exceptional.com"
+                  },
+                  backtrace: [
+                               "test/unit/exception_handling_test.rb:847:in `exception_1'",
+                               "test/unit/exception_handling_test.rb:455:in `block (4 levels) in <class:ExceptionHandlingTest>'"
+                             ],
+                  event_response: "Event successfully received"
+                }
               }
-            }
-            assert_equal_with_diff expected_data, honeybadger_data
+              assert_equal_with_diff expected_data, honeybadger_data
+            end
           end
 
           context "with post_log_error_hook set" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exception_handling
 version: !ruby/object:Gem::Version
-  version: 2.5.0.pre.1
+  version: 2.7.0.pre.1
 platform: ruby
 authors:
 - Invoca
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-18 00:00:00.000000000 Z
+date: 2020-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -143,6 +143,7 @@ files:
 - lib/exception_handling/exception_info.rb
 - lib/exception_handling/honeybadger_callbacks.rb
 - lib/exception_handling/log_stub_error.rb
+- lib/exception_handling/logging_methods.rb
 - lib/exception_handling/mailer.rb
 - lib/exception_handling/methods.rb
 - lib/exception_handling/sensu.rb
@@ -150,12 +151,14 @@ files:
 - lib/exception_handling/version.rb
 - test/helpers/controller_helpers.rb
 - test/helpers/exception_helpers.rb
+- test/rake_test_warning_false.rb
 - test/test_helper.rb
 - test/unit/exception_handling/exception_catalog_test.rb
 - test/unit/exception_handling/exception_description_test.rb
 - test/unit/exception_handling/exception_info_test.rb
 - test/unit/exception_handling/honeybadger_callbacks_test.rb
 - test/unit/exception_handling/log_error_stub_test.rb
+- test/unit/exception_handling/logging_methods_test.rb
 - test/unit/exception_handling/mailer_test.rb
 - test/unit/exception_handling/methods_test.rb
 - test/unit/exception_handling/sensu_test.rb
@@ -191,12 +194,14 @@ summary: Invoca's exception handling logger/emailer layer, based on exception_no
 test_files:
 - test/helpers/controller_helpers.rb
 - test/helpers/exception_helpers.rb
+- test/rake_test_warning_false.rb
 - test/test_helper.rb
 - test/unit/exception_handling/exception_catalog_test.rb
 - test/unit/exception_handling/exception_description_test.rb
 - test/unit/exception_handling/exception_info_test.rb
 - test/unit/exception_handling/honeybadger_callbacks_test.rb
 - test/unit/exception_handling/log_error_stub_test.rb
+- test/unit/exception_handling/logging_methods_test.rb
 - test/unit/exception_handling/mailer_test.rb
 - test/unit/exception_handling/methods_test.rb
 - test/unit/exception_handling/sensu_test.rb