sidekiq-rescue 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7e9209b0b3fcb19ae0068540e6a83aedf56928457fd53584e6ebf7397ef541a
-  data.tar.gz: debef2495e57e1452f19982777fb2238f75c811ab48a161f36858beff7f7a7e1
+  metadata.gz: 73ef52e3781eb80768b2ed8d3271ad8665537fb893d98d77a60b702377c8db08
+  data.tar.gz: c3a4bcb2bbbf95511379a8a0890a306e04c5cff10f1f13582352f82b2f25ecb3
 SHA512:
-  metadata.gz: 96620e97aeabdfb9bc0ed8df29216e5017409c28e126e0e41d3941b3dde8548b5a4ecf0c1e54253f6280a8046291f21e2110ab3c514673f26cb1a557b895f754
-  data.tar.gz: a01212d26bdfb69c4dd3377a89fdeae379f8a016d8e98087b5c916528e0a54191bdff9b99d5e41330e81b7d971aea0da18fcde7058d1f727d525ac57e29d72b6
+  metadata.gz: 32ce0eb6087e28f9ee95550e88f70d9ab2b808a516652673d5731fbcbdf61fe918425a294346c0eb81c775dcfde23086816776ff82ed669ebb5f778690a30a90
+  data.tar.gz: 6146c192a03de08da8e4da68a7b81adfe7e2d3de2142df62a83002d367208619a2a9d292107ade101af972a8b667588770f45218bee7da5b5d342cb672575efe

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [0.7.0] - 2026-04-18
+
+- Add `:polynomially_longer` built-in delay strategy for polynomial backoff (`executions**4 + 2` base, with configurable jitter) [#8](https://github.com/moofkit/sidekiq-rescue/pull/8)
+- Add `:exponentially_longer` built-in delay strategy for exponential backoff (`2**executions` base, with configurable jitter) [#14](https://github.com/moofkit/sidekiq-rescue/pull/14)
+- Bump and pin github actions [#15](https://github.com/moofkit/sidekiq-rescue/pull/14)
+
 ## [0.6.0] - 2025-03-15
 - Add support for Sidekiq 8.0, Ruby 3.4 [#6](https://github.com/moofkit/sidekiq-rescue/pull/6)
 
@@ -40,7 +46,8 @@
 - Add documentation
 - Add CI
 
-[Unreleased]: https://github.com/moofkit/sidekiq-rescue/compare/v0.6.0...HEAD
+[Unreleased]: https://github.com/moofkit/sidekiq-rescue/compare/v0.7.0...HEAD
+[0.6.0]: https://github.com/moofkit/sidekiq-rescue/releases/tag/v0.7.0
 [0.6.0]: https://github.com/moofkit/sidekiq-rescue/releases/tag/v0.6.0
 [0.5.0]: https://github.com/moofkit/sidekiq-rescue/releases/tag/v0.5.0
 [0.4.0]: https://github.com/moofkit/sidekiq-rescue/releases/tag/v0.4.0

data/README.md

@@ -20,6 +20,7 @@ class MyJob
   sidekiq_rescue ActiveRecord::Deadlocked, delay: 5.seconds.to_i, limit: 3
   sidekiq_rescue TooManyRequestsError, queue: "slow"
   sidekiq_rescue Net::OpenTimeout, Timeout::Error, limit: 10 # retries at most 10 times for Net::OpenTimeout and Timeout::Error combined
+  sidekiq_rescue FlakyServiceError, delay: :polynomially_longer
 
   def perform(*args)
     # Might raise CustomAppException, AnotherCustomAppException, or YetAnotherCustomAppException for something domain specific
@@ -91,16 +92,16 @@ class MyJob
 end
 ```
 
-* `delay` - the delay between retries in seconds
+* `delay` - the delay between retries in seconds. Accepts an `Integer`, `Float`, `Proc` (receives the retry counter), or a built-in strategy symbol (see **Built-in delay strategies** below).
 * `limit` - the number of retries. The number of attempts includes the original job execution.
 * `jitter` - represents the upper bound of possible wait time (expressed as a percentage) and defaults to 0.15 (15%)
 * `queue` - the queue to which the job will be enqueued if it fails
 
-The `delay` is not the exact time between retries, but a minimum delay. The actual delay calculates based on jitter and `delay` value. The formula is `delay + delay * jitter * rand` seconds. Randomization is used to avoid retry storms.
+The `delay` is not the exact time between retries, but a minimum delay. For fixed and proc-based delays, the actual delay is `delay + delay * jitter * rand` seconds. Randomization is used to avoid retry storms. Built-in delay strategy symbols define their own formulas.
 
 The default values are:
 - `delay`: 60 seconds
-- `limit`: 5 retries
+- `limit`: 10 retries
 - `jitter`: 0.15
 
 Delay, limit and jitter can be configured globally:
@@ -127,6 +128,48 @@ Sidekiq::Rescue.configure do |config|
 end
 ```
 
+### Built-in delay strategies
+
+The `delay:` option accepts the following built-in strategy symbols:
+
+#### `:polynomially_longer`
+
+Applies a polynomial backoff formula: `(executions**4 + 2) + (Kernel.rand * (executions**4 + 2) * jitter)`
+
+The `jitter:` option controls randomness (same semantics as for fixed delays). Setting `jitter: 0` makes the delay deterministic.
+
+| Attempt | Approx. delay (default jitter) |
+|---------|-------------------------------|
+| 1       | ~3s                           |
+| 2       | ~18s                          |
+| 3       | ~83s                          |
+| 4       | ~260s (~4m)                   |
+| 5       | ~627s (~10m)                  |
+
+```ruby
+sidekiq_rescue FlakyServiceError, delay: :polynomially_longer
+sidekiq_rescue FlakyServiceError, delay: :polynomially_longer, jitter: 0  # deterministic
+```
+
+#### `:exponentially_longer`
+
+Applies an exponential backoff formula: `(2**executions) + (Kernel.rand * (2**executions) * jitter)`
+
+The `jitter:` option controls randomness. Setting `jitter: 0` makes the delay deterministic.
+
+| Attempt | Delay (jitter: 0) | Approx. delay (default jitter) |
+|---------|-------------------|-------------------------------|
+| 1       | 2s                | ~2s                           |
+| 2       | 4s                | ~4s                           |
+| 3       | 8s                | ~9s                           |
+| 4       | 16s               | ~18s                          |
+| 5       | 32s               | ~37s                          |
+
+```ruby
+sidekiq_rescue FlakyServiceError, delay: :exponentially_longer
+sidekiq_rescue FlakyServiceError, delay: :exponentially_longer, jitter: 0  # deterministic
+```
+
 ### Testing
 
 1. Unit tests (recommended)

data/lib/sidekiq/rescue/dsl.rb

@@ -2,6 +2,8 @@
 
 module Sidekiq
   module Rescue
+    DELAY_STRATEGIES = %i[polynomially_longer exponentially_longer].freeze
+
     # This module is included into the job class to provide the Dsl for
     # configuring rescue options.
     module Dsl
@@ -15,7 +17,8 @@ module Sidekiq
         # Configure rescue options for the job.
         # @param error [StandardError] The error class to rescue.
         # @param error [Array<StandardError>] The error classes to rescue.
-        # @param delay [Integer, Float, Proc] The delay in seconds before retrying the job.
+        # @param delay [Integer, Float, Proc, Symbol] The delay in seconds before retrying the job.
+        #   Symbols like `:polynomially_longer` or `:exponentially_longer` are built-in delay strategies.
         # @param limit [Integer] The maximum number of retries.
         # @return [void]
         # @raise [ArgumentError] if error is not a StandardError
@@ -66,8 +69,10 @@ module Sidekiq
             return
           end
 
+          return if delay.is_a?(Symbol) && DELAY_STRATEGIES.include?(delay)
+
           raise ArgumentError,
-                "delay must be integer, float or proc"
+                "delay must be integer, float, proc, or one of: #{DELAY_STRATEGIES.join(", ")}"
         end
 
         def validate_limit_argument(limit)

data/lib/sidekiq/rescue/server_middleware.rb

@@ -49,9 +49,13 @@ module Sidekiq
       end
 
       def calculate_delay(delay, rescue_counter, jitter)
-        delay = delay.call(rescue_counter) if delay.is_a?(Proc)
-        jitter_delay = calculate_delay_jitter(jitter, delay)
-        delay + jitter_delay
+        base = case delay
+               when :polynomially_longer then (rescue_counter**4) + 2
+               when :exponentially_longer then 2**rescue_counter
+               when Proc                  then delay.call(rescue_counter)
+               else                            delay
+               end
+        base + calculate_delay_jitter(jitter, base)
       end
 
       def calculate_delay_jitter(jitter, delay)

data/lib/sidekiq/rescue/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module Rescue
-    VERSION = "0.6.0"
+    VERSION = "0.7.0"
   end
 end

data/lib/sidekiq/rescue.rb

@@ -30,6 +30,7 @@ module Sidekiq
 
     class << self
       extend Forwardable
+
       # Returns the logger instance
       #
       # @return [Logger] The logger instance.

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-rescue
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Dmitrii Ivliev
 bindir: bin
 cert_chain: []
-date: 2025-03-15 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -48,7 +48,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.6.0
+  documentation_uri: https://rubydoc.info/gems/sidekiq-rescue/0.7.0
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -64,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Rescue Sidekiq jobs on expected error and reschedule them
 test_files: []