resque-retry 1.5.0 → 1.8.0

data/test/resque_test.rb

@@ -1,11 +1,15 @@
 require 'test_helper'
 
-# make sure the worlds not fallen from beneith us.
 class ResqueTest < Minitest::Test
   def test_resque_version
-    major, minor, patch = Resque::Version.split('.')
-    assert_equal 1, major.to_i, 'major version does not match'
-    assert_operator minor.to_i, :>=, 8, 'minor version is too low'
+    major, minor, _ = resque_version.split('.')
+    assert [1, 2].include?(major.to_i), 'major version does not match'
+
+    if major.to_i == 1
+      assert_operator minor.to_i, :>=, 25, 'minor version is too low'
+    else
+      assert_operator minor.to_i, :>=, 0, 'minor version is too low'
+    end
   end
 
   def test_good_job
@@ -15,4 +19,14 @@ class ResqueTest < Minitest::Test
     assert_equal 1, Resque.info[:processed], 'processed job'
     assert_equal 0, Resque.delayed_queue_schedule_size
   end
+
+  private
+
+  def resque_version
+    begin
+      Resque::VERSION
+    rescue NameError
+      Resque::Version
+    end
+  end
 end

data/test/retry_custom_delay_test.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+
+class RetryCustomDelayTest < Minitest::Test
+  def setup
+    Resque.redis.flushall
+    @worker = Resque::Worker.new(:testing)
+    @worker.register_worker
+  end
+
+  def test_delay_with_exception
+    Resque.enqueue(DynamicDelayedJobOnException, 'arg1')
+    Resque.expects(:enqueue_in_with_queue).with(:testing, 4, DynamicDelayedJobOnException, 'arg1')
+
+    perform_next_job(@worker)
+  end
+
+  def test_delay_with_exception_and_args
+    Resque.enqueue(DynamicDelayedJobOnExceptionAndArgs, '3')
+    Resque.expects(:enqueue_in_with_queue).with(:testing, 3, DynamicDelayedJobOnExceptionAndArgs, '3')
+
+    perform_next_job(@worker)
+  end
+end

data/test/retry_exception_delay_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class RetryTest < Minitest::Test
+class RetryExceptionDelayTest < Minitest::Test
   def setup
     Resque.redis.flushall
     @worker = Resque::Worker.new(:testing)
@@ -43,4 +43,12 @@ class RetryTest < Minitest::Test
     assert_in_delta (start_time + 10), delayed[1], 1.00, '2nd retry delay timestamp'
     assert_in_delta (start_time + 15), delayed[2], 1.00, '3rd retry delay timestamp'
   end
+
+  def test_retry_delay_per_exception_multiple_delay_no_retry_limit_specified
+    # For this job-type there are 3 `Exception` types defined: `Exception`,
+    # `StandardError` and `Timeout::Error` -- their array-lengths are are 1, 3
+    # and 5 (respectively). We expect the `retry_limit` to default to the
+    # maximum length of the `Array` of delays or 1 (in this case: 5)
+    assert_equal 5, PerExceptionClassRetryCountArrayNoRetryLimitSpecifiedJob.retry_limit
+  end
 end

data/test/retry_queue_test.rb

@@ -0,0 +1,25 @@
+require 'test_helper'
+
+class RetryQueueTest < Minitest::Test
+  def setup
+    Resque.redis.flushall
+    @worker = Resque::Worker.new(:testing)
+    @worker.register_worker
+  end
+
+  def test_retry_delayed_failed_jobs_in_separate_queue
+    Resque.enqueue(DelayedJobWithRetryQueue, 'arg1')
+    Resque.expects(:enqueue_in_with_queue).with(:testing_retry_delegate, 1, JobRetryQueue, 'arg1')
+
+    perform_next_job(@worker)
+  end
+
+  def test_retry_delayed_failed_jobs_in_dynamic_queue
+    queue_name = "dynamic_queue_#{Time.now.to_i}"
+
+    Resque.enqueue(JobWithDynamicRetryQueue, queue_name)
+    Resque.expects(:enqueue_in_with_queue).with(queue_name, 1, JobWithDynamicRetryQueue, queue_name)
+
+    perform_next_job(@worker)
+  end
+end

data/test/retry_test.rb

@@ -18,8 +18,8 @@ class RetryTest < Minitest::Test
   def test_default_settings
     assert_equal 1, RetryDefaultSettingsJob.retry_limit, 'default retry limit'
     assert_equal 0, RetryDefaultSettingsJob.retry_attempt, 'default number of retry attempts'
-    assert_equal nil, RetryDefaultSettingsJob.fatal_exceptions, 'default fatal exceptions; nil = none'
-    assert_equal nil, RetryDefaultSettingsJob.retry_exceptions, 'default retry exceptions; nil = any'
+    assert_nil RetryDefaultSettingsJob.fatal_exceptions, 'default fatal exceptions; nil = none'
+    assert_nil RetryDefaultSettingsJob.retry_exceptions, 'default retry exceptions; nil = any'
     assert_equal 0, RetryDefaultSettingsJob.retry_delay, 'default seconds until retry'
   end
 
@@ -55,13 +55,6 @@ class RetryTest < Minitest::Test
     assert_equal test_args, job['args']
   end
 
-  def test_job_args_can_be_modified_by_overriding_args_for_retry
-    Resque.enqueue(DeprecatedRetryWithModifiedArgsJob)
-    DeprecatedRetryWithModifiedArgsJob.expects(:warn)
-    DeprecatedRetryWithModifiedArgsJob.expects(:args_for_retry)
-    perform_next_job(@worker)
-  end
-
   def test_job_args_can_be_modified_by_overriding_retry_args
     Resque.enqueue(RetryWithModifiedArgsJob)
     RetryWithModifiedArgsJob.expects(:retry_args)
@@ -221,9 +214,9 @@ class RetryTest < Minitest::Test
 
     perform_next_job(@worker)
 
-    assert job_from_retry_queue = Resque.pop(:testing_retry)
+    assert job_from_retry_queue = Resque.pop(:testing_retry_delegate)
     assert_equal ['arg1'], job_from_retry_queue['args']
-    assert_equal nil, Resque.redis.get(JobWithRetryQueue.redis_retry_key('arg1'))
+    assert_nil Resque.redis.get(JobWithRetryQueue.redis_retry_key('arg1'))
   end
 
   def test_clean_retry_key_should_splat_args
@@ -234,24 +227,17 @@ class RetryTest < Minitest::Test
     perform_next_job(@worker)
   end
 
-  def test_retry_delayed_failed_jobs_in_separate_queue
-    Resque.enqueue(DelayedJobWithRetryQueue, 'arg1')
-    Resque.expects(:enqueue_in).with(1, JobRetryQueue, 'arg1')
-
-    perform_next_job(@worker)
-  end
-
   def test_delete_redis_key_when_job_is_successful
     Resque.enqueue(GoodJob, 'arg1')
 
-    assert_equal nil, Resque.redis.get(GoodJob.redis_retry_key('arg1'))
+    assert_nil Resque.redis.get(GoodJob.redis_retry_key('arg1'))
     perform_next_job(@worker)
-    assert_equal nil, Resque.redis.get(GoodJob.redis_retry_key('arg1'))
+    assert_nil Resque.redis.get(GoodJob.redis_retry_key('arg1'))
   end
 
   def test_delete_redis_key_after_final_failed_retry
     Resque.enqueue(FailFiveTimesJob, 'yarrrr')
-    assert_equal nil, Resque.redis.get(FailFiveTimesJob.redis_retry_key('yarrrr'))
+    assert_nil Resque.redis.get(FailFiveTimesJob.redis_retry_key('yarrrr'))
 
     perform_next_job(@worker)
     assert_equal '0', Resque.redis.get(FailFiveTimesJob.redis_retry_key('yarrrr'))
@@ -262,7 +248,7 @@ class RetryTest < Minitest::Test
     5.times do
       perform_next_job(@worker)
     end
-    assert_equal nil, Resque.redis.get(FailFiveTimesJob.redis_retry_key('yarrrr'))
+    assert_nil Resque.redis.get(FailFiveTimesJob.redis_retry_key('yarrrr'))
 
     assert_equal 5, Resque.info[:failed], 'failed jobs'
     assert_equal 6, Resque.info[:processed], 'processed job'
