exception_hunter 0.2.0 → 1.0.0

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

@@ -0,0 +1,35 @@
+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,
+        class_name: exception.class.to_s,
+        message: exception.message,
+        backtrace: exception.backtrace,
+        custom_data: custom_data,
+        user: user,
+        environment_data: {}
+      )
+
+      nil
+    end
+  end
+end

data/lib/exception_hunter/user_attributes_collector.rb

@@ -1,13 +1,34 @@
 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
+
       attributes.reduce({}) do |data, attribute|
         data.merge(attribute => user.try(attribute))
       end
     end
 
+    private
+
     def attributes
       Config.user_attributes
     end

data/lib/exception_hunter/version.rb

@@ -1,3 +1,3 @@
 module ExceptionHunter
-  VERSION = '0.2.0'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/lib/generators/exception_hunter/create_users/create_users_generator.rb

@@ -22,7 +22,14 @@ module ExceptionHunter
     end
 
     def create_admin_user
-      invoke 'devise', [name]
+      invoke 'devise', [name], routes: false
+    end
+
+    def remove_registerable_from_model
+      return if options[:registerable]
+
+      model_file = File.join(destination_root, 'app', 'models', "#{file_path}.rb")
+      gsub_file model_file, /\:registerable([.]*,)?/, ''
     end
   end
 end

data/lib/generators/exception_hunter/install/install_generator.rb

@@ -15,7 +15,9 @@ module ExceptionHunter
 
     def setup_routes
       if options[:users]
-        inject_into_file 'config/routes.rb', "\n  ExceptionHunter.routes(self)", after: /devise_for .*/
+        gsub_file 'config/routes.rb',
+                  "\n  devise_for :#{plural_table_name}, skip: :all",
+                  "\n  ExceptionHunter.routes(self)"
       else
         route 'ExceptionHunter.routes(self)'
       end

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

@@ -5,10 +5,13 @@ class CreateExceptionHunterErrorGroups < ActiveRecord::Migration[<%= ActiveRecor
     create_table :exception_hunter_error_groups do |t|
       t.string :error_class_name, null: false
       t.string :message
+      t.integer :status, default: 0
+      t.text :tags, array: true, default: []
 
       t.timestamps
 
       t.index :message, opclass: :gin_trgm_ops, using: :gin
+      t.index :status
     end
   end
 end

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

@@ -1,4 +1,19 @@
 ExceptionHunter.setup do |config|
+  # == Enabling
+  #
+  # This flag allows disabling error tracking, it's set to track in
+  # any environment but development or test by default
+  #
+  config.enabled = !(Rails.env.development? || Rails.env.test?)
+
+  # == Dashboard User
+  # Exception Hunter allows you to restrict users who can see the dashboard
+  # to the ones included in the database. You can change the table name in
+  # case you are not satisfied with the default one. You can also remove the
+  # configuration if you wish to have no access restrictions for the dashboard.
+  #
+  <%= @use_authentication_method ? "config.admin_user_class = '#{name}'" : "# config.admin_user_class = '#{name}'" %>
+
   # == Current User
   #
   # Exception Hunter will include the user as part of the environment
@@ -15,4 +30,41 @@ ExceptionHunter.setup do |config|
   # as part of the user information that is kept from the request.
   #
   config.user_attributes = [:id, :email]
+
+  # == Stale errors
+  #
+  # You can configure how long it takes for errors to go stale. This is
+  # taken into account when purging old error messages but nothing will
+  # 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

data/lib/tasks/exception_hunter_tasks.rake

@@ -1,4 +1,6 @@
-# desc "Explaining what the task does"
-# task :exception_hunter do
-#   # Task goes here
-# end
+namespace :exception_hunter do
+  desc 'Purges old errors'
+  task purge_errors: [:environment] do
+    ::ExceptionHunter::ErrorReaper.call
+  end
+end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: exception_hunter
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Bruno Vezoli
 - Tiziana Romani
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-18 00:00:00.000000000 Z
+date: 2020-11-05 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: []
@@ -139,32 +153,52 @@ files:
 - app/assets/stylesheets/exception_hunter/base.css
 - app/assets/stylesheets/exception_hunter/errors.css
 - app/assets/stylesheets/exception_hunter/navigation.css
+- app/assets/stylesheets/exception_hunter/sessions.css
+- 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
 - app/models/exception_hunter/error_group.rb
+- app/presenters/exception_hunter/dashboard_presenter.rb
+- app/presenters/exception_hunter/error_group_presenter.rb
 - app/presenters/exception_hunter/error_presenter.rb
-- app/services/exception_hunter/error_creator.rb
+- app/views/exception_hunter/devise/sessions/new.html.erb
 - app/views/exception_hunter/errors/_error_backtrace.erb
+- app/views/exception_hunter/errors/_error_row.erb
 - app/views/exception_hunter/errors/_error_summary.erb
 - app/views/exception_hunter/errors/_error_user_data.erb
+- app/views/exception_hunter/errors/_errors_table.erb
+- app/views/exception_hunter/errors/_last_7_days_errors_table.erb
 - app/views/exception_hunter/errors/index.html.erb
 - app/views/exception_hunter/errors/pagy/_pagy_nav.html.erb
 - app/views/exception_hunter/errors/show.html.erb
 - app/views/layouts/exception_hunter/application.html.erb
-- config/initializers/exception_hunter.rb
+- app/views/layouts/exception_hunter/exception_hunter_logged_out.html.erb
 - config/rails_best_practices.yml
 - 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
 - lib/generators/exception_hunter/create_users/create_users_generator.rb
@@ -179,7 +213,7 @@ homepage: https://github.com/rootstrap/exception_hunter
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -195,7 +229,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.8
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Exception tracking engine
 test_files: []

data/app/services/exception_hunter/error_creator.rb

@@ -1,41 +0,0 @@
-module ExceptionHunter
-  class ErrorCreator
-    class << self
-      def call(**error_attrs)
-        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)
-          error.error_group = error_group
-          error.save!
-          error
-        end
-      rescue ActiveRecord::RecordInvalid
-        false
-      end
-
-      private
-
-      def update_error_group(error_group, error)
-        error_group.error_class_name = error.class_name
-        error_group.message = error.message
-
-        error_group.save!
-      end
-
-      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.delete(:user)
-        error_attrs
-      end
-    end
-  end
-end