exception_handling 2.4.3.pre.1 → 2.5.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5acc3546b0ac3da2bcfbdc00e013fafa3d4fa552dc3d899a61e109c9b406b93
-  data.tar.gz: 05ddf01fa324a5951b6af074ade46090db6fe9288a85d137331f33ababf9e8e9
+  metadata.gz: 267155818260bd0971adcfb3f325ce559c70b47fd362a8f80a2f92fc81117bf7
+  data.tar.gz: 52532fdf7184f79c85bbd384340ce99d753cd3b964ea9e1808da77091c5827b1
 SHA512:
-  metadata.gz: a2cc8be5a481a2ef381f710f5c566415635e2cbe8964a5d15ef0612aea72a4a62e7dde5a571b354025c8c0ca98076c323cedaab96ab54cff2e9359700b487dc4
-  data.tar.gz: 259376e8b5a1053203f5aeb358b765a7b61b56bd817e1a664e2b98ea2ca783d7f46997056ec4508007f36e002122e83f4d992a3b27d29984d852ae9c1a698922
+  metadata.gz: cf6315b8cf9c5bf2d1bae4732571ee0cc4609e57179c0935775b2b7435ebc44739ed3f61eb84f35adc22a59a7f643892f392f4d2e069ef672a17aa23c1753a67
+  data.tar.gz: d61c96173c88073a5be405480aeadd9a997749bc0b811534abe9b549c281f07b64e096123822a8268c0deb78f8eff139debd4ed93f78576305ae3ebc9e533cc8

data/CHANGELOG.md

@@ -4,7 +4,12 @@ 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.3] - Unreleased
+## [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
 - In `ExceptionHandling.logger=`, implicit `logger.extend ContextualLogger::LoggerMixin` is now deprecated.
   This will be removed in version 3.0 and an `ArgumentError` will be raised if the logger
@@ -24,6 +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.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,11 +8,11 @@ GIT
 PATH
   remote: .
   specs:
-    exception_handling (2.4.3.pre.1)
+    exception_handling (2.5.0.pre.1)
       actionmailer (>= 4.2, < 7.0)
       actionpack (>= 4.2, < 7.0)
       activesupport (>= 4.2, < 7.0)
-      contextual_logger
+      contextual_logger (~> 0.7)
       eventmachine (~> 1.0)
       invoca-utils (~> 0.3)
 
@@ -55,7 +55,7 @@ GEM
     builder (3.2.3)
     coderay (1.1.2)
     concurrent-ruby (1.1.5)
-    contextual_logger (0.6.1)
+    contextual_logger (0.8.0)
       activesupport
       json
     crass (1.0.6)
@@ -65,10 +65,10 @@ GEM
       activesupport (>= 4.2.0)
     i18n (0.9.5)
       concurrent-ruby (~> 1.0)
-    invoca-utils (0.3.0)
+    invoca-utils (0.4.1)
     jaro_winkler (1.5.3)
-    json (2.3.0)
-    loofah (2.5.0)
+    json (2.3.1)
+    loofah (2.6.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
@@ -82,7 +82,7 @@ GEM
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    nokogiri (1.10.9)
+    nokogiri (1.10.10)
       mini_portile2 (~> 2.4.0)
     parallel (1.17.0)
     parser (2.6.3.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/exception_handling.gemspec

@@ -20,10 +20,10 @@ Gem::Specification.new do |spec|
     "allowed_push_host" => "https://rubygems.org"
   }
 
-  spec.add_dependency 'actionmailer',  '>= 4.2', '< 7.0'
-  spec.add_dependency 'actionpack',    '>= 4.2', '< 7.0'
-  spec.add_dependency 'activesupport', '>= 4.2', '< 7.0'
-  spec.add_dependency 'contextual_logger'
-  spec.add_dependency 'eventmachine',  '~> 1.0'
-  spec.add_dependency 'invoca-utils',  '~> 0.3'
+  spec.add_dependency 'actionmailer',      '>= 4.2', '< 7.0'
+  spec.add_dependency 'actionpack',        '>= 4.2', '< 7.0'
+  spec.add_dependency 'activesupport',     '>= 4.2', '< 7.0'
+  spec.add_dependency 'contextual_logger', '~> 0.7'
+  spec.add_dependency 'eventmachine',      '~> 1.0'
+  spec.add_dependency 'invoca-utils',      '~> 0.3'
 end

data/lib/exception_handling.rb

@@ -60,7 +60,7 @@ module ExceptionHandling # never included
       @logger = if logger.is_a?(ContextualLogger::LoggerMixin)
                   logger
                 else
-                  Deprecation3_0.deprecation_warning('implicit extend with ContextualLogger::LoggerMixin', 'extend your logger instance or include your into your logger class first')
+                  Deprecation3_0.deprecation_warning('implicit extend with ContextualLogger::LoggerMixin', 'extend your logger instance or include into your logger class first')
                   logger.extend(ContextualLogger::LoggerMixin)
                 end
     end
@@ -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.3.pre.1'
+  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

@@ -636,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"
@@ -672,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.3.pre.1
+  version: 2.5.0.pre.1
 platform: ruby
 authors:
 - Invoca
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-12 00:00:00.000000000 Z
+date: 2020-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -74,16 +74,16 @@ dependencies:
   name: contextual_logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: eventmachine
   requirement: !ruby/object:Gem::Requirement