exception_handling 2.11.0 → 2.11.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9706778bbece312eb7aa676434e2b540161c0d855990d6cb76dc0eb29f584b69
-  data.tar.gz: 559115f2f7ce37041563104d0addcb4d5c10d35e02f6d506f28f21c1695a2ed1
+  metadata.gz: 2ecd3cd1b1ac9c74a1b64c7ac8884122bf2625175c902fb211994c3fc2364fb6
+  data.tar.gz: 8549017918ed765348567a73abb52fa2b97ae85a0a910962738f7aabafccf5e7
 SHA512:
-  metadata.gz: a1cdbd8aa1c88bf4d3eed2f5b5aeb41c6508849b8edf370c008436d5bfa667638a0e89c239d2621fb8e3454a10b47a7cea4a96fb0ed879a51b862f2aa96c663f
-  data.tar.gz: b67f31bd291331e34227b4a103b1acd6bea70b757bbf75c0194cc4cb7bbc9c266bb300afc8650e135145f27eedd7d7113cb268f58a7a162966dfba52d73387ab
+  metadata.gz: f88892659d8e4c87209013b95b874eeb57b29c01b7648a07096cf915e4724264a70c184c76e0b0d8f07e3520ef9f7187bf8bfd94507877b7fe19ba785bc59ad4
+  data.tar.gz: b5d4dc17af467b3d0994ce18e7050c7490e38318ab6abdade3a4dc050b9242e64aaba936b55b8806948051892a5c2856d7bd7308030ed899b4d978a8cfd8b472

data/CHANGELOG.md

@@ -4,6 +4,18 @@ 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.11.3] - 2022-04-07
+### Fixed
+- Fixed bug in ruby 2.7+ where `digest` was not required by default
+
+## [2.11.2] - 2022-04-04
+### Fixed
+- Fixed Ruby 3+ bug where arguments where not being passed using ** operator when writing to the logger
+
+## [2.11.1] - 2022-04-04
+### Fixed
+- Fixed bug in ruby 3+ where `contextual_logger` was missing ruby 3+ support
+
 ## [2.11.0] - 2022-03-29
 ### Added
 - Added support for rails 2.7 and 3+
@@ -79,6 +91,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.11.3]: https://github.com/Invoca/exception_handling/compare/v2.11.2...v2.11.3
+[2.11.2]: https://github.com/Invoca/exception_handling/compare/v2.11.1...v2.11.2
+[2.11.1]: https://github.com/Invoca/exception_handling/compare/v2.11.0...v2.11.1
+[2.11.0]: https://github.com/Invoca/exception_handling/compare/v2.10.0...v2.11.0
+[2.10.0]: https://github.com/Invoca/exception_handling/compare/v2.9.0...v2.10.0
 [2.9.0]: https://github.com/Invoca/exception_handling/compare/v2.8.1...v2.9.0
 [2.8.1]: https://github.com/Invoca/exception_handling/compare/v2.8.0...v2.8.1
 [2.8.0]: https://github.com/Invoca/exception_handling/compare/v2.7.0...v2.8.0

data/Gemfile.lock

@@ -1,11 +1,11 @@
 PATH
   remote: .
   specs:
-    exception_handling (2.11.0)
+    exception_handling (2.11.3)
       actionmailer (>= 5.2, < 7.0)
       actionpack (>= 5.2, < 7.0)
       activesupport (>= 5.2, < 7.0)
-      contextual_logger (~> 0.7)
+      contextual_logger (~> 1.0)
       escalate (~> 0.3)
       eventmachine (~> 1.0)
       invoca-utils (~> 0.3)
@@ -52,11 +52,11 @@ GEM
     byebug (11.1.3)
     coderay (1.1.2)
     concurrent-ruby (1.1.10)
-    contextual_logger (0.11.0)
+    contextual_logger (1.0.0)
       activesupport
       json
     crass (1.0.6)
-    diff-lcs (1.4.4)
+    diff-lcs (1.5.0)
     digest (3.1.0)
     erubi (1.10.0)
     escalate (0.3.0)
@@ -67,7 +67,6 @@ GEM
     i18n (1.10.0)
       concurrent-ruby (~> 1.0)
     invoca-utils (0.4.1)
-    io-wait (0.2.1)
     jaro_winkler (1.5.3)
     json (2.6.1)
     loofah (2.15.0)
