ndr_error 1.1.4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 26ef39b7a26a179c0169656601a9b3b036f1d0b3
-  data.tar.gz: 48200c2d86631bb6dd3be30044e6d2df0fa31988
+  metadata.gz: ca01898083de92ab17019a9f2f312f4536bcf144
+  data.tar.gz: 8593a587b1fd43619dfebe0002205c78ea1018cf
 SHA512:
-  metadata.gz: 4deb7e36e84c118d54c8b606f8c823372393157174703caafbaf3a8cbd52d733b1ab459a9b7b5bd293203f1e7670a340a8e9437d146fbdf1f06632a21354c375
-  data.tar.gz: 1058ab87ec829b8556d8c8e114c961cd33a916951443ebaea0cac09d925c42250d5d085f462225fb6c2cd42a0fe889b2af154ad7da38b489fb73e94fff73c2eb
+  metadata.gz: b4b6b12acc1e1472a63d0c14df1254a6789a83acf9894ea60a319d71a1a19b6c9926de3ac7db4b3cd875ac51a450729e968b11e1dedaedf689703c39b2d34400
+  data.tar.gz: 1151c024cde520d1d6ada13e679e7f12bacfebe292db259a7c4f31a45b489c4829933c922d22cefbcbc413aa8979ef16d228d0ab51aa80c6235003f36bda5704

data/app/controllers/ndr_error/application_controller.rb

@@ -6,6 +6,8 @@ module NdrError
     # Ensure Rails doesn't find any host layouts first:
     layout 'ndr_error/ndr_error'
 
+    helper NdrUi::BootstrapHelper
+
     private
 
     def authenticate

data/app/controllers/ndr_error/errors_controller.rb

@@ -20,6 +20,8 @@ module NdrError
       if @error.nil?
         flash[:error] = 'No matching Logs exist for that Fingerprint!'
         redirect_to error_fingerprints_url(q: @fingerprint.to_param)
+      elsif id.blank?
+        redirect_to log_id: @error.id
       end
     end
 

data/app/helpers/ndr_error/errors_helper.rb

@@ -43,10 +43,17 @@ module NdrError
     end
 
     def similar_error_link(error)
-      text = content_tag(:span, error.user_id, class: 'text-muted')
-      text << ' - ' << error.created_at.to_s(:db)
+      user = error.user_id && content_tag(:span, error.user_id, class: 'text-muted')
+      text = safe_join([user, error.created_at.to_s(:db)].compact, ' - ')
 
-      link_to text, error_fingerprint_path(error.error_fingerprint, log_id: error)
+      bootstrap_list_link_to text, error_fingerprint_path(error.error_fingerprint, log_id: error)
+    end
+
+    def downstream_fingerprint_link(print)
+      hash = content_tag(:span, print.id, class: 'text-muted')
+      text = print.error_logs.first.try(:error_class) || 'N/A'
+
+      bootstrap_list_link_to hash + ' - ' + text, error_fingerprint_path(print)
     end
 
     def ticket_link_for(fingerprint, small = false)
@@ -81,7 +88,7 @@ module NdrError
     def previous_button_for(error)
       css = 'btn btn-default'
       css << ' disabled' if error.nil?
-      text = glyphicon_tag('chevron-left') + h('Previous Occurrence')
+      text = glyphicon_tag('chevron-left')
       path = error.nil? ? '#' : error_fingerprint_path(error.error_fingerprint, log_id: error)
 
       link_to(text, path, class: css)
@@ -90,7 +97,7 @@ module NdrError
     def next_button_for(error)
       css = 'btn btn-default'
       css << ' disabled' if error.nil?
-      text = h('Next Occurrence') + glyphicon_tag('chevron-right')
+      text = glyphicon_tag('chevron-right')
       path = error.nil? ? '#' : error_fingerprint_path(error.error_fingerprint, log_id: error)
 
       link_to(text, path, class: css)

data/app/models/ndr_error/fingerprint.rb

@@ -6,6 +6,17 @@ 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
+
+    has_many :caused_error_fingerprints,
+             class_name:  'NdrError::Fingerprint',
+             foreign_key: 'causal_error_fingerprintid'
+
     has_many :error_logs,
              -> { latest_first },
              autosave:    true,

data/app/models/ndr_error/log.rb

@@ -63,27 +63,15 @@ module NdrError
       destroys.any?
     end
 
-    # Finds gets all errors that share an MD5 hash
-    # (including _error_).
-    def self.similar_to(error)
-      error.error_fingerprint.error_logs.not_deleted
-    end
-
-    # Gets similar errors.
-    def similar_errors(include_self = false)
-      unless defined?(@_similar)
-        @_similar = {}
-        @_similar[true]  = self.class.similar_to(self)
-        @_similar[false] = @_similar[true] - [self]
-      end
-
-      @_similar[include_self ? true : false]
+    # returns all sibling occurences, including self
+    def similar_errors
+      error_fingerprint.error_logs.not_deleted
     end
 
     # Returns the previous historical occurence,
     # or nil if there wasn't one.
     def previous
