delayed-job-ajaycb 2.0.10

data/lib/delayed/deserialization_error.rb

@@ -0,0 +1,4 @@
+module Delayed
+  class DeserializationError < StandardError
+  end
+end

data/lib/delayed/message_sending.rb

@@ -0,0 +1,53 @@
+module Delayed
+  class DelayProxy < ActiveSupport::BasicObject
+    def initialize(target, options)
+      @target = target
+      @options = options
+    end
+
+    def method_missing(method, *args)
+      Job.create({
+        :payload_object => PerformableMethod.new(@target, method.to_sym, args),
+        :priority       => ::Delayed::Worker.default_priority
+      }.merge(@options))
+    end
+  end
+
+  module MessageSending
+    def delay(options = {})
+      DelayProxy.new(self, options)
+    end
+    alias __delay__ delay
+    
+    def send_later(method, *args)
+      warn "[DEPRECATION] `object.send_later(:method)` is deprecated. Use `object.delay.method"
+      __delay__.__send__(method, *args)
+    end
+
+    def send_at(time, method, *args)
+      warn "[DEPRECATION] `object.send_at(time, :method)` is deprecated. Use `object.delay(:run_at => time).method"
+      __delay__(:run_at => time).__send__(method, *args)
+    end
+    
+    module ClassMethods
+      def handle_asynchronously(method, opts = {})
+        aliased_method, punctuation = method.to_s.sub(/([?!=])$/, ''), $1
+        with_method, without_method = "#{aliased_method}_with_delay#{punctuation}", "#{aliased_method}_without_delay#{punctuation}"
+        define_method(with_method) do |*args|
+          curr_opts = opts.clone
+          curr_opts.each_key do |key|
+            if (val = curr_opts[key]).is_a?(Proc)
+              curr_opts[key] = if val.arity == 1
+                val.call(self)
+              else
+                val.call
+              end
+            end
+          end
+          delay(curr_opts).__send__(without_method, *args)
+        end
+        alias_method_chain method, :delay
+      end
+    end
+  end                               
+end

data/lib/delayed/performable_method.rb

@@ -0,0 +1,62 @@
+class Class
+  def load_for_delayed_job(arg)
+    self
+  end
+  
+  def dump_for_delayed_job
+    name
+  end
+end
+
+module Delayed
+  class PerformableMethod < Struct.new(:object, :method, :args)
+    STRING_FORMAT = /^LOAD\;([A-Z][\w\:]+)(?:\;(\w+))?$/
+    
+    class LoadError < StandardError
+    end
+
+    def initialize(object, method, args)
+      raise NoMethodError, "undefined method `#{method}' for #{object.inspect}" unless object.respond_to?(method, true)
+
+      self.object = dump(object)
+      self.args   = args.map { |a| dump(a) }
+      self.method = method.to_sym
+    end
+    
+    def display_name
+      if STRING_FORMAT === object
+        "#{$1}#{$2 ? '#' : '.'}#{method}"
+      else
+        "#{object.class}##{method}"
+      end
+    end
+    
+    def perform
+      load(object).send(method, *args.map{|a| load(a)})
+    rescue PerformableMethod::LoadError
+      # We cannot do anything about objects that can't be loaded
+      true
+    end
+
+    private
+
+    def load(obj)
+      if STRING_FORMAT === obj
+        $1.constantize.load_for_delayed_job($2)
+      else
+        obj
+      end
+    rescue => e
+      Delayed::Worker.logger.warn "Could not load object for job: #{e.message}"
+      raise PerformableMethod::LoadError
+    end
+
+    def dump(obj)
+      if obj.respond_to?(:dump_for_delayed_job)
+        "LOAD;#{obj.dump_for_delayed_job}"
+      else
+        obj
+      end
+    end
+  end
+end

data/lib/delayed/railtie.rb

@@ -0,0 +1,10 @@
+require 'delayed_job'
+require 'rails'
+
+module Delayed
+  class Railtie < Rails::Railtie
+    initializer :after_initialize do
+      Delayed::Worker.guess_backend
+    end
+  end
+end

data/lib/delayed/recipes.rb

@@ -0,0 +1,50 @@
+# Capistrano Recipes for managing delayed_job
+#
+# Add these callbacks to have the delayed_job process restart when the server
+# is restarted:
+#
+#   after "deploy:stop",    "delayed_job:stop"
+#   after "deploy:start",   "delayed_job:start"
+#   after "deploy:restart", "delayed_job:restart"
+#
+# If you want to use command line options, for example to start multiple workers,
+# define a Capistrano variable delayed_job_args:
+#
+#   set :delayed_jobs_args, "-n 2"
+#
+# If you've got delayed_job workers running on a servers, you can also specify
+# which servers have delayed_job running and should be restarted after deploy.
+#
+#   set :delayed_job_server_role, :worker
+#
+
+Capistrano::Configuration.instance.load do
+  namespace :delayed_job do
+    def rails_env
+      fetch(:rails_env, false) ? "RAILS_ENV=#{fetch(:rails_env)}" : ''
+    end
+    
+    def args
+      fetch(:delayed_job_args, "")
+    end
+    
+    def roles
+      fetch(:delayed_job_server_role, :app)
+    end
+    
+    desc "Stop the delayed_job process"
+    task :stop, :roles => lambda { roles } do
+      run "cd #{current_path};#{rails_env} script/delayed_job stop"
+    end
+
+    desc "Start the delayed_job process"
+    task :start, :roles => lambda { roles } do
+      run "cd #{current_path};#{rails_env} script/delayed_job start #{args}"
+    end
+
+    desc "Restart the delayed_job process"
+    task :restart, :roles => lambda { roles } do
+      run "cd #{current_path};#{rails_env} script/delayed_job restart #{args}"
+    end
+  end
+end