@@ -79,8 +78,7 @@ GEM
     mini_mime (1.1.2)
     mini_portile2 (2.8.0)
     minitest (5.15.0)
-    net-protocol (0.1.2)
-      io-wait
+    net-protocol (0.1.3)
       timeout
     net-smtp (0.3.1)
       digest
@@ -123,7 +121,7 @@ GEM
     rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
+    rspec-support (3.9.4)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
     rubocop (0.74.0)

data/exception_handling.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'actionmailer',      '>= 5.2', '< 7.0'
   spec.add_dependency 'actionpack',        '>= 5.2', '< 7.0'
   spec.add_dependency 'activesupport',     '>= 5.2', '< 7.0'
-  spec.add_dependency 'contextual_logger', '~> 0.7'
+  spec.add_dependency 'contextual_logger', '~> 1.0'
   spec.add_dependency 'escalate',          '~> 0.3'
   spec.add_dependency 'eventmachine',      '~> 1.0'
   spec.add_dependency 'invoca-utils',      '~> 0.3'

data/lib/exception_handling/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ExceptionHandling
-  VERSION = '2.11.0'
+  VERSION = '2.11.3'
 end

data/lib/exception_handling.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'digest'
 require 'timeout'
 require 'active_support'
 require 'active_support/core_ext'
@@ -230,9 +231,9 @@ module ExceptionHandling # never included
         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)
+          ExceptionHandling.logger.warn("\nExceptionHandlingWarning (Warning:#{timestamp}) #{log_message}", **log_context)
         else
-          ExceptionHandling.logger.fatal("\nExceptionHandlingError (Error:#{timestamp}) #{log_message}", log_context)
+          ExceptionHandling.logger.fatal("\nExceptionHandlingError (Error:#{timestamp}) #{log_message}", **log_context)
         end
       end
     end
@@ -304,11 +305,11 @@ module ExceptionHandling # never included
     end
 
     def log_info(message, **log_context)
-      ExceptionHandling.logger.info(message, log_context)
+      ExceptionHandling.logger.info(message, **log_context)
     end
 
     def log_debug(message, **log_context)
-      ExceptionHandling.logger.debug(message, log_context)
+      ExceptionHandling.logger.debug(message, **log_context)
     end
 
     def ensure_safe(exception_context = "", **log_context)

data/spec/helpers/exception_helpers.rb

@@ -15,6 +15,6 @@ module ExceptionHelpers
 
   def capture_notifications
     @sent_notifications = []
-    allow(ExceptionHandling).to receive(:send_exception_to_honeybadger).with(anything) { |exception_info| @sent_notifications << exception_info }
+    allow(ExceptionHandling).to receive(:send_exception_to_honeybadger).with(any_args) { |exception_info| @sent_notifications << exception_info }
   end
 end

data/spec/unit/exception_handling/exception_catalog_spec.rb

@@ -41,7 +41,7 @@ module ExceptionHandling
         @exception_catalog = ExceptionCatalog.new(ExceptionHandling.filter_list_filename)
 
         expect(ExceptionHandling).to receive(:log_error).never
-        expect(ExceptionHandling).to receive(:write_exception_to_log).with(anything, "ExceptionCatalog#refresh_filters: ./config/exception_filters.yml", anything)
+        expect(ExceptionHandling).to receive(:write_exception_to_log).with(anything, "ExceptionCatalog#refresh_filters: ./config/exception_filters.yml", any_args)
         expect(@exception_catalog).to receive(:load_file) { raise "noooooo" }
 
         @exception_catalog.find({})

data/spec/unit/exception_handling/methods_spec.rb

@@ -31,7 +31,7 @@ module ExceptionHandling
       it "use the current_controller when available" do
         capture_notifications
 
-        expect(ExceptionHandling.logger).to receive(:fatal).with(/blah/, anything).at_least(:once)
+        expect(ExceptionHandling.logger).to receive(:fatal).with(/blah/, any_args).at_least(:once)
         @controller.simulate_around_filter do
           ExceptionHandling.log_error(ArgumentError.new("blah"))
           expect(sent_notifications.size).to eq(1)

data/spec/unit/exception_handling_spec.rb

@@ -109,8 +109,8 @@ describe ExceptionHandling do
 
   context "with warn and honeybadger notify stubbed" do
     before do
-      allow(ExceptionHandling).to receive(:warn).with(anything)
-      allow(Honeybadger).to receive(:notify).with(anything)
+      allow(ExceptionHandling).to receive(:warn).with(any_args)
+      allow(Honeybadger).to receive(:notify).with(any_args)
     end
 
     context "with logger stashed" do
@@ -372,13 +372,13 @@ describe ExceptionHandling do
 
       context "ExceptionHandling.ensure_safe" do
         it "log an exception with call stack if an exception is raised." do
-          expect(ExceptionHandling.logger).to receive(:fatal).with(/\(blah\):\n.*exception_handling_spec\.rb/, anything)
+          expect(ExceptionHandling.logger).to receive(:fatal).with(/\(blah\):\n.*exception_handling_spec\.rb/, any_args)
           ExceptionHandling.ensure_safe { raise ArgumentError, "blah" }
         end
 
         if ActionView::VERSION::MAJOR >= 5
           it "log an exception with call stack if an ActionView template exception is raised." do
-            expect(ExceptionHandling.logger).to receive(:fatal).with(/\(Error:\d+\) \nActionView::Template::Error: \(blah\):\n /, anything)
+            expect(ExceptionHandling.logger).to receive(:fatal).with(/\(Error:\d+\) \nActionView::Template::Error: \(blah\):\n /, any_args)
             ExceptionHandling.ensure_safe do
               begin
                 # Rails 5 made the switch from ActionView::TemplateError taking in the original exception
@@ -391,7 +391,7 @@ describe ExceptionHandling do
           end
         else
           it "log an exception with call stack if an ActionView template exception is raised." do
-            expect(ExceptionHandling.logger).to receive(:fatal).with(/\(Error:\d+\) \nActionView::Template::Error: \(blah\):\n /, anything)
+            expect(ExceptionHandling.logger).to receive(:fatal).with(/\(Error:\d+\) \nActionView::Template::Error: \(blah\):\n /, any_args)
             ExceptionHandling.ensure_safe { raise ActionView::TemplateError.new({}, ArgumentError.new("blah")) }
           end
         end
@@ -408,13 +408,13 @@ describe ExceptionHandling do
         end
 
         it "return nil if an exception is raised during an assignment" do
-          expect(ExceptionHandling.logger).to receive(:fatal).with(/\(blah\):\n.*exception_handling_spec\.rb/, anything)
+          expect(ExceptionHandling.logger).to receive(:fatal).with(/\(blah\):\n.*exception_handling_spec\.rb/, any_args)
           b = ExceptionHandling.ensure_safe { raise ArgumentError, "blah" }
           expect(b).to be_nil
         end
 
         it "allow a message to be appended to the error when logged." do
-          expect(ExceptionHandling.logger).to receive(:fatal).with(/mooo\nArgumentError: \(blah\):\n.*exception_handling_spec\.rb/, anything)
+          expect(ExceptionHandling.logger).to receive(:fatal).with(/mooo\nArgumentError: \(blah\):\n.*exception_handling_spec\.rb/, any_args)
           b = ExceptionHandling.ensure_safe("mooo") { raise ArgumentError, "blah" }
           expect(b).to be_nil
         end
@@ -422,7 +422,7 @@ describe ExceptionHandling do
         it "only rescue StandardError and descendents" do
           expect { ExceptionHandling.ensure_safe("mooo") { raise Exception } }.to raise_exception(Exception)
 
-          expect(ExceptionHandling.logger).to receive(:fatal).with(/mooo\nStandardError: \(blah\):\n.*exception_handling_spec\.rb/, anything)
+          expect(ExceptionHandling.logger).to receive(:fatal).with(/mooo\nStandardError: \(blah\):\n.*exception_handling_spec\.rb/, any_args)
 
           b = ExceptionHandling.ensure_safe("mooo") { raise StandardError, "blah" }
           expect(b).to be_nil
@@ -431,7 +431,7 @@ describe ExceptionHandling do
 
       context "ExceptionHandling.ensure_completely_safe" do
         it "log an exception if an exception is raised." do
-          expect(ExceptionHandling.logger).to receive(:fatal).with(/\(blah\):\n.*exception_handling_spec\.rb/, anything)
+          expect(ExceptionHandling.logger).to receive(:fatal).with(/\(blah\):\n.*exception_handling_spec\.rb/, any_args)
           ExceptionHandling.ensure_completely_safe { raise ArgumentError, "blah" }
         end
 
