Skip to content

Commit

Permalink
Allow passing multiple exceptions to retry_on/discard_on
Browse files Browse the repository at this point in the history
  • Loading branch information
georgeclaghorn committed Jun 25, 2018
1 parent 8324791 commit 3110cae
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 7 deletions.
14 changes: 7 additions & 7 deletions activejob/lib/active_job/exceptions.rb
Expand Up @@ -42,16 +42,16 @@ module ClassMethods
# # Might raise Net::OpenTimeout when the remote service is down
# end
# end
def retry_on(exception, wait: 3.seconds, attempts: 5, queue: nil, priority: nil)
rescue_from exception do |error|
def retry_on(*exceptions, wait: 3.seconds, attempts: 5, queue: nil, priority: nil)
rescue_from(*exceptions) do |error|
if executions < attempts
logger.error "Retrying #{self.class} in #{wait} seconds, due to a #{exception}. The original exception was #{error.cause.inspect}."
logger.error "Retrying #{self.class} in #{wait} seconds, due to a #{error.class}. The original exception was #{error.cause.inspect}."
retry_job wait: determine_delay(wait), queue: queue, priority: priority
else
if block_given?
yield self, error
else
logger.error "Stopped retrying #{self.class} due to a #{exception}, which reoccurred on #{executions} attempts. The original exception was #{error.cause.inspect}."
logger.error "Stopped retrying #{self.class} due to a #{error.class}, which reoccurred on #{executions} attempts. The original exception was #{error.cause.inspect}."
raise error
end
end
Expand All @@ -76,12 +76,12 @@ def retry_on(exception, wait: 3.seconds, attempts: 5, queue: nil, priority: nil)
# # Might raise CustomAppException for something domain specific
# end
# end
def discard_on(exception)
rescue_from exception do |error|
def discard_on(*exceptions)
rescue_from(*exceptions) do |error|
if block_given?
yield self, error
else
logger.error "Discarded #{self.class} due to a #{exception}. The original exception was #{error.cause.inspect}."
logger.error "Discarded #{self.class} due to a #{error.class}. The original exception was #{error.cause.inspect}."
end
end
end
Expand Down
18 changes: 18 additions & 0 deletions activejob/test/cases/exceptions_test.rb
Expand Up @@ -113,4 +113,22 @@ class ExceptionsTest < ActiveJob::TestCase
end
end
end

test "successfully retry job throwing one of two retryable exceptions" do
perform_enqueued_jobs do
RetryJob.perform_later "SecondRetryableErrorOfTwo", 3

assert_equal [
"Raised SecondRetryableErrorOfTwo for the 1st time",
"Raised SecondRetryableErrorOfTwo for the 2nd time",
"Successfully completed job" ], JobBuffer.values
end
end

test "discard job throwing one of two discardable exceptions" do
perform_enqueued_jobs do
RetryJob.perform_later "SecondDiscardableErrorOfTwo", 2
assert_equal [ "Raised SecondDiscardableErrorOfTwo for the 1st time" ], JobBuffer.values
end
end
end
7 changes: 7 additions & 0 deletions activejob/test/jobs/retry_job.rb
Expand Up @@ -4,22 +4,29 @@
require "active_support/core_ext/integer/inflections"

class DefaultsError < StandardError; end
class FirstRetryableErrorOfTwo < StandardError; end
class SecondRetryableErrorOfTwo < StandardError; end
class LongWaitError < StandardError; end
class ShortWaitTenAttemptsError < StandardError; end
class ExponentialWaitTenAttemptsError < StandardError; end
class CustomWaitTenAttemptsError < StandardError; end
class CustomCatchError < StandardError; end
class DiscardableError < StandardError; end
class FirstDiscardableErrorOfTwo < StandardError; end
class SecondDiscardableErrorOfTwo < StandardError; end
class CustomDiscardableError < StandardError; end

class RetryJob < ActiveJob::Base
retry_on DefaultsError
retry_on FirstRetryableErrorOfTwo, SecondRetryableErrorOfTwo
retry_on LongWaitError, wait: 1.hour, attempts: 10
retry_on ShortWaitTenAttemptsError, wait: 1.second, attempts: 10
retry_on ExponentialWaitTenAttemptsError, wait: :exponentially_longer, attempts: 10
retry_on CustomWaitTenAttemptsError, wait: ->(executions) { executions * 2 }, attempts: 10
retry_on(CustomCatchError) { |job, error| JobBuffer.add("Dealt with a job that failed to retry in a custom way after #{job.arguments.second} attempts. Message: #{error.message}") }

discard_on DiscardableError
discard_on FirstDiscardableErrorOfTwo, SecondDiscardableErrorOfTwo
discard_on(CustomDiscardableError) { |job, error| JobBuffer.add("Dealt with a job that was discarded in a custom way. Message: #{error.message}") }

def perform(raising, attempts)
Expand Down

0 comments on commit 3110cae

Please sign in to comment.