module ActiveJob::Exceptions

Provides behavior for retrying and discarding jobs on exceptions.

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 116
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:) click to toggle source
# File lib/active_job/exceptions.rb, line 123
def determine_delay(seconds_or_duration_or_algorithm:, executions:)
  case seconds_or_duration_or_algorithm
  when :exponentially_longer
    (executions**4) + 2
  when ActiveSupport::Duration
    duration = seconds_or_duration_or_algorithm
    duration.to_i
  when Integer
    seconds = seconds_or_duration_or_algorithm
    seconds
  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
executions_for(exceptions) click to toggle source
# File lib/active_job/exceptions.rb, line 147
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
instrument(name, error: nil, wait: nil, &block) click to toggle source
# File lib/active_job/exceptions.rb, line 141
def instrument(name, error: nil, wait: nil, &block)
  payload = { job: self, adapter: self.class.queue_adapter, error: error, wait: wait }

  ActiveSupport::Notifications.instrument("#{name}.active_job", payload, &block)
end