resque-lock-retry 0.0.1 → 0.0.2

data/README.markdown

@@ -8,11 +8,15 @@ Resque-lock-retry is an extension to
 only one job runs at a time. In the case of locking conflicts, the job may be
 ignored or retried.
 
+This plugin works best in combination with
+[resque-scheduler](http://github.com/bvandenbos/resque-scheduler), but it 
+isn't required.
+
 Locked jobs
 ------------
 
 If you want only one instance of your job running at a time, extend
-Resque::Plugins::Locked.
+`Resque::Plugins::Locked`.
 
 For example:
 
@@ -23,8 +27,8 @@ For example:
       end
     end
 
-While other UpdateNetworkGraph jobs will be placed on the queue, the Locked
-class will check Redis to see if any others are executing with the same
+While other UpdateNetworkGraph jobs will be placed on the queue, the `Locked`
+class will check `Redis` to see if any others are executing with the same
 arguments before beginning. If another is executing the job will be aborted.
 
 If you want to define the key yourself you can override the `lock` class
@@ -41,9 +45,9 @@ method in your subclass, e.g.
       end
     end
 
-The above modification will ensure only one job of class UpdateNetworkGraph is
-running at a time, regardless of the repo_id. Normally a job is locked using a
-combination of its class name and arguments.
+The above modification will ensure only one job of class `UpdateNetworkGraph`
+is running at a time, regardless of the `repo_id`. Normally a job is locked
+using a combination of its class name and arguments.
 
 Retried jobs
 ------------
@@ -51,7 +55,7 @@ Retried jobs
 ### Locks
 
 Normally, locked jobs simply abort when a lock is encountered. If you'd like
-the job to try again when the lock is lifted, extend RetryOnLock.
+the job to try again when the lock is lifted, extend `RetryOnLock`.
 
 For example:
 
@@ -67,7 +71,7 @@ a short delay.
 
 ### Failures
 
-If you'd like to retry jobs when certain exceptions happen, use RetryOnFail.
+If you'd like to retry jobs when certain exceptions happen, use `RetryOnFail`.
 Then, define the types of exceptions that are ok to retry on.
 
 For example:
@@ -82,8 +86,33 @@ For example:
       end
     end
 
-Now, if a NetworkError (or subclass) exception is thrown while performing the
-job, it will be required after a short delay.
+Now, if a `NetworkError` (or subclass) exception is thrown while performing
+the job, it will be required after a short delay.
+
+### Retry strategies
+
+Retrying comes in two flavors:
+
+1. [resque-scheduler](http://github.com/bvandenbos/resque-scheduler) If
+Resque responds to `enqueue_in`, the job will be scheduled to perform again in
+the 5 seconds.
+
+2. `sleep` If Resque does not respond to `enqueue_in`, then we simply sleep
+for 1 second before enqueing the job. This method is NOT recommended because
+it will block your worker.
+
+To change how long to wait until the job is retried, just override
+`seconds_until_retry`
+
+    class UpdateNetworkGraph
+      extend Resque::Plugins::RetryOnLock
+      def self.perform(repo_id)
+        heavy_lifting
+      end
+      def self.seconds_until_retry
+        100
+      end
+    end
 
 ### Bonus
 

data/Rakefile

@@ -2,15 +2,10 @@ require 'rake/testtask'
 
 task :default => :test
 
-def command?(command)
-  system("type #{command} > /dev/null")
-end
-
 desc "Run the test suite"
 task :test do
-  rg = command?(:rg)
   Dir['test/**/*_test.rb'].each do |f|
-    rg ? sh("rg #{f}") : ruby(f)
+    ruby(f)
   end
 end
 

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/resque/plugins/retried.rb

@@ -5,12 +5,12 @@ module Resque
       # Override in your subclass to control how long to wait before
       # performing this job again. Retrying comes in two flavors:
       #
-      # 1. ResqueScheduler
-      #    If Resque responds to :enqueue_in, the job will be scheduled to
+      # 1. `ResqueScheduler`
+      #    If Resque responds to `enqueue_in`, the job will be scheduled to
       #    perform again in the defined number of seconds.
       #
-      # 2. Sleep
-      #    If Resque does not respond to :enqueue_in, then we simply sleep
+      # 2. `sleep`
+      #    If Resque does not respond to `enqueue_in`, then we simply sleep
       #    for the defined number of seconds before enqueing the job. This
       #    method is NOT recommended because it will block your worker.
       #
@@ -19,12 +19,18 @@ module Resque
         Resque.respond_to?(:enqueue_in) ? 5 : 1
       end
 
+      # Modify the arguments used to requeue the job. Use this to do something
+      # other than try the exact same job again.
+      def args_for_try_again(*args)
+        args
+      end
+
       def try_again(*args)
         if Resque.respond_to?(:enqueue_in)
-          Resque.enqueue_in(seconds_until_retry || 0, self, *args)
+          Resque.enqueue_in(seconds_until_retry || 0, self, *args_for_try_again(*args))
         else
           sleep(seconds_until_retry) if seconds_until_retry
-          Resque.enqueue(self, *args)
+          Resque.enqueue(self, *args_for_try_again(*args))
         end
       end
 

data/resque-lock-retry.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{resque-lock-retry}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ryan Carver"]
-  s.date = %q{2010-04-04}
+  s.date = %q{2010-04-09}
   s.email = %q{ryan@typekit.com}
   s.extra_rdoc_files = [
     "README.markdown"

data/test/combined_test.rb

@@ -3,7 +3,7 @@ require File.dirname(__FILE__) + '/test_helper'
 class Resque::CombinedTest < Test::Unit::TestCase
 
   def setup
-    Resque.redis.flush_all
+    Resque.redis.flushall
   end
 
   def test_lock_on_fail_with_lock_on_retry

data/test/locked_test.rb

@@ -3,7 +3,7 @@ require File.dirname(__FILE__) + '/test_helper'
 class Resque::LockedJobTest < Test::Unit::TestCase
 
   def setup
-    Resque.redis.flush_all
+    Resque.redis.flushall
   end
 
   def test_lint

data/test/retried_test.rb

@@ -20,7 +20,7 @@ end
 class Resque::RetriedJobWithSleepTest < Test::Unit::TestCase
 
   def setup
-    Resque.redis.flush_all
+    Resque.redis.flushall
   end
 
   def test_default_seconds_until_retry
@@ -75,4 +75,30 @@ class Resque::RetriedJobWithSleepTest < Test::Unit::TestCase
     assert_equal(0, Resque.redis.llen("queue:testqueue").to_i, "job is NOT enqueued")
   end
 
+  def test_job_args_are_maintained
+    thread = Thread.new { perform_job RetriedOnFailJob, 1, FooError }
+    assert_equal(0, Resque.redis.llen("queue:testqueue").to_i, "queue is empty")
+    begin
+      thread.join
+      assert(false, "Should have raised an exception")
+    rescue StandardError => e
+      assert_equal(FooError, e.class, e.message)
+    end
+    assert job = Resque.pop(:testqueue)
+    assert_equal [1, "FooError"], job["args"]
+  end
+
+  def test_job_args_can_be_modified
+    thread = Thread.new { perform_job RetriedOnFailWithDifferentArgsJob, 1, FooError }
+    assert_equal(0, Resque.redis.llen("queue:testqueue").to_i, "queue is empty")
+    begin
+      thread.join
+      assert(false, "Should have raised an exception")
+    rescue StandardError => e
+      assert_equal(FooError, e.class, e.message)
+    end
+    assert job = Resque.pop(:testqueue)
+    assert_equal [2, "FooError"], job["args"]
+  end
+
 end

data/test/retried_test_with_scheduler.rb

@@ -12,7 +12,7 @@ end
 class Resque::RetriedJobWithResqueSchedulerTest < Test::Unit::TestCase
 
   def setup
-    Resque.redis.flush_all
+    Resque.redis.flushall
   end
 
   def test_default_seconds_until_retry
@@ -31,4 +31,16 @@ class Resque::RetriedJobWithResqueSchedulerTest < Test::Unit::TestCase
     assert_equal([5, RetriedOnFailJob, 0, FooError], Resque.last_enqueued_in)
   end
 
+  def test_job_args_can_be_modified
+    thread = Thread.new { perform_job RetriedOnFailWithDifferentArgsJob, 0, FooError }
+    assert_equal(0, Resque.redis.llen("queue:testqueue").to_i, "queue is empty")
+    begin
+      thread.join
+      assert(false, "Should have raised an exception")
+    rescue StandardError => e
+      assert_equal(FooError, e.class, e.message)
+    end
+    assert_equal([5, RetriedOnFailWithDifferentArgsJob, 1, FooError], Resque.last_enqueued_in)
+  end
+
 end

data/test/retry_on_fail_test.rb

@@ -3,7 +3,7 @@ require File.dirname(__FILE__) + '/test_helper'
 class Resque::RetriedOnFailJobTest < Test::Unit::TestCase
 
   def setup
-    Resque.redis.flush_all
+    Resque.redis.flushall
   end
 
   def test_lint

data/test/retry_on_lock_test.rb

@@ -3,7 +3,7 @@ require File.dirname(__FILE__) + '/test_helper'
 class Resque::RetriedOnLockJobTest < Test::Unit::TestCase
 
   def setup
-    Resque.redis.flush_all
+    Resque.redis.flushall
   end
 
   def test_lint

data/test/test_helper.rb

@@ -127,6 +127,24 @@ class RetriedOnFailJob
   end
 end
 
+class RetriedOnFailWithDifferentArgsJob
+  extend ::Resque::Plugins::RetryOnFail
+  @queue = :testqueue
+  def self.perform(sleep_time, ex)
+    sleep sleep_time
+    raise ex
+  end
+  def self.args_for_try_again(sleep_time, ex)
+    [sleep_time + 1, ex]
+  end
+  def self.retried_exceptions
+    [FooError, BarError]
+  end
+  def self.lock(*args)
+    "TestLock"
+  end
+end
+
 class RetriedOnLockAndFailJob
   extend ::Resque::Plugins::RetryOnLock
   extend ::Resque::Plugins::RetryOnFail

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Ryan Carver
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-04 00:00:00 -07:00
+date: 2010-04-09 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency