exception_handling 2.6.0 → 2.7.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5720f1d81733d8912d7777a97e57f29c412b05fd938ebe073c91973d1b948685
-  data.tar.gz: b7f587666d212e629be8603cbb711c76ade2917d1a03c91e541f87b7c3eb09c6
+  metadata.gz: 3794611262e09346bab80e7a683f4ce1d78d6ba04b46fa15fa4bc84ac087e41e
+  data.tar.gz: 36f96bed7f2b3375df4730d35ee5ec96cdf70e7c07f4ba589e187c75275c1736
 SHA512:
-  metadata.gz: c7138e98374c2f2609500fdd2c11c7bee9211d6f6d548e5c1afe3191318e5966c48ff8fd6e6af2230f5c3ceb6ca44ece1535a85009881e9bd748adcf7d8438e9
-  data.tar.gz: 6f6cdf2a385a190f1439488c3ac0e3dbaa4c5726a6dfdb4c8bb647b7e86c4dd06bb8d2740cc6e1ee54dfebd77a65b204884fd0bd76346367d201eb624f036757
+  metadata.gz: 2d1dad10749b867696c0f4dcacedcfb4af466ba792fa0c98ae307ee4bbeda10657f172fc95ff3c9b0162d1787d39c3c2a15a220fa6c6f4a7f7b10d857dad5eec
+  data.tar.gz: 8b28f2829a1e34787d7de51fdee4d0fe5a39356584d6d910c106edac2fe5d8ebcf0f3f5f1e9e1b7e4e7b0c36dd62035885214248072e47a7fdec7d1e4a854f94

data/CHANGELOG.md

@@ -4,7 +4,17 @@ 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.6.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.
@@ -42,6 +52,8 @@ 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.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

data/Gemfile.lock

@@ -8,7 +8,7 @@ GIT
 PATH
   remote: .
   specs:
-    exception_handling (2.6.0)
+    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.9.1)
+    contextual_logger (0.11.0)
       activesupport
       json
     crass (1.0.6)

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,8 +56,6 @@ 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.nil? || logger.is_a?(ContextualLogger::LoggerMixin)
                   logger

data/lib/exception_handling/exception_info.rb

@@ -57,9 +57,8 @@ module ExceptionHandling
       @timestamp = timestamp
       @controller = controller || controller_from_context(exception_context)
       @data_callback = data_callback
-      @merged_log_context = if log_context # merge into the surrounding context just like ContextualLogger does when logging
-                              ExceptionHandling.logger.current_context_for_thread.deep_merge(log_context)
-                            end
+      # 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
@@ -273,13 +272,11 @@ module ExceptionHandling
       data[:exception_context] = deep_clean_hash(@exception_context) if @exception_context.present?
       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.6.0'
+  VERSION = '2.7.0.pre.1'
 end

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exception_handling
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.7.0.pre.1
 platform: ruby
 authors:
 - Invoca
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-26 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
@@ -157,6 +158,7 @@ files:
 - 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
@@ -169,7 +171,7 @@ licenses: []
 metadata:
   source_code_uri: https://github.com/Invoca/exception_handling
   allowed_push_host: https://rubygems.org
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -180,12 +182,12 @@ 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: []
 rubygems_version: 3.0.3
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Invoca's exception handling logger/emailer layer, based on exception_notifier.
   Works with Rails or EventMachine or EventMachine+Synchrony.
@@ -199,6 +201,7 @@ test_files:
 - 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