@@ -285,10 +271,14 @@ class RetryTest < Minitest::Test
   end
 
   def test_retry_delay
+    assert_equal 0, NoRetryDelayJob.retry_delay
     assert_equal 3, NormalRetryCountJob.retry_delay
-    assert_equal 7, PerExceptionClassRetryCountJob.retry_delay(RuntimeError)
-    assert_equal 11, PerExceptionClassRetryCountJob.retry_delay(Exception)
-    assert_equal 13, PerExceptionClassRetryCountJob.retry_delay(Timeout::Error)
+    assert_equal 7, PerExceptionClassRetryCountJob.retry_delay(StandardError)
+    assert_equal 7, PerExceptionClassRetryCountJob.retry_delay(CustomException)
+    assert_equal 11, PerExceptionClassRetryCountJob.retry_delay(AnotherCustomException)
+    assert_equal 13, PerExceptionClassRetryCountJob.retry_delay(HierarchyCustomException)
+
+    assert_equal 7, PerExceptionClassRetryCountJob.instance_variable_get("@retry_exceptions")[CustomException]
   end
 
   def test_expire_key_set
@@ -297,6 +287,12 @@ class RetryTest < Minitest::Test
     perform_next_job(@worker)
   end
 
+  def test_expire_key_set_with_retry_exceptions
+    Resque.redis.expects(:expire).once.with(ExpiringJobWithRetryExceptions.redis_retry_key(StandardError), 17)
+    Resque.enqueue(ExpiringJobWithRetryExceptions, StandardError)
+    perform_next_job(@worker)
+  end
+
   def test_expire_key_setting_on_the_fly
     retry_key = 'resque-retry:FailFiveTimesWithCustomExpiryJob'
 
@@ -320,14 +316,14 @@ class RetryTest < Minitest::Test
       2.times do
         job = @worker.reserve
         child = fork do
-          Resque.redis.client.reconnect
+          Resque.redis.reconnect rescue Resque.redis.client.reconnect
           job.perform
         end
         Process.waitpid(child)
         job.fail(Resque::DirtyExit.new)
       end
 
-      assert_equal nil, @worker.reserve
+      assert_nil @worker.reserve
     end
   end
 end

data/test/test_helper.rb

@@ -1,13 +1,8 @@
 dir = File.dirname(File.expand_path(__FILE__))
 $LOAD_PATH.unshift dir + '/../lib'
-$TESTING = true
 
-require 'rubygems'
-require 'timeout'
-require 'minitest/autorun'
-require 'minitest/pride'
-require 'rack/test'
-require 'mocha/setup'
+$TESTING = true
+$VERBOSE = ENV['VERBOSE'] != 'true' ? nil : true
 
 # Run code coverage in MRI 1.9 only.
 if RUBY_VERSION >= '1.9' && RUBY_ENGINE == 'ruby'
@@ -17,28 +12,39 @@ if RUBY_VERSION >= '1.9' && RUBY_ENGINE == 'ruby'
   end
 end
 
+require 'rubygems'
+require 'timeout'
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'rack/test'
+require 'mocha/setup'
+
 require 'resque-retry'
 require dir + '/test_jobs'
 
-# make sure we can run redis-server
-if !system('which redis-server')
-  puts '', "** `redis-server` was not found in your PATH"
-  abort ''
-end
+if ENV['CI'] != 'true'
+  # make sure we can run redis-server
+  if !system('which redis-server')
+    puts '', "** `redis-server` was not found in your PATH"
+    abort ''
+  end
 
-# make sure we can shutdown the server using cli.
-if !system('which redis-cli')
-  puts '', "** `redis-cli` was not found in your PATH"
-  abort ''
-end
+  # make sure we can shutdown the server using cli.
+  if !system('which redis-cli')
+    puts '', "** `redis-cli` was not found in your PATH"
+    abort ''
+  end
 
-# This code is run after all the tests have finished running to ensure that the
-# Redis server is shutdowa
-Minitest.after_run { `redis-cli -p 9736 shutdown nosave` }
+  # This code is run after all the tests have finished running to ensure that the
+  # Redis server is shutdowa
+  Minitest.after_run { `redis-cli -p 9736 shutdown nosave` }
 
-puts "Starting redis for testing at localhost:9736..."
-`redis-server #{dir}/redis-test.conf`
-Resque.redis = '127.0.0.1:9736'
+  puts "Starting redis for testing at localhost:9736..."
+  `redis-server #{dir}/redis-test.conf`
+  Resque.redis = '127.0.0.1:9736'
+else
+  Resque.redis = '127.0.0.1:6379'
+end
 
 # Test helpers
 class Minitest::Test
@@ -65,11 +71,11 @@ class Minitest::Test
 
   def delayed_jobs
     # The double-checks here are so that we won't blow up if the config stops using redis-namespace
-    timestamps = Resque.redis.zrange("resque:delayed_queue_schedule", 0, -1) + 
+    timestamps = Resque.redis.zrange("resque:delayed_queue_schedule", 0, -1) +
                  Resque.redis.zrange("delayed_queue_schedule", 0, -1)
 
     delayed_jobs_as_json = timestamps.map do |timestamp|
-      Resque.redis.lrange("resque:delayed:#{timestamp}", 0, -1) + 
+      Resque.redis.lrange("resque:delayed:#{timestamp}", 0, -1) +
       Resque.redis.lrange("delayed:#{timestamp}", 0, -1)
     end.flatten
 

data/test/test_jobs.rb

@@ -7,7 +7,7 @@ class NoRetryJob
   @queue = :testing
 
   def self.perform(*args)
-    raise "error"
+    raise 'error'
   end
 end
 
@@ -28,6 +28,17 @@ class ExpiringJob
   end
 end
 
+class ExpiringJobWithRetryExceptions
+  extend Resque::Plugins::Retry
+
+  @queue = :testing
+  @expire_retry_key_after = 10
+  @retry_exceptions = { StandardError => 7 }
+
+  def self.perform(*args)
+  end
+end
+
 class RetryDefaultSettingsJob
   extend Resque::Plugins::Retry
   @queue = :testing
@@ -56,7 +67,7 @@ end
 
 class JobRetryQueue
   extend Resque::Plugins::Retry
-  @queue = :testing_retry
+  @queue = :testing_retry_delegate
 
   def self.perform(*args)
   end
@@ -72,6 +83,50 @@ class JobWithRetryQueue
   end
 end
 
+class JobWithDynamicRetryQueue
+  extend Resque::Plugins::Retry
+  @queue = :testing
+  @retry_delay = 1
+
+  def self.retry_queue(exception, *args)
+    args.first
+  end
+
+  def self.perform(*args)
+    raise
+  end
+end
+
+class DynamicDelayedJobOnExceptionAndArgs
+  extend Resque::Plugins::Retry
+  @queue = :testing
+
+  def self.retry_delay(exception, *args)
+    args.first.to_i
+  end
+
+  def self.perform(*args)
+    raise
+  end
+end
+
+class DynamicDelayedJobOnException
+  extend Resque::Plugins::Retry
+  @queue = :testing
+
+  def self.retry_delay(exception)
+    if exception == SocketError
+      4
+    else
+      1
+    end
+  end
+
+  def self.perform(*args)
+    raise SocketError
+  end
+end
+
 class DelayedJobWithRetryQueue
   extend Resque::Plugins::Retry
   @queue = :testing
@@ -102,14 +157,6 @@ class InheritTestWithMoreExtraJob < InheritTestWithExtraJob
   end
 end
 
-class DeprecatedRetryWithModifiedArgsJob < RetryDefaultsJob
-  @queue = :testing
-
-  def self.args_for_retry(*args)
-    # NOTE: implementation is irrelevant we only care that it's invoked
-  end
-end
-
 class RetryWithModifiedArgsJob < RetryDefaultsJob
   @queue = :testing
 
@@ -207,6 +254,12 @@ class ExponentialBackoffWithRetryDelayMultiplicandMinAndMaxJob < RetryDefaultsJo
   @retry_delay_multiplicand_max = 3.0
 end
 
+class ExponentialBackoffWithExpiryJob < RetryDefaultsJob
+  extend Resque::Plugins::ExponentialBackoff
+  @queue = :testing
+  @expire_retry_key_after = 60 * 60
+end
+
 class InvalidRetryDelayMaxConfigurationJob
   @queue = :testing
   @retry_delay_multiplicand_max = 0.9
