raygun4ruby 4.0.0.pre → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60ac385b98484429b3f056b123dd5fc409ad08974c9d851e727c4a1dbed74cee
-  data.tar.gz: 2f3a754c2a3fe0ce1d3392096255e5006e234af786d00b9ebb09cd2465180b55
+  metadata.gz: 6a0724f9d47f49615745fe91cc15eb47c033036cfa20c8bb0432c7bcc9bebb33
+  data.tar.gz: d5addaabbd8cac2efaf4bcd919246113f8ca5c3220dd976a51cb6f51cd1a8bb5
 SHA512:
-  metadata.gz: a3c0c8d72fdf503814b2a01f95b41c307037c830bd1aeaa3949a7d54931a438508d4271651ac5eff877949bcd71cee75c1b21780a179fc8fa5aa9963e576167f
-  data.tar.gz: e0c7d182af82124987f8b1cd6000f075e39f57e06078e75876a8fde3461fdf0ed43135104770f3695421f9d7b74b290ef1f5d662e199a911a5c29a7b6bffa7dc
+  metadata.gz: 59aba8123eb5282a7d1589a65d721579e594cd2dc5b5fdfb7e05f14b9bc711242cdeac17f907c41e67813b029658f9f03049637ce54e99c0ba22c22426720507
+  data.tar.gz: '0597d91a00bbe36f2d13d26f9116ddb16b792c9f30393b6d73f60714b762f7787d58eefe61dab621cab149d24c8a241018e088ac5e63d67245a31c7218b95fa1'

data/CHANGELOG.md

@@ -1,4 +1,8 @@
-## 4.0.0.pre (prerelease):
+## 4.0.1 (29/07/2024):
+
+- Adds the ability to unwrap `Sidekiq::JobRetry::Handled` exceptions (or ignore them entirely) ([#185](https://github.com/MindscapeHQ/raygun4ruby/pull/185))
+
+## 4.0.0 (20/05/2024):
 
 - BREAKING CHANGE: Remove support for end-of-life Ruby verisons and Rails versions prior to 6.0.0
 - Bug fix: Fix issue with breadcrumbs not being sent to Raygun when `send_in_background` is enabled (thanks to @jjb for the bug report)

data/README.md

@@ -12,25 +12,27 @@ And then execute:
 
     $ bundle install
 
-Or, if you're not using Bundler, install the gem directly:
-
-    $ gem install raygun4ruby
-
 ## Usage
 
 ### Rails 6+
 
+#### Step 1
+
 Run:
 
     rails g raygun:install YOUR_API_KEY_HERE
 
 You can find your API key in the [Raygun app](https://app.raygun.com/) under "Application Settings".
 
+#### Step 2
+
 You can then test your Raygun integration by running:
 
     rails raygun:test
 
-You should see an "ItWorksException" appear in your Raygun dashboard. You're ready to zap those errors! :zap:
+You should see an "ItWorksException" appear in your Raygun Crash Reporting dashboard. You're ready to zap those errors! :zap:
+
+#### Step 3 (optional)
 
 The generator will create a file in `config/initializers` called "raygun.rb". If you need to do any further configuration or customization of Raygun, that's the place to do it!
 
@@ -292,7 +294,7 @@ To see the defaults check out [affected_user.rb](https://github.com/MindscapeHQ/
 
 If you're using Rails, most authentication systems will have this method set and you should be good to go.
 
-The count of unique affected customers will appear on the error group in the Raygun dashboard. If your customer has an `email` attribute, and that email has a Gravatar associated with that address, you will also see your customer's avatar.
+The count of unique affected customers will appear on the error group in Raygun Crash Reporting. If your customer has an `email` attribute, and that email has a Gravatar associated with that address, you will also see your customer's avatar.
 
 If you wish to keep it anonymous, you could set this identifier to something like `SecureRandom.uuid` and store that in a cookie, like so:
 
@@ -400,6 +402,10 @@ class FailingWorker
   end
 ```
 
+##### Sidekiq Retries
+
+By default, Raygun4Ruby will unwrap `Sidekiq::JobRetry::Handled` exceptions and report the original error via `Exception#cause`. If you would prefer not to hear about retries, you can set `config.track_retried_sidekiq_jobs` to `false` in your Raygun configuration.
+
 ### Other Configuration options
 
 For a complete list of configuration options see the [configuration.rb](https://github.com/MindscapeHQ/raygun4ruby/blob/master/lib/raygun/configuration.rb) file

data/lib/raygun/configuration.rb

@@ -89,6 +89,9 @@ module Raygun
     # Should we register an error handler with [Rails' built in API](https://edgeguides.rubyonrails.org/error_reporting.html)
     config_option :register_rails_error_handler
 
+    # Should we track jobs that are retried in Sidekiq (ones that raise Sidekiq::JobRetry::Handled). Set to "false" to ignore.
+    config_option :track_retried_sidekiq_jobs
+
     # Exception classes to ignore by default
     IGNORE_DEFAULT = ['ActiveRecord::RecordNotFound',
                       'ActionController::RoutingError',
@@ -97,7 +100,8 @@ module Raygun
                       'CGI::Session::CookieStore::TamperedWithCookie',
                       'ActionController::UnknownAction',
                       'AbstractController::ActionNotFound',
-                      'Mongoid::Errors::DocumentNotFound']
+                      'Mongoid::Errors::DocumentNotFound',
+                      'Sidekiq::JobRetry::Skip']
 
     DEFAULT_FILTER_PARAMETERS = [ :password, :card_number, :cvv ]
 
@@ -142,7 +146,8 @@ module Raygun
         breadcrumb_level:              :info,
         record_raw_data:               false,
         send_in_background:            false,
-        error_report_send_timeout:     10
+        error_report_send_timeout:     10,
+        track_retried_sidekiq_jobs:    true
       )
     end
 

data/lib/raygun/demo_exception.rb

@@ -11,7 +11,7 @@ module Raygun
       response = Raygun.track_exception(e)
 
       if response.success?
-        puts "Success! Now go check your Raygun Dashboard"
+        puts "Success! Now go check your Raygun Crash Reporting dashboard"
       else
         puts "Oh-oh, something went wrong - double check your API key"
         puts "API Key - " << Raygun.configuration.api_key << ")"

data/lib/raygun/error_subscriber.rb

@@ -16,6 +16,10 @@ class Raygun::ErrorSubscriber
       tags: ["rails_error_reporter", *tags].compact
     }
 
-    Raygun.track_exception(error, data)
+    if source == "job.sidekiq" && defined?(Sidekiq)
+      Raygun::SidekiqReporter.call(error, data)
+    else
+      Raygun.track_exception(error, data)
+    end
   end
 end

data/lib/raygun/sidekiq.rb

@@ -6,7 +6,7 @@
 module Raygun
 
   class SidekiqReporter
-    def self.call(exception, context_hash, config)
+    def self.call(exception, context_hash = {}, config = nil)
       user = affected_user(context_hash)
       data =  {
         custom_data: {
@@ -14,6 +14,16 @@ module Raygun
         },
         tags: ['sidekiq']
       }
+
+      if exception.is_a?(Sidekiq::JobRetry::Handled) && exception.cause
+        if Raygun.configuration.track_retried_sidekiq_jobs
+          data.merge!(sidekiq_retried: true)
+          exception = exception.cause
+        else
+          return false
+        end
+      end
+
       if exception.instance_variable_defined?(:@__raygun_correlation_id) && correlation_id = exception.instance_variable_get(:@__raygun_correlation_id)
         data.merge!(correlation_id: correlation_id)
       end

data/lib/raygun/version.rb

@@ -1,3 +1,3 @@
 module Raygun
-  VERSION = "4.0.0.pre"
+  VERSION = "4.0.1"
 end

data/test/unit/sidekiq_failure_test.rb

@@ -1,6 +1,7 @@
 require_relative "../test_helper.rb"
 
 require "sidekiq"
+
 # Convince Sidekiq it's on a server :)
 module Sidekiq
   class << self
@@ -15,6 +16,8 @@ require "raygun/sidekiq"
 class SidekiqFailureTest < Raygun::UnitTest
 
   def setup
+    require "sidekiq/job_retry"
+
     super
     Raygun.configuration.send_in_background = false
 
@@ -32,6 +35,61 @@ class SidekiqFailureTest < Raygun::UnitTest
     assert response && response.success?, "Expected success, got #{response.class}: #{response.inspect}"
   end
 
+  def test_failure_backend_unwraps_retries
+    WebMock.reset!
+
+    unwrapped_stub = stub_request(:post, 'https://api.raygun.com/entries').
+      with(body: /StandardError/).
+      to_return(status: 202)
+
+    begin
+      raise StandardError.new("Some job in Sidekiq failed, oh dear!")
+    rescue
+      raise Sidekiq::JobRetry::Handled
+    end
+
+    rescue Sidekiq::JobRetry::Handled => e
+
+      response = Raygun::SidekiqReporter.call(
+        e,
+        { sidekick_name: "robin" }, 
+        {} # config
+      )
+
+      assert_requested unwrapped_stub
+      assert response && response.success?, "Expected success, got #{response.class}: #{response.inspect}"
+  end
+
+  def test_failured_backend_ignores_retries_if_configured
+    Raygun.configuration.track_retried_sidekiq_jobs = false
+    
+    begin
+      raise StandardError.new("Some job in Sidekiq failed, oh dear!")
+    rescue
+      raise Sidekiq::JobRetry::Handled
+    end
+
+    rescue Sidekiq::JobRetry::Handled => e
+
+      refute Raygun::SidekiqReporter.call(e,
+        { sidekick_name: "robin" }, 
+        {} # config
+      )
+  ensure
+    Raygun.configuration.track_retried_sidekiq_jobs = true
+  end
+
+  # See https://github.com/MindscapeHQ/raygun4ruby/issues/183
+  # (This is how Sidekiq pre 7.1.5 calls error handlers: https://github.com/sidekiq/sidekiq/blob/1ba89bbb22d2fd574b11702d8b6ed63ae59e2256/lib/sidekiq/config.rb#L269)
+  def test_failure_backend_appears_to_work_without_config_argument
+    response = Raygun::SidekiqReporter.call(
+      StandardError.new("Oh no! Your Sidekiq has failed!"),
+      { sidekick_name: "robin" }
+    )
+
+    assert response && response.success?, "Expected success, got #{response.class}: #{response.inspect}"
+  end
+
   def test_we_are_in_sidekiqs_list_of_error_handlers
     # Sidekiq 7.x stores error handlers inside a configuration object, while 6.x and below stores them directly against the Sidekiq module
     error_handlers = Sidekiq.respond_to?(:error_handlers) ? Sidekiq.error_handlers : Sidekiq.default_configuration.error_handlers
@@ -39,4 +97,26 @@ class SidekiqFailureTest < Raygun::UnitTest
     assert error_handlers.include?(Raygun::SidekiqReporter)
   end
 
+  def test_rails_error_reporter_uses_sidekiq_reporter
+    WebMock.reset!
+
+    tagged_request = stub_request(:post, 'https://api.raygun.com/entries').
+      with(body: /"sidekiq"/). # should have a sidekiq tag!
+      to_return(status: 202)
+
+    error = StandardError.new("Oh no! Your Sidekiq has failed!")
+
+    response = Raygun::ErrorSubscriber.new.report(
+      error,
+      handled: true,
+      severity: "error",
+      context: { sidekick_name: "robin" },
+      source: "job.sidekiq"
+    )
+
+    assert response && response.success?, "Expected success, got #{response.class}: #{response.inspect}"
+
+    assert_requested tagged_request
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: raygun4ruby
 version: !ruby/object:Gem::Version
-  version: 4.0.0.pre
+  version: 4.0.1
 platform: ruby
 authors:
 - Mindscape
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-04 00:00:00.000000000 Z
+date: 2024-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty