exception_handling 2.4.4 → 2.5.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de262141b33b7c4cb5e68018569d0465144097e36d0b85c268646cb0bfb5eb3f
-  data.tar.gz: cdbd41bfd1df237f6d6c3c1788ac52a0ed75314c5fbf63b3cb549edc21aeb3ed
+  metadata.gz: 267155818260bd0971adcfb3f325ce559c70b47fd362a8f80a2f92fc81117bf7
+  data.tar.gz: 52532fdf7184f79c85bbd384340ce99d753cd3b964ea9e1808da77091c5827b1
 SHA512:
-  metadata.gz: a64db1560f94c6c62ced1d7b5afadd1ece6618ee62e41db250b2384e8193b29ec35e39b9389edb2a1e130b2aebf77b4e7851b8173a705b8a7b620284f62e1b9e
-  data.tar.gz: c2efcf1378cf70651ccd1e2e4f3f0f85ff4fe49714f7547d3b4517a0afb1c657f7a8def9dd4339aa7bd510fc714d53b27cc7120fe109fa12eea2c8bbfe98de6e
+  metadata.gz: cf6315b8cf9c5bf2d1bae4732571ee0cc4609e57179c0935775b2b7435ebc44739ed3f61eb84f35adc22a59a7f643892f392f4d2e069ef672a17aa23c1753a67
+  data.tar.gz: d61c96173c88073a5be405480aeadd9a997749bc0b811534abe9b549c281f07b64e096123822a8268c0deb78f8eff139debd4ed93f78576305ae3ebc9e533cc8

data/CHANGELOG.md

@@ -4,9 +4,10 @@ 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.4.4] - 2020-08-10
-### Fixed
-- `ExceptionHandling.logger = nil` no longer displays an "implicit extend" deprecation warning.
+## [2.5.0] - Unreleased
+### Added
+- The `**log_context` passed to `log_error`/`log_warning`/`log_info` is now
+  passed into `Honeybadger.notify()`, in `context: { log_context: ... }`.
 
 ## [2.4.3] - 2020-05-14
 ### Deprecated
@@ -28,7 +29,7 @@ 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.4.3]: https://github.com/Invoca/exception_handling/compare/v2.4.3...v2.4.4
+[2.5.0]: https://github.com/Invoca/exception_handling/compare/v2.4.3...v2.5.0
 [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.4.4)
+    exception_handling (2.5.0.pre.1)
       actionmailer (>= 4.2, < 7.0)
       actionpack (>= 4.2, < 7.0)
       activesupport (>= 4.2, < 7.0)

data/Rakefile

@@ -4,6 +4,8 @@
 require "bundler/gem_tasks"
 require 'rake/testtask'
 
+require_relative 'test/rake_test_warning_false'
+
 task default: :test
 
 Rake::TestTask.new do |t|

data/lib/exception_handling.rb

@@ -57,7 +57,7 @@ module ExceptionHandling # never included
     Deprecation3_0 = ActiveSupport::Deprecation.new('3.0', 'exception_handling')
 
     def logger=(logger)
-      @logger = if logger.nil? || logger.is_a?(ContextualLogger::LoggerMixin)
+      @logger = if 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')
@@ -193,7 +193,9 @@ module ExceptionHandling # never included
     def log_error(exception_or_string, exception_context = '', controller = nil, 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,
+                                         controller: controller || current_controller, data_callback: data_callback,
+                                         log_context: log_context)
 
       if stub_handler
         stub_handler.handle_stub_log_error(exception_info.data)

data/lib/exception_handling/exception_info.rb

@@ -3,7 +3,7 @@
 module ExceptionHandling
   class ExceptionInfo
 
