exception_hunter 0.2.0 → 0.3.0

data/app/views/exception_hunter/errors/pagy/_pagy_nav.html.erb

@@ -1,17 +1,17 @@
-<% link = pagy_link_proc(pagy) %>
-<nav aria-label="pager" class="pagy_nav pagination" role="navigation">
-  <% if pagy.prev %>
-  <span class="page prev"><%== link.call(pagy.prev, '◄', 'aria-label="previous"') %></span>
-  <% else %>
-    <span class="page prev disabled">
-      ◄
-    </span>
+<div class="error-occurrences__nav">
+  <%= link_to pagy_url_for(1, pagy) do %>
+    <%= button_tag 'First', class: %w[button button-outline error-occurrences__nav-link], disabled: pagy.prev.nil? %>
   <% end %>
-  <% if pagy.next %>
-    <span class="page next"><%== link.call(pagy.next, '►', 'aria-label="next"') %></span>
-  <% else %>
-    <span class="page next disabled">
-      ►
-    </span>
+  <%= link_to pagy_url_for(pagy.prev, pagy) do %>
+    <%= button_tag '<', class: %w[button button-outline error-occurrences__nav-link], disabled: pagy.prev.nil? %>
   <% end %>
-</nav>
+  <div class="error-occurrences__nav-current">
+    <%= occurred_at %> (<%= pagy.page %>/<%= pagy.last %>)
+  </div>
+  <%= link_to pagy_url_for(pagy.next, pagy) do %>
+    <%= button_tag '>', class: %w[button button-outline error-occurrences__nav-link], disabled: pagy.next.nil? %>
+  <% end %>
+  <%= link_to pagy_url_for(pagy.last, pagy) do %>
+    <%= button_tag 'Last', class: %w[button button-outline error-occurrences__nav-link], disabled: pagy.next.nil? %>
+  <% end %>
+</div>

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

@@ -1,33 +1,69 @@
-<div class="row">
-  <div class="column column-offset-80 column-20">
-    <%= render partial: 'exception_hunter/errors/pagy/pagy_nav', locals: { pagy: @pagy } %>
+<div class="row error-occurrence__header">
+  <div class="column column-10">
+    <% @error.tags.each do|tag| %>
+    <div class="error-cell__tags">
+      <span class="error-tag"><%= tag %></span>
+    </div>
+    <% end %>
+  </div>
+  <div class="column column-80">
+    <div class="error-title">
+      <%= @error.class_name %>: <%= @error.message %>
+    </div>
+  </div>
+  <div class="column column-10">
+    <%= button_to('Resolve', resolved_errors_path(error_group: { id: @error.error_group_id }),
+                  method: :post,
+                  class: %w[button resolve-button],
+                  data: { confirm: 'Are you sure you want to resolve this error?' }) %>
   </div>
 </div>
 
-<div class="error-title">
-  <%= @error.class_name %>: <%= @error.message %>
-</div>
-<div class="error-occurred_at">
-  <%= @error.occurred_at %>
+<div class="row">
+  <div class="column column-50">
+    <ul data-tabs class="errors-tabs">
+      <li class="errors-tab">
+        <a data-tabby-default href="#summary">
+          <div class="errors-tab__content">
+            Summary
+          </div>
+        </a>
+      </li>
+      <li class="errors-tab">
+        <a href="#backtrace">
+          <div class="errors-tab__content">
+            Backtrace
+          </div>
+        </a>
+      </li>
+      <li class="errors-tab">
+        <a href="#user-data">
+          <div class="errors-tab__content">
+            User Data
+          </div>
+        </a>
+      </li>
+    </ul>
+  </div>
+  <div class="column column-50">
+    <%= render partial: 'exception_hunter/errors/pagy/pagy_nav', locals: { pagy: @pagy, occurred_at: @error.occurred_at } %>
+  </div>
 </div>
 
-<ul data-tabs>
-  <li><a data-tabby-default href="#summary">Summary</a></li>
-  <li><a href="#backtrace">Backtrace</a></li>
-  <li><a href="#user-data">User Data</a></li>
-</ul>
 
-<div class="tab-content">
-  <div id="summary">
-    <%= render partial: 'exception_hunter/errors/error_summary', locals: { error: @error } %>
-  </div>
+<div class="errors__container">
+  <div class="tab-content">
+    <div id="summary">
+      <%= render partial: 'exception_hunter/errors/error_summary', locals: { error: @error } %>
+    </div>
 
-  <div id="backtrace">
-    <%= render partial: 'exception_hunter/errors/error_backtrace', locals: { error: @error } %>
-  </div>
+    <div id="backtrace">
+      <%= render partial: 'exception_hunter/errors/error_backtrace', locals: { error: @error } %>
+    </div>
 
-  <div id="user-data">
-    <%= render partial: 'exception_hunter/errors/error_user_data', locals: { error: @error } %>
+    <div id="user-data">
+      <%= render partial: 'exception_hunter/errors/error_user_data', locals: { error: @error } %>
+    </div>
   </div>
 </div>
 

data/app/views/layouts/exception_hunter/application.html.erb

@@ -7,12 +7,11 @@
 
   <%= favicon_link_tag 'exception_hunter/logo.png' %>
 
-  <link rel="stylesheet" href="//fonts.googleapis.com/css?family=Roboto:300,300italic,700,700italic">
+  <link rel="stylesheet" href="https://rsms.me/inter/inter.css">
   <link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/normalize/5.0.0/normalize.css">
   <link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/milligram/1.3.0/milligram.css">
 
   <!-- Get patch fixes within a minor version -->
-  <link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/gh/cferdinandi/tabby@12.0/dist/css/tabby-ui.min.css">
   <script src="https://cdn.jsdelivr.net/gh/cferdinandi/tabby@12.0/dist/js/tabby.polyfills.min.js"></script>
 
   <%= stylesheet_link_tag "exception_hunter/application", media: "all" %>
@@ -22,18 +21,78 @@
 <div class="wrapper">
   <nav class="nav">
     <div class="container container__nav">
-      <div class="nav__logo">
-        <%= link_to errors_path do %>
-          <%= image_tag 'exception_hunter/logo.png', alt: 'Logo' %>
-        <% end %>
+      <div class="row">
+        <div class="column column-40">
+          <%= link_to errors_path do %>
+            <div class="nav__title">Exception Hunter</div>
+          <% end %>
+        </div>
+        <div class="column column-10 column-offset-50">
+          <div class="logout">
+            <% if current_admin_user? %>
+              <div class="sign_out">
+                <%= link_to exception_hunter_logout_path do %>
+                  Sign out
+                <% end %>
+              </div>
+            <% end %>
+          </div>
+        </div>
       </div>
     </div>
   </nav>
 
   <div class="container">
+    <% if flash[:notice] %>
+      <div id="flash-notice" class="flash flash--notice row">
+        <div class="column column-80">
+          <%= flash[:notice] %>
+        </div>
+        <div class="column column-20">
+          <div class="button button-clear button-dismiss" data-dismiss="#flash-notice">
+            <%= ['Cool!', 'Nice!', 'Ok', 'Dismiss', 'Fine. Whatever.', 'I know that'].sample %>
+          </div>
+        </div>
+      </div>
+    <% end %>
+
     <%= yield %>
   </div>
+
+  <div class="footer">
+    Made with ♥ at <a href="https://www.rootstrap.com/" class="text--underline">Rootstrap</a>
+  </div>
 </div>
 
+<script type="text/javascript" charset="utf-8">
+  function confirmable(element) {
+    const message = element.getAttribute('data-confirm')
+    element.form.addEventListener('submit', confirm(message))
+
+    function confirm(message) {
+      return function (event) {
+        if (!window.confirm(message)) {
+          event.preventDefault()
+        }
+      }
+    }
+  }
+
+  function dismissible(element) {
+    element.addEventListener('click', dismiss(element))
+
+    function dismiss(element) {
+      return function () {
+        const selector = element.getAttribute('data-dismiss')
+        const elementToDismiss = document.querySelector(selector)
+        elementToDismiss.remove()
+      }
+    }
+  }
+
+  Array.from(document.querySelectorAll('[data-confirm]')).forEach(confirmable)
+  Array.from(document.querySelectorAll('[data-dismiss]')).forEach(dismissible)
+</script>
+
 </body>
 </html>

data/app/views/layouts/exception_hunter/exception_hunter_logged_out.html.erb

@@ -0,0 +1,24 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Exception Hunter</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <link rel="stylesheet" href="//fonts.googleapis.com/css?family=Roboto:300,300italic,700,700italic">
+  <link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/normalize/5.0.0/normalize.css">
+  <link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/milligram/1.3.0/milligram.css">
+  <link rel="stylesheet" href="https://rsms.me/inter/inter.css">
+
+  <!-- Get patch fixes within a minor version -->
+  <link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/gh/cferdinandi/tabby@12.0/dist/css/tabby-ui.min.css">
+  <script src="https://cdn.jsdelivr.net/gh/cferdinandi/tabby@12.0/dist/js/tabby.polyfills.min.js"></script>
+
+  <%= stylesheet_link_tag "exception_hunter/application", media: "all" %>
+</head>
+<body style="background-color: #E5E5E5;">
+<div class="container">
+  <%= yield %>
+</div>
+</body>
+</html>

data/config/rails_best_practices.yml

@@ -16,7 +16,7 @@ MoveFinderToNamedScopeCheck: { }
 MoveModelLogicIntoModelCheck: { use_count: 4 }
 NeedlessDeepNestingCheck: { nested_count: 2 }
 NotUseDefaultRouteCheck: { }
-NotUseTimeAgoInWordsCheck: { ignored_files: ['index.html.erb'] }
+#NotUseTimeAgoInWordsCheck: { ignored_files: ['index.html.erb'] }
 OveruseRouteCustomizationsCheck: { customize_count: 3 }
 ProtectMassAssignmentCheck: { }
 RemoveEmptyHelpersCheck: { }
@@ -29,7 +29,7 @@ ReplaceComplexCreationWithFactoryMethodCheck: { attribute_assignment_count: 2 }
 ReplaceInstanceVariableWithLocalVariableCheck: { }
 RestrictAutoGeneratedRoutesCheck: { }
 SimplifyRenderInControllersCheck: { }
-SimplifyRenderInViewsCheck: { }
+#SimplifyRenderInViewsCheck: { }
 #UseBeforeFilterCheck: { customize_count: 2 }
 UseModelAssociationCheck: { }
 UseMultipartAlternativeAsContentTypeOfEmailCheck: { }

data/config/routes.rb

@@ -1,3 +1,21 @@
 ExceptionHunter::Engine.routes.draw do
-  resources :errors, only: %i[index show]
+  resources :errors, only: %i[index show] do
+    delete 'purge', on: :collection, to: 'errors#destroy', as: :purge
+  end
+
+  resources :resolved_errors, only: %i[create]
+
+  get '/', to: redirect('/exception_hunter/errors')
+
+  if ExceptionHunter::Config.auth_enabled?
+    admin_user_class = ExceptionHunter::Config.admin_user_class.underscore.to_sym
+
+    devise_scope admin_user_class do
+      get '/login', to: 'devise/sessions#new', as: :exception_hunter_login
+      post '/login', to: 'devise/sessions#create', as: :exception_hunter_create_session
+      get '/logout', to: 'devise/sessions#destroy', as: :exception_hunter_logout
+    end
+
+    devise_for admin_user_class, only: []
+  end
 end

data/lib/exception_hunter.rb

@@ -1,16 +1,26 @@
+require 'pagy'
+
 require 'exception_hunter/engine'
 require 'exception_hunter/middleware/request_hunter'
 require 'exception_hunter/middleware/sidekiq_hunter' if defined?(Sidekiq)
 require 'exception_hunter/config'
+require 'exception_hunter/error_creator'
+require 'exception_hunter/error_reaper'
+require 'exception_hunter/tracking'
 require 'exception_hunter/user_attributes_collector'
-require 'pagy'
 
 module ExceptionHunter
+  autoload :Devise, 'exception_hunter/devise'
+
+  extend ::ExceptionHunter::Tracking
+
   def self.setup(&block)
     block.call(Config)
   end
 
   def self.routes(router)
+    return unless Config.enabled
+
     router.mount(ExceptionHunter::Engine, at: 'exception_hunter')
   end
 end

data/lib/exception_hunter/config.rb

@@ -1,5 +1,12 @@
 module ExceptionHunter
   class Config
-    cattr_accessor :current_user_method, :user_attributes
+    cattr_accessor :admin_user_class,
+                   :current_user_method, :user_attributes
+    cattr_accessor :enabled, default: true
+    cattr_accessor :errors_stale_time, default: 45.days
+
+    def self.auth_enabled?
+      admin_user_class.present? && admin_user_class.try(:underscore)
+    end
   end
 end

data/lib/exception_hunter/devise.rb

@@ -0,0 +1,17 @@
+module ExceptionHunter
+  module Devise
+    class SessionsController < ::Devise::SessionsController
+      skip_before_action :verify_authenticity_token
+
+      layout 'exception_hunter/exception_hunter_logged_out'
+
+      def after_sign_out_path_for(*)
+        '/exception_hunter/login'
+      end
+
+      def after_sign_in_path_for(*)
+        '/exception_hunter'
+      end
+    end
+  end
+end

data/{app/services → lib}/exception_hunter/error_creator.rb

@@ -1,12 +1,18 @@
 module ExceptionHunter
   class ErrorCreator
+    HTTP_TAG = 'HTTP'.freeze
+    WORKER_TAG = 'Worker'.freeze
+    MANUAL_TAG = 'Manual'.freeze
+
     class << self
-      def call(**error_attrs)
+      def call(tag: nil, **error_attrs)
+        return unless should_create?
+
         ActiveRecord::Base.transaction do
           error_attrs = extract_user_data(error_attrs)
           error = Error.new(error_attrs)
           error_group = ErrorGroup.find_matching_group(error) || ErrorGroup.new
-          update_error_group(error_group, error)
+          update_error_group(error_group, error, tag)
           error.error_group = error_group
           error.save!
           error
@@ -17,9 +23,15 @@ module ExceptionHunter
 
       private
 
-      def update_error_group(error_group, error)
+      def should_create?
+        Config.enabled
+      end
+
+      def update_error_group(error_group, error, tag)
         error_group.error_class_name = error.class_name
         error_group.message = error.message
+        error_group.tags << tag unless tag.nil?
+        error_group.tags.uniq!
 
         error_group.save!
       end

data/lib/exception_hunter/error_reaper.rb

@@ -0,0 +1,12 @@
+module ExceptionHunter
+  class ErrorReaper
+    class << self
+      def purge(stale_time: Config.errors_stale_time)
+        ActiveRecord::Base.transaction do
+          Error.with_occurrences_before(Date.today - stale_time).destroy_all
+          ErrorGroup.without_errors.destroy_all
+        end
+      end
+    end
+  end
+end

data/lib/exception_hunter/middleware/request_hunter.rb

@@ -30,6 +30,7 @@ module ExceptionHunter
       def catch_prey(env, exception)
         user = user_from_env(env)
         ErrorCreator.call(
+          tag: ErrorCreator::HTTP_TAG,
           class_name: exception.class.to_s,
           message: exception.message,
           environment_data: environment_data(env),

data/lib/exception_hunter/middleware/sidekiq_hunter.rb

@@ -29,6 +29,7 @@ module ExceptionHunter
         return unless should_track?(context)
 
         ErrorCreator.call(
+          tag: ErrorCreator::WORKER_TAG,
           class_name: exception.class.to_s,
           message: exception.message,
           environment_data: environment_data(context),

data/lib/exception_hunter/tracking.rb

@@ -0,0 +1,16 @@
+module ExceptionHunter
+  module Tracking
+    def track(exception, custom_data: {}, user: nil)
+      ErrorCreator.call(
+        tag: ErrorCreator::MANUAL_TAG,
+        class_name: exception.class.to_s,
+        message: exception.message,
+        backtrace: exception.backtrace,
+        custom_data: custom_data,
+        user: user
+      )
+
+      nil
+    end
+  end
+end

data/lib/exception_hunter/user_attributes_collector.rb

@@ -3,11 +3,15 @@ module ExceptionHunter
     extend self
 
     def collect_attributes(user)
+      return unless user
+
       attributes.reduce({}) do |data, attribute|
         data.merge(attribute => user.try(attribute))
       end
     end
 
+    private
+
     def attributes
       Config.user_attributes
     end