data/lib/delayed/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

data/lib/delayed/worker.rb

@@ -0,0 +1,190 @@
+require 'timeout'
+require 'active_support/core_ext/numeric/time'
+
+module Delayed
+  class Worker
+    cattr_accessor :min_priority, :max_priority, :max_attempts, :max_run_time, :default_priority, :sleep_delay, :logger
+
+    attr_accessor :queues
+    
+    self.sleep_delay = 5
+    self.max_attempts = 25
+    self.max_run_time = 4.hours
+    self.default_priority = 0
+
+    # By default failed jobs are destroyed after too many attempts. If you want to keep them around
+    # (perhaps to inspect the reason for the failure), set this to false.
+    cattr_accessor :destroy_failed_jobs
+    self.destroy_failed_jobs = true
+    
+    self.logger = if defined?(Merb::Logger)
+      Merb.logger
+    elsif defined?(RAILS_DEFAULT_LOGGER)
+      RAILS_DEFAULT_LOGGER
+    end
+
+    # name_prefix is ignored if name is set directly
+    attr_accessor :name_prefix
+    
+    cattr_reader :backend
+    
+    def self.backend=(backend)
+      if backend.is_a? Symbol
+        require "delayed/backend/#{backend}"
+        backend = "Delayed::Backend::#{backend.to_s.classify}::Job".constantize
+      end
+      @@backend = backend
+      silence_warnings { ::Delayed.const_set(:Job, backend) }
+    end
+    
+    def self.guess_backend
+      self.backend ||= if defined?(ActiveRecord)
+        :active_record
+      elsif defined?(MongoMapper)
+        :mongo_mapper
+      else
+        logger.warn "Could not decide on a backend, defaulting to active_record"
+        :active_record
+      end
+    end
+
+    def initialize(options={})
+      @quiet = options[:quiet]
+      self.class.min_priority = options[:min_priority] if options.has_key?(:min_priority)
+      self.class.max_priority = options[:max_priority] if options.has_key?(:max_priority)
+      self.class.sleep_delay = options[:sleep_delay] if options.has_key?(:sleep_delay)
+      self.queues = options[:queues] || ["default"]
+    end
+
+    # Every worker has a unique name which by default is the pid of the process. There are some
+    # advantages to overriding this with something which survives worker retarts:  Workers can#
+    # safely resume working on tasks which are locked by themselves. The worker will assume that
+    # it crashed before.
+    def name
+      return @name unless @name.nil?
+      "#{@name_prefix}host:#{Socket.gethostname} pid:#{Process.pid}" rescue "#{@name_prefix}pid:#{Process.pid}"
+    end
+
+    # Sets the name of the worker.
+    # Setting the name to nil will reset the default worker name
+    def name=(val)
+      @name = val
+    end
+
+    def start
+      say "Starting job worker"
+
+      trap('TERM') { say 'Exiting...'; $exit = true }
+      trap('INT')  { say 'Exiting...'; $exit = true }
+
+      loop do
+        result = nil
+
+        realtime = Benchmark.realtime do
+          result = work_off
+        end
+
+        count = result.sum
+
+        break if $exit
+
+        if count.zero?
+          sleep(self.class.sleep_delay)
+        else
+          say "#{count} jobs processed at %.4f j/s, %d failed ..." % [count / realtime, result.last]
+        end
+
+        break if $exit
+      end
+
+    ensure
+      Delayed::Job.clear_locks!(name)
+    end
+    
+    # Do num jobs and return stats on success/failure.
+    # Exit early if interrupted.
+    def work_off(num = 100)
+      success, failure = 0, 0
+
+      num.times do
+        case reserve_and_run_one_job
+        when true
+            success += 1
+        when false
+            failure += 1
+        else
+          break  # leave if no work could be done
+        end
+        break if $exit # leave if we're exiting
+      end
+
+      return [success, failure]
+    end
+    
+    def run(job)
+      runtime =  Benchmark.realtime do
+        Timeout.timeout(self.class.max_run_time.to_i) { job.invoke_job }
+        job.destroy
+      end
+      say "#{job.name} completed after %.4f" % runtime
+      return true  # did work
+    rescue DeserializationError => error
+      job.last_error = "{#{error.message}\n#{error.backtrace.join('\n')}"
+      failed(job)
+    rescue Exception => error
+      handle_failed_job(job, error)
+      return false  # work failed
+    end
+    
+    # Reschedule the job in the future (when a job fails).
+    # Uses an exponential scale depending on the number of failed attempts.
+    def reschedule(job, time = nil)
+      if (job.attempts += 1) < max_attempts(job)
+        job.run_at = time || job.reschedule_at
+        job.unlock
+        job.save!
+      else
+        say "PERMANENTLY removing #{job.name} because of #{job.attempts} consecutive failures.", Logger::INFO
+        failed(job)
+      end
+    end
+
+    def failed(job)
+      begin
+        if job.payload_object.respond_to? :on_permanent_failure
+            say "Running on_permanent_failure hook"
+            job.payload_object.on_permanent_failure
+        end
+      rescue DeserializationError
+        # do nothing
+      end
+      
+      self.class.destroy_failed_jobs ? job.destroy : job.update_attributes(:failed_at => Delayed::Job.db_time_now)
+    end
+
+    def say(text, level = Logger::INFO)
+      text = "[Worker(#{name})] #{text}"
+      puts text unless @quiet
+      logger.add level, "#{Time.now.strftime('%FT%T%z')}: #{text}" if logger
+    end
+
+    def max_attempts(job)
+      job.max_attempts || self.class.max_attempts
+    end
+    
+  protected
+    
+    def handle_failed_job(job, error)
+      job.last_error = error.message + "\n" + error.backtrace.join("\n")
+      say "#{job.name} failed with #{error.class.name}: #{error.message} - #{job.attempts} failed attempts", Logger::ERROR
+      reschedule(job)
+    end
+    
+    # Run the next job we can get an exclusive lock on.
+    # If no jobs are left we return nil
+    def reserve_and_run_one_job
+      job = Delayed::Job.reserve(self)
+      run(job) if job
+    end
+  end
+end

