ndr_error 2.0.2 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5dd7e6a0913bf10fcf2b1a3aac9f963f201f4f32d3fb59adf874a4a6eac51736
-  data.tar.gz: a3492d3af1d28af880fbf560d6419e3c4ea8eca38e562d872174c53f7ccfb690
+  metadata.gz: 905684f0ea130a6c5613e2df87f46d0e098fe6d16ebcc5647594318bc55cf4a1
+  data.tar.gz: cc8defe0ac32639a4b3b86d7756e6bdbd9fac7a8f0c1923ec2f4982cdfe5f076
 SHA512:
-  metadata.gz: 9285560f82cc42c548f3c36ce93763c64e5c9b354a42d39475c6d826fa03c65ca794a5ff5465ee89e411dc7e764079d26c32fc723d6ee90057e6a461b995c64b
-  data.tar.gz: 6ff76ea64127ba4fb70828ccc0edb7993c80c5d5d793cf1a64d83bb6f74e54e53edaab15f9bffd58818f7c28cc65920762447cceebc3278fd8e2354239173f5f
+  metadata.gz: ee098ccf9dab59e79c533139b754a41306c2cf7d0425098ffeb338dd770d16b53ebb7b818f4976b5c92235831205a8a6e18aa4c39c8c2fc01aab6c05cb120c98
+  data.tar.gz: f8fed40535c7289b0375393518bcca2017dd6f7dea525d4fdc9e22d185cf86f9f23ac5b25a98c60106e8489d2eec1b10399406097ad65586962ff8c49f9504dc

data/README.md

@@ -1,4 +1,4 @@
-# NdrError [![Build Status](https://travis-ci.org/PublicHealthEngland/ndr_error.svg?branch=master)](https://travis-ci.org/PublicHealthEngland/ndr_error) [![Gem Version](https://badge.fury.io/rb/ndr_error.svg)](https://badge.fury.io/rb/ndr_error)
+# NdrError [![Build Status](https://github.com/publichealthengland/ndr_error/workflows/Test/badge.svg)](https://github.com/publichealthengland/ndr_error/actions?query=workflow%3Atest) [![Gem Version](https://badge.fury.io/rb/ndr_error.svg)](https://rubygems.org/gems/ndr_error)
 
 This is the Public Health England (PHE) National Disease Registers (NDR) Error ruby gem. It is a 
 Rails engine that provides error logging, viewing, and grouping capabilities.
@@ -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/app/controllers/ndr_error/application_controller.rb

@@ -1,5 +1,3 @@
-require 'ndr_ui'
-
 module NdrError
   # Global controller logic
   class ApplicationController < ActionController::Base

data/app/models/ndr_error/fingerprint.rb

@@ -6,22 +6,23 @@ module NdrError
 
     self.primary_key = 'error_fingerprintid'
 
-    belongs_to_options = {
-      class_name:  'NdrError::Fingerprint',
-      foreign_key: 'causal_error_fingerprintid'
-    }
-    belongs_to_options[:optional] = true if Rails::VERSION::MAJOR > 4
-    belongs_to :causal_error_fingerprint, belongs_to_options
+    belongs_to :causal_error_fingerprint,
+               class_name: 'NdrError::Fingerprint',
+               foreign_key: 'causal_error_fingerprintid',
+               inverse_of: :caused_error_fingerprints,
+               optional: true
 
     has_many :caused_error_fingerprints,
              class_name:  'NdrError::Fingerprint',
-             foreign_key: 'causal_error_fingerprintid'
+             foreign_key: 'causal_error_fingerprintid',
+             inverse_of: :causal_error_fingerprint
 
     has_many :error_logs,
              -> { latest_first },
              autosave:    true,
              class_name:  'NdrError::Log',
-             foreign_key: 'error_fingerprintid'
+             foreign_key: 'error_fingerprintid',
+             inverse_of: :error_fingerprint
 
     validate :ensure_ticket_url_matched_a_supplied_format
 

data/app/models/ndr_error/log.rb

@@ -15,7 +15,8 @@ module NdrError
 
     belongs_to :error_fingerprint,
                class_name:  'NdrError::Fingerprint',
-               foreign_key: 'error_fingerprintid'
+               foreign_key: 'error_fingerprintid',
+               inverse_of: :error_logs
 
     scope :deleted,     -> { where("status like 'deleted%'") }
     scope :not_deleted, -> { where("(status is null) or (status not like 'deleted%')") }

data/lib/ndr_error/callbacks.rb

@@ -0,0 +1,27 @@
+module NdrError
+  # contains logic for registering callbacks
+  module Callbacks
+    def self.extended(base)
+      base.mattr_accessor :_after_log_callbacks
+      base._after_log_callbacks = []
+    end
+
+    # Register callbacks that will be called after an exception
+    # has been logged.
+    #
+    #   NdrError.after_log do |exception, fingerprint, log|
+    #     # ...
+    #   end
+    #
+    # Multiple callbacks can be registered.
+    def after_log(&block)
+      _after_log_callbacks << block
+    end
+
+    def run_after_log_callbacks(*args)
+      _after_log_callbacks.each do |callback|
+        callback.call(*args)
+      end
+    end
+  end
+end

data/lib/ndr_error/engine.rb

@@ -1,5 +1,7 @@
 require 'active_support/all' # TODO: want duration
 
+require 'ndr_ui/engine'
+
 require 'will_paginate'
 require 'will_paginate/array'
 
@@ -12,11 +14,13 @@ module NdrError
 
     # Hook into host app's asset pipeline
     initializer 'ndr_error.assets.precompile' do |app|
-      app.config.assets.precompile += %w[
-        ndr_error/ndr_error.css
-        ndr_error/ndr_error.js
-        ndr_error/bootstrap/glyphicons-halflings-regular*
-      ]
+      if app.config.respond_to?(:assets)
+        app.config.assets.precompile += %w[
+          ndr_error/ndr_error.css
+          ndr_error/ndr_error.js
+          ndr_error/bootstrap/glyphicons-halflings-regular*
+        ]
+      end
     end
 
     # Extract context filtering from the host application

data/lib/ndr_error/logging.rb

@@ -16,9 +16,11 @@ module NdrError
 
       print = Fingerprint.find_or_create_by_id(log.md5_digest)
       print.causal_error_fingerprint = parent_print
-      error = print.store_log(log)
+      log = print.store_log(log)
 
-      [print, error]
+      NdrError.run_after_log_callbacks(exception, print, log)
+
+      [print, log]
     end
 
     def monitor(ancillary_data: {}, request: nil, swallow: false)

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.0.2'.freeze
+  VERSION = '2.3.0'
 end

data/lib/ndr_error.rb

@@ -1,6 +1,8 @@
 require 'ndr_error/engine'
+require 'ndr_error/recorder'
 
 require 'ndr_error/backtrace_compression'
+require 'ndr_error/callbacks'
 require 'ndr_error/finder'
 require 'ndr_error/fuzzing'
 require 'ndr_error/logging'
@@ -8,6 +10,7 @@ require 'ndr_error/uuid_builder'
 
 # Configuration for NdrError + convienence methods.
 module NdrError
+  extend Callbacks
   extend Finder
   extend Logging
 
@@ -95,6 +98,6 @@ module NdrError
   # 4.2 compatability layer is targetted since all the bundled migrations were written prior to
   # Rails 5.
   def self.migration_class
-    Rails::VERSION::MAJOR < 5 ? ActiveRecord::Migration : ActiveRecord::Migration[4.2]
+    ActiveRecord::Migration[4.2]
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ndr_error
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.3.0
 platform: ruby
 authors:
 - NCRS Development Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-16 00:00:00.000000000 Z
+date: 2022-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '7'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '7'
@@ -72,6 +72,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -132,22 +146,16 @@ dependencies:
   name: ndr_dev_support
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.3
+        version: '5.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.3
+        version: '5.10'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -189,11 +197,13 @@ files:
 - db/migrate/20180203174345_add_cause_to_error_fingerprints.rb
 - lib/ndr_error.rb
 - lib/ndr_error/backtrace_compression.rb
+- lib/ndr_error/callbacks.rb
 - lib/ndr_error/engine.rb
 - lib/ndr_error/finder.rb
 - 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
@@ -209,14 +219,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Rails exception logging