sidekiq-rescue 0.2.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1a8899e388b21924f60017c1eb3b724bc129bec25c96f4765a37ab1f1d8e7fb
-  data.tar.gz: 41c934da18716cf917af164e92ce1bccdcab1a5bbce08df1c4cbf6550d5cfe70
+  metadata.gz: f373ccbd6c038182766f55cd0d2091eb3052c2a008827b223aa9293728d41268
+  data.tar.gz: d6b8c96d73cb0690446be1b8330eda3f805a63f386d1778d5a1682d70e379037
 SHA512:
-  metadata.gz: a644feb9b9c4d3e1eef97d24738b1157c7efc370102d3db19db3df23f2133382878a264818b5a9a99059e1f64e9b60cbe8e4ea8b297757a760e00fb1df71865b
-  data.tar.gz: 678d83f42a1ffff8dd71def36911fcdc42b7cf2186e053e47b02c9d4237ea51efc2bd10ed003c7909ec830006b3e725b5e64253faca3c0d4555d97a8536be114
+  metadata.gz: 967dd0e178742e6dd1df06f0e5382d2a07d889a18007db15c7202f2725954c29916a866b182b1823e35fe24ad5252df791201e26045c456272ac74b36f1c82c8
+  data.tar.gz: 6ce5d97588e78c3cf1bd49e462a9af742bd7afa2fc25a5b6e798adc67a182e0d2236b8c24471d729de757a7cbb25d8544d7baac3e69d5fb01dec164fb72c34a8

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [Unreleased]
 
+## [0.3.1] - 2024-05-30
+
+- Fix bug with inheritance of DSL options
+
+## [0.3.0] - 2024-05-30
+
+- Fix issue with RSpec matcher when job is not rescueable
+- Add support for multiple invocations of the DSL #3
+- Update documentation with new features
+
 ## [0.2.1] - 2024-02-27
 
 - Fix readme with correct middleware name
@@ -20,7 +30,9 @@
 - Add documentation
 - Add CI
 
-[Unreleased]: https://github.com/moofkit/sidekiq-rescue/compare/v0.2.1...HEAD
+[Unreleased]: https://github.com/moofkit/sidekiq-rescue/compare/v0.3.1...HEAD
+[0.3.1]: https://github.com/moofkit/sidekiq-rescue/releases/tag/v0.3.1
+[0.3.0]: https://github.com/moofkit/sidekiq-rescue/releases/tag/v0.3.0
 [0.2.1]: https://github.com/moofkit/sidekiq-rescue/releases/tag/v0.2.1
 [0.2.0]: https://github.com/moofkit/sidekiq-rescue/releases/tag/v0.2.0
 [0.1.0]: https://github.com/moofkit/sidekiq-rescue/releases/tag/v0.1.0

data/README.md

