exception_hunter 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ba4ba0c2e1205126ac00e8d0c27b9b98cc3b932dff902e6d7552b7bb640e681
-  data.tar.gz: 49b05057f76bb754bec371065918aeb0cb087208794326c78b837fb894af2fad
+  metadata.gz: 7fb03df52c56c0849ab0400679af9ce9a7711c0eab80c42f4d79f59ff3613ace
+  data.tar.gz: 181ba4a3cfb249ac1a02f7ec55548f4d306ee4eb902cace8ef741d271aed394b
 SHA512:
-  metadata.gz: dfd7faf102765439718b72f1c643593d48c6f1613db7ea573a4cb0ea66206819d6fcf5f17eb9f229beb31efa20f76901e995539703ed266073986cdae5795712
-  data.tar.gz: b9711187a6887b4542973bc5f1c687a9e6034dc5b136cc6755fec9126d4ccce4311bbad8eafdfd49c53be7e437c63f69f505b4868f46da3abf387e3e6bc02ab1
+  metadata.gz: 4379274f01ea33abbc12e696c137cfbd8fac013a052f2d34bfe86db804904bfbf1008a6d43b88c5b3768ddfd3373b56dc23b05739c21ae66c0233e861f6ce888
+  data.tar.gz: 60213532b0048da8de7b00383e8bf049f3a82143765add61099a8cf7f005ad1474970e4cbbc8415701b2efa2bf4a3095c60e52050a62bcedbe30742bc124ce81

data/README.md

@@ -1,5 +1,9 @@
 # ExceptionHunter
 
+![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](doc/screenshot.png)
 
 Exception Hunter is a Rails engine meant to track errors in your Rails project. It works
@@ -21,7 +25,7 @@ project, and MVP or something else.
 Add Exception Hunter to your application's Gemfile:
 
 ```ruby
-gem 'exception_hunter', '~> 0.3.0'
+gem 'exception_hunter', '~> 0.4.0'
 ```
 
 You may also need to add [Devise](https://github.com/heartcombo/devise) to your Gemfile

data/lib/exception_hunter.rb

@@ -2,7 +2,6 @@ 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'

data/lib/exception_hunter/engine.rb

@@ -12,5 +12,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/middleware/delayed_job_hunter.rb

@@ -0,0 +1,69 @@
+require 'delayed_job'
+
+module ExceptionHunter
+  module Middleware
+    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.each_with_object({}) do |data_param, dict|
+            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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: exception_hunter
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Bruno Vezoli
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-10 00:00:00.000000000 Z
+date: 2020-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pagy
@@ -17,14 +17,14 @@ 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: brakeman
   requirement: !ruby/object:Gem::Requirement
@@ -115,14 +115,14 @@ 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
+        version: 0.17.1
 description: 
 email:
 - bruno.vezoli@rootstrap.com
@@ -175,6 +175,7 @@ files:
 - 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/tracking.rb
@@ -207,7 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Exception tracking engine