instance method `discard_on`

Ruby on Rails 8.1.2

Since v5.2.8.1

Available in: v5.2.8.1 v6.0.6 v6.1.7.10 v7.0.10 v7.1.6 v7.2.3 v8.0.4 v8.1.2

Compare with:

discard_on(*exceptions, report: false)

Discard the job with no attempts to retry, if the exception is raised. This is useful when the subject of the job, like an Active Record, is no longer available, and the job is thus no longer relevant.

Passing the :report option reports the error through the error reporter before discarding the job.

You can also pass a block that’ll be invoked. This block is yielded with the job instance as the first and the error instance as the second parameter.

retry_on and discard_on handlers are searched from bottom to top, and up the class hierarchy. The handler of the first class for which exception.is_a?(klass) holds true is the one invoked, if any.

Example

class SearchIndexingJob < ActiveJob::Base
  discard_on ActiveJob::DeserializationError
  discard_on CustomAppException, report: true
  discard_on(AnotherCustomAppException) do |job, error|
    CustomErrorHandlingCode.handle(job, error)
  end

  def perform(record)
    # Will raise ActiveJob::DeserializationError if the record can't be deserialized
    # Might raise CustomAppException for something domain specific
  end
end

Parameters

exceptions rest
report key = false

Source

# File activejob/lib/active_job/exceptions.rb, line 109
      def discard_on(*exceptions, report: false)
        rescue_from(*exceptions) do |error|
          instrument :discard, error: error do
            ActiveSupport.error_reporter.report(error, source: "application.active_job") if report
            yield self, error if block_given?
            run_after_discard_procs(error)
          end
        end
      end

Defined in activejob/lib/active_job/exceptions.rb line 109 · View on GitHub · Improve this page · Find usages on GitHub

Defined in ActiveJob::Exceptions::ClassMethods

Signature

Example

Parameters