RubyGems - exception_hunter - Versions diffs - 0.2.0 → 1.0.0 - Mend

exception_hunter 0.2.0 → 1.0.0

Files changed (56) hide show

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

@@ -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 CHANGED

@@ -13,10 +13,10 @@ 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'] }
+#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 CHANGED

@@ -1,3 +1,23 @@
 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]
+  resources :ignored_errors, only: %i[create]
+  post :reopen, to: 'ignored_errors#reopen'
+  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 CHANGED

@@ -1,16 +1,58 @@
+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'
+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 CHANGED

@@ -1,5 +1,29 @@
 module ExceptionHunter
+  # Config singleton class used to customize ExceptionHunter
   class Config
-    cattr_accessor :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
   end
 end

data/lib/exception_hunter/data_redacter.rb ADDED

@@ -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 ADDED

@@ -0,0 +1,19 @@
+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
+      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/lib/exception_hunter/engine.rb CHANGED

@@ -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 ADDED

@@ -0,0 +1,72 @@
+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_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
+        false
+      end
+      private
+      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
+      def extract_user_data(**error_attrs)
+        user = error_attrs[:user]
+        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 ADDED

@@ -0,0 +1,20 @@
+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
+          ErrorGroup.without_errors.destroy_all
+        end
+      end
+    end
+  end
+end

data/lib/exception_hunter/middleware/delayed_job_hunter.rb ADDED

@@ -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 CHANGED

@@ -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
@@ -30,6 +32,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),
@@ -52,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 CHANGED

@@ -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[
@@ -29,6 +28,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),