moneypools-delayed_job 1.8.4

data/lib/delayed_job.rb

@@ -0,0 +1,22 @@
+require 'active_support'
+
+require File.dirname(__FILE__) + '/delayed/message_sending'
+require File.dirname(__FILE__) + '/delayed/performable_method'
+require File.dirname(__FILE__) + '/delayed/backend/base'
+require File.dirname(__FILE__) + '/delayed/worker'
+
+Object.send(:include, Delayed::MessageSending)   
+Module.send(:include, Delayed::MessageSending::ClassMethods)
+
+if defined?(ActiveRecord)
+  Delayed::Worker.backend = :active_record
+elsif defined?(MongoMapper)
+  Delayed::Worker.backend = :mongo_mapper
+else
+  $stderr.puts "Could not decide on a backend, defaulting to active_record"
+  Delayed::Worker.backend = :active_record
+end
+
+if defined?(Merb::Plugins)
+  Merb::Plugins.add_rakefiles File.dirname(__FILE__) / 'delayed' / 'tasks'
+end

data/recipes/delayed_job.rb

@@ -0,0 +1 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'delayed', 'recipes'))

data/spec/backend/active_record_job_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+require 'delayed/backend/active_record'
+
+describe Delayed::Job do
+  before(:all) do
+    @backend = Delayed::Job
+  end
+  
+  before(:each) do
+    Delayed::Worker.max_priority = nil
+    Delayed::Worker.min_priority = nil
+    Delayed::Job.delete_all
+    SimpleJob.runs = 0
+  end
+  
+  after do
+    Time.zone = nil
+  end
+  
+  it_should_behave_like 'a backend'
+
+  context "db_time_now" do
+    it "should return time in current time zone if set" do
+      Time.zone = 'Eastern Time (US & Canada)'
+      Delayed::Job.db_time_now.zone.should == 'EST'
+    end
+    
+    it "should return UTC time if that is the AR default" do
+      Time.zone = nil
+      ActiveRecord::Base.default_timezone = :utc
+      Delayed::Job.db_time_now.zone.should == 'UTC'
+    end
+
+    it "should return local time if that is the AR default" do
+      Time.zone = 'Central Time (US & Canada)'
+      ActiveRecord::Base.default_timezone = :local
+      Delayed::Job.db_time_now.zone.should == 'CST'
+    end
+  end
+  
+end

data/spec/backend/mongo_mapper_job_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+require 'delayed/backend/mongo_mapper'
+
+describe Delayed::Backend::MongoMapper::Job do
+  before(:all) do
+    @backend = Delayed::Backend::MongoMapper::Job
+  end
+  
+  before(:each) do
+    MongoMapper.database.collections.each(&:remove)
+  end
+  
+  it_should_behave_like 'a backend'
+  
+  describe "delayed method" do
+    class MongoStoryReader
+      def read(story)
+        "Epilog: #{story.tell}"
+      end
+    end
+    
+    class MongoStory
+      include ::MongoMapper::Document
+      key :text, String
+      
+      def tell
+        text
+      end
+    end
+    
+    it "should ignore not found errors because they are permanent" do
+      story = MongoStory.create :text => 'Once upon a time…'
+      job = story.send_later(:tell)
+      story.destroy
+      lambda { job.invoke_job }.should_not raise_error
+    end
+
+    it "should store the object as string" do
+      story = MongoStory.create :text => 'Once upon a time…'
+      job = story.send_later(:tell)
+
+      job.payload_object.class.should   == Delayed::PerformableMethod
+      job.payload_object.object.should  == "LOAD;MongoStory;#{story.id}"
+      job.payload_object.method.should  == :tell
+      job.payload_object.args.should    == []
+      job.payload_object.perform.should == 'Once upon a time…'
+    end
+
+    it "should store arguments as string" do
+      story = MongoStory.create :text => 'Once upon a time…'
+      job = MongoStoryReader.new.send_later(:read, story)
+      job.payload_object.class.should   == Delayed::PerformableMethod
+      job.payload_object.method.should  == :read
+      job.payload_object.args.should    == ["LOAD;MongoStory;#{story.id}"]
+      job.payload_object.perform.should == 'Epilog: Once upon a time…'
+    end
+  end
+end

data/spec/backend/shared_backend_spec.rb

@@ -0,0 +1,244 @@
+shared_examples_for 'a backend' do
+  def create_job(opts = {})
+    @backend.create(opts.merge(:payload_object => SimpleJob.new))
+  end
+
+  before do
+    SimpleJob.runs = 0
+  end
+  
+  it "should set run_at automatically if not set" do
+    @backend.create(:payload_object => ErrorJob.new ).run_at.should_not be_nil
+  end
+
+  it "should not set run_at automatically if already set" do
+    later = @backend.db_time_now + 5.minutes
+    @backend.create(:payload_object => ErrorJob.new, :run_at => later).run_at.should be_close(later, 1)
+  end
+
+  it "should raise ArgumentError when handler doesn't respond_to :perform" do
+    lambda { @backend.enqueue(Object.new) }.should raise_error(ArgumentError)
+  end
+
+  it "should increase count after enqueuing items" do
+    @backend.enqueue SimpleJob.new
+    @backend.count.should == 1
+  end
+  
+  it "should be able to set priority when enqueuing items" do
+    @job = @backend.enqueue SimpleJob.new, 5
+    @job.priority.should == 5
+  end
+
+  it "should be able to set run_at when enqueuing items" do
+    later = @backend.db_time_now + 5.minutes
+    @job = @backend.enqueue SimpleJob.new, 5, later
+    @job.run_at.should be_close(later, 1)
+  end
+
+  it "should work with jobs in modules" do
+    M::ModuleJob.runs = 0
+    job = @backend.enqueue M::ModuleJob.new
+    lambda { job.invoke_job }.should change { M::ModuleJob.runs }.from(0).to(1)
+  end
+                   
+  it "should raise an DeserializationError when the job class is totally unknown" do
+    job = @backend.new :handler => "--- !ruby/object:JobThatDoesNotExist {}"
+    lambda { job.payload_object.perform }.should raise_error(Delayed::Backend::DeserializationError)
+  end
+
+  it "should try to load the class when it is unknown at the time of the deserialization" do
+    job = @backend.new :handler => "--- !ruby/object:JobThatDoesNotExist {}"
+    job.should_receive(:attempt_to_load).with('JobThatDoesNotExist').and_return(true)
+    lambda { job.payload_object.perform }.should raise_error(Delayed::Backend::DeserializationError)
+  end
+
+  it "should try include the namespace when loading unknown objects" do
+    job = @backend.new :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::Backend::DeserializationError)
+  end
+
+  it "should also try to load structs when they are unknown (raises TypeError)" do
+    job = @backend.new :handler => "--- !ruby/struct:JobThatDoesNotExist {}"
+    job.should_receive(:attempt_to_load).with('JobThatDoesNotExist').and_return(true)
+    lambda { job.payload_object.perform }.should raise_error(Delayed::Backend::DeserializationError)
+  end
+
+  it "should try include the namespace when loading unknown structs" do
+    job = @backend.new :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::Backend::DeserializationError)
+  end
+  
+  describe "find_available" do
+    it "should not find failed jobs" do
+      @job = create_job :attempts => 50, :failed_at => @backend.db_time_now
+      @backend.find_available('worker', 5, 1.second).should_not include(@job)
+    end
+    
+    it "should not find jobs scheduled for the future" do
+      @job = create_job :run_at => (@backend.db_time_now + 1.minute)
+      @backend.find_available('worker', 5, 4.hours).should_not include(@job)
+    end
+    
+    it "should not find jobs locked by another worker" do
+      @job = create_job(:locked_by => 'other_worker', :locked_at => @backend.db_time_now - 1.minute)
+      @backend.find_available('worker', 5, 4.hours).should_not include(@job)
+    end
+    
+    it "should find open jobs" do
+      @job = create_job
+      @backend.find_available('worker', 5, 4.hours).should include(@job)
+    end
+    
+    it "should find expired jobs" do
+      @job = create_job(:locked_by => 'worker', :locked_at => @backend.db_time_now - 2.minutes)
+      @backend.find_available('worker', 5, 1.minute).should include(@job)
+    end
+    
+    it "should find own jobs" do
+      @job = create_job(:locked_by => 'worker', :locked_at => (@backend.db_time_now - 1.minutes))
+      @backend.find_available('worker', 5, 4.hours).should include(@job)
+    end
+
+    it "should find only the right amount of jobs" do
+      10.times { create_job }
+      @backend.find_available('worker', 7, 4.hours).should have(7).jobs
+    end
+  end
+  
+  context "when another worker is already performing an task, it" do
+
+    before :each do
+      @job = @backend.create :payload_object => SimpleJob.new, :locked_by => 'worker1', :locked_at => @backend.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
+      @backend.find_available('worker2', 1, 6.minutes).length.should == 0
+    end
+
+    it "should be found by another worker if the time has expired" do
+      @backend.find_available('worker2', 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').should be_true
+      @job.lock_exclusively!(5.minutes, 'worker1').should be_true
+      @job.lock_exclusively!(5.minutes, 'worker1').should be_true
+    end                                        
+  end
+  
+  context "when another worker has worked on a task since the job was found to be available, it" do
+
+    before :each do
+      @job = @backend.create :payload_object => SimpleJob.new
+      @job_copy_for_worker_2 = @backend.find(@job.id)
+    end
+
+    it "should not allow a second worker to get exclusive access if already successfully processed by worker1" do
+      @job.destroy
+      @job_copy_for_worker_2.lock_exclusively!(4.hours, 'worker2').should == false
+    end
+
+    it "should not allow a second worker to get exclusive access if failed to be processed by worker1 and run_at time is now in future (due to backing off behaviour)" do
+      @job.update_attributes(:attempts => 1, :run_at => 1.day.from_now)
+      @job_copy_for_worker_2.lock_exclusively!(4.hours, 'worker2').should == false
+    end
+  end
+
+  context "#name" do
+    it "should be the class name of the job that was enqueued" do
+      @backend.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
+      @job = Story.send_later(:create)
+      @job.name.should == "Story.create"
+    end
+
+    it "should be the instance method that will be called if its a performable method object" do
+      @job = Story.create(:text => "...").send_later(:save)
+      @job.name.should == 'Story#save'
+    end
+  end
+  
+  context "worker prioritization" do
+    before(:each) do
+      Delayed::Worker.max_priority = nil
+      Delayed::Worker.min_priority = nil
+    end
+
+    it "should fetch jobs ordered by priority" do
+      10.times { @backend.enqueue SimpleJob.new, rand(10) }
+      jobs = @backend.find_available('worker', 10)
+      jobs.size.should == 10
+      jobs.each_cons(2) do |a, b| 
+        a.priority.should <= b.priority
+      end
+    end
+
+    it "should only find jobs greater than or equal to min priority" do
+      min = 5
+      Delayed::Worker.min_priority = min
+      10.times {|i| @backend.enqueue SimpleJob.new, i }
+      jobs = @backend.find_available('worker', 10)
+      jobs.each {|job| job.priority.should >= min}
+    end
+
+    it "should only find jobs less than or equal to max priority" do
+      max = 5
+      Delayed::Worker.max_priority = max
+      10.times {|i| @backend.enqueue SimpleJob.new, i }
+      jobs = @backend.find_available('worker', 10)
+      jobs.each {|job| job.priority.should <= max}
+    end
+  end
+  
+  context "clear_locks!" do
+    before do
+      @job = create_job(:locked_by => 'worker', :locked_at => @backend.db_time_now)
+    end
+    
+    it "should clear locks for the given worker" do
+      @backend.clear_locks!('worker')
+      @backend.find_available('worker2', 5, 1.minute).should include(@job)
+    end
+    
+    it "should not clear locks for other workers" do
+      @backend.clear_locks!('worker1')
+      @backend.find_available('worker1', 5, 1.minute).should_not include(@job)
+    end
+  end
+  
+  context "unlock" do
+    before do
+      @job = create_job(:locked_by => 'worker', :locked_at => @backend.db_time_now)
+    end
+
+    it "should clear locks" do
+      @job.unlock
+      @job.locked_by.should be_nil
+      @job.locked_at.should be_nil
+    end
+  end
+  
+end

data/spec/delayed_method_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe 'random ruby objects' do
+  before       { Delayed::Job.delete_all }
+
+  it "should respond_to :send_later method" do
+    Object.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 { Object.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
+    lambda { Object.new.send_later(:to_s) }.should change { Delayed::Job.count }.by(1)
+  end
+
+  it "should add a new entry to the job table when send_later is called on the class" do
+    lambda { Object.send_later(:to_s) }.should change { Delayed::Job.count }.by(1)
+  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.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
+
+  context "send_at" do
+    it "should queue a new job" do
+      lambda do
+        "string".send_at(1.hour.from_now, :length)
+      end.should change { Delayed::Job.count }.by(1)
+    end
+    
+    it "should schedule the job in the future" do
+      time = 1.hour.from_now.utc.to_time
+      job = "string".send_at(time, :length)
+      job.run_at.to_i.should == time.to_i
+    end
+    
+    it "should store payload as PerformableMethod" do
+      job = "string".send_at(1.hour.from_now, :count, 'r')
+      job.payload_object.class.should   == Delayed::PerformableMethod
+      job.payload_object.method.should  == :count
+      job.payload_object.args.should    == ['r']
+      job.payload_object.perform.should == 1
+    end
+  end
+
+end

data/spec/performable_method_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+class StoryReader
+  def read(story)
+    "Epilog: #{story.tell}"
+  end
+end
+
+describe Delayed::PerformableMethod do
+  
+  it "should ignore ActiveRecord::RecordNotFound errors because they are permanent" do
+    story = Story.create :text => 'Once upon...'
+    p = Delayed::PerformableMethod.new(story, :tell, [])
+    story.destroy
+    lambda { p.perform }.should_not raise_error
+  end
+  
+  it "should store the object as string if its an active record" do
+    story = Story.create :text => 'Once upon...'
+    p = Delayed::PerformableMethod.new(story, :tell, [])
+    p.class.should   == Delayed::PerformableMethod
+    p.object.should  == "LOAD;Story;#{story.id}"
+    p.method.should  == :tell
+    p.args.should    == []
+    p.perform.should == 'Once upon...'
+  end
+  
+  it "should allow class methods to be called on ActiveRecord models" do
+    p = Delayed::PerformableMethod.new(Story, :count, [])
+    lambda { p.send(:load, p.object) }.should_not raise_error
+  end
+  
+  it "should store arguments as string if they are active record objects" do
+    story = Story.create :text => 'Once upon...'
+    reader = StoryReader.new
+    p = Delayed::PerformableMethod.new(reader, :read, [story])
+    p.class.should   == Delayed::PerformableMethod
+    p.method.should  == :read
+    p.args.should    == ["LOAD;Story;#{story.id}"]
+    p.perform.should == 'Epilog: Once upon...'
+  end                 
+end