-    ENVIRONMENT_WHITELIST = [
+    ENVIRONMENT_ALLOWLIST = [
       /^HTTP_/,
       /^QUERY_/,
       /^REQUEST_/,
@@ -46,16 +46,18 @@ module ExceptionHandling
     EOS
 
     SECTIONS = [:request, :session, :environment, :backtrace, :event_response].freeze
-    HONEYBADGER_CONTEXT_SECTIONS = [:timestamp, :error_class, :exception_context, :server, :scm_revision, :notes, :user_details, :request, :session, :environment, :backtrace, :event_response].freeze
+    HONEYBADGER_CONTEXT_SECTIONS = [:timestamp, :error_class, :exception_context, :server, :scm_revision, :notes,
+                                    :user_details, :request, :session, :environment, :backtrace, :event_response, :log_context].freeze
 
     attr_reader :exception, :controller, :exception_context, :timestamp
 
-    def initialize(exception, exception_context, timestamp, controller = nil, data_callback = nil)
+    def initialize(exception, exception_context, timestamp, controller: nil, data_callback: nil, log_context: nil)
       @exception = exception
       @exception_context = exception_context
       @timestamp = timestamp
       @controller = controller || controller_from_context(exception_context)
       @data_callback = data_callback
+      @log_context = log_context
     end
 
     def data
@@ -176,7 +178,7 @@ module ExceptionHandling
 
     def clean_environment(env)
       Hash[ env.map do |k, v|
-        [k, v] if !"#{k}: #{v}".in?(ENVIRONMENT_OMIT) && ENVIRONMENT_WHITELIST.any? { |regex| k =~ regex }
+        [k, v] if !"#{k}: #{v}".in?(ENVIRONMENT_OMIT) && ENVIRONMENT_ALLOWLIST.any? { |regex| k =~ regex }
       end.compact ]
     end
 
@@ -267,6 +269,7 @@ 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
       unstringify_sections(data)
       context_data = HONEYBADGER_CONTEXT_SECTIONS.reduce({}) do |context, section|
         if data[section].present?

data/lib/exception_handling/version.rb

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

data/test/unit/exception_handling/exception_info_test.rb

@@ -29,7 +29,7 @@ module ExceptionHandling
           exception_context = {
             "action_controller.instance" => Object.new
           }
-          exception_info = ExceptionInfo.new(@exception, exception_context, @timestamp, @controller)
+          exception_info = ExceptionInfo.new(@exception, exception_context, @timestamp, controller: @controller)
           assert_equal @controller, exception_info.controller
           assert_not_equal exception_context["action_controller.instance"], exception_info.controller
         end
@@ -107,7 +107,7 @@ module ExceptionHandling
         request_uri = "host/path"
         controller = create_dummy_controller(env, parameters, session, request_uri)
         data_callback = ->(data) { data[:custom_section] = "value" }
-        exception_info = ExceptionInfo.new(@exception, "custom context data", @timestamp, controller, data_callback)
+        exception_info = ExceptionInfo.new(@exception, "custom context data", @timestamp, controller: controller, data_callback: data_callback)
 
         dont_allow(exception_info).extract_and_merge_controller_data
         dont_allow(exception_info).customize_from_data_callback
@@ -177,7 +177,7 @@ module ExceptionHandling
       end
 
       should "include controller data when available" do
-        exception_info = ExceptionInfo.new(@exception, @exception_context, @timestamp, @controller)
+        exception_info = ExceptionInfo.new(@exception, @exception_context, @timestamp, controller: @controller)
         expected_data = {
           "error_class" => "StandardError",
           "error_string" => "StandardError: something went wrong",
@@ -220,7 +220,7 @@ module ExceptionHandling
       end
 
       should "add to_s attribute to specific sections that have their content in hash format" do
-        exception_info = ExceptionInfo.new(@exception, @exception_context, @timestamp, @controller)
+        exception_info = ExceptionInfo.new(@exception, @exception_context, @timestamp, controller: @controller)
         expected_data = {
           "error_class" => "StandardError",
           "error_string" => "StandardError: something went wrong",
@@ -251,7 +251,7 @@ module ExceptionHandling
       should "filter out sensitive parameters like passwords" do
         @controller.request.parameters[:password] = "super_secret"
         @controller.request.parameters[:user] = { "password" => "also super secret", "password_confirmation" => "also super secret" }
-        exception_info = ExceptionInfo.new(@exception, @exception_context, @timestamp, @controller)
+        exception_info = ExceptionInfo.new(@exception, @exception_context, @timestamp, controller: @controller)
         expected_params = {
           "password" => "[FILTERED]",
           "advertiser_id" => 435, "controller" => "dummy",
@@ -265,7 +265,7 @@ module ExceptionHandling
       end
 
       should "include the changes from the custom data callback" do
-        exception_info = ExceptionInfo.new(@exception, @exception_context, @timestamp, nil, @data_callback)
+        exception_info = ExceptionInfo.new(@exception, @exception_context, @timestamp, controller: nil, data_callback: @data_callback)
         expected_data = {
           "error_class" => "StandardError",
           "error_string" => "StandardError: something went wrong",
@@ -331,7 +331,7 @@ module ExceptionHandling
         request_uri = "host/path"
         controller = create_dummy_controller(env, parameters, session, request_uri)
         exception = StandardError.new("Request to click domain rejected")
-        exception_info = ExceptionInfo.new(exception, {}, Time.now, controller)
+        exception_info = ExceptionInfo.new(exception, nil, Time.now, controller: controller)
         assert_equal true, exception_info.enhanced_data[:request].is_a?(Hash)
         description = exception_info.exception_description
         assert_not_nil description
@@ -340,11 +340,11 @@ module ExceptionHandling
 
       should "return same description object for related errors (avoid reloading exception catalog from disk)" do
         exception = StandardError.new("No route matches")
-        exception_info = ExceptionInfo.new(exception, {}, Time.now)
+        exception_info = ExceptionInfo.new(exception, nil, Time.now)
         description = exception_info.exception_description
 
         repeat_ex = StandardError.new("No route matches 2")
-        repeat_ex_info = ExceptionInfo.new(repeat_ex, {}, Time.now)
+        repeat_ex_info = ExceptionInfo.new(repeat_ex, nil, Time.now)
         assert_equal description.object_id, repeat_ex_info.exception_description.object_id
       end
     end
@@ -368,7 +368,7 @@ module ExceptionHandling
         session     = { username:   'smith' }
         request_uri = "host/path"
         controller  = create_dummy_controller(env, parameters, session, request_uri)
-        exception_info = ExceptionInfo.new(@exception, @exception_context, @timestamp, controller)
+        exception_info = ExceptionInfo.new(@exception, @exception_context, @timestamp, controller: controller)
 
         assert_equal 'some_controller', exception_info.controller_name
       end
@@ -384,7 +384,7 @@ module ExceptionHandling
       should "be enabled when Honeybadger is defined and exception is not in the filter list" do
         stub(ExceptionHandling).honeybadger_defined? { true }
         exception = StandardError.new("something went wrong")
-        exception_info = ExceptionInfo.new(exception, {}, Time.now)
+        exception_info = ExceptionInfo.new(exception, nil, Time.now)
         assert_nil exception_info.exception_description
         assert_equal true, exception_info.send_to_honeybadger?
       end
@@ -392,7 +392,7 @@ module ExceptionHandling
       should "be enabled when Honeybadger is defined and exception is on the filter list with the flag turned on" do
         stub(ExceptionHandling).honeybadger_defined? { true }
         exception = StandardError.new("No route matches")
-        exception_info = ExceptionInfo.new(exception, {}, Time.now)
+        exception_info = ExceptionInfo.new(exception, nil, Time.now)
         assert_not_nil exception_info.exception_description
         assert_equal true, exception_info.exception_description.send_to_honeybadger
         assert_equal true, exception_info.send_to_honeybadger?
@@ -401,7 +401,7 @@ module ExceptionHandling
       should "be disabled when Honeybadger is defined and exception is on the filter list with the flag turned off" do
         stub(ExceptionHandling).honeybadger_defined? { true }
         exception = StandardError.new("No route matches")
-        exception_info = ExceptionInfo.new(exception, {}, Time.now)
+        exception_info = ExceptionInfo.new(exception, nil, Time.now)
         assert_not_nil exception_info.exception_description
         stub(exception_info.exception_description).send_to_honeybadger { false }
         assert_equal false, exception_info.send_to_honeybadger?
@@ -410,7 +410,7 @@ module ExceptionHandling
       should "be disabled when Honeybadger is not defined" do
         stub(ExceptionHandling).honeybadger_defined? { false }
         exception = StandardError.new("something went wrong")
-        exception_info = ExceptionInfo.new(exception, {}, Time.now)
+        exception_info = ExceptionInfo.new(exception, nil, Time.now)
         assert_nil exception_info.exception_description
         assert_equal false, exception_info.send_to_honeybadger?
       end
@@ -438,7 +438,7 @@ module ExceptionHandling
           data[:other_section] = "This should not be included in the response"
         end
         timestamp = Time.now
-        exception_info = ExceptionInfo.new(exception, exception_context, timestamp, controller, data_callback)
+        exception_info = ExceptionInfo.new(exception, exception_context, timestamp, controller: controller, data_callback: data_callback)
 
         expected_data = {
           timestamp: timestamp,

data/test/unit/exception_handling/honeybadger_callbacks_test.rb

@@ -95,7 +95,7 @@ module ExceptionHandling
           assert_equal "#<ExceptionHandling::HoneybadgerCallbacksTest::TestRaiseOnInspectWithId @id=123 [error 'RuntimeError: some error' while calling #inspect]>", result
         end
 
-        should "handle exceptions for objects responding to to_pik" do
+        should "handle exceptions for objects responding to to_pk" do
           result = HoneybadgerCallbacks.send(:local_variable_filter, :variable_name, TestRaiseOnInspectWithToPk.new, ['password'])
           assert_equal "#<ExceptionHandling::HoneybadgerCallbacksTest::TestRaiseOnInspectWithToPk @pk=SomeRecord-123 [error 'RuntimeError: some error' while calling #inspect]>", result
         end

data/test/unit/exception_handling_test.rb

@@ -126,11 +126,6 @@ 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')
@@ -641,7 +636,8 @@ 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|
+            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"
@@ -677,7 +673,8 @@ class ExceptionHandlingTest < ActiveSupport::TestCase
                   "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: { "log_source" => "gem/listen", "cuid" => "AA12BC34DE" }
               }
             }
             assert_equal_with_diff expected_data, honeybadger_data

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exception_handling
 version: !ruby/object:Gem::Version
-  version: 2.4.4
+  version: 2.5.0.pre.1
 platform: ruby
 authors:
 - Invoca
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-11 00:00:00.000000000 Z
+date: 2020-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -179,9 +179,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: []
 rubygems_version: 3.0.3
 signing_key: