exception_hunter 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 461f614a3acb4efa1cabad37cc849850c45b0f186f627b016c5d48d09684b6c4
-  data.tar.gz: fa8c5abe1c5a2020d96ce5be459cacc624e227917eca8a5875046f528a021aa4
+  metadata.gz: a48a18bd03288de4cf787931d9be95dea04f3f168224c87c971ad5b2cd9fb1bf
+  data.tar.gz: 6194494c81ccd89d7f3ce0c2a00c607fe2c7836e872074d11b37454cf8f93122
 SHA512:
-  metadata.gz: a057aff5a6cea927c804120a39b2c708a6e1d363d08d2707461c9fd0f39a8234bdb4cc7ca6b6e153f56cacf18d657eb88e0bd843c08953beef2aacfa2f721108
-  data.tar.gz: 68eafa484c4350384b5fd8bd38c131462d6634fe9ff344c62ab71c91fcd3995f1b7f8ad4700b5715b7c89ca86741469141364a412887fa5eda680a4f63fd1d30
+  metadata.gz: 9bd3b4b6410b75f39a43ce1a4f87234883f5a625d77e63f42dd217db865f31a515a95577d3def6d0de838905003640c348f9b43f8d1c4c9731b13e3d4dbff8a7
+  data.tar.gz: 18744e0c947daa72a222449986d3c75d2e80b9993baa89ab9d90f137b2de9ac5b82272550096894dd248f4f7b337277ff94f61aa605a7229715a8fdf0049fb1e

data/README.md

@@ -8,7 +8,7 @@ How to use my plugin.
 Add Exception Hunter to your application's Gemfile:
 
 ```ruby
-gem 'exception_hunter', '~> 0.1.1'
+gem 'exception_hunter', '~> 0.2.0'
 ```
 
 You may also need to add [Devise](https://github.com/heartcombo/devise) to your Gemfile
@@ -26,7 +26,8 @@ $ rails generate exception_hunter:install
 
 This will create an initializer and invoke Devise to
 create an `AdminUser` which will be used for authentication to access the dashboard. If you already
-have this user created (Devise uses the same model) you can run the command with the `--skip-users` flag.
+have this user created ([ActiveAdmin](https://github.com/activeadmin/activeadmin) uses the same model)
+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!

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

@@ -59,6 +59,10 @@
     color: var(--main-color);
 }
 
+.tracked-data {
+    border-left-color: var(--main-color);
+}
+
 .backtrace {
     padding-top: 1em;
     padding-bottom: 1em;

data/app/helpers/exception_hunter/errors_helper.rb

@@ -0,0 +1,7 @@
+module ExceptionHunter
+  module ErrorsHelper
+    def format_tracked_data(tracked_data)
+      JSON.pretty_generate(tracked_data)
+    end
+  end
+end

data/app/presenters/exception_hunter/error_presenter.rb

@@ -14,6 +14,14 @@ module ExceptionHunter
       end
     end
 
+    def environment_data
+      error.environment_data.except('params')
+    end
+
+    def tracked_params
+      (error.environment_data || {})['params']
+    end
+
     private
 
     attr_reader :error

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

@@ -6,10 +6,22 @@
   <div class="row error-row-no-border data-title">
     Environment Data
   </div>
-  <% error.environment_data.each do |key, value| %>
-    <b><%= key %></b>: <%= value %><br>
-  <% end %>
+  <pre class="tracked-data">
+
+<%= format_tracked_data(error.environment_data) %>
+  </pre>
 <% end %>
+
+<% unless error.tracked_params.nil? %>
+  <div class="row error-row-no-border data-title">
+    Tracked Params
+  </div>
+  <pre class="tracked-data">
+
+<%= format_tracked_data(error.tracked_params) %>
+  </pre>
+<% end %>
+
 <% if error.custom_data.nil? %>
   <div class="row error-row-no-border data-title">
     No custom data included.
@@ -18,7 +30,8 @@
   <div class="row error-row-no-border data-title">
     Custom Data
   </div>
-  <% error.custom_data.each do |key, value| %>
-    <b><%= key %></b>: <%= value || 'None' %> <br>
-  <% end %>
+  <pre class="tracked-data">
+
+<%= format_tracked_data(error.custom_data) %>
+  </pre>
 <% end %>

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

@@ -3,9 +3,8 @@
     Unfortunately, no user information has been registered for this error.
   </div>
 <% else %>
-  <% error.user_data.transform_keys(&:to_sym).each do |key, value| %>
-    <div class="column column-15">
-      <b><%= key %></b>: <%= value %>
-    </div>
-  <% end %>
+  <pre class="tracked-data">
+
+<%= format_tracked_data(error.user_data) %>
+  </pre>
 <% end %>

data/config/rails_best_practices.yml

@@ -15,7 +15,6 @@ MoveCodeIntoModelCheck: { use_count: 2 }
 MoveFinderToNamedScopeCheck: { }
 MoveModelLogicIntoModelCheck: { use_count: 4 }
 NeedlessDeepNestingCheck: { nested_count: 2 }
-NotRescueExceptionCheck: { ignored_files: 'request_hunter.rb' }
 NotUseDefaultRouteCheck: { }
 NotUseTimeAgoInWordsCheck: { ignored_files: ['index.html.erb'] }
 OveruseRouteCustomizationsCheck: { customize_count: 3 }

data/lib/exception_hunter.rb

@@ -1,5 +1,6 @@
 require 'exception_hunter/engine'
-require 'exception_hunter/railtie'
+require 'exception_hunter/middleware/request_hunter'
+require 'exception_hunter/middleware/sidekiq_hunter' if defined?(Sidekiq)
 require 'exception_hunter/config'
 require 'exception_hunter/user_attributes_collector'
 require 'pagy'

data/lib/exception_hunter/middleware/request_hunter.rb

@@ -0,0 +1,70 @@
+module ExceptionHunter
+  module Middleware
+    class RequestHunter
+      ENVIRONMENT_KEYS =
+        %w[PATH_INFO
+           QUERY_STRING
+           REMOTE_HOST
+           REQUEST_METHOD
+           REQUEST_URI
+           SERVER_PROTOCOL
+           HTTP_HOST
+           CONTENT_TYPE
+           HTTP_USER_AGENT].freeze
+
+      FILTERED_PARAMS = [/password/].freeze
+
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        @app.call(env)
+      rescue Exception => exception # rubocop:disable Lint/RescueException
+        catch_prey(env, exception)
+        raise exception
+      end
+
+      private
+
+      def catch_prey(env, exception)
+        user = user_from_env(env)
+        ErrorCreator.call(
+          class_name: exception.class.to_s,
+          message: exception.message,
+          environment_data: environment_data(env),
+          backtrace: exception.backtrace,
+          user: user
+        )
+      end
+
+      def environment_data(env)
+        env
+          .select { |key, _value| ENVIRONMENT_KEYS.include?(key) }
+          .merge(params: filtered_sensitive_params(env))
+      end
+
+      def user_from_env(env)
+        current_user_method = Config.current_user_method
+        controller = env['action_controller.instance']
+        controller.try(current_user_method)
+      end
+
+      def filtered_sensitive_params(env)
+        params = env['action_dispatch.request.parameters']
+        parameter_filter = ::ActiveSupport::ParameterFilter.new(FILTERED_PARAMS)
+        parameter_filter.filter(params || {})
+      end
+    end
+  end
+end
+
+module ExceptionHunter
+  class Railtie < Rails::Railtie
+    initializer 'exception_hunter.add_middleware', after: :load_config_initializers do |app|
+      app.config.middleware.insert_after(
+        ActionDispatch::DebugExceptions, ExceptionHunter::Middleware::RequestHunter
+      )
+    end
+  end
+end

data/lib/exception_hunter/middleware/sidekiq_hunter.rb

@@ -0,0 +1,58 @@
+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[
+        queue
+        retry_count
+      ].freeze
+      ARGS_TRACKED_DATA = %w[
+        job_class
+        job_id
+        arguments
+        enqueued_at
+      ].freeze
+
+      def call(_worker, context, _queue)
+        yield
+      rescue Exception => exception # rubocop:disable Lint/RescueException
+        track_exception(exception, context)
+        raise exception
+      end
+
+      private
+
+      def track_exception(exception, context)
+        return unless should_track?(context)
+
+        ErrorCreator.call(
+          class_name: exception.class.to_s,
+          message: exception.message,
+          environment_data: environment_data(context),
+          backtrace: exception.backtrace
+        )
+      end
+
+      def environment_data(context)
+        job_data = context.select { |key, _value| JOB_TRACKED_DATA.include?(key) }
+        args_data = (context['args']&.first || {}).select { |key, _value| ARGS_TRACKED_DATA.include?(key) }
+
+        job_data.merge(args_data)
+      end
+
+      def should_track?(context)
+        TRACK_AT_RETRY.include?(context['retry_count'].to_i)
+      end
+    end
+  end
+end
+
+# As seen in https://github.com/mperham/sidekiq/wiki/Error-Handling
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add(ExceptionHunter::Middleware::SidekiqHunter)
+  end
+end

data/lib/exception_hunter/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: exception_hunter
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Bruno Vezoli
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-17 00:00:00.000000000 Z
+date: 2020-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pagy
@@ -142,6 +142,7 @@ files:
 - app/controllers/exception_hunter/application_controller.rb
 - app/controllers/exception_hunter/errors_controller.rb
 - app/helpers/exception_hunter/application_helper.rb
+- app/helpers/exception_hunter/errors_helper.rb
 - app/jobs/exception_hunter/application_job.rb
 - app/mailers/exception_hunter/application_mailer.rb
 - app/models/exception_hunter/application_record.rb
@@ -162,8 +163,8 @@ files:
 - lib/exception_hunter.rb
 - lib/exception_hunter/config.rb
 - lib/exception_hunter/engine.rb
-- lib/exception_hunter/railtie.rb
-- lib/exception_hunter/request_hunter.rb
+- lib/exception_hunter/middleware/request_hunter.rb
+- lib/exception_hunter/middleware/sidekiq_hunter.rb
 - lib/exception_hunter/user_attributes_collector.rb
 - lib/exception_hunter/version.rb
 - lib/generators/exception_hunter/create_users/create_users_generator.rb

data/lib/exception_hunter/railtie.rb

@@ -1,11 +0,0 @@
-require_dependency 'exception_hunter/request_hunter'
-
-module ExceptionHunter
-  class Railtie < Rails::Railtie
-    initializer 'exception_hunter.add_middleware', after: :load_config_initializers do |app|
-      app.config.middleware.insert_after(
-        ActionDispatch::DebugExceptions, ExceptionHunter::RequestHunter
-      )
-    end
-  end
-end

data/lib/exception_hunter/request_hunter.rb

@@ -1,41 +0,0 @@
-module ExceptionHunter
-  class RequestHunter
-    ENVIRONMENT_KEYS =
-      %w[PATH_INFO QUERY_STRING REMOTE_HOST REQUEST_METHOD REQUEST_URI
-         SERVER_PROTOCOL HTTP_HOST HTTP_USER_AGENT].freeze
-
-    def initialize(app)
-      @app = app
-    end
-
-    def call(env)
-      @app.call(env)
-    rescue Exception => exception
-      catch_prey(env, exception)
-      raise exception
-    end
-
-    private
-
-    def catch_prey(env, exception)
-      user = user_from_env(env)
-      ErrorCreator.call(
-        class_name: exception.class.to_s,
-        message: exception.message,
-        environment_data: environment_data(env),
-        backtrace: exception.backtrace,
-        user: user
-      )
-    end
-
-    def environment_data(env)
-      env.select { |key, _value| ENVIRONMENT_KEYS.include?(key) }
-    end
-
-    def user_from_env(env)
-      current_user_method = Config.current_user_method
-      controller = env['action_controller.instance']
-      controller.try(current_user_method)
-    end
-  end
-end