resque-lock 1.0.0 → 1.1.0

data/lib/resque/plugins/lock.rb

@@ -41,6 +41,14 @@ module Resque
     # repo_id. Normally a job is locked using a combination of its
     # class name and arguments.
     module Lock
+
+      # Override in your job to control the lock experiation time. This is the
+      # time in seconds that the lock should be considered valid. The default
+      # is one hour (3600 seconds).
+      def lock_timeout
+        3600
+      end
+
       # Override in your job to control the lock key. It is
       # passed the same arguments as `perform`, that is, your job's
       # payload.
@@ -48,8 +56,23 @@ module Resque
         "lock:#{name}-#{args.to_s}"
       end
 
+      # See the documentation for SETNX http://redis.io/commands/setnx for an
+      # explanation of this deadlock free locking pattern
       def before_enqueue_lock(*args)
-        Resque.redis.setnx(lock(*args), true)
+        key = lock(*args)
+        now = Time.now.to_i
+        timeout = now + lock_timeout + 1
+
+        # return true if we successfully acquired the lock
+        return true if Resque.redis.setnx(key, timeout)
+
+        # see if the existing timeout is still valid and return false if it is
+        # (we cannot acquire the lock during the timeout period)
+        return false if now <= Resque.redis.get(key).to_i
+
+        # otherwise set the timeout and ensure that no other worker has
+        # acquired the lock
+        now > Resque.redis.getset(key, timeout).to_i
       end
 
       def around_perform_lock(*args)

data/test/lock_test.rb

@@ -9,6 +9,10 @@ class LockTest < Test::Unit::TestCase
     extend Resque::Plugins::Lock
     @queue = :lock_test
 
+    def self.lock_timeout
+      1
+    end
+
     def self.perform
       raise "Woah woah woah, that wasn't supposed to happen"
     end
@@ -37,4 +41,20 @@ class LockTest < Test::Unit::TestCase
 
     assert_equal 1, Resque.redis.llen('queue:lock_test')
   end
+
+  def test_deadlock
+    now = Time.now.to_i
+
+    Resque.redis.set(Job.lock, now+60)
+    Resque.enqueue(Job)
+    assert_equal 0, Resque.redis.llen('queue:lock_test')
+
+    Resque.redis.set(Job.lock, now-1)
+    Resque.enqueue(Job)
+    assert_equal 1, Resque.redis.llen('queue:lock_test')
+
+    sleep 3
+    Resque.enqueue(Job)
+    assert_equal 2, Resque.redis.llen('queue:lock_test')
+  end
 end

metadata

@@ -1,85 +1,54 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: resque-lock
-version: !ruby/object:Gem::Version 
-  hash: 23
+version: !ruby/object:Gem::Version
+  version: 1.1.0
   prerelease: 
-  segments: 
-  - 1
-  - 0
-  - 0
-  version: 1.0.0
 platform: ruby
-authors: 
+authors:
 - Chris Wanstrath
 - Ray Krueger
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-08-18 00:00:00 -07:00
-default_executable: 
+date: 2012-11-08 00:00:00.000000000 Z
 dependencies: []
-
-description: |
-  A Resque plugin. If you want only one instance of your job
-  queued at a time, extend it with this module.
-  
-  For example:
-  
-      class UpdateNetworkGraph
-        extend Resque::Jobs::Locked
-  
-        def self.perform(repo_id)
-          heavy_lifting
-        end
-      end
-
+description: ! "A Resque plugin. If you want only one instance of your job\nqueued
+  at a time, extend it with this module.\n\nFor example:\n\n    class UpdateNetworkGraph\n
+  \     extend Resque::Jobs::Locked\n\n      def self.perform(repo_id)\n        heavy_lifting\n
+  \     end\n    end\n"
 email: chris@ozmm.org
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - README.md
 - Rakefile
 - LICENSE
 - lib/resque/plugins/lock.rb
 - test/lock_test.rb
-has_rdoc: true
 homepage: http://github.com/defunkt/resque-lock
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: A Resque plugin for ensuring only one instance of your job is queued at a time.
+summary: A Resque plugin for ensuring only one instance of your job is queued at a
+  time.
 test_files: []
-