module ActiveJob::Exceptions

Provides behavior for retrying and discarding jobs on exceptions.

Constants

JITTER_DEFAULT

Public Instance Methods

retry_job(options = {}) click to toggle source

Reschedules the job to be re-executed. This is useful in combination with the rescue_from option. When you rescue an exception from your job you can ask Active Job to retry performing your job.

Options

  • :wait - Enqueues the job with the specified delay in seconds

  • :wait_until - Enqueues the job at the time specified

  • :queue - Enqueues the job on the specified queue

  • :priority - Enqueues the job with the specified priority

Examples

class SiteScraperJob < ActiveJob::Base
  rescue_from(ErrorLoadingSite) do
    retry_job queue: :low_priority
  end

  def perform(*args)
    # raise ErrorLoadingSite if cannot scrape
  end
end
# File lib/active_job/exceptions.rb, line 124
def retry_job(options = {})
  instrument :enqueue_retry, options.slice(:error, :wait) do
    enqueue options
  end
end

Private Instance Methods

determine_delay(seconds_or_duration_or_algorithm:, executions:, jitter: JITTER_DEFAULT) click to toggle source
# File lib/active_job/exceptions.rb, line 134
def determine_delay(seconds_or_duration_or_algorithm:, executions:, jitter: JITTER_DEFAULT)
  jitter = jitter == JITTER_DEFAULT ? self.class.retry_jitter : (jitter || 0.0)

  case seconds_or_duration_or_algorithm
  when :exponentially_longer
    delay = executions**4
    delay_jitter = determine_jitter_for_delay(delay, jitter)
    delay + delay_jitter + 2
  when ActiveSupport::Duration, Integer
    delay = seconds_or_duration_or_algorithm.to_i
    delay_jitter = determine_jitter_for_delay(delay, jitter)
    delay + delay_jitter
  when Proc
    algorithm = seconds_or_duration_or_algorithm
    algorithm.call(executions)
  else
    raise "Couldn't determine a delay based on #{seconds_or_duration_or_algorithm.inspect}"
  end
end
determine_jitter_for_delay(delay, jitter) click to toggle source
# File lib/active_job/exceptions.rb, line 154
def determine_jitter_for_delay(delay, jitter)
  return 0.0 if jitter.zero?
  Kernel.rand * delay * jitter
end
executions_for(exceptions) click to toggle source
# File lib/active_job/exceptions.rb, line 159
def executions_for(exceptions)
  if exception_executions
    exception_executions[exceptions.to_s] = (exception_executions[exceptions.to_s] || 0) + 1
  else
    # Guard against jobs that were persisted before we started having individual executions counters per retry_on
    executions
  end
end