exception_hunter 0.3.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ba4ba0c2e1205126ac00e8d0c27b9b98cc3b932dff902e6d7552b7bb640e681
-  data.tar.gz: 49b05057f76bb754bec371065918aeb0cb087208794326c78b837fb894af2fad
+  metadata.gz: 5657d47c0ace57c4aac4aa9ec45374739ff2a282271d9d3f7ec6c3e21cffd509
+  data.tar.gz: 999dccabdad8f6b8e78a6db43d8d8cb5ff9454fcd7bb0df7e93ede4bb8a04aea
 SHA512:
-  metadata.gz: dfd7faf102765439718b72f1c643593d48c6f1613db7ea573a4cb0ea66206819d6fcf5f17eb9f229beb31efa20f76901e995539703ed266073986cdae5795712
-  data.tar.gz: b9711187a6887b4542973bc5f1c687a9e6034dc5b136cc6755fec9126d4ccce4311bbad8eafdfd49c53be7e437c63f69f505b4868f46da3abf387e3e6bc02ab1
+  metadata.gz: f01e7a68936214ac9c2673ad44d2603731d517bfdfa7a22f4f88669629328d26a8b2161233c844c87accd6b455831ebb8162ddf2dd4d9a80fd95a5c132571551
+  data.tar.gz: 7d84f1b86524e91f9d2b73c6f42fd4d75d34e3b946d5948a30513ef5fb1ee026dcfc58e09438bc27d881fdb4d63483442ad90c2bf8ca852acd33fabcdc3c8aeb

data/README.md

@@ -1,6 +1,10 @@
 # ExceptionHunter
 
-![Index screenshot](doc/screenshot.png)
+![CI](https://github.com/rootstrap/exception_hunter/workflows/Rails%20tests/badge.svg)
+[![Maintainability](https://api.codeclimate.com/v1/badges/86f6aaa2377c894f8ee4/maintainability)](https://codeclimate.com/github/rootstrap/exception_hunter/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/86f6aaa2377c894f8ee4/test_coverage)](https://codeclimate.com/github/rootstrap/exception_hunter/test_coverage)
+
+![Index screenshot](docs/index-screenshot.png)
 
 Exception Hunter is a Rails engine meant to track errors in your Rails project. It works
 by using your Postgres database to save errors with their corresponding metadata (like backtrace
@@ -17,11 +21,15 @@ Error tracking is one of the most important tools a developer can have in their
 we think it'd be nice to provide a way for everyone to have it in their project, be it a personal
 project, and MVP or something else.
 
+## Docs
+
+You can check the full documentation at [https://rootstrap.github.io/exception_hunter]().
+
 ## Installation
 Add Exception Hunter to your application's Gemfile:
 
 ```ruby
-gem 'exception_hunter', '~> 0.3.0'
+gem 'exception_hunter', '~> 1.0'
 ```
 
 You may also need to add [Devise](https://github.com/heartcombo/devise) to your Gemfile
@@ -45,6 +53,19 @@ you can run the command with the `--skip-users` flag.
 Additionally it should add the 'ExceptionHunter.routes(self)' line to your routes, which means you can go to
 `/exception_hunter/errors` in your browser and start enjoying some good old fashioned exception tracking!
 
+#### Testing it on dev:
+
+ExceptionHunter is disabled on dev by default so if you want to test it before shipping it to another
+environment, which we highly recommend, you should enable it by going to the initializer and changing the
+line that says `config.enabled = !(Rails.env.development? || Rails.env.test?)` with something like
+`config.enabled = !(Rails.env.test?)` while you test. Don't forget to change it back if you don't
+want a bunch of errors in your local DB!
+
+You can then open a `rails console` and manually track an exception to check that it
+works `ExceptionHunter.track(StandardError.new("It works!"))`. You should now see the exception
+on [http://localhost:3000/exception_hunter]().
+
+
 ## Stale data
 
 You can get rid of stale errors by running the rake task to purge them:
@@ -58,6 +79,59 @@ a week would be ideal. You can also purge errors by running `ExceptionHunter::Er
 
 The time it takes for an error to go stale defaults to 45 days but it's configurable via the initializer.
 
+## Manual tracking
+
+ExceptionHunter also includes a facility to manually log from anywhere in the code. Imagine the following case:
+
+```ruby
+case current_user.status
+when :inactive then do_something
+when :active then do_something_else
+when :banned then do_something_else_else
+else
+  ExceptionHunter.track(ArgumentError.new('This should never happen'), custom_data: { status: current_user.status }, current_user: user)
+end
+```
+
+In this scenario we don't really want to raise an exception but we might want to be alerted if by any chance a user
+has an invalid status.
+
+## Slack notifications
+
+You can configure ExceptionHunter to send a message to slack every time an error occurs.
+You have to do the following:
+
+1. Create a Slack app.
+2. Add it to your workspace.
+3. Add one or more webhooks linked to the channels you want to receive the notifications.
+4. Set the webhook urls in the `exception_hunter` initializer.
+
+```ruby
+config.notifiers << {
+  name: :slack,
+  options: {
+    webhook: 'SLACK_WEBHOOK_URL_1'
+  }
+}
+
+config.notifiers << {
+  name: :slack,
+  options: {
+    webhook: 'SLACK_WEBHOOK_URL_2'
+  }
+}
+```
+
+6. Add the code below to the environment config file where you are using ExceptionHunter with the correct server url.
+
+```ruby
+ExceptionHunter::Engine.configure do |config|
+  config.routes.default_url_options = { host: "your_server_url" }
+end
+```
+
+This uses ActiveJob to send notification in the background, so [make sure you configure](https://guides.rubyonrails.org/active_job_basics.html#setting-the-backend) it with the adapter you are using, if not notifications will be sent synchronously.
+
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 

data/app/assets/stylesheets/exception_hunter/base.css

@@ -71,3 +71,7 @@ form {
 .button.button-dismiss:hover, .button.button-dismiss:focus, .button.button-dismiss:active {
     color: var(--inactive-grey);
 }
+
+.mr-5{
+    margin-right: 5px;
+}

data/app/assets/stylesheets/exception_hunter/errors.css

@@ -153,6 +153,31 @@ li.errors-tab {
     border-color: var(--focused-grey);
 }
 
+.button_to .button.button-outlined.ignore-button {
+    color: var(--highlight-color);
+    border-color: var(--highlight-color);
+    font-size: 10px;
+    padding: 0 1rem;
+    height: 3rem;
+    line-height: 3rem;
+  }
+
+  .button_to .button.ignore-button {
+    color: #FFF;
+    background-color: var(--highlight-color);
+    border-color: var(--highlight-color);
+    font-size: 10px;
+    padding: 0 1rem;
+    height: 3rem;
+    line-height: 3rem;
+    margin-bottom: 0;
+  }
+
+  .button.ignore-button:hover, .button.ignore-button:focus {
+    color: var(--focused-grey);
+    border-color: var(--focused-grey);
+  }
+
 .error-occurred_at {
     color: var(--highlight-color);
     font-size: 14px;

data/app/controllers/exception_hunter/errors_controller.rb

@@ -41,6 +41,8 @@ module ExceptionHunter
         ErrorGroup.active
       when DashboardPresenter::RESOLVED_ERRORS_TAB
         ErrorGroup.resolved
+      when DashboardPresenter::IGNORED_ERRORS_TAB
+        ErrorGroup.ignored
       end
     end
   end

data/app/controllers/exception_hunter/ignored_errors_controller.rb

@@ -0,0 +1,25 @@
+require_dependency 'exception_hunter/application_controller'
+
+module ExceptionHunter
+  class IgnoredErrorsController < ApplicationController
+    def create
+      error_group.ignored!
+      redirect_to errors_path, notice: 'Error ignored successfully'
+    end
+
+    def reopen
+      error_group.active!
+      redirect_to errors_path, notice: 'Error re-opened successfully'
+    end
+
+    private
+
+    def error_group
+      @error_group ||= ErrorGroup.find(error_group_params[:id])
+    end
+
+    def error_group_params
+      params.require(:error_group).permit(:id)
+    end
+  end
+end

data/app/helpers/exception_hunter/application_helper.rb

@@ -1,5 +1,27 @@
 module ExceptionHunter
   module ApplicationHelper
     include Pagy::Frontend
+
+    def application_name
+      if defined? Rails.application.class.module_parent_name
+        Rails.application.class.module_parent_name
+      else
+        Rails.application.class.parent_name
+      end
+    end
+
+    def display_action_button(title, error)
+      button_to(title.to_s, route_for_button(title, error),
+                class: "button button-outline #{title}-button",
+                data: { confirm: "Are you sure you want to #{title} this error?" }).to_s
+    end
+
+    def route_for_button(title, error)
+      if title.eql?('ignore')
+        ignored_errors_path(error_group: { id: error.id })
+      else
+        resolved_errors_path(error_group: { id: error.id })
+      end
+    end
   end
 end

data/app/jobs/exception_hunter/send_notification_job.rb

@@ -0,0 +1,15 @@
+module ExceptionHunter
+  class SendNotificationJob < ApplicationJob
+    queue_as :default
+
+    def perform(serialized_notifier)
+      # Use SlackNotifierSerializer as it's the only one for now.
+      serializer = ExceptionHunter::Notifiers::SlackNotifierSerializer
+      deserialized_notifier = serializer.deserialize(serialized_notifier)
+      deserialized_notifier.notify
+    rescue Exception # rubocop:disable Lint/RescueException
+      # Suppress all exceptions to avoid loop as this would create a new error in EH.
+      false
+    end
+  end
+end

data/app/models/exception_hunter/error.rb

@@ -1,12 +1,12 @@
 module ExceptionHunter
-  class Error < ApplicationRecord
+  class Error < ::ExceptionHunter::ApplicationRecord
     validates :class_name, presence: true
     validates :occurred_at, presence: true
 
     belongs_to :error_group, touch: true
 
     before_validation :set_occurred_at, on: :create
-    after_create :unresolve_error_group, unless: -> { error_group.active? }
+    after_create :unresolve_error_group, if: -> { error_group.resolved? }
 
     scope :most_recent, lambda { |error_group_id|
       where(error_group_id: error_group_id).order(occurred_at: :desc)
@@ -26,6 +26,10 @@ module ExceptionHunter
       joins(:error_group).where(error_group: ErrorGroup.resolved)
     }
 
+    scope :from_ignored_error_groups, lambda {
+      joins(:error_group).where(error_group: ErrorGroup.ignored)
+    }
+
     private
 
     def set_occurred_at

data/app/models/exception_hunter/error_group.rb

@@ -1,12 +1,12 @@
 module ExceptionHunter
-  class ErrorGroup < ApplicationRecord
+  class ErrorGroup < ::ExceptionHunter::ApplicationRecord
     SIMILARITY_THRESHOLD = 0.75
 
     validates :error_class_name, presence: true
 
     has_many :grouped_errors, class_name: 'ExceptionHunter::Error', dependent: :destroy
 
-    enum status: { active: 0, resolved: 1 }
+    enum status: { active: 0, resolved: 1, ignored: 2 }
 
     scope :most_similar, lambda { |message|
       message_similarity = sql_similarity(ErrorGroup[:message], message)

data/app/presenters/exception_hunter/dashboard_presenter.rb

@@ -4,7 +4,8 @@ module ExceptionHunter
     CURRENT_MONTH_TAB = 'current_month'.freeze
     TOTAL_ERRORS_TAB = 'total_errors'.freeze
     RESOLVED_ERRORS_TAB = 'resolved'.freeze
-    TABS = [LAST_7_DAYS_TAB, CURRENT_MONTH_TAB, TOTAL_ERRORS_TAB, RESOLVED_ERRORS_TAB].freeze
+    IGNORED_ERRORS_TAB = 'ignored'.freeze
+    TABS = [LAST_7_DAYS_TAB, CURRENT_MONTH_TAB, TOTAL_ERRORS_TAB, RESOLVED_ERRORS_TAB, IGNORED_ERRORS_TAB].freeze
     DEFAULT_TAB = LAST_7_DAYS_TAB
 
     attr_reader :current_tab
@@ -22,7 +23,7 @@ module ExceptionHunter
       case current_tab
       when LAST_7_DAYS_TAB
         'exception_hunter/errors/last_7_days_errors_table'
-      when CURRENT_MONTH_TAB, TOTAL_ERRORS_TAB, RESOLVED_ERRORS_TAB
+      when CURRENT_MONTH_TAB, TOTAL_ERRORS_TAB, RESOLVED_ERRORS_TAB, IGNORED_ERRORS_TAB
         'exception_hunter/errors/errors_table'
       end
     end
@@ -47,7 +48,8 @@ module ExceptionHunter
         LAST_7_DAYS_TAB => active_errors.in_last_7_days.count,
         CURRENT_MONTH_TAB => active_errors.in_current_month.count,
         TOTAL_ERRORS_TAB => active_errors.count,
-        RESOLVED_ERRORS_TAB => Error.from_resolved_error_groups.count
+        RESOLVED_ERRORS_TAB => Error.from_resolved_error_groups.count,
+        IGNORED_ERRORS_TAB => Error.from_ignored_error_groups.count
       }
     end
   end

data/app/presenters/exception_hunter/error_presenter.rb

@@ -10,13 +10,13 @@ module ExceptionHunter
     end
 
     def backtrace
-      error.backtrace.map do |line|
+      (error.backtrace || []).map do |line|
         format_backtrace_line(line)
       end
     end
 
     def environment_data
-      error.environment_data.except('params')
+      error.environment_data&.except('params') || {}
     end
 
     def tracked_params

data/app/views/exception_hunter/errors/_error_row.erb

@@ -6,7 +6,7 @@
       </div>
     <% end %>
   </div>
-  <div class="column column-40 error-cell error-cell__message">
+  <div class="column column-33 error-cell error-cell__message">
     <%= link_to error.message, error_path(error.id), class: %w[error-message] %>
   </div>
 
@@ -26,19 +26,27 @@
     <% end %>
   </div>
 
-  <div class="column column-10 error-cell">
+  <div class="column column-8 error-cell">
     <%= error.total_occurrences %>
   </div>
 
-  <div class="column column-10 error-cell">
-    <% if error.active? %>
-      <div class="color-green">
-        <%= button_to('Resolve', resolved_errors_path(error_group: { id: error.id }),
-                      method: :post,
+   <div class="column column-18 error-cell">
+    <div class="row">
+      <% if error.active? %>
+        <div class="column mr-5">
+        <%= display_action_button('resolve', error) %>
+        </div>
+        <div class="column">
+          <%= display_action_button('ignore', error) %>
+        </div>
+      <% elsif error.ignored? %>
+        <div class="column">
+          <%= button_to('Reopen', reopen_path(error_group: { id: error.id }),
                       class: %w[button button-outline resolve-button],
-                      data: { confirm: 'Are you sure you want to resolve this error?' }) %>
-      </div>
-    <% end %>
-  </div>
+                      data: { confirm: 'Are you sure you want to reopen this error?' }) %>
+        </div>
+      <% end %>
+    </div>
+   </div>
 </div>
 

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

@@ -52,6 +52,19 @@
           </div>
         <% end %>
       </div>
+
+      <div class="errors-tab errors-tab__ignored <%= 'errors-tab--active' if @dashboard.tab_active?(@dashboard.class::IGNORED_ERRORS_TAB) %>">
+        <%= link_to errors_path(tab: @dashboard.class::IGNORED_ERRORS_TAB) do %>
+          <div class="errors-tab__content">
+            <div class="errors-tab__badge">
+              <%= @dashboard.errors_count(@dashboard.class::IGNORED_ERRORS_TAB) || '-' %>
+            </div>
+            <div class="errors-tab__description">
+              Ignored
+            </div>
+          </div>
+        <% end %>
+      </div>
     </div>
   </div>
 
@@ -66,11 +79,12 @@
 <div class="errors__container">
   <div class="row error-row error-row--header">
     <div class="column column-10">Tags</div>
-    <div class="column column-40">Message</div>
+    <div class="column column-33">Message</div>
     <div class="column column-15">First Occurrence</div>
     <div class="column column-15">Last Occurrence</div>
-    <div class="column column-10">Total</div>
-    <div class="column column-10"></div>
+    <div class="column column-8">Total</div>
+    <div class="column column-18"></div>
+
   </div>
 
   <%= render partial: @dashboard.partial_for_tab, locals: { errors: @errors } %>

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

@@ -24,7 +24,9 @@
       <div class="row">
         <div class="column column-40">
           <%= link_to errors_path do %>
-            <div class="nav__title">Exception Hunter</div>
+            <div class="nav__title">
+              Exception Hunter / <%= application_name %>
+            </div>
           <% end %>
         </div>
         <div class="column column-10 column-offset-50">

data/config/rails_best_practices.yml

@@ -13,7 +13,7 @@ MoveCodeIntoControllerCheck: { }
 MoveCodeIntoHelperCheck: { array_count: 3 }
 MoveCodeIntoModelCheck: { use_count: 2 }
 MoveFinderToNamedScopeCheck: { }
-MoveModelLogicIntoModelCheck: { use_count: 4 }
+# MoveModelLogicIntoModelCheck: { use_count: 4 }
 NeedlessDeepNestingCheck: { nested_count: 2 }
 NotUseDefaultRouteCheck: { }
 #NotUseTimeAgoInWordsCheck: { ignored_files: ['index.html.erb'] }

data/config/routes.rb

@@ -4,6 +4,8 @@ ExceptionHunter::Engine.routes.draw do
   end
 
   resources :resolved_errors, only: %i[create]
+  resources :ignored_errors, only: %i[create]
+  post :reopen, to: 'ignored_errors#reopen'
 
   get '/', to: redirect('/exception_hunter/errors')
 

data/lib/exception_hunter.rb

@@ -2,25 +2,57 @@ 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 'exception_hunter/notifiers/slack_notifier'
+require 'exception_hunter/notifiers/slack_notifier_serializer'
+require 'exception_hunter/notifiers/misconfigured_notifiers'
+require 'exception_hunter/data_redacter'
 
+# @api public
 module ExceptionHunter
   autoload :Devise, 'exception_hunter/devise'
 
   extend ::ExceptionHunter::Tracking
 
+  # Used to setup ExceptionHunter's configuration
+  # it receives a block with the {ExceptionHunter::Config} singleton
+  # class.
+  #
+  # @return [void]
   def self.setup(&block)
     block.call(Config)
+    validate_config!
   end
 
+  # Mounts the ExceptionHunter dashboard at /exception_hunter
+  # if it's enabled on the current environment.
+  #
+  # @example
+  #   Rails.application.routes.draw do
+  #     ExceptionHunter.routes(self)
+  #   end
+  #
+  # @param [ActionDispatch::Routing::Mapper] router to mount to
+  # @return [void]
   def self.routes(router)
     return unless Config.enabled
 
     router.mount(ExceptionHunter::Engine, at: 'exception_hunter')
   end
+
+  # @private
+  def self.validate_config!
+    notifiers = Config.notifiers
+    return if notifiers.blank?
+
+    notifiers.each do |notifier|
+      next if notifier[:name] == :slack && notifier.dig(:options, :webhook).present?
+
+      raise ExceptionHunter::Notifiers::MisconfiguredNotifiers, notifier
+    end
+  end
 end

data/lib/exception_hunter/config.rb

@@ -1,10 +1,27 @@
 module ExceptionHunter
+  # Config singleton class used to customize ExceptionHunter
   class Config
-    cattr_accessor :admin_user_class,
-                   :current_user_method, :user_attributes
+    # @!attribute
+    # @return [Boolean] whether ExceptionHunter is active or not
     cattr_accessor :enabled, default: true
+    # @!attribute
+    # @return [String] the name of the admin class (generally AdminUser)
+    cattr_accessor :admin_user_class
+    # @!attribute
+    # @return [Symbol] the name of the current user method provided by Devise
+    cattr_accessor :current_user_method
+    # @return [Array<Symbol>] attributes to whitelist on the user (see {ExceptionHunter::UserAttributesCollector})
+    cattr_accessor :user_attributes
+    # @return [Numeric] number of days until an error is considered stale
     cattr_accessor :errors_stale_time, default: 45.days
+    # @return [Array<Hash>] configured notifiers for the application (see {ExceptionHunter::Notifiers})
+    cattr_accessor :notifiers, default: []
+    cattr_accessor :sensitive_fields, default: []
 
+    # Returns true if there's an admin user class configured to
+    # authenticate against.
+    #
+    # @return Boolean
     def self.auth_enabled?
       admin_user_class.present? && admin_user_class.try(:underscore)
     end

data/lib/exception_hunter/data_redacter.rb

@@ -0,0 +1,27 @@
+module ExceptionHunter
+  class DataRedacter
+    attr_reader :params, :params_to_filter
+
+    def initialize(params, params_to_filter)
+      @params = params
+      @params_to_filter = params_to_filter
+    end
+
+    def redact
+      return params if params.blank?
+
+      parameter_filter = params_filter.new(params_to_filter)
+      parameter_filter.filter(params)
+    end
+
+    private
+
+    def params_filter
+      if defined?(::ActiveSupport::ParameterFilter)
+        ::ActiveSupport::ParameterFilter
+      else
+        ::ActionDispatch::Http::ParameterFilter
+      end
+    end
+  end
+end

data/lib/exception_hunter/devise.rb

@@ -1,5 +1,7 @@
 module ExceptionHunter
   module Devise
+    # Used so we can integrate with {https://github.com/heartcombo/devise Devise} and
+    # provide a custom login on the dashboard.
     class SessionsController < ::Devise::SessionsController
       skip_before_action :verify_authenticity_token
 

data/lib/exception_hunter/engine.rb

@@ -1,4 +1,5 @@
 module ExceptionHunter
+  # @private
   class Engine < ::Rails::Engine
     isolate_namespace ExceptionHunter
 
@@ -12,5 +13,10 @@ module ExceptionHunter
       app.config.assets.precompile << 'exception_hunter/application.css'
       app.config.assets.precompile << 'exception_hunter/logo.png'
     end
+
+    initializer 'exception_hunter.load_middleware', group: :all do
+      require 'exception_hunter/middleware/sidekiq_hunter' if defined?(Sidekiq)
+      require 'exception_hunter/middleware/delayed_job_hunter' if defined?(Delayed)
+    end
   end
 end

data/lib/exception_hunter/error_creator.rb

@@ -1,20 +1,30 @@
 module ExceptionHunter
+  # Core class in charge of the actual persistence of errors and notifications.
   class ErrorCreator
     HTTP_TAG = 'HTTP'.freeze
     WORKER_TAG = 'Worker'.freeze
     MANUAL_TAG = 'Manual'.freeze
 
     class << self
+      # Creates an error with the given attributes and persists it to
+      # the database.
+      #
+      # @param [HTTP_TAG, WORKER_TAG, MANUAL_TAG] tag to append to the error if any
+      # @return [ExceptionHunter::Error, false] the error or false if it was not possible to create it
       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
+          error_attrs = hide_sensitive_values(error_attrs)
+          error = ::ExceptionHunter::Error.new(error_attrs)
+          error_group = ::ExceptionHunter::ErrorGroup.find_matching_group(error) || ::ExceptionHunter::ErrorGroup.new
           update_error_group(error_group, error, tag)
           error.error_group = error_group
           error.save!
+          return if error_group.ignored?
+
+          notify(error)
           error
         end
       rescue ActiveRecord::RecordInvalid
@@ -38,16 +48,25 @@ module ExceptionHunter
 
       def extract_user_data(**error_attrs)
         user = error_attrs[:user]
-        error_attrs[:user_data] =
-          if user.nil?
-            {}
-          else
-            UserAttributesCollector.collect_attributes(user)
-          end
+        error_attrs[:user_data] = UserAttributesCollector.collect_attributes(user)
 
         error_attrs.delete(:user)
         error_attrs
       end
+
+      def notify(error)
+        ExceptionHunter::Config.notifiers.each do |notifier|
+          slack_notifier = ExceptionHunter::Notifiers::SlackNotifier.new(error, notifier)
+          serializer = ExceptionHunter::Notifiers::SlackNotifierSerializer
+          serialized_slack_notifier = serializer.serialize(slack_notifier)
+          ExceptionHunter::SendNotificationJob.perform_later(serialized_slack_notifier)
+        end
+      end
+
+      def hide_sensitive_values(error_attrs)
+        sensitive_fields = ExceptionHunter::Config.sensitive_fields
+        ExceptionHunter::DataRedacter.new(error_attrs, sensitive_fields).redact
+      end
     end
   end
 end

data/lib/exception_hunter/error_reaper.rb

@@ -1,6 +1,14 @@
 module ExceptionHunter
+  # Class in charge of disposing of stale errors as specified in the {ExceptionHunter::Config}.
   class ErrorReaper
     class << self
+      # Destroys all stale errors.
+      #
+      # @example
+      #   ErrorReaper.purge(stale_time: 30.days)
+      #
+      # @param [Numeric] stale_time considered when destroying errors
+      # @return [void]
       def purge(stale_time: Config.errors_stale_time)
         ActiveRecord::Base.transaction do
           Error.with_occurrences_before(Date.today - stale_time).destroy_all

data/lib/exception_hunter/middleware/delayed_job_hunter.rb

@@ -0,0 +1,70 @@
+require 'delayed_job'
+
+module ExceptionHunter
+  module Middleware
+    # DelayedJob plugin to track exceptions on apps using DelayedJob.
+    class DelayedJobHunter < ::Delayed::Plugin
+      TRACK_AT_RETRY = [0, 3, 6, 10].freeze
+      JOB_TRACKED_DATA = %w[
+        attempts
+      ].freeze
+      ARGS_TRACKED_DATA = %w[
+        queue_name
+        job_class
+        job_id
+        arguments
+        enqueued_at
+      ].freeze
+
+      callbacks do |lifecycle|
+        lifecycle.around(:invoke_job) do |job, *args, &block|
+          block.call(job, *args)
+
+        rescue Exception => exception # rubocop:disable Lint/RescueException
+          track_exception(exception, job)
+
+          raise exception
+        end
+      end
+
+      def self.track_exception(exception, job)
+        return unless should_track?(job.attempts)
+
+        ErrorCreator.call(
+          tag: ErrorCreator::WORKER_TAG,
+          class_name: exception.class.to_s,
+          message: exception.message,
+          environment_data: environment_data(job),
+          backtrace: exception.backtrace
+        )
+      end
+
+      def self.environment_data(job)
+        job_data =
+          JOB_TRACKED_DATA.reduce({}) do |dict, data_param|
+            dict.merge(data_param => job.try(data_param))
+          end
+
+        job_class = if job.payload_object.class.name == 'ActiveJob::QueueAdapters::DelayedJobAdapter::JobWrapper'
+                      # support for Rails 4.2 ActiveJob
+                      job.payload_object.job_data['job_class']
+                    elsif job.payload_object.object.is_a?(Class)
+                      job.payload_object.object.name
+                    else
+                      job.payload_object.object.class.name
+                    end
+        args_data = (job.payload_object.try(:job_data) || {}).select { |key, _value| ARGS_TRACKED_DATA.include?(key) }
+
+        args_data['job_class'] = job_class || job.payload_object.class.name if args_data['job_class'].nil?
+
+        job_data.merge(args_data)
+      end
+
+      def self.should_track?(attempts)
+        TRACK_AT_RETRY.include?(attempts)
+      end
+    end
+  end
+end
+
+Delayed::Worker.plugins << ExceptionHunter::Middleware::DelayedJobHunter

data/lib/exception_hunter/middleware/request_hunter.rb

@@ -1,5 +1,7 @@
 module ExceptionHunter
   module Middleware
+    # {https://www.rubyguides.com/2018/09/rack-middleware Rack Middleware} used to
+    # rescue from exceptions track them and then re-raise them.
     class RequestHunter
       ENVIRONMENT_KEYS =
         %w[PATH_INFO
@@ -53,14 +55,14 @@ module ExceptionHunter
 
       def filtered_sensitive_params(env)
         params = env['action_dispatch.request.parameters']
-        parameter_filter = ::ActiveSupport::ParameterFilter.new(FILTERED_PARAMS)
-        parameter_filter.filter(params || {})
+        ExceptionHunter::DataRedacter.new(params, FILTERED_PARAMS).redact
       end
     end
   end
 end
 
 module ExceptionHunter
+  # @private
   class Railtie < Rails::Railtie
     initializer 'exception_hunter.add_middleware', after: :load_config_initializers do |app|
       app.config.middleware.insert_after(

data/lib/exception_hunter/middleware/sidekiq_hunter.rb

@@ -2,7 +2,6 @@ module ExceptionHunter
   module Middleware
     # Middleware to report errors
     # when a Sidekiq worker fails
-    #
     class SidekiqHunter
       TRACK_AT_RETRY = [0, 3, 6, 10].freeze
       JOB_TRACKED_DATA = %w[

data/lib/exception_hunter/notifiers/misconfigured_notifiers.rb

@@ -0,0 +1,10 @@
+module ExceptionHunter
+  module Notifiers
+    # Error raised when there's a malformed notifier.
+    class MisconfiguredNotifiers < StandardError
+      def initialize(notifier)
+        super("Notifier has incorrect configuration: #{notifier.inspect}")
+      end
+    end
+  end
+end

data/lib/exception_hunter/notifiers/slack_notifier.rb

@@ -0,0 +1,42 @@
+require 'slack-notifier'
+
+module ExceptionHunter
+  module Notifiers
+    # Notifier that sends a message to a Slack channel every time an
+    # exception is tracked.
+    class SlackNotifier
+      attr_reader :error, :notifier
+
+      def initialize(error, notifier)
+        @error = error
+        @notifier = notifier
+      end
+
+      def notify
+        slack_notifier = Slack::Notifier.new(notifier[:options][:webhook])
+        slack_notifier.ping(slack_notification_message)
+      end
+
+      private
+
+      def slack_notification_message
+        {
+          blocks: [
+            {
+              type: 'section',
+              text: {
+                type: 'mrkdwn',
+                text: error_message
+              }
+            }
+          ]
+        }
+      end
+
+      def error_message
+        "*#{error.class_name}*: #{error.message}. \n" \
+          "<#{ExceptionHunter::Engine.routes.url_helpers.error_url(error.error_group)}|Click to see the error>"
+      end
+    end
+  end
+end

data/lib/exception_hunter/notifiers/slack_notifier_serializer.rb

@@ -0,0 +1,20 @@
+module ExceptionHunter
+  module Notifiers
+    # @private
+    class SlackNotifierSerializer
+      def self.serialize(slack_notifier)
+        {
+          error: slack_notifier.error,
+          notifier: slack_notifier.notifier.as_json
+        }
+      end
+
+      def self.deserialize(hash)
+        ExceptionHunter::Notifiers::SlackNotifier.new(
+          hash[:error],
+          hash[:notifier].deep_symbolize_keys
+        )
+      end
+    end
+  end
+end

data/lib/exception_hunter/tracking.rb

@@ -1,5 +1,23 @@
 module ExceptionHunter
+  # Mixin used to track manual exceptions.
   module Tracking
+    # Used to manually track errors in cases where raising might
+    # not be adequate and but some insight is desired.
+    #
+    # @example Track the else clause on a case
+    #   case user.status
+    #   when :active then do_something()
+    #   when :inactive then do_something_else()
+    #   else
+    #     ExceptionHunter.track(StandardError.new("User with unknown status"),
+    #                                             custom_data: { status: user.status },
+    #                                             user: user)
+    #   end
+    #
+    # @param [Exception] exception to track.
+    # @param [Hash] custom_data to include and help debug the error. (optional)
+    # @param [User] user in the current session. (optional)
+    # @return [void]
     def track(exception, custom_data: {}, user: nil)
       ErrorCreator.call(
         tag: ErrorCreator::MANUAL_TAG,
@@ -7,7 +25,8 @@ module ExceptionHunter
         message: exception.message,
         backtrace: exception.backtrace,
         custom_data: custom_data,
-        user: user
+        user: user,
+        environment_data: {}
       )
 
       nil

data/lib/exception_hunter/user_attributes_collector.rb

@@ -1,9 +1,26 @@
 module ExceptionHunter
+  # Utility module used to whitelist the user's attributes.
+  # Can be configured in {ExceptionHunter.setup ExceptionHunter.setup} to extract
+  # custom attributes.
+  #
+  # @example
+  #   ExceptionHunter.setup do |config|
+  #     config.user_attributes = [:id, :email, :role, :active?]
+  #   end
+  #
   module UserAttributesCollector
     extend self
 
+    # Gets the attributes configured for the user.
+    #
+    # @example
+    #   UserAttributesCollector.collect_attributes(current_user)
+    #   # => { id: 42, email: "example@user.com" }
+    #
+    # @param user instance in your application
+    # @return [Hash] the whitelisted attributes from the user
     def collect_attributes(user)
-      return unless user
+      return {} unless user
 
       attributes.reduce({}) do |data, attribute|
         data.merge(attribute => user.try(attribute))

data/lib/exception_hunter/version.rb

@@ -1,3 +1,3 @@
 module ExceptionHunter
-  VERSION = '0.3.0'.freeze
+  VERSION = '1.0.1'.freeze
 end

data/lib/generators/exception_hunter/install/templates/exception_hunter.rb.erb

@@ -38,4 +38,33 @@ ExceptionHunter.setup do |config|
   # happen automatically.
   #
   # config.errors_stale_time = 45.days
+
+  # == Slack notifications
+  #
+  # You can configure if you want to send notifications to slack for each error occurrence.
+  # You can enter multiple webhook urls.
+  # Default: []
+  #
+  # config.notifiers << {
+  #   name: :slack,
+  #   options: {
+  #     webhook: 'SLACK_WEBHOOK_URL_1'
+  #   }
+  # }
+  #
+  # config.notifiers << {
+  #   name: :slack,
+  #   options: {
+  #     webhook: SLACK_WEBHOOK_URL_2'
+  #   }
+  # }
+
+  # == Filter sensitive parameters
+  #
+  # You can configure if you want to filter some fields on the error's data for security or privacy issues.
+  # We use ActiveSupport::ParameterFilter for this, any accepted pattern will work.
+  # https://api.rubyonrails.org/classes/ActiveSupport/ParameterFilter.html
+  # Default: []
+  #
+  # config.sensitive_parameters = [:id, :name]
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: exception_hunter
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Bruno Vezoli
 - Tiziana Romani
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-10 00:00:00.000000000 Z
+date: 2020-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pagy
@@ -17,14 +17,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: slack-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: brakeman
   requirement: !ruby/object:Gem::Requirement
@@ -115,15 +129,15 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.5
+        version: 0.17.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.5
-description: 
+        version: 0.17.1
+description:
 email:
 - bruno.vezoli@rootstrap.com
 executables: []
@@ -143,11 +157,13 @@ files:
 - app/controllers/concerns/exception_hunter/authorization.rb
 - app/controllers/exception_hunter/application_controller.rb
 - app/controllers/exception_hunter/errors_controller.rb
+- app/controllers/exception_hunter/ignored_errors_controller.rb
 - app/controllers/exception_hunter/resolved_errors_controller.rb
 - app/helpers/exception_hunter/application_helper.rb
 - app/helpers/exception_hunter/errors_helper.rb
 - app/helpers/exception_hunter/sessions_helper.rb
 - app/jobs/exception_hunter/application_job.rb
+- app/jobs/exception_hunter/send_notification_job.rb
 - app/mailers/exception_hunter/application_mailer.rb
 - app/models/exception_hunter/application_record.rb
 - app/models/exception_hunter/error.rb
@@ -171,12 +187,17 @@ files:
 - config/routes.rb
 - lib/exception_hunter.rb
 - lib/exception_hunter/config.rb
+- lib/exception_hunter/data_redacter.rb
 - lib/exception_hunter/devise.rb
 - lib/exception_hunter/engine.rb
 - lib/exception_hunter/error_creator.rb
 - lib/exception_hunter/error_reaper.rb
+- lib/exception_hunter/middleware/delayed_job_hunter.rb
 - lib/exception_hunter/middleware/request_hunter.rb
 - lib/exception_hunter/middleware/sidekiq_hunter.rb
+- lib/exception_hunter/notifiers/misconfigured_notifiers.rb
+- lib/exception_hunter/notifiers/slack_notifier.rb
+- lib/exception_hunter/notifiers/slack_notifier_serializer.rb
 - lib/exception_hunter/tracking.rb
 - lib/exception_hunter/user_attributes_collector.rb
 - lib/exception_hunter/version.rb
@@ -186,13 +207,12 @@ files:
 - lib/generators/exception_hunter/install/templates/create_exception_hunter_error_groups.rb.erb
 - lib/generators/exception_hunter/install/templates/create_exception_hunter_errors.rb.erb
 - lib/generators/exception_hunter/install/templates/exception_hunter.rb.erb
-- lib/tasks/code_analysis.rake
 - lib/tasks/exception_hunter_tasks.rake
 homepage: https://github.com/rootstrap/exception_hunter
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -207,8 +227,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: Exception tracking engine
 test_files: []

data/lib/tasks/code_analysis.rake

@@ -1,7 +0,0 @@
-desc 'code analysis'
-task :code_analysis do
-  sh 'bundle exec brakeman . -z -q'
-  sh 'bundle exec rubocop app config lib spec'
-  sh 'bundle exec reek app config lib'
-  sh 'bundle exec rails_best_practices .'
-end