data/lib/delayed_job.rb

@@ -0,0 +1,15 @@
+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'
+require File.dirname(__FILE__) + '/delayed/deserialization_error'
+require File.dirname(__FILE__) + '/delayed/railtie' if defined?(::Rails::Railtie)
+
+Object.send(:include, Delayed::MessageSending)   
+Module.send(:include, Delayed::MessageSending::ClassMethods)
+
+if defined?(Merb::Plugins)
+  Merb::Plugins.add_rakefiles File.dirname(__FILE__) / 'delayed' / 'tasks'
+end

data/rails/init.rb

@@ -0,0 +1,5 @@
+require 'delayed_job'
+
+config.after_initialize do
+  Delayed::Worker.guess_backend
+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,70 @@
+require 'spec_helper'
+require 'backend/shared_backend_spec'
+require 'delayed/backend/active_record'
+
+describe Delayed::Backend::ActiveRecord::Job do
+  before(:all) do
+    @backend = Delayed::Backend::ActiveRecord::Job
+  end
+  
+  before(:each) do
+    Delayed::Backend::ActiveRecord::Job.delete_all
+    SimpleJob.runs = 0
+  end
+  
+  after do
+    Time.zone = nil
+  end
+  
+  it_should_behave_like 'a backend'
+
+  describe "reserve with queue names" do
+    before do
+      Delayed::Worker.max_run_time = 2.minutes
+      @worker_q1 = Delayed::Worker.new(:quiet => true, :queues => ["q1"])
+      @worker_q2 = Delayed::Worker.new(:quiet => true, :queues => ["q2"])
+    end
+
+    it "q1 should not reserve default queue" do
+      create_job 
+      described_class.reserve(@worker_q1).should be_nil
+      described_class.reserve(@worker_q2).should be_nil
+    end
+
+    it "q1 should be able to reserve on q1 queue" do
+      create_job(:queue_name=>"q1")
+      described_class.reserve(@worker_q1).should_not be_nil
+    end
+
+    it "q1 should not be able to reserve on q2 queue" do
+      create_job(:queue_name=>"q2")
+      described_class.reserve(@worker_q1).should be_nil
+    end
+  end
+
+  context "db_time_now" do
+    it "should return time in current time zone if set" do
+      Time.zone = 'Eastern Time (US & Canada)'
+      %w(EST EDT).should include(Delayed::Job.db_time_now.zone)
+    end
+    
+    it "should return UTC time if that is the AR default" do
+      Time.zone = nil
+      ActiveRecord::Base.default_timezone = :utc
+      Delayed::Backend::ActiveRecord::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
+      %w(CST CDT).should include(Delayed::Backend::ActiveRecord::Job.db_time_now.zone)
+    end
+  end
+  
+  describe "after_fork" do
+    it "should call reconnect on the connection" do
+      ActiveRecord::Base.connection.should_receive(:reconnect!)
+      Delayed::Backend::ActiveRecord::Job.after_fork
+    end
+  end
+end