exception_hunter 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c65dc23c6e47e44540d172c0499734b0788b9a22dc689b58e7c558fca89efefd
-  data.tar.gz: 286902eea5d066ba92dd66aeab81114688dd6b71ca0a0b484bf4a5cbee2cc5f3
+  metadata.gz: 2fb501bfc67399400c0d73e8d6df68fb8a20c25f6e12ef2dbc0507afda20aa93
+  data.tar.gz: 7f9af95d0edc69281d63c6b9cffb3ae259dec67bda2ce7e7901d6cb5bda371b8
 SHA512:
-  metadata.gz: 9f51b701f9d13e33cb37a477b1eedeb799ccfcdb9b45dd13cd96fa1d47f80c66bbea9fad6293ed51488991c9b3073d80844cd3651c26dbba904693d948b5938a
-  data.tar.gz: feb499e25bdb858705bc9eb5a28d4ece1603028633f7fd201859bc26da4ae24b7194dd5f9e3241f2f31b01f160c1dfe8ee60563f65972d6879769bcec24324ea
+  metadata.gz: 6170a00e2225b75eb4c7b9e8ee4278cf520df79728fe717ba5bd785136195f31fe72c417d8d794e38d63b64b528dcbc4a449fee09f2976b286542e1c69ff2dcd
+  data.tar.gz: b349b87bf65da803cf32044b69cfb53a81329d6a02b50dc535c6a257aaad16dd32789547eb3858d2714015322f67008efdf217e4d3f5474418ed008f19abb2d5

data/README.md

@@ -23,9 +23,10 @@ project, and MVP or something else.
 
 ## Docs
 
-You can check the full documentation at [https://rootstrap.github.io/exception_hunter]().
+You can check the full documentation at [https://rootstrap.github.io/exception_hunter](https://rootstrap.github.io/exception_hunter).
 
 ## Installation
+
 Add Exception Hunter to your application's Gemfile:
 
 ```ruby
@@ -65,7 +66,6 @@ You can then open a `rails console` and manually track an exception to check tha
 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:
@@ -89,7 +89,7 @@ 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)
+  ExceptionHunter.track(ArgumentError.new('This should never happen'), custom_data: { status: current_user.status }, user: current_user)
 end
 ```
 
@@ -102,9 +102,9 @@ You can configure ExceptionHunter to send a message to slack every time an error
 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.
+1. Add it to your workspace.
+1. Add one or more webhooks linked to the channels you want to receive the notifications.
+1. Set the webhook urls in the `exception_hunter` initializer.
 
 ```ruby
 config.notifiers << {
@@ -122,7 +122,7 @@ config.notifiers << {
 }
 ```
 
-6. Add the code below to the environment config file where you are using ExceptionHunter with the correct server url.
+1. 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|
@@ -132,7 +132,21 @@ 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.
 
+## Async Logging
+
+You can configure ExceptionHunter to log async when an error occurs.
+You have to do the following:
+
+```ruby
+config.async_logging = true;
+```
+
+This uses ActiveJob to log the error 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 the error will be logged synchronously.
+
+Note: Errors from jobs will still be logged synchronously to not queue a job from a job (which sound like a bad idea)
+
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 ## Credits

data/app/jobs/exception_hunter/async_logging_job.rb

@@ -0,0 +1,13 @@
+module ExceptionHunter
+  class AsyncLoggingJob < ApplicationJob
+    queue_as :default
+
+    def perform(tag, error_attrs)
+      error_attrs = error_attrs.merge(occurred_at: Time.at(error_attrs[:occurred_at])) if error_attrs[:occurred_at]
+      ErrorCreator.call(async_logging: false, tag: tag, **error_attrs)
+    rescue Exception
+      # Suppress all exceptions to avoid loop as this would create a new error in EH.
+      false
+    end
+  end
+end

data/app/presenters/exception_hunter/error_group_presenter.rb

@@ -11,7 +11,8 @@ module ExceptionHunter
     end
 
     def self.format_occurrence_day(day)
-      day.to_date.strftime('%A, %B %d')
+      date = day.to_date
+      date == Date.yesterday ? 'Yesterday' : date.strftime('%A, %B %d')
     end
 
     def show_for_day?(day)

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

@@ -1,11 +1,7 @@
 <% today_errors = errors.select { |error| error.show_for_day?(Date.current) } %>
 <%= render partial: 'exception_hunter/errors/error_row', collection: today_errors, as: :error %>
 
-<% yesterday_errors = errors.select { |error| error.show_for_day?(Date.yesterday) } %>
-<div class="errors-date-group">Yesterday</div>
-<%= render partial: 'exception_hunter/errors/error_row', collection: yesterday_errors, as: :error %>
-
-<% (2..6).each do |i| %>
+<% (1..6).each do |i| %>
   <% errors_on_day = errors.select { |error| error.show_for_day?(i.days.ago) } %>
   <div class="errors-date-group"><%= ExceptionHunter::ErrorGroupPresenter.format_occurrence_day(i.days.ago) %></div>
   <%= render partial: 'exception_hunter/errors/error_row', collection: errors_on_day, as: :error %>

data/lib/exception_hunter/config.rb

@@ -17,6 +17,9 @@ module ExceptionHunter
     # @return [Array<Hash>] configured notifiers for the application (see {ExceptionHunter::Notifiers})
     cattr_accessor :notifiers, default: []
     cattr_accessor :sensitive_fields, default: []
+    # @!attribute
+    # @return [Boolean] whether ExceptionHunter should log async or not
+    cattr_accessor :async_logging, default: false
 
     # Returns true if there's an admin user class configured to
     # authenticate against.

data/lib/exception_hunter/error_creator.rb

@@ -12,9 +12,22 @@ module ExceptionHunter
       #
       # @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)
+      def call(async_logging: Config.async_logging, tag: nil, **error_attrs)
         return unless should_create?
 
+        if async_logging
+          # Time is sent in unix format and then converted to Time to avoid ActiveJob::SerializationError
+          ::ExceptionHunter::AsyncLoggingJob.perform_later(tag, error_attrs.merge(occurred_at: Time.now.to_i))
+        else
+          create_error(tag, error_attrs)
+        end
+      rescue ActiveRecord::RecordInvalid
+        false
+      end
+
+      private
+
+      def create_error(tag, error_attrs)
         ActiveRecord::Base.transaction do
           error_attrs = extract_user_data(error_attrs)
           error_attrs = hide_sensitive_values(error_attrs)
@@ -28,12 +41,8 @@ module ExceptionHunter
           notify(error)
           error
         end
-      rescue ActiveRecord::RecordInvalid
-        false
       end
 
-      private
-
       def should_create?
         Config.enabled
       end

data/lib/exception_hunter/middleware/delayed_job_hunter.rb

@@ -31,6 +31,7 @@ module ExceptionHunter
         return unless should_track?(job.attempts)
 
         ErrorCreator.call(
+          async_logging: false,
           tag: ErrorCreator::WORKER_TAG,
           class_name: exception.class.to_s,
           message: exception.message,

data/lib/exception_hunter/middleware/sidekiq_hunter.rb

@@ -28,6 +28,7 @@ module ExceptionHunter
         return unless should_track?(context)
 
         ErrorCreator.call(
+          async_logging: false,
           tag: ErrorCreator::WORKER_TAG,
           class_name: exception.class.to_s,
           message: exception.message,

data/lib/exception_hunter/tracking.rb

@@ -19,6 +19,26 @@ module ExceptionHunter
     # @param [User] user in the current session. (optional)
     # @return [void]
     def track(exception, custom_data: {}, user: nil)
+      if open_transactions?
+        create_error_within_new_thread(exception, custom_data, user)
+      else
+        create_error(exception, custom_data, user)
+      end
+
+      nil
+    end
+
+    private
+
+    def create_error_within_new_thread(exception, custom_data, user)
+      Thread.new {
+        ActiveRecord::Base.connection_pool.with_connection do
+          create_error(exception, custom_data, user)
+        end
+      }.join
+    end
+
+    def create_error(exception, custom_data, user)
       ErrorCreator.call(
         tag: ErrorCreator::MANUAL_TAG,
         class_name: exception.class.to_s,
@@ -28,8 +48,10 @@ module ExceptionHunter
         user: user,
         environment_data: {}
       )
+    end
 
-      nil
+    def open_transactions?
+      ActiveRecord::Base.connection.open_transactions.positive?
     end
   end
 end

data/lib/exception_hunter/version.rb

@@ -1,3 +1,3 @@
 module ExceptionHunter
-  VERSION = '1.0.2'.freeze
+  VERSION = '1.1.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: exception_hunter
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Bruno Vezoli
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-03 00:00:00.000000000 Z
+date: 2021-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pagy
@@ -163,6 +163,7 @@ files:
 - 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/async_logging_job.rb
 - app/jobs/exception_hunter/send_notification_job.rb
 - app/mailers/exception_hunter/application_mailer.rb
 - app/models/exception_hunter/application_record.rb