resque-batched-job 1.3.0 → 1.4.0

data/README.md

@@ -1,4 +1,4 @@
-# Resque Batched Job
+# Resque Batched Job [![Build Status](https://secure.travis-ci.org/drfeelngood/resque-batched-job.png)](http://travis-ci.org/drfeelngood/resque-batched-job)
 
 A [Resque](http://github.com/defunkt/resque) plugin. Requires Resque >= 1.10.0
 

data/lib/resque/plugins/batched_job/support.rb

@@ -0,0 +1,72 @@
+module Resque
+  module Plugins
+    module BatchedJobSupport
+
+      # Checks the size of the batched job list and returns true if the list is
+       # empty or if the key does not exist.
+       #
+       # @param batch_id (see Resque::Plugins::BatchedJob#batch)
+       def batch_complete?(batch_id)
+         mutex(batch_id) do |bid| 
+           redis.llen(bid) == 0
+         end
+       end
+
+       # Check to see if the Redis key exists.
+       #
+       # @param batch_id (see Resque::Plugins::BatchedJob#batch)
+       def batch_exist?(batch_id)
+         mutex(batch_id) do |bid| 
+           redis.exists(bid)
+         end
+       end
+
+      private
+
+      # Lock a batch key before executing Redis commands.  This will ensure
+      # no race conditions occur when modifying batch information.  Here is
+      # an example of how this works.  See http://redis.io/commands/setnx for
+      # more information. (fixes #4) (closes #5)
+      # 
+      # * Job2 sends SETNX batch:123:lock in order to aquire a lock.
+      # * Job1 still has the key locked, so Job2 continues into the loop.
+      # * Job2 sends GET to aquire the lock timestamp.
+      # * If the timestamp does not exist (Job1 released the lock), Job2 
+      #   attemps to start from the beginning again.
+      # * If the timestamp exists and has not expired, Job2 sleeps for a 
+      #   moment and then retries from the start.
+      # * If the timestamp exists and has expired, Job2 sends GETSET to aquire
+      #   a lock.  This returns the previous value of the lock.
+      # * If the previous timestamp has not expired, another process was faster
+      #   and aquired the lock.  This means Job2 has to start from the beginnig.
+      # * If the previous timestamp is still expired the lock has been set and
+      #   processing can continue safely
+      #
+      # @param id (see Resque::Plugins::BatchedJob#batch)
+      # @yield [bid] Yields the current batch id.
+      # @yieldparam [String] The current batch id.
+      def mutex(id, &block)
+        is_expired = lambda do |locked_at|
+          locked_at.to_f < Time.now.to_f
+        end
+        bid   = batch(id)
+        _key_ = "#{bid}:lock"
+
+        until redis.setnx(_key_, Time.now.to_f + 0.5)
+          next unless timestamp = redis.get(_key_)
+
+          unless is_expired.call(timestamp)
+            sleep(0.1)
+            next
+          end
+
+          break unless timestamp = redis.getset(_key_, Time.now.to_f + 0.5)
+          break if is_expired.call(timestamp)
+        end
+        yield(bid)
+      ensure
+        redis.del(_key_)
+      end
+    end
+  end
+end

data/lib/resque/plugins/batched_job/version.rb

@@ -1,7 +1,7 @@
 module Resque
   module Plugins
     module BatchedJob
-      VERSION = '1.3.0'
+      VERSION = '1.4.0'
     end
   end
-end
+end

data/lib/resque/plugins/batched_job.rb

@@ -45,9 +45,7 @@ module Resque
       #
       # @param id (see Resque::Plugins::BatchedJob#after_enqueue_batch)
       def after_perform_batch(id, *args)
-        remove_batched_job(id, *args)
-
-        if batch_complete?(id)
+        if remove_batched_job(id, *args) == 0
           after_batch_hooks = Resque::Plugin.after_batch_hooks(self)
           after_batch_hooks.each do |hook|
             send(hook, id, *args)
@@ -60,7 +58,7 @@ module Resque
       #
       # @param id (see Resque::Plugins::BatchedJob#batch)
       def batch_complete?(id)
-        mutex(id) do |bid| 
+        mutex(id) do |bid|
           redis.llen(bid) == 0
         end
       end
@@ -69,7 +67,7 @@ module Resque
       #
       # @param id (see Resque::Plugins::BatchedJob#batch)
       def batch_exist?(id)
-        mutex(id) do |bid| 
+        mutex(id) do |bid|
           redis.exists(bid)
         end
       end
@@ -80,6 +78,7 @@ module Resque
       def remove_batched_job(id, *args)
         mutex(id) do |bid|
           redis.lrem(bid, 1, encode(:class => self.name, :args => args))
+          redis.llen(bid)
         end
       end
 
@@ -96,13 +95,13 @@ module Resque
         # no race conditions occur when modifying batch information.  Here is
         # an example of how this works.  See http://redis.io/commands/setnx for
         # more information. (fixes #4) (closes #5)
-        # 
+        #
         # * Job2 sends SETNX batch:123:lock in order to aquire a lock.
         # * Job1 still has the key locked, so Job2 continues into the loop.
         # * Job2 sends GET to aquire the lock timestamp.
-        # * If the timestamp does not exist (Job1 released the lock), Job2 
+        # * If the timestamp does not exist (Job1 released the lock), Job2
         #   attemps to start from the beginning again.
-        # * If the timestamp exists and has not expired, Job2 sleeps for a 
+        # * If the timestamp exists and has not expired, Job2 sleeps for a
         #   moment and then retries from the start.
         # * If the timestamp exists and has expired, Job2 sends GETSET to aquire
         #   a lock.  This returns the previous value of the lock.

data/test/test_batched_job.rb

@@ -46,7 +46,7 @@ class BatchedJobTest < Test::Unit::TestCase
   # Make sure the after_batch hook is fired
   def test_batch_hook
     assert_equal(false, Job.batch_exist?(@batch_id))
-    
+
     assert_nothing_raised do
       5.times { Resque.enqueue(Job, @batch_id, "arg#{rand(100)}") }
     end
@@ -129,6 +129,11 @@ class BatchedJobTest < Test::Unit::TestCase
   end
 
   def test_remove_batched_job
+    Resque.enqueue(JobWithoutArgs, @batch_id)
+    Resque.enqueue(JobWithoutArgs, @batch_id)
+    assert_equal(1, JobWithoutArgs.remove_batched_job(@batch_id))
+    assert_equal(0, JobWithoutArgs.remove_batched_job(@batch_id))
+
     Resque.enqueue(JobWithoutArgs, @batch_id)
 
     assert_nothing_raised do
@@ -159,4 +164,4 @@ class BatchedJobTest < Test::Unit::TestCase
       Resque.redis
     end
 
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resque-batched-job
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-20 00:00:00.000000000 Z
+date: 2012-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: resque
-  requirement: &70171540725400 !ruby/object:Gem::Requirement
+  requirement: &70106096870560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: 1.10.0
   type: :runtime
   prerelease: false
-  version_requirements: *70171540725400
+  version_requirements: *70106096870560
 description: ! "  Resque plugin for batching jobs. When a batch/group of jobs are
   complete, \nadditional work can be performed usings batch hooks.\n"
 email: dan@dj-agiledev.com
@@ -33,6 +33,7 @@ files:
 - Rakefile
 - README.md
 - lib/resque/batched_job.rb
+- lib/resque/plugins/batched_job/support.rb
 - lib/resque/plugins/batched_job/tasks.rb
 - lib/resque/plugins/batched_job/version.rb
 - lib/resque/plugins/batched_job.rb