@@ -320,8 +373,15 @@ class BaseJob < AsyncJob
 
     def inherited(subclass)
       super
-      %w(@retry_exceptions @retry_delay @retry_limit @auto_retry_limit).each do |variable|
-        value = BaseJob.instance_variable_get(variable)
+      %i[
+        @auto_retry_limit
+        @retry_delay
+        @retry_exceptions
+        @retry_limit
+      ].each do |variable|
+        value = nil
+        value = BaseJob.instance_variable_get(variable) \
+          if BaseJob.instance_variable_defined?(variable)
         value = value.dup rescue value
         subclass.instance_variable_set(variable, value)
       end
@@ -483,6 +543,13 @@ class CustomRetryIdentifierFailingJob
   end
 end
 
+class NoRetryDelayJob
+  extend Resque::Plugins::Retry
+
+  @queue = :testing
+  @retry_exceptions = {}
+end
+
 class NormalRetryCountJob
   extend Resque::Plugins::Retry
 
@@ -496,7 +563,7 @@ class PerExceptionClassRetryCountJob
 
   @queue = :testing
   @retry_limit = 3
-  @retry_exceptions = { RuntimeError => 7, Exception => 11, Timeout::Error => 13 }
+  @retry_exceptions = { StandardError => 7, AnotherCustomException => 11, HierarchyCustomException => 13 }
 
   def self.perform
     raise RuntimeError, 'I always fail with a RuntimeError'
@@ -515,6 +582,17 @@ class PerExceptionClassRetryCountArrayJob
   end
 end
 
+class PerExceptionClassRetryCountArrayNoRetryLimitSpecifiedJob
+  extend Resque::Plugins::Retry
+
+  @queue = :testing
+  @retry_exceptions = { Exception => 11, RuntimeError => [5, 10, 15],  Timeout::Error => [2, 4, 6, 8, 10] }
+
+  def self.perform
+    raise RuntimeError, 'I always fail with a RuntimeError'
+  end
+end
+
 # We can't design a job to fail during connect, see perform_next_job_fail_on_reconnect
 class FailsDuringConnectJob < RetryDefaultsJob
   @queue = :testing
@@ -579,3 +657,15 @@ class RetryCallbacksJob
 
   give_up_callback :on_give_up_c
 end
+
+class IgnoreExceptionsJob
+  extend Resque::Plugins::Retry
+  @queue = :testing
+  @ignore_exceptions = [CustomException]
+  @retry_exceptions = [CustomException, AnotherCustomException]
+  @retry_limit = 3
+
+  def self.perform
+    "Hello, World!"
+  end
+end

metadata

@@ -1,45 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: resque-retry
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Luke Antins
 - Ryan Carver
 - Jonathan W. Zaleski
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-10-24 00:00:00.000000000 Z
+date: 2023-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: resque
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.25'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.25'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: resque-scheduler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -102,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -155,8 +167,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
 - Gemfile
 - HISTORY.md
 - LICENSE
@@ -181,13 +193,17 @@ files:
 - lib/resque/plugins/retry/logging.rb
 - resque-retry.gemspec
 - test/exponential_backoff_test.rb
+- test/ignore_exceptions_test.rb
 - test/multiple_failure_test.rb
 - test/redis-test.conf
+- test/resque_inline_test.rb
 - test/resque_test.rb
 - test/retry_callbacks_test.rb
 - test/retry_criteria_test.rb
+- test/retry_custom_delay_test.rb
 - test/retry_exception_delay_test.rb
 - test/retry_inheriting_checks_test.rb
+- test/retry_queue_test.rb
 - test/retry_test.rb
 - test/server_helpers_test.rb
 - test/server_test.rb
@@ -198,7 +214,7 @@ homepage: http://github.com/lantins/resque-retry
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -213,11 +229,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.2
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: A resque plugin; provides retry, delay and exponential backoff support for
   resque jobs.
 test_files: []
-has_rdoc: false

data/.travis.yml

@@ -1,15 +0,0 @@
-language: ruby
-
-matrix:
-  allow_failures:
-    - rvm: jruby-19mode
-    - rvm: rbx-2
-
-rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
-  - 2.1.1
-  - 2.1.2
-  - jruby-19mode
-  - rbx-2