keithmgould-delayed_job 1.7.1

data/lib/delayed_job.rb

@@ -0,0 +1,13 @@
+autoload :ActiveRecord, 'activerecord'
+
+require File.dirname(__FILE__) + '/delayed/message_sending'
+require File.dirname(__FILE__) + '/delayed/performable_method'
+require File.dirname(__FILE__) + '/delayed/job'
+require File.dirname(__FILE__) + '/delayed/worker'
+
+Object.send(:include, Delayed::MessageSending)   
+Module.send(:include, Delayed::MessageSending::ClassMethods)
+
+if defined?(Merb::Plugins)
+  Merb::Plugins.add_rakefiles File.dirname(__FILE__) / '..' / 'tasks' / 'tasks'
+end

data/spec/database.rb

@@ -0,0 +1,43 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+$:.unshift(File.dirname(__FILE__) + '/../../rspec/lib')
+
+require 'rubygems'
+require 'active_record'
+gem 'sqlite3-ruby'
+
+require File.dirname(__FILE__) + '/../init'
+require 'spec'
+  
+ActiveRecord::Base.logger = Logger.new('/tmp/dj.log')
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => '/tmp/jobs.sqlite')
+ActiveRecord::Migration.verbose = false
+ActiveRecord::Base.default_timezone = :utc if Time.zone.nil?
+
+ActiveRecord::Schema.define do
+
+  create_table :delayed_jobs, :force => true do |table|
+    table.integer  :priority, :default => 0
+    table.integer  :attempts, :default => 0
+    table.text     :handler
+    table.string   :last_error
+    table.datetime :run_at
+    table.datetime :locked_at
+    table.string   :locked_by
+    table.datetime :failed_at
+    table.timestamps
+  end
+
+  create_table :stories, :force => true do |table|
+    table.string :text
+  end
+
+end
+
+
+# Purely useful for test cases...
+class Story < ActiveRecord::Base
+  def tell; text; end       
+  def whatever(n, _); tell*n; end
+  
+  handle_asynchronously :whatever
+end

data/spec/delayed_method_spec.rb

@@ -0,0 +1,128 @@
+require File.dirname(__FILE__) + '/database'
+
+class SimpleJob
+  cattr_accessor :runs; self.runs = 0
+  def perform; @@runs += 1; end
+end
+
+class RandomRubyObject  
+  def say_hello
+    'hello'
+  end
+end
+
+class ErrorObject
+
+  def throw
+    raise ActiveRecord::RecordNotFound, '...'
+    false
+  end
+
+end
+
+class StoryReader
+
+  def read(story)
+    "Epilog: #{story.tell}"
+  end
+
+end
+
+class StoryReader
+
+  def read(story)
+    "Epilog: #{story.tell}"
+  end
+
+end
+
+describe 'random ruby objects' do
+  before       { Delayed::Job.delete_all }
+
+  it "should respond_to :send_later method" do
+
+    RandomRubyObject.new.respond_to?(:send_later)
+
+  end
+
+  it "should raise a ArgumentError if send_later is called but the target method doesn't exist" do
+    lambda { RandomRubyObject.new.send_later(:method_that_deos_not_exist) }.should raise_error(NoMethodError)
+  end
+
+  it "should add a new entry to the job table when send_later is called on it" do
+    Delayed::Job.count.should == 0
+
+    RandomRubyObject.new.send_later(:to_s)
+
+    Delayed::Job.count.should == 1
+  end
+
+  it "should add a new entry to the job table when send_later is called on the class" do
+    Delayed::Job.count.should == 0
+
+    RandomRubyObject.send_later(:to_s)
+
+    Delayed::Job.count.should == 1
+  end
+
+  it "should run get the original method executed when the job is performed" do
+
+    RandomRubyObject.new.send_later(:say_hello)
+
+    Delayed::Job.count.should == 1
+  end
+
+  it "should ignore ActiveRecord::RecordNotFound errors because they are permanent" do
+
+    ErrorObject.new.send_later(:throw)
+
+    Delayed::Job.count.should == 1
+
+    Delayed::Job.reserve_and_run_one_job
+
+    Delayed::Job.count.should == 0
+
+  end
+
+  it "should store the object as string if its an active record" do
+    story = Story.create :text => 'Once upon...'
+    story.send_later(:tell)
+
+    job =  Delayed::Job.find(:first)
+    job.payload_object.class.should   == Delayed::PerformableMethod
+    job.payload_object.object.should  == "AR:Story:#{story.id}"
+    job.payload_object.method.should  == :tell
+    job.payload_object.args.should    == []
+    job.payload_object.perform.should == 'Once upon...'
+  end
+
+  it "should store arguments as string if they an active record" do
+
+    story = Story.create :text => 'Once upon...'
+
+    reader = StoryReader.new
+    reader.send_later(:read, story)
+
+    job =  Delayed::Job.find(:first)
+    job.payload_object.class.should   == Delayed::PerformableMethod
+    job.payload_object.method.should  == :read
+    job.payload_object.args.should    == ["AR:Story:#{story.id}"]
+    job.payload_object.perform.should == 'Epilog: Once upon...'
+  end                 
+  
+  it "should call send later on methods which are wrapped with handle_asynchronously" do
+    story = Story.create :text => 'Once upon...'
+  
+    Delayed::Job.count.should == 0
+  
+    story.whatever(1, 5)
+  
+    Delayed::Job.count.should == 1
+    job =  Delayed::Job.find(:first)
+    job.payload_object.class.should   == Delayed::PerformableMethod
+    job.payload_object.method.should  == :whatever_without_send_later
+    job.payload_object.args.should    == [1, 5]
+    job.payload_object.perform.should == 'Once upon...'
+  end
+
+end

