resque-workers-lock 1.0.3 → 1.0.4

data/README.md

@@ -12,7 +12,7 @@ If resque jobs have the same lock applied this means that those jobs cannot be p
 By default the lock is the instance name + arguments (just like the classic resque-lock). Override this lock to lock on specific arguments.
 
 ## How does it differ from resque-lock?
-Resque-lock will not let you queue jobs when you locked them. Resque-workers-lock locks on a workers-level and will requeue the locked jobs. Resque workers lock will not prevent you to queue jobs. If a worker takes on a job that is already being processed by another worker it will put the job back up in the queue!
+Resque-lock will not let you queue jobs when you locked them. Resque-workers-lock locks on a workers-level and will requeue the locked jobs. Resque workers lock will not prevent you to queue jobs. If a worker takes on a job that is already being processed by another worker it will put the job back up in the queue! Also, this plugin will still offer you the ability to lock at enqueue-level just like resque-lock does (see example).
 
 ## Example
 This example shows how you can use the workers-lock to prevent two jobs with the same domain to be processed simultaneously.
@@ -23,9 +23,14 @@ class Parser
   extend Resque::Plugins::Workers::Lock
 
 	# Lock method has the same arguments as the self.perform
-	def self.lock(domain, arg2, arg3)
+	def self.workers_lock(domain, arg2, arg3)
 		return domain
 	end
+	
+	# Turn off standard resque-lock functionality
+	def self.enqueue_lock(domain, arg2, arg3)
+		false
+	end
 
 	# Perform method with some arguments
   def self.perform(domain, arg2, arg3)
@@ -35,6 +40,9 @@ end
 ```
 In this example `domain` is used to specify certain types of jobs that are not allowed to run at the same time. For example: if you create three jobs with the domain argument google.com, google.com and yahoo.com, the two google.com jobs will never run at the same time.
 
+## One queue
+Best results with one big queue instead of multiple queues.
+
 ## Requeue loop
 When a job is requeue'ed there is a small delay (1 second by default) before the worker places the job actually back in the queue. Let's say you have two jobs left, and one job is taking 15 seconds on the first worker and the other similar job is being blocked by the second worker. The second worker will continuously try to put the job back in the queue and it will try to process it again (racing for 15 seconds untill the other job has finished). This only happens when there are no other (not locked) jobs in the queue.
 

data/lib/resque/plugins/workers/lock.rb

@@ -2,21 +2,36 @@ module Resque
   module Plugins
     module Workers
       module Lock
-        # Override in your job to control the lock key.
-        def lock(*args)
-          "lock:#{name}-#{args.to_s}"
+        
+        # Override in your job to control the queue lock key
+        def enqueue_lock(*args)
+          "enqueuelock:#{name}-#{args.to_s}"
+        end
+        
+        # Override in your job to control the workers lock key.
+        def workers_lock(*args)
+          "workerslock:#{name}-#{args.to_s}"
         end
         
+        # Override in your job to change the perform requeue delay
         def requeue_perform_delay
           1.0
         end
         
+        def before_enqueue_lock(*args)
+          if enqueue_lock(*args)
+            Resque.redis.setnx(enqueue_lock(*args), true)
+          end
+        end
+        
         def before_perform_lock(*args)
-          nx = Resque.redis.setnx(lock(*args), true)
-          if nx == false
-            sleep(requeue_perform_delay)
-            Resque.enqueue(self, *args)
-            raise Resque::Job::DontPerform
+          if workers_lock(*args)
+            nx = Resque.redis.setnx(workers_lock(*args), true)
+            if nx == false
+              sleep(requeue_perform_delay)
+              Resque.enqueue(self, *args)
+              raise Resque::Job::DontPerform
+            end
           end
         end
       
@@ -25,14 +40,17 @@ module Resque
             yield
           ensure
             # Clear the lock. (even with errors)
-            Resque.redis.del(lock(*args))
+            Resque.redis.del(workers_lock(*args))
+            Resque.redis.del(enqueue_lock(*args))
           end
         end
         
         def on_failure_lock(exception, *args)
           # Clear the lock on DirtyExit
-          Resque.redis.del(lock(*args))
+          Resque.redis.del(workers_lock(*args))
+          Resque.redis.del(enqueue_lock(*args))
         end
+        
       end
     end
   end

data/test/lock_test.rb

@@ -16,7 +16,8 @@ class LockTest < Test::Unit::TestCase
 
   def setup
     Resque.redis.del('queue:lock_test')
-    Resque.redis.del(Job.lock)
+    Resque.redis.del(Job.workers_lock)
+    Resque.redis.del(Job.enqueue_lock)
   end
 
   def test_lint
@@ -35,7 +36,7 @@ class LockTest < Test::Unit::TestCase
   def test_enqueue
     3.times { Resque.enqueue(Job) }
 
-    assert_equal 3, Resque.redis.llen('queue:lock_test')
+    assert_equal 1, Resque.redis.llen('queue:lock_test')
   end
   
   def test_lock

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resque-workers-lock
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
   prerelease: 
 platform: ruby
 authors: