Add exponentially_longer and custom wait algorithms

上级 08a92d47
......@@ -12,7 +12,10 @@ module ClassMethods
# holding queue for inspection.
#
# ==== Options
# * <tt>:wait</tt> - Re-enqueues the job with the specified delay in seconds (default: 3 seconds)
# * <tt>:wait</tt> - Re-enqueues the job with a delay specified either in seconds (default: 3 seconds),
# as a computing proc that the number of executions so far as an argument, or as a symbol reference of
# <tt>:exponentially_longer<>, which applies the wait algorithm of <tt>(executions ** 4) + 2</tt>
# (first wait 3s, then 18s, then 83s, etc)
# * <tt>:attempts</tt> - Re-enqueues the job the specified number of times (default: 5 attempts)
# * <tt>:queue</tt> - Re-enqueues the job on a different queue
# * <tt>:priority</tt> - Re-enqueues the job with a different priority
......@@ -20,9 +23,14 @@ module ClassMethods
# ==== Examples
#
# class RemoteServiceJob < ActiveJob::Base
# retry_on Net::OpenTimeout, wait: 30.seconds, attempts: 10
# retry_on CustomAppException # defaults to 3s wait, 5 attempts
# retry_on AnotherCustomAppException, wait: ->(executions) { executions * 2 }
# retry_on ActiveRecord::StatementInvalid, wait: 5.seconds, attempts: 3
# retry_on Net::OpenTimeout, wait: :exponentially_longer, attempts: 10
#
# def perform(*args)
# # Might raise CustomAppException or AnotherCustomAppException for something domain specific
# # Might raise ActiveRecord::StatementInvalid when a local db deadlock is detected
# # Might raise Net::OpenTimeout when the remote service is down
# end
# end
......@@ -30,7 +38,7 @@ def retry_on(exception, wait: 3.seconds, attempts: 5, queue: nil, priority: nil)
rescue_from exception do |error|
if executions < attempts
logger.error "Retrying #{self.class} in #{wait} seconds, due to a #{exception}. The original exception was #{error.cause.inspect}."
retry_job wait: wait, queue: queue, priority: priority
retry_job wait: determine_delay(wait), queue: queue, priority: priority
else
logger.error "Stopped retrying #{self.class} due to a #{exception}, which reoccurred on #{executions} attempts. The original exception was #{error.cause.inspect}."
raise error
......@@ -81,5 +89,19 @@ def discard_on(exception)
def retry_job(options = {})
enqueue options
end
private
def determine_delay(seconds_or_algorithm)
case seconds_or_algorithm
when :exponentially_longer
(executions ** 4) + 2
when Integer
seconds = seconds_or_algorithm
seconds
when Proc
algorithm = seconds_or_algorithm
algorithm.call(executions)
end
end
end
end
require 'helper'
require 'jobs/retry_job'
require 'byebug'
class ExceptionsTest < ActiveSupport::TestCase
setup do
......@@ -45,3 +46,41 @@ class ExceptionsTest < ActiveSupport::TestCase
assert_equal "Raised DiscardableError for the 1st time", JobBuffer.last_value
end
end
class ExponentiallyBackoffExceptionsTest < ActiveJob::TestCase
setup do
JobBuffer.clear
end
test "exponentially retrying job" do
travel_to Time.now
perform_enqueued_jobs do
assert_performed_with at: (Time.now + 3.seconds).to_i do
assert_performed_with at: (Time.now + 18.seconds).to_i do
assert_performed_with at: (Time.now + 83.seconds).to_i do
assert_performed_with at: (Time.now + 258.seconds).to_i do
RetryJob.perform_later 'ExponentialWaitTenAttemptsError', 5
end
end
end
end
end
end
test "custom wait retrying job" do
travel_to Time.now
perform_enqueued_jobs do
assert_performed_with at: (Time.now + 2.seconds).to_i do
assert_performed_with at: (Time.now + 4.seconds).to_i do
assert_performed_with at: (Time.now + 6.seconds).to_i do
assert_performed_with at: (Time.now + 8.seconds).to_i do
RetryJob.perform_later 'CustomWaitTenAttemptsError', 5
end
end
end
end
end
end
end
\ No newline at end of file
......@@ -3,11 +3,15 @@
class DefaultsError < StandardError; end
class ShortWaitTenAttemptsError < StandardError; end
class ExponentialWaitTenAttemptsError < StandardError; end
class CustomWaitTenAttemptsError < StandardError; end
class DiscardableError < StandardError; end
class RetryJob < ActiveJob::Base
retry_on DefaultsError
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
discard_on DiscardableError
def perform(raising, attempts)
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册