exception_handling 2.5.0.pre.1 → 2.5.0.pre.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 267155818260bd0971adcfb3f325ce559c70b47fd362a8f80a2f92fc81117bf7
-  data.tar.gz: 52532fdf7184f79c85bbd384340ce99d753cd3b964ea9e1808da77091c5827b1
+  metadata.gz: e1f2be68af4ed35506d1ecb517eb720a197a4d3c7d346eeb11c87d8a6e9abdf5
+  data.tar.gz: c87a3341b654ae7144f41888fc0e454953f52663a259f353405790c25d8596ba
 SHA512:
-  metadata.gz: cf6315b8cf9c5bf2d1bae4732571ee0cc4609e57179c0935775b2b7435ebc44739ed3f61eb84f35adc22a59a7f643892f392f4d2e069ef672a17aa23c1753a67
-  data.tar.gz: d61c96173c88073a5be405480aeadd9a997749bc0b811534abe9b549c281f07b64e096123822a8268c0deb78f8eff139debd4ed93f78576305ae3ebc9e533cc8
+  metadata.gz: 4d2b5d03154666523f7fe03321ad1d1fa28ac0ae00629249c21f9f73a330b6f325acfe1ce8b039df4f318b6ade3dd28373b476f87f12d46917016403fbc8a8d6
+  data.tar.gz: 1482537c680996153dd63c7edb30b43259789a16ff3f86b8a61b5cd8aab402a9c07905dbc7d0a945ea0b93fd0fea2ea3ec09bbe51b389fe440d9d58991f08bb9

data/CHANGELOG.md

@@ -9,6 +9,10 @@ Note: this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0
 - The `**log_context` passed to `log_error`/`log_warning`/`log_info` is now
   passed into `Honeybadger.notify()`, in `context: { log_context: ... }`.
 
+## [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 +33,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.5.0]: https://github.com/Invoca/exception_handling/compare/v2.4.3...v2.5.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.5.0.pre.2)
       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.9.1)
       activesupport
       json
     crass (1.0.6)

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.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')
@@ -195,7 +195,7 @@ module ExceptionHandling # never included
       timestamp = set_log_error_timestamp
       exception_info = ExceptionInfo.new(ex, exception_context, timestamp,
                                          controller: controller || current_controller, data_callback: data_callback,
-                                         log_context: log_context)
+                                         log_context: logger.current_context_for_thread.deep_merge(log_context))
 
       if stub_handler
         stub_handler.handle_stub_log_error(exception_info.data)

data/lib/exception_handling/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ExceptionHandling
-  VERSION = '2.5.0.pre.1'
+  VERSION = '2.5.0.pre.2'
 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/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')
@@ -616,68 +621,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.5.0.pre.2
 platform: ruby
 authors:
 - Invoca
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-18 00:00:00.000000000 Z
+date: 2020-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -150,6 +150,7 @@ 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
@@ -191,6 +192,7 @@ 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