@@ -3,6 +3,31 @@
 [![Build Status](https://github.com/moofkit/sidekiq-rescue/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/moofkit/sidekiq-rescue/actions/workflows/main.yml)
 
 [Sidekiq](https://github.com/sidekiq/sidekiq) plugin to rescue jobs from expected errors and retry them later.
+Catch expected errors and retry the job with a delay and a limit. It's useful when you want to retry jobs that failed due to expected errors and not spam your exception tracker with these errors. If the exception will getting raised beyond the limit, it will be re-raised and will be handled by Sidekiq standard retry mechanism.
+
+Handlers are searched from bottom to top, and up the inheritance chain. The first handler that `exception.is_a?(klass)` holds true will be used.
+
+## Example
+
+```ruby
+class MyJob
+  include Sidekiq::Job
+  include Sidekiq::Rescue::Dsl
+
+  sidekiq_rescue CustomAppException # defaults to 60 seconds delay and 10 retries
+  sidekiq_rescue AnotherCustomAppException, delay: ->(counter) { counter * 2 }
+  sidekiq_rescue CustomInfrastructureException, delay: 5.minutes
+  sidekiq_rescue ActiveRecord::Deadlocked, delay: 5.seconds, limit: 3
+  sidekiq_rescue Net::OpenTimeout, Timeout::Error, limit: 10 # retries at most 10 times for Net::OpenTimeout and Timeout::Error combined
+
+  def perform(*args)
+    # Might raise CustomAppException, AnotherCustomAppException, or YetAnotherCustomAppException for something domain specific
+    # Might raise ActiveRecord::Deadlocked when a local db deadlock is detected
+    # Might raise Net::OpenTimeout or Timeout::Error when the remote service is down
+  end
+end
+```
+
 
 ## Installation
 
@@ -224,7 +249,7 @@ end
 ## Motivation
 
 Sidekiq provides a retry mechanism for jobs that failed due to unexpected errors. However, it does not provide a way to retry jobs that failed due to expected errors. This gem aims to fill this gap.
-In addition, it provides a way to configure the number of retries and the delay between retries independently from the Sidekiq standard retry mechanism.
+In addition, it provides a way to configure the number of retries and the delay between retries independently from the Sidekiq standard retry mechanism. Mostly inspired by [ActiveJob](https://edgeapi.rubyonrails.org/classes/ActiveJob/Exceptions/ClassMethods.html#method-i-retry_on)
 
 ## Supported Ruby versions
 

data/lib/sidekiq/rescue/dsl.rb

@@ -24,16 +24,20 @@ module Sidekiq
         # @raise [ArgumentError] if limit is not an Integer
         # @example
         #  sidekiq_rescue NetworkError, delay: 60, limit: 10
-        def sidekiq_rescue(*error, delay: nil, limit: nil)
-          error = validate_and_unpack_error_argument(error)
+        def sidekiq_rescue(*errors, delay: Sidekiq::Rescue.config.delay, limit: Sidekiq::Rescue.config.limit)
+          unpacked_errors = validate_and_unpack_error_argument(errors)
           validate_delay_argument(delay)
           validate_limit_argument(limit)
+          assign_sidekiq_rescue_options(unpacked_errors, delay, limit)
+        end
 
-          self.sidekiq_rescue_options = {
-            error: error,
-            delay: delay || Sidekiq::Rescue.config.delay,
-            limit: limit || Sidekiq::Rescue.config.limit
-          }
+        # Find the error group and options for the given exception.
+        # @param exception [StandardError] The exception to find the error group for.
+        # @return [Array<StandardError>, Hash] The error group and options.
+        def sidekiq_rescue_error_group_with_options_by(exception)
+          sidekiq_rescue_options.reverse_each.find do |error_group, _options|
+            Array(error_group).any? { |error_klass| exception.is_a?(error_klass) }
+          end
         end
 
         private
@@ -63,6 +67,11 @@ module Sidekiq
         def validate_limit_argument(limit)
           raise ArgumentError, "limit must be integer" if limit && !limit.is_a?(Integer)
         end
+
+        def assign_sidekiq_rescue_options(errors, delay, limit)
+          self.sidekiq_rescue_options ||= {}
+          self.sidekiq_rescue_options = self.sidekiq_rescue_options.merge(errors => { delay: delay, limit: limit })
+        end
       end
     end
     # Alias for Dsl; TODO: remove in 1.0.0

data/lib/sidekiq/rescue/rspec/matchers.rb

@@ -28,11 +28,17 @@ module Sidekiq
           end
 
           match do |actual|
-            actual.is_a?(Class) &&
-              actual.include?(Sidekiq::Rescue::Dsl) &&
-              actual.sidekiq_rescue_options[:error].include?(expected) &&
-              (@delay.nil? || actual.sidekiq_rescue_options[:delay] == @delay) &&
-              (@limit.nil? || actual.sidekiq_rescue_options[:limit] == @limit)
+            matched = actual.is_a?(Class) &&
+                      actual.include?(Sidekiq::Rescue::Dsl) &&
+                      actual.respond_to?(:sidekiq_rescue_options) &&
+                      actual&.sidekiq_rescue_options&.keys&.flatten&.include?(expected)
+
+            return false unless matched
+
+            _error_group, options = actual.sidekiq_rescue_error_group_with_options_by(expected.new)
+
+            (@delay.nil? || options.fetch(:delay) == @delay) &&
+              (@limit.nil? || options.fetch(:limit) == @limit)
           end
 
           match_when_negated do |actual|
@@ -41,7 +47,8 @@ module Sidekiq
 
             actual.is_a?(Class) &&
               actual.include?(Sidekiq::Rescue::Dsl) &&
-              !actual.sidekiq_rescue_options[:error].include?(expected)
+              actual.respond_to?(:sidekiq_rescue_options) &&
+              !Array(actual&.sidekiq_rescue_options&.[](:error)).include?(expected)
           end
         end
       end

data/lib/sidekiq/rescue/server_middleware.rb

@@ -11,9 +11,8 @@ module Sidekiq
 
       def call(job_instance, job_payload, _queue, &block)
         job_class = job_instance.class
-        options = job_class.sidekiq_rescue_options if job_class.respond_to?(:sidekiq_rescue_options)
-        if options
-          sidekiq_rescue(job_payload, **options, &block)
+        if job_class.respond_to?(:sidekiq_rescue_options) && !job_class.sidekiq_rescue_options.nil?
+          sidekiq_rescue(job_payload, job_class, &block)
         else
           yield
         end
@@ -21,19 +20,28 @@ module Sidekiq
 
       private
 
-      def sidekiq_rescue(job_payload, delay:, limit:, error:, **)
+      def sidekiq_rescue(job_payload, job_class)
         yield
-      rescue *error => e
-        rescue_counter = increment_rescue_counter(job_payload)
-        raise e if rescue_counter > limit
+      rescue StandardError => e
+        error_group, options = job_class.sidekiq_rescue_error_group_with_options_by(e)
+        raise e unless error_group
+
+        rescue_error(e, error_group, options, job_payload)
+      end
+
+      def rescue_error(error, error_group, options, job_payload)
+        delay, limit = options.fetch_values(:delay, :limit)
+        rescue_counter = increment_rescue_counter_for(error_group, job_payload)
+        raise error if rescue_counter > limit
 
         reschedule_at = calculate_reschedule_time(delay, rescue_counter)
-        log_reschedule_info(rescue_counter, e, reschedule_at)
-        reschedule_job(job_payload, reschedule_at, rescue_counter)
+        log_reschedule_info(rescue_counter, error, reschedule_at)
+        reschedule_job(job_payload: job_payload, reschedule_at: reschedule_at, rescue_counter: rescue_counter,
+                       error_group: error_group)
       end
 
-      def increment_rescue_counter(job_payload)
-        rescue_counter = job_payload["sidekiq_rescue_counter"].to_i
+      def increment_rescue_counter_for(error_group, job_payload)
+        rescue_counter = job_payload.dig("sidekiq_rescue_exceptions_counter", error_group.to_s) || 0
         rescue_counter += 1
         rescue_counter
       end
@@ -52,8 +60,10 @@ module Sidekiq
                                     "#{error.message}; rescheduling at #{reschedule_at}")
       end
 
-      def reschedule_job(job_payload, reschedule_at, rescue_counter)
-        Sidekiq::Client.push(job_payload.merge("at" => reschedule_at, "sidekiq_rescue_counter" => rescue_counter))
+      def reschedule_job(job_payload:, reschedule_at:, rescue_counter:, error_group:)
+        payload = job_payload.merge("at" => reschedule_at,
+                                    "sidekiq_rescue_exceptions_counter" => { error_group.to_s => rescue_counter })
+        Sidekiq::Client.push(payload)
       end
     end
   end

data/lib/sidekiq/rescue/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module Rescue
-    VERSION = "0.2.1"
+    VERSION = "0.3.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-rescue
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors:
 - Dmitrii Ivliev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-27 00:00:00.000000000 Z
+date: 2024-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -50,7 +50,7 @@ metadata:
   homepage_uri: https://github.com/moofkit/sidekiq-rescue
   source_code_uri: https://github.com/moofkit/sidekiq-rescue
   changelog_uri: https://github.com/moofkit/sidekiq-rescue/blob/master/CHANGELOG.md
-  documentation_uri: https://rubydoc.info/gems/sidekiq-rescue/0.2.1
+  documentation_uri: https://rubydoc.info/gems/sidekiq-rescue/0.3.1
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -67,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Rescue Sidekiq jobs on expected error and reschedule them