raygun4ruby 4.0.1 → 4.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a0724f9d47f49615745fe91cc15eb47c033036cfa20c8bb0432c7bcc9bebb33
-  data.tar.gz: d5addaabbd8cac2efaf4bcd919246113f8ca5c3220dd976a51cb6f51cd1a8bb5
+  metadata.gz: f1f1acdc84e42b8f39dd817b3e3b74e39dd18b07c675f46afa1cb57bf42bb435
+  data.tar.gz: 6ca0a6036d1d56d23e66105c5535ccc8687973b55b32e461d7643543693e475a
 SHA512:
-  metadata.gz: 59aba8123eb5282a7d1589a65d721579e594cd2dc5b5fdfb7e05f14b9bc711242cdeac17f907c41e67813b029658f9f03049637ce54e99c0ba22c22426720507
-  data.tar.gz: '0597d91a00bbe36f2d13d26f9116ddb16b792c9f30393b6d73f60714b762f7787d58eefe61dab621cab149d24c8a241018e088ac5e63d67245a31c7218b95fa1'
+  metadata.gz: 318c63ba10cb3645f7c75b81f1f4da06de5f361650f3ae7b3a32cc229fa9670589b742952e3cbb1929cfb02d581bdac3fd45c120b957645bea5c9339096021ff
+  data.tar.gz: 396e058ef6bb5fe5a802a6430c548d3133e2b50000af67bdca300cb280c211d2f5464fb12afe4c3c694e658c5887c1983f1d7af08e4cbc2b535c88be75917558

data/lib/raygun/configuration.rb

@@ -86,6 +86,12 @@ module Raygun
     # How long to wait for the POST request to the API server before timing out
     config_option :error_report_send_timeout
 
+    # How many times to try sending to Raygun before giving up
+    config_option :error_report_max_attempts
+
+    # Whether or not we should raise an exception if the error reporting fails
+    config_option :raise_on_failed_error_report
+
     # Should we register an error handler with [Rails' built in API](https://edgeguides.rubyonrails.org/error_reporting.html)
     config_option :register_rails_error_handler
 
@@ -147,6 +153,8 @@ module Raygun
         record_raw_data:               false,
         send_in_background:            false,
         error_report_send_timeout:     10,
+        error_report_max_attempts:     1,
+        raise_on_failed_error_report:  false,
         track_retried_sidekiq_jobs:    true
       )
     end

data/lib/raygun/version.rb

@@ -1,3 +1,3 @@
 module Raygun
-  VERSION = "4.0.1"
+  VERSION = "4.0.2"
 end

data/lib/raygun.rb

@@ -60,15 +60,15 @@ module Raygun
       !!configuration.api_key
     end
 
-    def track_exception(exception_instance, env = {}, user = nil, retry_count = 1)
+    def track_exception(exception_instance, env = {}, user = nil, retries_remaining = configuration.error_report_max_attempts - 1)
       log('tracking exception')
       
       exception_instance.set_backtrace(caller) if exception_instance.is_a?(Exception) && exception_instance.backtrace.nil?
 
       result = if configuration.send_in_background
-        track_exception_async(exception_instance, env, user, retry_count)
+        track_exception_async(exception_instance, env, user, retries_remaining)
       else
-        track_exception_sync(exception_instance, env, user, retry_count)
+        track_exception_sync(exception_instance, env, user, retries_remaining)
       end
 
       result
@@ -128,10 +128,10 @@ module Raygun
 
     private
 
-    def track_exception_async(exception_instance, env, user, retry_count)
+    def track_exception_async(exception_instance, env, user, retries_remaining)
       env[:rg_breadcrumb_store] = Raygun::Breadcrumbs::Store.take_until_size(Client::MAX_BREADCRUMBS_SIZE) if Raygun::Breadcrumbs::Store.any?
 
-      future = Concurrent::Future.execute { track_exception_sync(exception_instance, env, user, retry_count) }
+      future = Concurrent::Future.execute { track_exception_sync(exception_instance, env, user, retries_remaining) }
       future.add_observer(lambda do |_, value, reason|
         if value == nil || !value.responds_to?(:response) || value.response.code != "202"
           log("unexpected response from Raygun, could indicate error: #{value.inspect}")
@@ -143,7 +143,7 @@ module Raygun
       future
     end
 
-    def track_exception_sync(exception_instance, env, user, retry_count)
+    def track_exception_sync(exception_instance, env, user, retries_remaining)
       if should_report?(exception_instance)
         log('attempting to send exception')
         resp = Client.new.track_exception(exception_instance, env, user)
@@ -158,18 +158,25 @@ module Raygun
         failsafe_log("Problem reporting exception to Raygun: #{e.class}: #{e.message}\n\n#{e.backtrace.join("\n")}")
       end
 
-      if retry_count > 0
+      if retries_remaining > 0
         new_exception = e.exception("raygun4ruby encountered an exception processing your exception")
         new_exception.set_backtrace(e.backtrace)
 
         env[:custom_data] ||= {}
-        env[:custom_data].merge!(original_stacktrace: exception_instance.backtrace)
+        env[:custom_data].merge!(original_stacktrace: exception_instance.backtrace, retries_remaining: retries_remaining)
 
         ::Raygun::Breadcrumbs::Store.clear
 
-        track_exception(new_exception, env, user, retry_count - 1)
+        track_exception(new_exception, env, user, retries_remaining - 1)
       else
-        raise e
+        if configuration.raise_on_failed_error_report
+          raise e
+        else
+          retries = configuration.error_report_max_attempts - retries_remaining
+          if configuration.failsafe_logger
+            failsafe_log("Gave up reporting exception to Raygun after #{retries} #{retries == 1 ? "retry" : "retries"}: #{e.class}: #{e.message}\n\n#{e.backtrace.join("\n")}")
+          end
+        end
       end
     end
 

data/raygun4ruby.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "json"
   spec.add_runtime_dependency "rack"
   spec.add_runtime_dependency "concurrent-ruby"
+  spec.add_runtime_dependency "ostruct"
 
   spec.add_development_dependency "bundler", ">= 2.3"
   spec.add_development_dependency "rake", ">= 12.3.3"

data/test/unit/raygun_test.rb

@@ -103,4 +103,43 @@ class RaygunTest < Raygun::UnitTest
     assert_equal Raygun.default_configuration.api_url, Raygun.configuration.api_url
     refute_equal original_api_url, Raygun.configuration.api_url
   end
+
+  def test_retries 
+    failsafe_logger = FakeLogger.new
+    Raygun.setup do |c|
+      c.error_report_max_attempts = 3
+      c.failsafe_logger = failsafe_logger
+    end  
+
+    WebMock.reset!
+    report_request = stub_request(:post, "https://api.raygun.com/entries").to_timeout
+
+    error = StandardError.new
+    Raygun.track_exception(error)
+
+    assert_requested report_request, times: 3
+
+    assert_match(/Gave up reporting exception to Raygun after 3 retries/, failsafe_logger.get)
+  ensure
+    Raygun.reset_configuration
+  end
+
+  def test_raising_on_retry_failure
+    Raygun.setup do |c|
+      c.error_report_max_attempts = 1
+      c.raise_on_failed_error_report = true
+    end  
+
+    report_request = stub_request(:post, "https://api.raygun.com/entries").to_timeout
+
+    error = StandardError.new
+
+    assert_raises(StandardError) do
+      Raygun.track_exception(error)
+      assert_requested report_request
+    end
+
+  ensure
+    Raygun.reset_configuration
+  end
 end

data/test/unit/sidekiq_failure_test.rb

@@ -48,16 +48,16 @@ class SidekiqFailureTest < Raygun::UnitTest
       raise Sidekiq::JobRetry::Handled
     end
 
-    rescue Sidekiq::JobRetry::Handled => e
+  rescue Sidekiq::JobRetry::Handled => e
 
-      response = Raygun::SidekiqReporter.call(
-        e,
-        { sidekick_name: "robin" }, 
-        {} # config
-      )
+    response = Raygun::SidekiqReporter.call(
+      e,
+      { sidekick_name: "robin" }, 
+      {} # config
+    )
 
-      assert_requested unwrapped_stub
-      assert response && response.success?, "Expected success, got #{response.class}: #{response.inspect}"
+    assert_requested unwrapped_stub
+    assert response && response.success?, "Expected success, got #{response.class}: #{response.inspect}"
   end
 
   def test_failured_backend_ignores_retries_if_configured
@@ -69,12 +69,12 @@ class SidekiqFailureTest < Raygun::UnitTest
       raise Sidekiq::JobRetry::Handled
     end
 
-    rescue Sidekiq::JobRetry::Handled => e
+  rescue Sidekiq::JobRetry::Handled => e
 
-      refute Raygun::SidekiqReporter.call(e,
-        { sidekick_name: "robin" }, 
-        {} # config
-      )
+    refute Raygun::SidekiqReporter.call(e,
+      { sidekick_name: "robin" }, 
+      {} # config
+    )
   ensure
     Raygun.configuration.track_retried_sidekiq_jobs = true
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: raygun4ruby
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.0.2
 platform: ruby
 authors:
 - Mindscape
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-28 00:00:00.000000000 Z
+date: 2024-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -67,6 +67,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement