exception_handling 2.5.0 → 2.5.1.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b8df9043df9ecc580c8ea91495410cf37316c113acf43ac7f28dfeb885e235d
-  data.tar.gz: 84f2a6eac09d7388f3c9ffd2e58a4211231aff7ccfe8869b1e307c51e9b02788
+  metadata.gz: 5c3561b45435bb79e5ee48f090362ea006a0d522ab5b61809af57a56951d5aff
+  data.tar.gz: b711a085d3a0049dd5dfbf6e454cb4e948f5f20b2a5d561d6b05a40f0d5c33d8
 SHA512:
-  metadata.gz: 958f9994d47ff6ab87082ed04411c62af377e5e317c8f8669c349d4d7d38f4c7d0a88f6119a2c2a83882ed1be8624baf6e4c67e5fe0bedaeeebcfea7921558e5
-  data.tar.gz: c412244a874549ce99d8e0645ceb6b56a59b9b8b92ddba6cbfab8eb83e5159954d13e5e96e119519e4c9e97e5786412f9f3d60ebef66f4bd5aa5c71dbd70901c
+  metadata.gz: a98fa1af28748a12facbe69b35d56641204db4f43d700970115a476b6689f591e9cc9cd5301a6d8709751f386642f51dd07657efb27f85de1e6ad61173a0e08d
+  data.tar.gz: 143f2f54b21e73299b2486ddff7532e4142fa01e5e92544f1cf4c07d8fd2f5d6de53cacace2089816ae81ccad850e820569e8a60efebb3196e7524e3dd8f26bd

data/CHANGELOG.md

@@ -4,6 +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.5.1] - Unreleased
+### Changed
+- Calling `log_warning` will now log with Severity::WARNING rather than FATAL.
+
 ## [2.5.0] - 2020-08-19
 ### Added
 - The `**log_context` passed to `log_error`/`log_warning`/`log_info` is now
@@ -37,6 +41,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.1]: https://github.com/Invoca/exception_handling/compare/v2.5.0...v2.5.1
 [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

data/Gemfile.lock

@@ -8,7 +8,7 @@ GIT
 PATH
   remote: .
   specs:
-    exception_handling (2.5.0)
+    exception_handling (2.5.1.pre.1)
       actionmailer (>= 4.2, < 7.0)
       actionpack (>= 4.2, < 7.0)
       activesupport (>= 4.2, < 7.0)

data/lib/exception_handling.rb

@@ -222,7 +222,13 @@ module ExceptionHandling # never included
     #
     def write_exception_to_log(ex, exception_context, timestamp, log_context = {})
       ActiveSupport::Deprecation.silence do
-        ExceptionHandling.logger.fatal("\nExceptionHandlingError (Error:#{timestamp}) #{ex.class} #{exception_context} (#{encode_utf8(ex.message.to_s)}):\n  " + clean_backtrace(ex).join("\n  ") + "\n\n", log_context)
+        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)
+        else
+          ExceptionHandling.logger.fatal("\nExceptionHandlingError (Error:#{timestamp}) #{log_message}", log_context)
+        end
       end
     end
 

data/lib/exception_handling/version.rb

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

data/test/test_helper.rb

@@ -33,16 +33,20 @@ class LoggerStub
     clear
   end
 
+  def debug(message, log_context = {})
+    logged << { message: message, context: log_context, severity: 'DEBUG' }
+  end
+
   def info(message, log_context = {})
-    logged << { message: message, context: log_context }
+    logged << { message: message, context: log_context, severity: 'INFO' }
   end
 
   def warn(message, log_context = {})
-    logged << { message: message, context: log_context }
+    logged << { message: message, context: log_context, severity: 'WARN' }
   end
 
   def fatal(message, log_context = {})
-    logged << { message: message, context: log_context }
+    logged << { message: message, context: log_context, severity: 'FATAL' }
   end
 
   def clear

data/test/unit/exception_handling_test.rb

@@ -149,6 +149,11 @@ class ExceptionHandlingTest < ActiveSupport::TestCase
         assert_not_empty logged_excluding_reload_filter.last[:context]
         assert_equal logged_excluding_reload_filter.last[:context], service_name: 'exception_handling'
       end
+
+      should "log with Severity::FATAL" do
+        ExceptionHandling.log_error('This is a Warning', service_name: 'exception_handling')
+        assert_equal logged_excluding_reload_filter.last[:severity], 'FATAL'
+      end
     end
 
     context "#log_warning" do
@@ -165,24 +170,53 @@ class ExceptionHandlingTest < ActiveSupport::TestCase
         assert_not_empty logged_excluding_reload_filter.last[:context]
         assert_equal logged_excluding_reload_filter.last[:context], service_name: 'exception_handling'
       end
+
+      should "log with Severity::WARN" do
+        ExceptionHandling.log_warning('This is a Warning', service_name: 'exception_handling')
+        assert_equal logged_excluding_reload_filter.last[:severity], 'WARN'
+      end
     end
 
     context "#log_info" do
       should "take in additional key word args as logging context and pass them to the logger" do
-        ExceptionHandling.log_warning('This is an Info', service_name: 'exception_handling')
+        ExceptionHandling.log_info('This is an Info', service_name: 'exception_handling')
         assert_match(/This is an Info/, logged_excluding_reload_filter.last[:message])
         assert_not_empty logged_excluding_reload_filter.last[:context]
         assert_equal logged_excluding_reload_filter.last[:context], service_name: 'exception_handling'
       end
+
+      should "log with Severity::INFO" do
+        ExceptionHandling.log_info('This is a Warning', service_name: 'exception_handling')
+        assert_equal logged_excluding_reload_filter.last[:severity], 'INFO'
+      end
     end
 
     context "#log_debug" do
       should "take in additional key word args as logging context and pass them to the logger" do
-        ExceptionHandling.log_warning('This is a Debug', service_name: 'exception_handling')
+        ExceptionHandling.log_debug('This is a Debug', service_name: 'exception_handling')
         assert_match(/This is a Debug/, logged_excluding_reload_filter.last[:message])
         assert_not_empty logged_excluding_reload_filter.last[:context]
         assert_equal logged_excluding_reload_filter.last[:context], service_name: 'exception_handling'
       end
+
+      should "log with Severity::DEBUG" do
+        ExceptionHandling.log_debug('This is a Warning', service_name: 'exception_handling')
+        assert_equal logged_excluding_reload_filter.last[:severity], 'DEBUG'
+      end
+    end
+
+    context "#write_exception_to_log" do
+      should "log warnings with Severity::WARN" do
+        warning = ExceptionHandling::Warning.new('This is a Warning')
+        ExceptionHandling.write_exception_to_log(warning, '', Time.now.to_i, service_name: 'exception_handling')
+        assert_equal logged_excluding_reload_filter.last[:severity], 'WARN'
+      end
+
+      should "log everything else with Severity::FATAL" do
+        error = RuntimeError.new('This is a runtime error')
+        ExceptionHandling.write_exception_to_log(error, '', Time.now.to_i, service_name: 'exception_handling')
+        assert_equal logged_excluding_reload_filter.last[:severity], 'FATAL'
+      end
     end
 
     context "configuration with custom_data_hook or post_log_error_hook" do
@@ -339,7 +373,7 @@ class ExceptionHandlingTest < ActiveSupport::TestCase
 
         if ActionView::VERSION::MAJOR >= 5
           should "log an exception with call stack if an ActionView template exception is raised." do
-            mock(ExceptionHandling.logger).fatal(/\(Error:\d+\) ActionView::Template::Error  \(blah\):\n /, anything)
+            mock(ExceptionHandling.logger).fatal(/\(Error:\d+\) \nActionView::Template::Error: \(blah\):\n /, anything)
             ExceptionHandling.ensure_safe do
               begin
                 # Rails 5 made the switch from ActionView::TemplateError taking in the original exception
@@ -352,7 +386,7 @@ class ExceptionHandlingTest < ActiveSupport::TestCase
           end
         else
           should "log an exception with call stack if an ActionView template exception is raised." do
-            mock(ExceptionHandling.logger).fatal(/\(Error:\d+\) ActionView::Template::Error  \(blah\):\n /, anything)
+            mock(ExceptionHandling.logger).fatal(/\(Error:\d+\) \nActionView::Template::Error: \(blah\):\n /, anything)
             ExceptionHandling.ensure_safe { raise ActionView::TemplateError.new({}, ArgumentError.new("blah")) }
           end
         end
@@ -375,7 +409,7 @@ class ExceptionHandlingTest < ActiveSupport::TestCase
         end
 
         should "allow a message to be appended to the error when logged." do
-          mock(ExceptionHandling.logger).fatal(/mooo \(blah\):\n.*exception_handling_test\.rb/, anything)
+          mock(ExceptionHandling.logger).fatal(/mooo\nArgumentError: \(blah\):\n.*exception_handling_test\.rb/, anything)
           b = ExceptionHandling.ensure_safe("mooo") { raise ArgumentError, "blah" }
           assert_nil b
         end
@@ -383,7 +417,7 @@ class ExceptionHandlingTest < ActiveSupport::TestCase
         should "only rescue StandardError and descendents" do
           assert_raise(Exception) { ExceptionHandling.ensure_safe("mooo") { raise Exception } }
 
-          mock(ExceptionHandling.logger).fatal(/mooo \(blah\):\n.*exception_handling_test\.rb/, anything)
+          mock(ExceptionHandling.logger).fatal(/mooo\nStandardError: \(blah\):\n.*exception_handling_test\.rb/, anything)
 
           b = ExceptionHandling.ensure_safe("mooo") { raise StandardError, "blah" }
           assert_nil b
@@ -414,7 +448,7 @@ class ExceptionHandlingTest < ActiveSupport::TestCase
         end
 
         should "allow a message to be appended to the error when logged." do
-          mock(ExceptionHandling.logger).fatal(/mooo \(blah\):\n.*exception_handling_test\.rb/, anything)
+          mock(ExceptionHandling.logger).fatal(/mooo\nArgumentError: \(blah\):\n.*exception_handling_test\.rb/, anything)
           b = ExceptionHandling.ensure_completely_safe("mooo") { raise ArgumentError, "blah" }
           assert_nil b
         end
@@ -471,7 +505,7 @@ class ExceptionHandlingTest < ActiveSupport::TestCase
           ExceptionHandling.ensure_escalation("ensure context") { raise ArgumentError, "first_test_exception" }
 
           assert_match(/ArgumentError.*first_test_exception/, log_fatals[0].first)
-          assert_match(/safe_email_deliver.*Delivery Error/, log_fatals[1].first)
+          assert_match(/safe_email_deliver.*Delivery Error/m, log_fatals[1].first)
 
           assert_equal 2, log_fatals.size, log_fatals.inspect
 
@@ -541,7 +575,7 @@ class ExceptionHandlingTest < ActiveSupport::TestCase
         should "include the timestamp when the exception is logged" do
           capture_notifications
 
-          mock(ExceptionHandling.logger).fatal(/\(Error:517033020\) ArgumentError context \(blah\):\n.*exception_handling_test\.rb/, anything)
+          mock(ExceptionHandling.logger).fatal(/\(Error:517033020\) context\nArgumentError: \(blah\):\n.*exception_handling_test\.rb/, anything)
           b = ExceptionHandling.ensure_safe("context") { raise ArgumentError, "blah" }
           assert_nil b
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exception_handling
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.5.1.pre.1
 platform: ruby
 authors:
 - Invoca
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-20 00:00:00.000000000 Z
+date: 2020-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -169,7 +169,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 +180,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.