resque-lockbr 1.1.0br

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) Chris Wanstrath, Ray Krueger
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+Software), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,46 @@
+Resque Lock
+===========
+
+A [Resque][rq] plugin. Requires Resque 1.7.0.
+
+If you want only one instance of your job queued at a time, extend it
+with this module.
+
+
+For example:
+
+    require 'resque/plugins/lock'
+
+    class UpdateNetworkGraph
+      extend Resque::Plugins::Lock
+
+      def self.perform(repo_id)
+        heavy_lifting
+      end
+    end
+
+While this job is queued or running, no other UpdateNetworkGraph
+jobs with the same arguments will be placed on the queue.
+
+If you want to define the key yourself you can override the
+`lock` class method in your subclass, e.g.
+
+    class UpdateNetworkGraph
+      extend Resque::Plugins::Lock
+
+      Run only one at a time, regardless of repo_id.
+      def self.lock(repo_id)
+        "network-graph"
+      end
+
+      def self.perform(repo_id)
+        heavy_lifting
+      end
+    end
+
+The above modification will ensure only one job of class
+UpdateNetworkGraph is queued at a time, regardless of the
+repo_id. Normally a job is locked using a combination of its
+class name and arguments.
+
+[rq]: http://github.com/defunkt/resque

data/Rakefile

@@ -0,0 +1,26 @@
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+def command?(command)
+  system("type #{command} > /dev/null")
+end
+
+#
+# Tests
+#
+
+task :default => :test
+
+if command? :turn
+  desc "Run tests"
+  task :test do
+    suffix = "-n #{ENV['TEST']}" if ENV['TEST']
+    sh "turn test/*.rb #{suffix}"
+  end
+else
+  Rake::TestTask.new do |t|
+    t.libs << 'lib'
+    t.pattern = 'test/**/*_test.rb'
+    t.verbose = false
+  end
+end

data/lib/resque/plugins/lock.rb

@@ -0,0 +1,90 @@
+module Resque
+  module Plugins
+    # If you want only one instance of your job queued at a time,
+    # extend it with this module.
+    #
+    # For example:
+    #
+    # require 'resque/plugins/lock'
+    #
+    # class UpdateNetworkGraph
+    #   extend Resque::Plugins::Lock
+    #
+    #   def self.perform(repo_id)
+    #     heavy_lifting
+    #   end
+    # end
+    #
+    # No other UpdateNetworkGraph jobs will be placed on the queue,
+    # the QueueLock class will check Redis to see if any others are
+    # queued with the same arguments before queueing. If another
+    # is queued the enqueue will be aborted.
+    #
+    # If you want to define the key yourself you can override the
+    # `lock` class method in your subclass, e.g.
+    #
+    # class UpdateNetworkGraph
+    #   extend Resque::Plugins::Lock
+    #
+    #   # Run only one at a time, regardless of repo_id.
+    #   def self.lock(repo_id)
+    #     "network-graph"
+    #   end
+    #
+    #   def self.perform(repo_id)
+    #     heavy_lifting
+    #   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.
+    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.
+      def lock(*args)
+        "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)
+        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)
+        begin
+          yield
+        ensure
+          # Always clear the lock when we're done, even if there is an
+          # error.
+          Resque.redis.del(lock(*args))
+        end
+      end
+    end
+  end
+end
+

data/test/lock_test.rb

@@ -0,0 +1,60 @@
+require 'test/unit'
+require 'resque'
+require 'resque/plugins/lock'
+
+$counter = 0
+
+class LockTest < Test::Unit::TestCase
+  class Job
+    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
+  end
+
+  def setup
+    Resque.redis.del('queue:lock_test')
+    Resque.redis.del(Job.lock)
+  end
+
+  def test_lint
+    assert_nothing_raised do
+      Resque::Plugin.lint(Resque::Plugins::Lock)
+    end
+  end
+
+  def test_version
+    major, minor, patch = Resque::Version.split('.')
+    assert_equal 1, major.to_i
+    assert minor.to_i >= 17
+    assert Resque::Plugin.respond_to?(:before_enqueue_hooks)
+  end
+
+  def test_lock
+    3.times { Resque.enqueue(Job) }
+
+    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

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: resque-lockbr
+version: !ruby/object:Gem::Version
+  version: 1.1.0br
+  prerelease: 5
+platform: ruby
+authors:
+- Chris Wanstrath
+- Ray Krueger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-10 00:00:00.000000000 Z
+dependencies: []
+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:
+- README.md
+- Rakefile
+- LICENSE
+- lib/resque/plugins/lock.rb
+- test/lock_test.rb
+homepage: http://github.com/defunkt/resque-lock
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A Resque plugin for ensuring only one instance of your job is queued at a
+  time.
+test_files: []