nogara-resque-lonely_job 0.0.3

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in resque-lonelyjob.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jonathan R. Wallace
+
+MIT License
+
+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,120 @@
+# Resque::LonelyJob
+
+A [Resque](https://github.com/defunkt/resque) plugin. Requires Resque >= 1.20.0.
+
+Ensures that for a given queue, only one worker is working on a job at any given
+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.
+
+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
+
+Add this line to your application's Gemfile:
+
+    gem 'resque-lonely_job'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install resque-lonely_job
+
+## Usage
+
+#### Example #1 -- One job running per queue
+
+    require 'resque/plugins/lonely_job'
+
+    class StrictlySerialJob
+      extend Resque::Plugins::LonelyJob
+
+      @queue = :serial_work
+
+      def self.perform
+        # only one at a time in this block, no parallelism allowed for this
+        # particular queue
+      end
+    end
+
+#### 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
+method.
+
+    require 'resque/plugins/lonely_job'
+
+    class StrictlySerialJob
+      extend Resque::Plugins::LonelyJob
+
+      @queue = :serial_work
+
+      # Returns a string that will be used as the redis key
+      # NOTE: it is recommended to prefix your string with the 'lonely_job:' to
+      # namespace your key!
+      def self.redis_key(account_id, *args)
+        "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
+      end
+    end
+
+*NOTE*: Without careful consideration of your problem domain, worker starvation
+and/or unfairness is possible for jobs in this example.  Imagine a scenario
+where you have three jobs in the queue with two resque workers:
+
+    +---------------------------------------------------+
+    | :serial_work                                      |
+    |---------------------------------------------------|
+    |             |             |             |         |
+    | redis_key:  | redis_key:  | redis_key:  | ...     |
+    |    A        |    A        |    B        |         |
+    |             |             |             |         |
+    | job 1       | job 2       | job 3       |         |
+    +---------------------------------------------------+
+                                      ^
+                                      |
+      Possible starvation +-----------+
+      for this job and
+      subsequent ones
+
+
+  When the first worker grabs job 1, it'll acquire the mutex for processing
+  redis\_key A.  The second worker tries to grab the next job off the queue but
+  is unable to acquire the mutex for redis\_key A so it places job 2 back at the
+  head of the :serial\_work queue.  Until worker 1 completes job 1 and releases
+  the mutex for redis\_key A, no work will be done in this queue.
+
+  This issue may be avoided by employing dynamic queues,
+  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
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/lib/resque-lonely_job.rb

@@ -0,0 +1,53 @@
+require 'resque-lonely_job/version'
+
+module Resque
+  module Plugins
+    module LonelyJob
+      LOCK_TIMEOUT = 60 * 60 * 24 * 5 # 5 days
+
+      def lock_timeout
+        Time.now.utc + LOCK_TIMEOUT + 1
+      end
+
+      # Overwrite this method to uniquely identify which mutex should be used
+      # for a resque worker.
+      def redis_key(*args)
+        "lonely_job:#{@queue}"
+      end
+
+      def can_lock_queue?(*args)
+        Resque.redis.setnx(redis_key(*args), lock_timeout)
+      end
+
+      def unlock_queue(*args)
+        Resque.redis.del(redis_key(*args))
+      end
+
+      # Unfortunately, there's not a Resque interface for lpush so we have to
+      # 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 reenqueue(*args)
+        Resque.enqueue(self, *args)
+      end
+
+      def before_perform(*args)
+        unless can_lock_queue?(*args)
+          # can't get the lock, so re-enqueue the task
+          reenqueue(*args)
+
+          # and don't perform
+          raise Resque::Job::DontPerform
+        end
+      end
+
+      def around_perform(*args)
+        begin
+          yield
+        ensure
+          unlock_queue(*args)
+        end
+      end
+    end
+  end
+end

data/lib/resque-lonely_job/version.rb

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

data/resque-lonely_job.gemspec

@@ -0,0 +1,41 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/resque-lonely_job/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jonathan R. Wallace"]
+  gem.email         = ["jonathan.wallace@gmail.com"]
+  gem.summary       = %q{A resque plugin that ensures that only one job for a given queue will be running on any worker at a given time.}
+  gem.homepage      = "http://github.com/wallace/resque-lonely_job"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "nogara-resque-lonely_job"
+  gem.require_paths = ["lib"]
+  gem.version       = Resque::Plugins::LonelyJob::VERSION
+
+  gem.add_dependency 'resque', '~> 1.21.0'
+  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.
+
+Example:
+
+  require 'resque/plugins/lonely_job'
+
+  class StrictlySerialJob
+    extend Resque::Plugins::LonelyJob
+
+    @queue = :serial_work
+
+    def self.perform
+      # only one at a time in this block, no parallelism allowed for this
+      # particular queue
+    end
+  end
+desc
+end

data/spec/lib/lonely_job_spec.rb

@@ -0,0 +1,134 @@
+require 'spec_helper'
+
+class SerialJob
+  extend Resque::Plugins::LonelyJob
+  @queue = :serial_work
+
+  def self.perform(*args); end
+end
+
+class SerialJobWithCustomRedisKey
+  extend Resque::Plugins::LonelyJob
+  @queue = :serial_work
+
+  def redis_key(account_id, *args)
+    "lonely_job:#{@queue}:#{account_id}"
+  end
+
+  def self.perform(account_id, *args); end
+end
+
+describe Resque::Plugins::LonelyJob do
+  before do
+    Resque.redis.flushall
+  end
+
+  describe ".can_lock_queue?" do
+    it 'can lock a queue' do
+      SerialJob.can_lock_queue?(:serial_work).should be_true
+    end
+
+    it 'cannot lock an already locked queue' do
+      SerialJob.can_lock_queue?(:serial_work).should be_true
+      SerialJob.can_lock_queue?(:serial_work).should be_false
+    end
+  end
+
+  describe ".perform" do
+    describe "using the default redis key" do
+      it 'should lock and unlock the queue' do
+        job = Resque::Job.new(:serial_work, { 'class' => 'SerialJob', 'args' => %w[account_one job_one] })
+
+        # job is the first SerialJob to run so it can lock the queue and perform
+        SerialJob.should_receive(:can_lock_queue?).and_return(true)
+
+        # but it should also clean up after itself
+        SerialJob.should_receive(:unlock_queue)
+
+        job.perform
+      end
+
+      it 'should clean up lock even with catastrophic job failure' do
+        job = Resque::Job.new(:serial_work, { 'class' => 'SerialJob', 'args' => %w[account_one job_one] })
+
+        # job is the first SerialJob to run so it can lock the queue and perform
+        SerialJob.should_receive(:can_lock_queue?).and_return(true)
+
+        # but we have a catastrophic job failure
+        SerialJob.should_receive(:perform).and_raise(Exception)
+
+        # and still it should clean up after itself
+        SerialJob.should_receive(:unlock_queue)
+
+        # unfortunately, the job will be lost but resque doesn't guarantee jobs
+        # aren't lost
+        -> { job.perform }.should raise_error(Exception)
+      end
+
+      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)
+
+        # perform returns false when DontPerform exception is raised in
+        # before_perform callback
+        job1 = Resque.reserve(:serial_work)
+        job1.perform.should be_false
+
+        first_queue_element = Resque.reserve(:serial_work)
+        first_queue_element.payload["args"].should == [job2_payload]
+      end
+    end
+
+    describe "with a custom redis_key" do
+      it 'should lock and unlock the queue' do
+        job = Resque::Job.new(:serial_work, { 'class' => 'SerialJobWithCustomRedisKey', 'args' => %w[account_one job_one] })
+
+        # job is the first SerialJobWithCustomRedisKey to run so it can lock the queue and perform
+        SerialJobWithCustomRedisKey.should_receive(:can_lock_queue?).and_return(true)
+
+        # but it should also clean up after itself
+        SerialJobWithCustomRedisKey.should_receive(:unlock_queue)
+
+        job.perform
+      end
+
+      it 'should clean up lock even with catastrophic job failure' do
+        job = Resque::Job.new(:serial_work, { 'class' => 'SerialJobWithCustomRedisKey', 'args' => %w[account_one job_one] })
+
+        # job is the first SerialJobWithCustomRedisKey to run so it can lock the queue and perform
+        SerialJobWithCustomRedisKey.should_receive(:can_lock_queue?).and_return(true)
+
+        # but we have a catastrophic job failure
+        SerialJobWithCustomRedisKey.should_receive(:perform).and_raise(Exception)
+
+        # and still it should clean up after itself
+        SerialJobWithCustomRedisKey.should_receive(:unlock_queue)
+
+        # unfortunately, the job will be lost but resque doesn't guarantee jobs
+        # aren't lost
+        -> { job.perform }.should raise_error(Exception)
+      end
+
+      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)
+
+        # perform returns false when DontPerform exception is raised in
+        # before_perform callback
+        job1 = Resque.reserve(:serial_work)
+        job1.perform.should be_false
+
+        first_queue_element = Resque.reserve(:serial_work)
+        first_queue_element.payload["args"].should == [job2_payload]
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec'
+
+require 'mock_redis'
+require 'resque'
+require 'resque-lonely_job'
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    Resque.redis = MockRedis.new
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: nogara-resque-lonely_job
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Jonathan R. Wallace
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+- !ruby/object:Gem::Dependency
+  name: mock_redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+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
+  \   def self.perform\n      # only one at a time in this block, no parallelism allowed
+  for this\n      # particular queue\n    end\n  end\n"
+email:
+- jonathan.wallace@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/resque-lonely_job.rb
+- lib/resque-lonely_job/version.rb
+- resque-lonely_job.gemspec
+- spec/lib/lonely_job_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/wallace/resque-lonely_job
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A resque plugin that ensures that only one job for a given queue will be
+  running on any worker at a given time.
+test_files:
+- spec/lib/lonely_job_spec.rb
+- spec/spec_helper.rb