@@ -447,19 +447,19 @@ describe ExceptionHandling do
         end
 
         it "return nil if an exception is raised during an assignment" do
-          expect(ExceptionHandling.logger).to receive(:fatal).with(/\(blah\):\n.*exception_handling_spec\.rb/, anything) { nil }
+          expect(ExceptionHandling.logger).to receive(:fatal).with(/\(blah\):\n.*exception_handling_spec\.rb/, any_args) { nil }
           b = ExceptionHandling.ensure_completely_safe { raise ArgumentError, "blah" }
           expect(b).to be_nil
         end
 
         it "allow a message to be appended to the error when logged." do
-          expect(ExceptionHandling.logger).to receive(:fatal).with(/mooo\nArgumentError: \(blah\):\n.*exception_handling_spec\.rb/, anything)
+          expect(ExceptionHandling.logger).to receive(:fatal).with(/mooo\nArgumentError: \(blah\):\n.*exception_handling_spec\.rb/, any_args)
           b = ExceptionHandling.ensure_completely_safe("mooo") { raise ArgumentError, "blah" }
           expect(b).to be_nil
         end
 
         it "rescue any instance or child of Exception" do
-          expect(ExceptionHandling.logger).to receive(:fatal).with(/\(blah\):\n.*exception_handling_spec\.rb/, anything)
+          expect(ExceptionHandling.logger).to receive(:fatal).with(/\(blah\):\n.*exception_handling_spec\.rb/, any_args)
           ExceptionHandling.ensure_completely_safe { raise Exception, "blah" }
         end
 
@@ -481,7 +481,7 @@ describe ExceptionHandling do
         end
 
         it "log the exception as usual and send the proper email" do
-          expect(ExceptionHandling.logger).to receive(:fatal).with(/\(blah\):\n.*exception_handling_spec\.rb/, anything)
+          expect(ExceptionHandling.logger).to receive(:fatal).with(/\(blah\):\n.*exception_handling_spec\.rb/, any_args)
           ExceptionHandling.ensure_escalation("Favorite Feature") { raise ArgumentError, "blah" }
           expect(ActionMailer::Base.deliveries.count).to eq(1)
           expect(sent_notifications.size).to eq(1), sent_notifications.inspect
@@ -516,7 +516,7 @@ describe ExceptionHandling do
 
         it "allow the caller to specify custom recipients" do
           custom_recipients = ['something@invoca.com']
-          expect(ExceptionHandling.logger).to receive(:fatal).with(/\(blah\):\n.*exception_handling_spec\.rb/, anything)
+          expect(ExceptionHandling.logger).to receive(:fatal).with(/\(blah\):\n.*exception_handling_spec\.rb/, any_args)
           ExceptionHandling.ensure_escalation("Favorite Feature", custom_recipients) { raise ArgumentError, "blah" }
           expect(ActionMailer::Base.deliveries.count).to eq(1)
           expect(sent_notifications.size).to eq(1), sent_notifications.inspect
@@ -532,7 +532,7 @@ describe ExceptionHandling do
       context "ExceptionHandling.ensure_alert" do
         it "log the exception as usual and fire a sensu event" do
           expect(ExceptionHandling::Sensu).to receive(:generate_event).with("Favorite Feature", "test context\nblah")
-          expect(ExceptionHandling.logger).to receive(:fatal).with(/\(blah\):\n.*exception_handling_spec\.rb/, anything)
+          expect(ExceptionHandling.logger).to receive(:fatal).with(/\(blah\):\n.*exception_handling_spec\.rb/, any_args)
           ExceptionHandling.ensure_alert('Favorite Feature', 'test context') { raise ArgumentError, "blah" }
         end
 
@@ -544,8 +544,8 @@ describe ExceptionHandling do
 
         it "log if the sensu event could not be sent" do
           expect(ExceptionHandling::Sensu).to receive(:send_event).with(anything) { raise "Failed to send" }
-          expect(ExceptionHandling.logger).to receive(:fatal).with(/first_test_exception/, anything)
-          expect(ExceptionHandling.logger).to receive(:fatal).with(/Failed to send/, anything)
+          expect(ExceptionHandling.logger).to receive(:fatal).with(/first_test_exception/, any_args)
+          expect(ExceptionHandling.logger).to receive(:fatal).with(/Failed to send/, any_args)
           ExceptionHandling.ensure_alert("Not Used", 'test context') { raise ArgumentError, "first_test_exception" }
         end
 
@@ -575,7 +575,7 @@ describe ExceptionHandling do
         it "include the timestamp when the exception is logged" do
           capture_notifications
 
-          expect(ExceptionHandling.logger).to receive(:fatal).with(/\(Error:517033020\) context\nArgumentError: \(blah\):\n.*exception_handling_spec\.rb/, anything)
+          expect(ExceptionHandling.logger).to receive(:fatal).with(/\(Error:517033020\) context\nArgumentError: \(blah\):\n.*exception_handling_spec\.rb/, any_args)
           b = ExceptionHandling.ensure_safe("context") { raise ArgumentError, "blah" }
           expect(b).to be_nil
 
@@ -850,7 +850,7 @@ describe ExceptionHandling do
       allow(ExceptionHandling).to receive(:make_exception) { raise ArgumentError, "Bad argument" }
       expect(ExceptionHandling).to receive(:write_exception_to_log).with(satisfy { |ex| ex.to_s['Bad argument'] },
                                                      satisfy { |context| context['ExceptionHandlingError: log_error rescued exception while logging Runtime message'] },
-                                                     anything)
+                                                     any_args)
       ExceptionHandling.log_error(RuntimeError.new("A runtime error"), "Runtime message")
     end
 
@@ -858,7 +858,7 @@ describe ExceptionHandling do
       expect(ExceptionHandling).to receive(:write_exception_to_log).with(satisfy { |ex| ex.to_s['Bad argument'] },
                                                      satisfy { |context| context['Context message'] },
                                                      anything,
-                                                     anything)
+                                                     any_args)
       ExceptionHandling.log_error(ArgumentError.new("Bad argument"), "Context message") { |_data| raise 'Error!!!' }
     end
 
@@ -963,7 +963,7 @@ describe ExceptionHandling do
       it "omit environment defaults" do
         capture_notifications
 
-        allow(ExceptionHandling).to receive(:send_exception_to_honeybadger).with(anything) { |exception_info| sent_notifications << exception_info }
+        allow(ExceptionHandling).to receive(:send_exception_to_honeybadger).with(any_args) { |exception_info| sent_notifications << exception_info }
 
         ExceptionHandling.log_error("some message") do |data|
           data[:environment] = { SERVER_PORT: '80', SERVER_PROTOCOL: "HTTP/1.0" }
@@ -1052,7 +1052,7 @@ describe ExceptionHandling do
               ActionMailer::Base.deliveries.clear
 
               set_test_const('EventMachine::Protocols::SmtpClient', SmtpClientErrbackStub)
-              expect(ExceptionHandling.logger).to receive(:fatal).with(/Exception to escalate/, anything)
+              expect(ExceptionHandling.logger).to receive(:fatal).with(/Exception to escalate/, any_args)
               expect(ExceptionHandling.logger).to receive(:fatal).with(/Failed to email by SMTP: "credential mismatch"/)
 
               ExceptionHandling.ensure_escalation("ensure message") { raise 'Exception to escalate!' }
@@ -1064,7 +1064,7 @@ describe ExceptionHandling do
               expect((SmtpClientErrbackStub.send_hash & EXPECTED_SMTP_HASH.keys).map_hash { |_k, v| v.to_s }).to eq(EXPECTED_SMTP_HASH), SmtpClientErrbackStub.send_hash.inspect            end
 
             it "log fatal on EventMachine dns resolver errback" do
-              expect(ExceptionHandling.logger).to receive(:fatal).with(/Exception to escalate/, anything)
+              expect(ExceptionHandling.logger).to receive(:fatal).with(/Exception to escalate/, any_args)
               expect(ExceptionHandling.logger).to receive(:fatal).with(/Failed to resolv DNS for localhost: "softlayer sucks"/)
 
               ExceptionHandling.ensure_escalation("ensure message") { raise 'Exception to escalate!' }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exception_handling
 version: !ruby/object:Gem::Version
-  version: 2.11.0
+  version: 2.11.3
 platform: ruby
 authors:
 - Invoca
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-29 00:00:00.000000000 Z
+date: 2022-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -76,14 +76,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: escalate
   requirement: !ruby/object:Gem::Requirement