resque-retry 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 105706892be947dafeb239f354c775e3bcb8df9d
-  data.tar.gz: 43c4248749336f1dd2a56fd561fcc0f56676ab30
+  metadata.gz: 66d34a270a535f97586c21a6c259d780c7a1ce9f
+  data.tar.gz: 9ab5f4591d2a99e262cc1ab2501d70e845f710aa
 SHA512:
-  metadata.gz: a6cc62c680c943615e628f65e64e7391bd8db8b8f9257ce8080690650bd55e7a0812e8ecc62001a8a608d1f82f9daa92ef6ca36c5498d6094f01a327a3d8f126
-  data.tar.gz: baf25c455e64044e2b3849df250d1b9a594b278b83903f41703d04a6c2b0ac56d3ec9ef6aa7bcadb0a672b658bd1251f8169b9f90893ed925754b265954b856e
+  metadata.gz: 03b4b70d9ef0e69d46d738fb3b6c1dd987e3e0e46cf3a2724300b50e1fbdcfc9f44d2af1b18b53999a21e74d48e335fe1a689e9885e14e784070ad5384f1fcac
+  data.tar.gz: 781a313ebd129ad8db24df9822b47bec750879aa2fa1abcc524df00228767c6a50eca03c780b19aee8e576304fcb294fe83f963af8fb75beacf4cb89b3f631fb

data/.travis.yml

@@ -10,5 +10,6 @@ rvm:
   - 2.0.0
   - 2.1.0
   - 2.1.1
+  - 2.1.2
   - jruby-19mode
   - rbx-2

data/HISTORY.md

@@ -1,5 +1,12 @@
 ## HEAD
 
+## 1.3.0 (2014-07-25)
+
+* Adjust gem dependency on `resque-scheduler` to ~> 3.0
+* Deprecated: `args_for_retry` in favor of `retry_args` (will output deprecation warnings if your using the older method).
+* Feature: Allow changing the args for a given exception using `retry_args_for_exception` (@jonp)
+* Feature: Allow setting `@expire_retry_key_after` on the fly (@orenmazor)
+
 ## 1.2.1 (2014-06-09)
 
 * Fixed Kernel.rand: "invalid argument - 0.0 (ArgumentError)" error with "ExponentialBackoff" (on "Rubinius") when `retry_delay_multiplicand_min` and `retry_delay_multiplicand_max` were the same value (@saizai)

data/README.md

@@ -1,7 +1,7 @@
 resque-retry
 ============
 
-A [Resque][rq] plugin. Requires Resque ~> 1.25 & [resque-scheduler][rqs] ~> 2.5.
+A [Resque][rq] plugin. Requires Resque ~> 1.25 & [resque-scheduler][rqs] ~> 3.0.
 
 resque-retry provides retry, delay and exponential backoff support for
 resque jobs.
@@ -28,7 +28,7 @@ If you're using [Bundler][bundler] to manage your dependencies, you should add `
 Add this to your `Rakefile`:
 ```ruby
 require 'resque/tasks'
-require 'resque_scheduler/tasks'
+require 'resque/scheduler/tasks'
 ```
 
 The delay between retry attempts is provided by [resque-scheduler][rqs].
@@ -120,8 +120,8 @@ run Resque::Server.new
 Retry Options & Logic
 ---------------------
 
-Please take a look at the yardoc/code for more details on methods you may
-wish to override.
+Please take a look at the [yardoc](http://rubydoc.info/gems/resque-retry)/code
+for more details on methods you may wish to override.
 
 Customisation is pretty easy, the below examples should give you
 some ideas =), adapt for your own usage and feel free to pick and mix!
@@ -332,7 +332,7 @@ job should retry.
 
 ### Retry Arguments
 
-You may override `args_for_retry`, which is passed the current
+You may override `retry_args`, which is passed the current
 job arguments, to modify the arguments for the next retry attempt.
 ```ruby
 class DeliverViaSMSC
@@ -340,7 +340,7 @@ class DeliverViaSMSC
   @queue = :mt_smsc_messages
 
   # retry using the emergency SMSC.
-  def self.args_for_retry(smsc_id, mt_message)
+  def self.retry_args(smsc_id, mt_message)
     [999, mt_message]
   end
 
@@ -350,6 +350,25 @@ class DeliverViaSMSC
 end
 ```
 
+Alternatively, if you require finer control of the args based on the
+exception thrown, you may override `retry_args_for_exception`, which is passed
+the exception and the current job arguments, to modify the arguments for the
+next retry attempt.
+```ruby
+class DeliverViaSMSC
+  extend Resque::Plugins::Retry
+  @queue = :mt_smsc_messages
+
+  # retry using the emergency SMSC.
+  def self.retry_args_for_exception(exception, smsc_id, mt_message)
+    [999, mt_message + exception.message]
+  end
+
+  self.perform(smsc_id, mt_message)
+    heavy_lifting
+  end
+end
+```
 ### Job Retry Identifier/Key
 
 The retry attempt is incremented and stored in a Redis key. The key is
