resque-lonely_job 0.0.2 → 0.0.3

data/README.md

@@ -8,8 +8,11 @@ time.
 This differs from [resque-lock](from https://github.com/defunkt/resque-lock) and
 [resque-loner](http://github.com/jayniz/resque-loner) in that the same job may
 be queued multiple times but you're guaranteed that first job queued will run to
-completion before subsequent jobs are run.  In other words, job ordering is
-preserved.
+completion before subsequent jobs are run.
+
+However, it is possible that subsequent jobs are re-ordered depending upon
+worker behavior.  Therefore it is recommended that the payload for jobs be
+stored in a separate redis list distinct from the Resque queue (see Example #3).
 
 ## Installation
 
@@ -27,7 +30,7 @@ Or install it yourself as:
 
 ## Usage
 
-#### Example #1
+#### Example #1 -- One job running per queue
 
     require 'resque/plugins/lonely_job'
 
@@ -42,7 +45,7 @@ Or install it yourself as:
       end
     end
 
-#### Example #2
+#### Example #2 -- One job running per user-defined attribute
 
 Let's say you want the serial constraint to apply at a more granular
 level.  Instead of applying at the queue level, you can overwrite the .redis\_key
@@ -62,6 +65,12 @@ method.
         "lonely_job:strictly_serial_job:#{account_id}"
       end
 
+      # Overwrite reenqueue to lpush instead of default rpush.  This attempts to
+      # preserve job ordering but job order is *NOT* guaranteed.
+      def self.reenqueue(*args)
+        Resque.redis.lpush("queue:#{Resque.queue_from_class(self)}", Resque.encode(class: self, args: args))
+      end
+
       def self.perform(account_id, *args)
         # only one at a time in this block, no parallelism allowed for this
         # particular redis_key
@@ -98,6 +107,10 @@ where you have three jobs in the queue with two resque workers:
   http://blog.kabisa.nl/2010/03/16/dynamic-queue-assignment-for-resque-jobs/,
   where the queue is a one to one mapping to the redis\_key.
 
+#### Example #3 -- One job running per user-defined attribute with job ordering preserved
+
+TODO
+
 ## Contributing
 
 1. Fork it

data/lib/resque-lonely_job/version.rb

@@ -1,7 +1,7 @@
 module Resque
   module Plugins
     module LonelyJob
-      VERSION = "0.0.2"
+      VERSION = "0.0.3"
     end
   end
 end

data/lib/resque-lonely_job.rb

@@ -27,14 +27,14 @@ module Resque
       # role our own.  This is based on Resque.push but we don't need to
       # call Resque.watch_queue as the queue should already exist if we're
       # unable to get the lock.
-      def lpush(*args)
-        Resque.redis.lpush("queue:#{Resque.queue_from_class(self)}", Resque.encode(class: self, args: args))
+      def reenqueue(*args)
+        Resque.enqueue(self, *args)
       end
 
       def before_perform(*args)
         unless can_lock_queue?(*args)
-          # can't get the lock, so place at the front of the queue
-          lpush(*args)
+          # can't get the lock, so re-enqueue the task
+          reenqueue(*args)
 
           # and don't perform
           raise Resque::Job::DontPerform

data/resque-lonely_job.gemspec

@@ -15,9 +15,10 @@ Gem::Specification.new do |gem|
   gem.version       = Resque::Plugins::LonelyJob::VERSION
 
   gem.add_dependency 'resque', '~> 1.20.0'
-  gem.add_dependency 'mock_redis', '~> 0.4.1'
+  gem.add_development_dependency 'mock_redis', '~> 0.4.1'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'debugger'
 
   gem.description   = <<desc
 Ensures that for a given queue, only one worker is working on a job at any given time.

data/spec/lib/lonely_job_spec.rb

@@ -65,9 +65,11 @@ describe Resque::Plugins::LonelyJob do
         -> { job.perform }.should raise_error(Exception)
       end
 
-      it 'should place self at the beginning of the queue if unable to acquire the lock' do
-        job1 = Resque::Job.create(:serial_work, 'SerialJob', %w[account_one job_one])
-        job2 = Resque::Job.create(:serial_work, 'SerialJob', %w[account_one job_two])
+      it 'should place self at the end of the queue if unable to acquire the lock' do
+        job1_payload = %w[account_one job_one]
+        job2_payload = %w[account_one job_two]
+        Resque::Job.create(:serial_work, 'SerialJob', job1_payload)
+        Resque::Job.create(:serial_work, 'SerialJob', job2_payload)
 
         SerialJob.should_receive(:can_lock_queue?).and_return(false)
 
@@ -77,7 +79,7 @@ describe Resque::Plugins::LonelyJob do
         job1.perform.should be_false
 
         first_queue_element = Resque.reserve(:serial_work)
-        first_queue_element.should == job1
+        first_queue_element.payload["args"].should == [job2_payload]
       end
     end
 
@@ -111,9 +113,11 @@ describe Resque::Plugins::LonelyJob do
         -> { job.perform }.should raise_error(Exception)
       end
 
-      it 'should place self at the beginning of the queue if unable to acquire the lock' do
-        job1 = Resque::Job.create(:serial_work, 'SerialJobWithCustomRedisKey', %w[account_one job_one])
-        job2 = Resque::Job.create(:serial_work, 'SerialJobWithCustomRedisKey', %w[account_one job_two])
+      it 'should place self at the end of the queue if unable to acquire the lock' do
+        job1_payload = %w[account_one job_one]
+        job2_payload = %w[account_one job_two]
+        Resque::Job.create(:serial_work, 'SerialJobWithCustomRedisKey', job1_payload)
+        Resque::Job.create(:serial_work, 'SerialJobWithCustomRedisKey', job2_payload)
 
         SerialJobWithCustomRedisKey.should_receive(:can_lock_queue?).and_return(false)
 
@@ -123,7 +127,7 @@ describe Resque::Plugins::LonelyJob do
         job1.perform.should be_false
 
         first_queue_element = Resque.reserve(:serial_work)
-        first_queue_element.should == job1
+        first_queue_element.payload["args"].should == [job2_payload]
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resque-lonely_job
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-24 00:00:00.000000000 Z
+date: 2012-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: resque
-  requirement: &70163618247460 !ruby/object:Gem::Requirement
+  requirement: &70264194773380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,21 +21,21 @@ dependencies:
         version: 1.20.0
   type: :runtime
   prerelease: false
-  version_requirements: *70163618247460
+  version_requirements: *70264194773380
 - !ruby/object:Gem::Dependency
   name: mock_redis
-  requirement: &70163618260080 !ruby/object:Gem::Requirement
+  requirement: &70264194772640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.4.1
-  type: :runtime
+  type: :development
   prerelease: false
-  version_requirements: *70163618260080
+  version_requirements: *70264194772640
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70163618269840 !ruby/object:Gem::Requirement
+  requirement: &70264194772020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70163618269840
+  version_requirements: *70264194772020
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70163618268580 !ruby/object:Gem::Requirement
+  requirement: &70264194771040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70264194771040
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: &70264194768800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70163618268580
+  version_requirements: *70264194768800
 description: ! "Ensures that for a given queue, only one worker is working on a job
   at any given time.\n\nExample:\n\n  require 'resque/plugins/lonely_job'\n\n  class
   StrictlySerialJob\n    extend Resque::Plugins::LonelyJob\n\n    @queue = :serial_work\n\n