-      lookup = similar_errors(true).reverse
+      lookup = similar_errors.reverse
       index  = lookup.index(self)
       lookup[0...index].last
     end
@@ -91,7 +79,7 @@ module NdrError
     # Returns the next historical occurence,
     # or nil if there hasn't been one.
     def next
-      lookup = similar_errors(true).to_a
+      lookup = similar_errors.to_a
       index  = lookup.index(self)
       lookup[0...index].last
     end
@@ -116,6 +104,12 @@ module NdrError
       extract_request_attributes(request)
     end
 
+    # If we have more details about a parent error, track
+    # that too so it can be mixed in to the MD5 digest.
+    def register_parent(parent_print)
+      @parent_print = parent_print.id if parent_print
+    end
+
     # Store as much of `params' as possible in
     # the YAML parameters column.
     def parameters_yml=(params)
@@ -158,7 +152,7 @@ module NdrError
     # Creates (and caches) the md5 of this error,
     # which is used to match to similar errors.
     def md5_digest
-      @_digest ||= fuzz(description, backtrace)
+      @_digest ||= fuzz(description, backtrace, parent_print)
     end
 
     # Allow the digest to be set manually if so desired.
@@ -168,6 +162,10 @@ module NdrError
 
     private
 
+    def parent_print
+      defined?(@parent_print) && @parent_print
+    end
+
     # For the given `request' object, return the
     # parameters in a form suitable for logging.
     def extract_request_params(request)

data/app/views/ndr_error/errors/edit.html.erb

@@ -1,3 +1,12 @@
+<%=
+  bootstrap_breadcrumbs([
+    bootstrap_breadcrumb('Errors', error_fingerprints_path),
+    bootstrap_breadcrumb(@fingerprint.id, error_fingerprint_path(@fingerprint), true),
+    bootstrap_breadcrumb('Edit', nil)
+  ])
+%>
+
+
 <%= form_for @fingerprint, as: :error_fingerprint, url: error_fingerprint_path(@fingerprint), method: :put do |form| %>
   <div class="form-group">
     <%= form.label :ticket_url, 'Ticket URL' %>

data/app/views/ndr_error/errors/index.html.erb

@@ -1,3 +1,9 @@
+<%=
+  bootstrap_breadcrumbs([
+    bootstrap_breadcrumb('Errors', error_fingerprints_path)
+  ])
+%>
+
 <div class="row">
   <div id="search_form_container" class="col-md-4 col-md-offset-8">
   <%= form_tag(error_fingerprints_path, method: :get) do %>

data/app/views/ndr_error/errors/show.html.erb

@@ -1,4 +1,12 @@
-<div>
+<%=
+  bootstrap_breadcrumbs([
+    bootstrap_breadcrumb('Errors', error_fingerprints_path),
+    bootstrap_breadcrumb(@fingerprint.id, error_fingerprint_path(@fingerprint, log_id: @error), true)
+  ])
+%>
+
+<hr />
+<div class="clearfix">
   <div class="pull-right">
     <div class="btn-group">
       <%= ticket_link_for(@fingerprint) if @fingerprint.ticket_url.present? %>
@@ -8,30 +16,51 @@
     <%= purge_button_for(@fingerprint) if user_can_edit_errors? %>
   </div>
 
-  <% if @error.similar_errors.any? %>
-    <div class="">
-      <%= previous_button_for(@error.previous) %>
+  <div class="btn-toolbar">
+    <% if @error.similar_errors.length > 1 %>
+      <div class="btn-group">
+        <%= previous_button_for(@error.previous) %>
+
+        <div class="btn-group">
+          <a class="btn btn-default dropdown-toggle" data-toggle="dropdown" href="#">
+            <%= pluralize(@error.similar_errors.length - 1, 'Similar Error') %> Stored
+            <span class="caret"></span>
+          </a>
+          <ul class="dropdown-menu">
+            <% @error.similar_errors.each do |other| %>
+              <li><%= similar_error_link(other) %></li>
+            <% end %>
+          </ul>
+        </div>
+
+        <%= next_button_for(@error.next) %>
+      </div>
+    <% end %>
+
+    <% if @fingerprint.causal_error_fingerprint %>
+      <div class="btn-group">
+        <%= link_to bootstrap_icon_tag('arrow-up') + ' View Cause', error_fingerprint_path(@fingerprint.causal_error_fingerprint), class: 'btn btn-default' %>
+      </div>
+    <% end %>
 
+    <% if @fingerprint.caused_error_fingerprints.any? %>
       <div class="btn-group">
         <a class="btn btn-default dropdown-toggle" data-toggle="dropdown" href="#">