@@ -401,7 +420,7 @@ This saves you from having to run a "house cleaning" or "errand" job.
 The expiary timeout is "pushed forward" or "touched" after each failure to
 ensure its not expired too soon.
 
-### Debug Plugging Logging
+### Debug Plugin Logging
 
 The inner-workings of the plugin are output to the Resque [Logger](https://github.com/resque/resque/wiki/Logging)
 when `Resque.logger.level` is set to `Logger::DEBUG`.

data/examples/demo/Rakefile

@@ -12,7 +12,7 @@ require 'resque/failure/redis'
 
 # Require Rakefile related resque things.
 require 'resque/tasks'
-require 'resque_scheduler/tasks'
+require 'resque/scheduler/tasks'
 
 # Enable resque-retry failure backend.
 Resque::Failure::MultipleWithRetrySuppression.classes = [Resque::Failure::Redis]

data/lib/resque-retry.rb

@@ -1,5 +1,5 @@
 require 'resque'
-require 'resque_scheduler'
+require 'resque-scheduler'
 
 require 'resque/plugins/retry'
 require 'resque/plugins/exponential_backoff'

data/lib/resque-retry/server.rb

@@ -1,6 +1,6 @@
 require 'cgi'
 require 'resque/server'
-require 'resque_scheduler/server'
+require 'resque/scheduler/server'
 
 # Extend Resque::Server to add tabs.
 module ResqueRetry

data/lib/resque-retry/version.rb

@@ -1,3 +1,3 @@
 module ResqueRetry
-  VERSION = '1.2.1'
+  VERSION = '1.3.0'
 end

data/lib/resque/plugins/retry.rb

@@ -154,8 +154,27 @@ module Resque
       # @return [Array] new job arguments
       #
       # @api public
-      def args_for_retry(*args)
-        args
+      def retry_args(*args)
+        # Here for backwards compatibility. If an "args_for_retry" method exists
+        # invoke it, but warn that it is deprecated (and will be removed in a
+        # future revision)
+        if respond_to?(:args_for_retry)
+          warn "`Resque::Plugins::Retry#args_for_retry` is deprecated, please use `Resque::Plugins::Retry#retry_args` instead."
+          args_for_retry(*args)
+        else
+          args
+        end
+      end
+
+      # @abstract
+      # Modify the arguments used to retry the job based on the exception.
+      # Use this to do something other than try the exact same job again.
+      #
+      # @return [Array] new job arguments
+      #
+      # @api public
+      def retry_args_for_exception(exception, *args)
+        retry_args(*args)
       end
 
       # Convenience method to test whether you may retry on a given
@@ -223,6 +242,14 @@ module Resque
         end
       end
 
+      # @abstract
+      # The number of seconds to set the TTL to on the resque-retry key in redis
+      #
+      # @return [Number] number of seconds
+      #
+      # @api public
+      attr_reader :expire_retry_key_after
+
       # Test if the retry criteria is valid
       #
       # @param [Exception] exception
@@ -322,11 +349,13 @@ module Resque
         # jobs that fail before ::perform will be both retried and sent to the failed queue.
         Resque.redis.setnx(redis_retry_key(*args), -1)
 
+        retry_args = retry_args_for_exception(exception, *args)
+
         if temp_retry_delay <= 0
           # If the delay is 0, no point passing it through the scheduler
-          Resque.enqueue(retry_in_queue, *args_for_retry(*args))
+          Resque.enqueue(retry_in_queue, *retry_args)
         else
-          Resque.enqueue_in(temp_retry_delay, retry_in_queue, *args_for_retry(*args))
+          Resque.enqueue_in(temp_retry_delay, retry_in_queue, *retry_args)
         end
 
         # remove retry key from redis if we handed retry off to another queue.
@@ -338,7 +367,8 @@ module Resque
 
       # Resque before_perform hook
       #
-      # Increments and sets the `@retry_attempt` count.
+      # Increments `@retry_attempt` count and updates the "retry_key" expiration
+      # time (if applicable)
       #
       # @api private
       def before_perform_retry(*args)
@@ -347,10 +377,15 @@ module Resque
 
         # store number of retry attempts.
         retry_key = redis_retry_key(*args)
-        Resque.redis.setnx(retry_key, -1)             # default to -1 if not set.
-        @retry_attempt = Resque.redis.incr(retry_key) # increment by 1.
+        Resque.redis.setnx(retry_key, -1)
+        @retry_attempt = Resque.redis.incr(retry_key)
         log_message "attempt: #{@retry_attempt} set in Redis", args
-        Resque.redis.expire(retry_key, @retry_delay.to_i + @expire_retry_key_after.to_i) if @expire_retry_key_after
+
+        # set/update the "retry_key" expiration
+        if expire_retry_key_after
+          log_message "updating expiration for retry key: #{retry_key}", args
+          Resque.redis.expire(retry_key, retry_delay + expire_retry_key_after)
+        end
       end
 
       # Resque after_perform hook

data/resque-retry.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |s|
   s.require_paths = %w[lib]
 
   s.add_dependency('resque', '~> 1.25')
-  s.add_dependency('resque-scheduler', '~> 2.5')
+  s.add_dependency('resque-scheduler', '~> 3.0')
 
   s.add_development_dependency('rake', '~> 10.1')
   s.add_development_dependency('minitest', '~> 4.0')

data/test/retry_test.rb

@@ -55,12 +55,23 @@ class RetryTest < MiniTest::Unit::TestCase
     assert_equal test_args, job['args']
   end
 
-  def test_job_args_may_be_modified
-    Resque.enqueue(RetryWithModifiedArgsJob, 'foo', 'bar')
+  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
 
-    assert job = Resque.pop(:testing)
-    assert_equal ['foobar', 'barbar'], job['args']
+  def test_job_args_can_be_modified_by_overriding_retry_args
+    Resque.enqueue(RetryWithModifiedArgsJob)
+    RetryWithModifiedArgsJob.expects(:retry_args)
+    perform_next_job(@worker)
+  end
+
+  def test_job_args_can_be_modified_by_overriding_retry_args_for_exception
+    Resque.enqueue(RetryWithExceptionBasedArgsJob)
+    RetryWithExceptionBasedArgsJob.expects(:retry_args_for_exception)
+    perform_next_job(@worker)
   end
 
   def test_retry_never_give_up
@@ -286,22 +297,19 @@ class RetryTest < MiniTest::Unit::TestCase
     perform_next_job(@worker)
   end
 
-  if Process.respond_to?(:fork) && Gem::Version.new(Resque::VERSION) >= Gem::Version.new('1.20.0')
-    def test_retry_on_dirty_exit
-      Resque.enqueue(RetryKilledJob)
-      RetryKilledJob.expects(:clean_retry_key).once
-      2.times do
-        job = @worker.reserve
-        child = fork do
-          Resque.redis.client.reconnect
-          job.perform
-        end
-        Process.waitpid(child)
-        job.fail(Resque::DirtyExit.new)
-      end
+  def test_expire_key_setting_on_the_fly
+    retry_key = 'resque-retry:FailFiveTimesWithCustomExpiryJob'
+
+    Resque.redis.expects(:expire).
+      with(retry_key, 100).then.
+      with(retry_key, 101).then.
+      with(retry_key, 102).then.
+      with(retry_key, 103).then.
+      with(retry_key, 104)
 
-      assert_equal nil, @worker.reserve
+    Resque.enqueue(FailFiveTimesWithCustomExpiryJob)
+    5.times do
+      perform_next_job(@worker)
     end
   end
-
 end

data/test/test_jobs.rb

@@ -41,7 +41,7 @@ class RetryDefaultsJob
   @queue = :testing
 
   def self.perform(*args)
-    raise
+    raise 'error'
   end
 end
 
@@ -102,11 +102,27 @@ class InheritTestWithMoreExtraJob < InheritTestWithExtraJob
   end
 end
 
-class RetryWithModifiedArgsJob < RetryDefaultsJob
+class DeprecatedRetryWithModifiedArgsJob < RetryDefaultsJob
   @queue = :testing
 
   def self.args_for_retry(*args)
-    args.each { |arg| arg << 'bar' }
+    # NOTE: implementation is irrelevant we only care that it's invoked
+  end
+end
+
+class RetryWithModifiedArgsJob < RetryDefaultsJob
+  @queue = :testing
+
+  def self.retry_args(*args)
+    # NOTE: implementation is irrelevant we only care that it's invoked
+  end
+end
+
+class RetryWithExceptionBasedArgsJob < RetryDefaultsJob
+  @queue = :testing
+
+  def self.retry_args_for_exception(exception, *args)
+    # NOTE: implementation is irrelevant we only care that it's invoked
   end
 end
 
@@ -154,6 +170,19 @@ class FailFiveTimesWithExpiryJob < RetryDefaultsJob
   end
 end
 
+class FailFiveTimesWithCustomExpiryJob < RetryDefaultsJob
+  @queue = :testing
+  @retry_limit = 6
+
+  def self.expire_retry_key_after
+    retry_attempt + 100
+  end
+
+  def self.perform(*args)
+    raise if retry_attempt <= 4
+  end
+end
+
 class ExponentialBackoffJob < RetryDefaultsJob
   extend Resque::Plugins::ExponentialBackoff
   @queue = :testing
@@ -474,13 +503,3 @@ class FailsDuringConnectJob < RetryDefaultsJob
   @retry_limit = 3
   @retry_delay = 10
 end
-
-
-class RetryKilledJob
-  extend Resque::Plugins::Retry
-  @queue = :testing
-
-  def self.perform(*args)
-    Process.kill("KILL", Process.pid)
-  end
-end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resque-retry
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Luke Antins
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-09 00:00:00.000000000 Z
+date: 2014-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: resque
@@ -32,14 +32,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement