Module: Axn::Async::Adapters::Sidekiq::RetryHelpers

Defined in:
lib/axn/async/adapters/sidekiq/retry_helpers.rb

Overview

Shared helpers for extracting retry information from Sidekiq jobs

Constant Summary collapse

SIDEKIQ_DEFAULT_RETRIES =

Sidekiq’s built-in default when retry: true or retry not specified

25

Class Method Summary collapse

Class Method Details

.build_retry_context(job, from_death_handler: false) ⇒ Object

Builds an Axn::Async::RetryContext from a Sidekiq job hash. Used by both middleware and death handler to ensure consistent context.

Parameters:

  • from_death_handler (Boolean) (defaults to: false) —

    When true, subtracts 1 from the computed attempt because Sidekiq increments retry_count before calling death handlers, so the value in the job hash is one higher than the retry_count present during the last execution.



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/axn/async/adapters/sidekiq/retry_helpers.rb', line 50

def build_retry_context(job, from_death_handler: false)
  attempt = extract_attempt_number(job)
  # Sidekiq increments retry_count before calling retries_exhausted/death handlers,
  # so the job hash has retry_count = last_execution_retry_count + 1. Subtract 1 to
  # recover the actual last execution's attempt number. Guard on non-nil: when Sidekiq
  # calls death handlers directly (retry: false), retry_count is absent and attempt is
  # already correct.
  attempt -= 1 if from_death_handler && !job["retry_count"].nil?
  RetryContext.new(
    adapter: :sidekiq,
    attempt:,
    max_retries: extract_max_retries(job),
    job_id: job["jid"],
  )
end

.extract_attempt_number(job) ⇒ Object

Calculates the attempt number from Sidekiq’s retry_count field. Sidekiq’s retry_count semantics:

  • nil: first execution (attempt 1)

  • 0: first retry after first failure (attempt 2)

  • 1: second retry (attempt 3)

  • etc.



39
40
41
42
 
# File 'lib/axn/async/adapters/sidekiq/retry_helpers.rb', line 39

def extract_attempt_number(job)
  retry_count = job["retry_count"]
  retry_count.nil? ? 1 : retry_count + 2
end

.extract_max_retries(job) ⇒ Object

Extracts the maximum number of retries from a Sidekiq job hash. Sidekiq’s retry option can be:

  • true or nil: use Sidekiq default (25), unless config override is set

  • false: no retries (0)

  • an integer: explicit retry count

If Axn.config.async_max_retries is explicitly set, it overrides the Sidekiq default (but not explicit per-job integer values).



22
23
24
25
26
27
28
29
30
31
 
# File 'lib/axn/async/adapters/sidekiq/retry_helpers.rb', line 22

def extract_max_retries(job)
  retry_option = job["retry"]
  case retry_option
  when false then 0
  when Integer then retry_option
  else
    # true, nil, or unknown value - use config override if set, else Sidekiq default
    Axn.config.async_max_retries || SIDEKIQ_DEFAULT_RETRIES
  end
end