-          <%= pluralize(@error.similar_errors.length, 'Similar Error') %> Stored
+          <%= pluralize(@fingerprint.caused_error_fingerprints.length, 'Downstream Error') %> Stored
           <span class="caret"></span>
         </a>
         <ul class="dropdown-menu">
-          <% @error.similar_errors.each do |other| %>
-            <li><%= similar_error_link(other) %></li>
+          <% @fingerprint.caused_error_fingerprints.each do |print| %>
+            <li><%= downstream_fingerprint_link print %></li>
           <% end %>
         </ul>
       </div>
+    <% end %>
+  </div>
 
-      <%= next_button_for(@error.next) %>
-    </div>
-  <% end %>
 </div>
 
-<hr/>
 <h1>
-  <%= link_to 'Errors', error_fingerprints_path %> &#187;
   <%= @error.error_class %>
   <br><small><%=h @error.description %></small>
 </h1>

data/db/migrate/20150918162403_create_error_fingerprints.rb

@@ -1,4 +1,4 @@
-# Adds complete ERROR_FINGERPRINT table to schema
+# Adds original ERROR_FINGERPRINT table to schema
 class CreateErrorFingerprints < NdrError.migration_class
   def change
     create_table :error_fingerprints, id: false do |t|

data/db/migrate/20180203174345_add_cause_to_error_fingerprints.rb

@@ -0,0 +1,12 @@
+# Adds supplementary column to error fingerprint
+class AddCauseToErrorFingerprints < NdrError.migration_class
+  def change
+    add_column :error_fingerprints, :causal_error_fingerprintid, :string
+
+    add_foreign_key :error_fingerprints, :error_fingerprints,
+                    column:      :causal_error_fingerprintid,
+                    primary_key: :error_fingerprintid
+
+    add_index :error_fingerprints, :causal_error_fingerprintid
+  end
+end

data/lib/ndr_error/fuzzing.rb

@@ -1,8 +1,12 @@
 module NdrError
   # Mixin to help with fuzzing of exception messages/traces.
   module Fuzzing
-    def fuzz(description, backtrace)
-      Digest::MD5.hexdigest(fuzz_description(description) + fuzz_backtrace(backtrace))
+    def fuzz(description, backtrace, parent_print = nil)
+      Digest::MD5.hexdigest([
+        fuzz_description(description),
+        fuzz_backtrace(backtrace),
+        parent_print
+      ].compact.join)
     end
 
     private

data/lib/ndr_error/logging.rb

@@ -6,16 +6,28 @@ module NdrError
 
     # Log the given `exception`.
     def log(exception, ancillary_data, request_object)
+      # Capture details about a parent exception, if possible:
+      parent_print, = exception.cause && log(exception.cause, ancillary_data, request_object)
+
       log = initialize_log(ancillary_data)
       log.register_exception(exception)
       log.register_request(request_object)
+      log.register_parent(parent_print)
 
       print = Fingerprint.find_or_create_by_id(log.md5_digest)
+      print.causal_error_fingerprint = parent_print
       error = print.store_log(log)
 
       [print, error]
     end
 
+    def monitor(ancillary_data: {}, request: nil, swallow: false)
+      yield
+    rescue Exception => exception # rubocop:disable Lint/RescueException
+      data = log(exception, ancillary_data, request)
+      swallow ? data : raise(exception)
+    end
+
     private
 
     # Manual attribute whitelisting:

data/lib/ndr_error/middleware/public_exceptions.rb

@@ -28,7 +28,7 @@ module NdrError
       # Unhandled exceptions with logging could terminate the web server!
       def rescuing_everything
         yield
-      rescue Exception => exception
+      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!

data/lib/ndr_error/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 # Contains the version of NdrError. Sourced by the gemspec.
 module NdrError
-  VERSION = '1.1.4'.freeze
+  VERSION = '2.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ndr_error
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 2.0.0
 platform: ruby
 authors:
 - NCRS Development Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-30 00:00:00.000000000 Z
+date: 2018-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -19,7 +19,7 @@ dependencies:
         version: '4.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '4.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: will_paginate
   requirement: !ruby/object:Gem::Requirement
@@ -134,14 +134,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  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'
 description: Mountable engine for exception logging and fingerprinting
 email: []
 executables: []
@@ -166,6 +180,7 @@ files:
 - config/routes.rb
 - db/migrate/20150918162403_create_error_fingerprints.rb
 - db/migrate/20150918162612_create_error_logs.rb
+- db/migrate/20180203174345_add_cause_to_error_fingerprints.rb
 - lib/ndr_error.rb
 - lib/ndr_error/backtrace_compression.rb
 - lib/ndr_error/engine.rb
@@ -196,7 +211,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Rails exception logging