data/spec/job_spec.rb

@@ -0,0 +1,345 @@
+require File.dirname(__FILE__) + '/database'
+
+class SimpleJob
+  cattr_accessor :runs; self.runs = 0
+  def perform; @@runs += 1; end
+end
+
+class ErrorJob
+  cattr_accessor :runs; self.runs = 0
+  def perform; raise 'did not work'; end
+end             
+
+module M
+  class ModuleJob
+    cattr_accessor :runs; self.runs = 0
+    def perform; @@runs += 1; end    
+  end
+  
+end
+
+describe Delayed::Job do
+  before  do               
+    Delayed::Job.max_priority = nil
+    Delayed::Job.min_priority = nil      
+    
+    Delayed::Job.delete_all
+  end
+  
+  before(:each) do
+    SimpleJob.runs = 0
+  end
+
+  it "should set run_at automatically if not set" do
+    Delayed::Job.create(:payload_object => ErrorJob.new ).run_at.should_not == nil
+  end
+
+  it "should not set run_at automatically if already set" do
+    later = 5.minutes.from_now
+    Delayed::Job.create(:payload_object => ErrorJob.new, :run_at => later).run_at.should == later
+  end
+
+  it "should raise ArgumentError when handler doesn't respond_to :perform" do
+    lambda { Delayed::Job.enqueue(Object.new) }.should raise_error(ArgumentError)
+  end
+
+  it "should increase count after enqueuing items" do
+    Delayed::Job.enqueue SimpleJob.new
+    Delayed::Job.count.should == 1
+  end
+
+  it "should be able to set priority when enqueuing items" do
+    Delayed::Job.enqueue SimpleJob.new, 5
+    Delayed::Job.first.priority.should == 5
+  end
+
+  it "should be able to set run_at when enqueuing items" do
+    later = (Delayed::Job.db_time_now+5.minutes)
+    Delayed::Job.enqueue SimpleJob.new, 5, later
+
+    # use be close rather than equal to because millisecond values cn be lost in DB round trip
+    Delayed::Job.first.run_at.should be_close(later, 1)
+  end
+
+  it "should call perform on jobs when running work_off" do
+    SimpleJob.runs.should == 0
+
+    Delayed::Job.enqueue SimpleJob.new
+    Delayed::Job.work_off
+
+    SimpleJob.runs.should == 1
+  end
+                     
+                     
+  it "should work with eval jobs" do
+    $eval_job_ran = false
+
+    Delayed::Job.enqueue do <<-JOB
+      $eval_job_ran = true
+    JOB
+    end
+
+    Delayed::Job.work_off
+
+    $eval_job_ran.should == true
+  end
+                   
+  it "should work with jobs in modules" do
+    M::ModuleJob.runs.should == 0
+
+    Delayed::Job.enqueue M::ModuleJob.new
+    Delayed::Job.work_off
+
+    M::ModuleJob.runs.should == 1
+  end
+                   
+  it "should re-schedule by about 1 second at first and increment this more and more minutes when it fails to execute properly" do
+    Delayed::Job.enqueue ErrorJob.new
+    Delayed::Job.work_off(1)
+
+    job = Delayed::Job.find(:first)
+
+    job.last_error.should =~ /did not work/
+    job.last_error.should =~ /job_spec.rb:10:in `perform'/
+    job.attempts.should == 1
+
+    job.run_at.should > Delayed::Job.db_time_now - 10.minutes
+    job.run_at.should < Delayed::Job.db_time_now + 10.minutes
+  end
+
+  it "should raise an DeserializationError when the job class is totally unknown" do
+
+    job = Delayed::Job.new
+    job['handler'] = "--- !ruby/object:JobThatDoesNotExist {}"
+
+    lambda { job.payload_object.perform }.should raise_error(Delayed::DeserializationError)
+  end
+
+  it "should try to load the class when it is unknown at the time of the deserialization" do
+    job = Delayed::Job.new
+    job['handler'] = "--- !ruby/object:JobThatDoesNotExist {}"
+
+    job.should_receive(:attempt_to_load).with('JobThatDoesNotExist').and_return(true)
+
+    lambda { job.payload_object.perform }.should raise_error(Delayed::DeserializationError)
+  end
+
+  it "should try include the namespace when loading unknown objects" do
+    job = Delayed::Job.new
+    job['handler'] = "--- !ruby/object:Delayed::JobThatDoesNotExist {}"
+    job.should_receive(:attempt_to_load).with('Delayed::JobThatDoesNotExist').and_return(true)
+    lambda { job.payload_object.perform }.should raise_error(Delayed::DeserializationError)
+  end
+
+  it "should also try to load structs when they are unknown (raises TypeError)" do
+    job = Delayed::Job.new
+    job['handler'] = "--- !ruby/struct:JobThatDoesNotExist {}"
+
+    job.should_receive(:attempt_to_load).with('JobThatDoesNotExist').and_return(true)
+
+    lambda { job.payload_object.perform }.should raise_error(Delayed::DeserializationError)
+  end
+
+  it "should try include the namespace when loading unknown structs" do
+    job = Delayed::Job.new
+    job['handler'] = "--- !ruby/struct:Delayed::JobThatDoesNotExist {}"
+
+    job.should_receive(:attempt_to_load).with('Delayed::JobThatDoesNotExist').and_return(true)
+    lambda { job.payload_object.perform }.should raise_error(Delayed::DeserializationError)
+  end
+  
+  it "should be failed if it failed more than MAX_ATTEMPTS times and we don't want to destroy jobs" do
+    default = Delayed::Job.destroy_failed_jobs
+    Delayed::Job.destroy_failed_jobs = false
+
+    @job = Delayed::Job.create :payload_object => SimpleJob.new, :attempts => 50
+    @job.reload.failed_at.should == nil
+    @job.reschedule 'FAIL'
+    @job.reload.failed_at.should_not == nil
+
+    Delayed::Job.destroy_failed_jobs = default
+  end
+
+  it "should be destroyed if it failed more than MAX_ATTEMPTS times and we want to destroy jobs" do
+    default = Delayed::Job.destroy_failed_jobs
+    Delayed::Job.destroy_failed_jobs = true
+
+    @job = Delayed::Job.create :payload_object => SimpleJob.new, :attempts => 50
+    @job.should_receive(:destroy)
+    @job.reschedule 'FAIL'
+
+    Delayed::Job.destroy_failed_jobs = default
+  end
+
+  it "should never find failed jobs" do
+    @job = Delayed::Job.create :payload_object => SimpleJob.new, :attempts => 50, :failed_at => Delayed::Job.db_time_now
+    Delayed::Job.find_available(1).length.should == 0
+  end
+
+  context "when another worker is already performing an task, it" do
+
+    before :each do
+      Delayed::Job.worker_name = 'worker1'
+      @job = Delayed::Job.create :payload_object => SimpleJob.new, :locked_by => 'worker1', :locked_at => Delayed::Job.db_time_now - 5.minutes
+    end
+
+    it "should not allow a second worker to get exclusive access" do
+      @job.lock_exclusively!(4.hours, 'worker2').should == false
+    end
+
+    it "should allow a second worker to get exclusive access if the timeout has passed" do
+      @job.lock_exclusively!(1.minute, 'worker2').should == true
+    end      
+    
+    it "should be able to get access to the task if it was started more then max_age ago" do
+      @job.locked_at = 5.hours.ago
+      @job.save
+
+      @job.lock_exclusively! 4.hours, 'worker2'
+      @job.reload
+      @job.locked_by.should == 'worker2'
+      @job.locked_at.should > 1.minute.ago
+    end
+
+    it "should not be found by another worker" do
+      Delayed::Job.worker_name = 'worker2'
+
+      Delayed::Job.find_available(1, 6.minutes).length.should == 0
+    end
+
+    it "should be found by another worker if the time has expired" do
+      Delayed::Job.worker_name = 'worker2'
+
+      Delayed::Job.find_available(1, 4.minutes).length.should == 1
+    end
+
+    it "should be able to get exclusive access again when the worker name is the same" do
+      @job.lock_exclusively! 5.minutes, 'worker1'
+      @job.lock_exclusively! 5.minutes, 'worker1'
+      @job.lock_exclusively! 5.minutes, 'worker1'
+    end                                        
+  end            
+  
+  context "#name" do
+    it "should be the class name of the job that was enqueued" do
+      Delayed::Job.create(:payload_object => ErrorJob.new ).name.should == 'ErrorJob'
+    end
+
+    it "should be the method that will be called if its a performable method object" do
+      Delayed::Job.send_later(:clear_locks!)
+      Delayed::Job.last.name.should == 'Delayed::Job.clear_locks!'
+
+    end
+    it "should be the instance method that will be called if its a performable method object" do
+      story = Story.create :text => "..."                 
+      
+      story.send_later(:save)
+      
+      Delayed::Job.last.name.should == 'Story#save'
+    end
+  end
+  
+  context "worker prioritization" do
+    
+    before(:each) do
+      Delayed::Job.max_priority = nil
+      Delayed::Job.min_priority = nil      
+    end
+  
+    it "should only work_off jobs that are >= min_priority" do
+      Delayed::Job.min_priority = -5
+      Delayed::Job.max_priority = 5
+      SimpleJob.runs.should == 0
+    
+      Delayed::Job.enqueue SimpleJob.new, -10
+      Delayed::Job.enqueue SimpleJob.new, 0
+      Delayed::Job.work_off
+    
+      SimpleJob.runs.should == 1
+    end
+  
+    it "should only work_off jobs that are <= max_priority" do
+      Delayed::Job.min_priority = -5
+      Delayed::Job.max_priority = 5
+      SimpleJob.runs.should == 0
+    
+      Delayed::Job.enqueue SimpleJob.new, 10
+      Delayed::Job.enqueue SimpleJob.new, 0
+
+      Delayed::Job.work_off
+
+      SimpleJob.runs.should == 1
+    end                         
+   
+  end
+  
+  context "when pulling jobs off the queue for processing, it" do
+    before(:each) do
+      @job = Delayed::Job.create(
+        :payload_object => SimpleJob.new, 
+        :locked_by => 'worker1', 
+        :locked_at => Delayed::Job.db_time_now - 5.minutes)
+    end
+
+    it "should leave the queue in a consistent state and not run the job if locking fails" do
+      SimpleJob.runs.should == 0     
+      @job.stub!(:lock_exclusively!).with(any_args).once.and_return(false)
+      Delayed::Job.should_receive(:find_available).once.and_return([@job])
+      Delayed::Job.work_off(1)
+      SimpleJob.runs.should == 0
+    end
+  
+  end
+  
+  context "while running alongside other workers that locked jobs, it" do
+    before(:each) do
+      Delayed::Job.worker_name = 'worker1'
+      Delayed::Job.create(:payload_object => SimpleJob.new, :locked_by => 'worker1', :locked_at => (Delayed::Job.db_time_now - 1.minutes))
+      Delayed::Job.create(:payload_object => SimpleJob.new, :locked_by => 'worker2', :locked_at => (Delayed::Job.db_time_now - 1.minutes))
+      Delayed::Job.create(:payload_object => SimpleJob.new)
+      Delayed::Job.create(:payload_object => SimpleJob.new, :locked_by => 'worker1', :locked_at => (Delayed::Job.db_time_now - 1.minutes))
+    end
+
+    it "should ingore locked jobs from other workers" do
+      Delayed::Job.worker_name = 'worker3'
+      SimpleJob.runs.should == 0
+      Delayed::Job.work_off
+      SimpleJob.runs.should == 1 # runs the one open job
+    end
+
+    it "should find our own jobs regardless of locks" do
+      Delayed::Job.worker_name = 'worker1'
+      SimpleJob.runs.should == 0
+      Delayed::Job.work_off
+      SimpleJob.runs.should == 3 # runs open job plus worker1 jobs that were already locked
+    end
+  end
+
+  context "while running with locked and expired jobs, it" do
+    before(:each) do
+      Delayed::Job.worker_name = 'worker1'
+      exp_time = Delayed::Job.db_time_now - (1.minutes + Delayed::Job::MAX_RUN_TIME)
+      Delayed::Job.create(:payload_object => SimpleJob.new, :locked_by => 'worker1', :locked_at => exp_time)
+      Delayed::Job.create(:payload_object => SimpleJob.new, :locked_by => 'worker2', :locked_at => (Delayed::Job.db_time_now - 1.minutes))
+      Delayed::Job.create(:payload_object => SimpleJob.new)
+      Delayed::Job.create(:payload_object => SimpleJob.new, :locked_by => 'worker1', :locked_at => (Delayed::Job.db_time_now - 1.minutes))
+    end
+
+    it "should only find unlocked and expired jobs" do
+      Delayed::Job.worker_name = 'worker3'
+      SimpleJob.runs.should == 0
+      Delayed::Job.work_off
+      SimpleJob.runs.should == 2 # runs the one open job and one expired job
+    end
+
+    it "should ignore locks when finding our own jobs" do
+      Delayed::Job.worker_name = 'worker1'
+      SimpleJob.runs.should == 0
+      Delayed::Job.work_off
+      SimpleJob.runs.should == 3 # runs open job plus worker1 jobs
+      # This is useful in the case of a crash/restart on worker1, but make sure multiple workers on the same host have unique names!
+    end
+
+  end
+  
+end

data/spec/story_spec.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + '/database'
+
+describe "A story" do
+
+  before(:all) do
+    @story = Story.create :text => "Once upon a time..."
+  end
+
+  it "should be shared" do
+    @story.tell.should == 'Once upon a time...'
+  end
+
+  it "should not return its result if it storytelling is delayed" do
+    @story.send_later(:tell).should_not == 'Once upon a time...'
+  end
+
+end

data/spec/worker_spec.rb

@@ -0,0 +1,60 @@
+require File.dirname(__FILE__) + '/database'
+
+class SimpleJob
+  def perform; puts "I'm being run"; end
+end
+
+describe Delayed::Worker do
+  before do
+    Delayed::Job.delete_all
+  end
+  
+  describe "#idle_after" do
+    it "should default to 1 minute" do
+      w = Delayed::Worker.new
+      w.idle_after.should == 1.minute
+    end
+  
+    it "should be over-ridable" do
+      w = Delayed::Worker.new(:idle_after => 2.minutes)
+      w.idle_after.should == 2.minutes
+    end
+  end
+  
+  describe "#next_idle" do
+    it "should equal Time.now + idle_after" do
+      worker = Delayed::Worker.new
+      worker_thread = Thread.new { worker.start }
+      expected_next_idle = Time.new + worker.idle_after
+      next_idle = worker.next_idle
+      sleep(2)
+      Thread.kill(worker_thread)
+      next_idle.should be_close(expected_next_idle, 2)
+    end
+  
+    it "should update after we return from a job" do
+      worker = Delayed::Worker.new
+      worker_thread = Thread.new { worker.start }
+      next_idle_start = worker.next_idle
+      sleep(2)
+      Delayed::Job.enqueue SimpleJob.new
+      sleep(10)
+      next_idle_after = worker.next_idle
+      Thread.kill(worker_thread)
+      next_idle_after.should > next_idle_start
+    end
+  end
+  
+  describe "#on_idle" do
+    it "should be called when Time.now > next_idle" do
+      Delayed::Worker.class_eval "def on_idle; @test_var = true; end"
+      worker = Delayed::Worker.new(:idle_after => 5)
+      worker_thread = Thread.new { worker.start }
+      worker.instance_variable_defined?(:@test_var).should == false
+      sleep(10)
+      worker.instance_variable_defined?(:@test_var).should == true
+      Thread.kill(worker_thread)
+    end
+  end
+  
+end

data/tasks/jobs.rake

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'tasks')

data/tasks/tasks.rb

@@ -0,0 +1,15 @@
+# Re-definitions are appended to existing tasks
+task :environment
+task :merb_env
+
+namespace :jobs do
+  desc "Clear the delayed_job queue."
+  task :clear => [:merb_env, :environment] do
+    Delayed::Job.delete_all
+  end
+
+  desc "Start a delayed_job worker."
+  task :work => [:merb_env, :environment] do
+    Delayed::Worker.new(:min_priority => ENV['MIN_PRIORITY'], :max_priority => ENV['MAX_PRIORITY']).start
+  end
+end