ndr_error 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6865b3a4040710403bca5666e77832264f6a37e6c796056fd53ff0f699f00b3a
-  data.tar.gz: 6040c091ea3cd82836fa14a2fedb6f53228e29f094d34858d60f801072156d2f
+  metadata.gz: 89b4e3b5c4c353c4451a663613117248484b70ca4765e88c234d0ef7fef257e1
+  data.tar.gz: f506e8f64cdfd4e24306c5859e3db30e8eb4ca0bc9c99a0e420b50c3582414a0
 SHA512:
-  metadata.gz: 0d095ec96d771ec3b5f080f47c120f1004108de7f1db63ff99fb7a52176ed0a7ad5ba0b3a68e0290a4452e80fd01dc7a709efe8ad46a7b6abb01edcb32ea4fde
-  data.tar.gz: 235331ff5050c58f76dcc6a64c802d82a7dcb5b06d9bc976a693627a2e21adff9daafce7586fee99c75cfecda9d3ed69eb10dbc90ef4e5ac14447dbc8f0e4d3c
+  metadata.gz: ba72752fa59c55f7a04fc15e57c9fae93c4df17a6eeb7918c18ae3ae466e2ee34a9578255d0d9a7c1d5a3bdadf5c14dd95c4db0dfbfc776b0cce63af10081f39
+  data.tar.gz: 2895abbd8d19f9a0868889437ead29029040f6e7f1ec601859c96f913953f41541bc172b958d21a2d1d3abcb62ac9755b12483cf884607af2b440ad88949fcdd

data/README.md

@@ -38,6 +38,11 @@ a Rack application that can be used as part of the Rails exception-handling midd
 
 In the host application's `application.rb`, the following configuration can be added:
 
+To log the error, but have the host application's routing respond:
+```ruby
+config.exceptions_app = NdrError::Recorder.new(self.routes)
+```
+or log the error, then serve error templates from `public/` (legacy):
 ```ruby
 require 'ndr_error/middleware/public_exceptions'
 # Configure the ActionDispatch::ShowExceptions middleware to use NdrError's exception logger:

data/lib/ndr_error.rb

@@ -1,4 +1,5 @@
 require 'ndr_error/engine'
+require 'ndr_error/recorder'
 
 require 'ndr_error/backtrace_compression'
 require 'ndr_error/callbacks'

data/lib/ndr_error/middleware/public_exceptions.rb

@@ -1,40 +1,9 @@
 module NdrError
   module Middleware
     # Middleware for logging exceptions, can be used as exception_app for Rails.
-    class PublicExceptions < ::ActionDispatch::PublicExceptions
-      def call(env)
-        rescuing_everything do
-          request   = ActionDispatch::Request.new(env)
-          exception = env['action_dispatch.exception']
-
-          # "falsey" callback return value allows logging to be skipped
-          log_exception(request, exception) if run_exception_callback(request, exception)
-        end
-
-        super # Invoke the PublicExceptions behaviour
-      end
-
-      private
-
-      def log_exception(request, exception)
-        parameters = NdrError.log_parameters.call(request)
-        _fingerprint, _log = NdrError.log(exception, parameters, request)
-      end
-
-      def run_exception_callback(request, exception)
-        NdrError.exception_app_callback.call(request, exception)
-      end
-
-      # Unhandled exceptions with logging could terminate the web server!
-      def rescuing_everything
-        yield
-      rescue Exception => exception # rubocop:disable Lint/RescueException
-        # "Log the exception caused by logging an exception..."
-        Rails.logger.warn <<-MSG.strip_heredoc
-          NdrError failed to log an exception!
-            logging error class:   #{exception.class}
-            logging error message: #{exception.message}
-        MSG
+    class PublicExceptions < NdrError::Recorder
+      def initialize(public_path)
+        super ::ActionDispatch::PublicExceptions.new(public_path)
       end
     end
   end

data/lib/ndr_error/recorder.rb

@@ -0,0 +1,45 @@
+module NdrError
+  # Middleware for logging exceptions, can be used as exception_app for Rails.
+  class Recorder
+    # the parent_handler could be the host app's routes, or an instance
+    # of ActionDispatch::PublicExceptions, or any other middleware.
+    def initialize(parent_handler)
+      @parent_handler = parent_handler
+    end
+
+    def call(env)
+      rescuing_everything do
+        request   = ActionDispatch::Request.new(env)
+        exception = env['action_dispatch.exception']
+
+        # "falsey" callback return value allows logging to be skipped
+        log_exception(request, exception) if run_exception_callback(request, exception)
+      end
+
+      @parent_handler.call(env)
+    end
+
+    private
+
+    def log_exception(request, exception)
+      parameters = NdrError.log_parameters.call(request)
+      _fingerprint, _log = NdrError.log(exception, parameters, request)
+    end
+
+    def run_exception_callback(request, exception)
+      NdrError.exception_app_callback.call(request, exception)
+    end
+
+    # Unhandled exceptions with logging could terminate the web server!
+    def rescuing_everything
+      yield
+    rescue Exception => exception # rubocop:disable Lint/RescueException
+      # "Log the exception caused by logging an exception..."
+      Rails.logger.warn <<-MSG.strip_heredoc
+        NdrError failed to log an exception!
+          logging error class:   #{exception.class}
+          logging error message: #{exception.message}
+      MSG
+    end
+  end
+end

data/lib/ndr_error/version.rb

@@ -2,5 +2,5 @@
 
 # Contains the version of NdrError. Sourced by the gemspec.
 module NdrError
-  VERSION = '2.1.0'.freeze
+  VERSION = '2.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ndr_error
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - NCRS Development Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-08 00:00:00.000000000 Z
+date: 2020-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -189,6 +189,7 @@ files:
 - lib/ndr_error/fuzzing.rb
 - lib/ndr_error/logging.rb
 - lib/ndr_error/middleware/public_exceptions.rb
+- lib/ndr_error/recorder.rb
 - lib/ndr_error/uuid_builder.rb
 - lib/ndr_error/version.rb
 - lib/tasks/ndr_error_tasks.rake