delayed_job_hooked 2.1.5

data/lib/delayed/command.rb

@@ -0,0 +1,112 @@
+require 'rubygems'
+require 'daemons'
+require 'optparse'
+
+module Delayed
+  class Command
+    attr_accessor :worker_count
+    
+    def initialize(args)
+      @files_to_reopen = []
+      @options = {
+        :quiet => true,
+        :pid_dir => "#{Rails.root}/tmp/pids"
+      }
+      
+      @worker_count = 1
+      @monitor = false
+      
+      opts = OptionParser.new do |opts|
+        opts.banner = "Usage: #{File.basename($0)} [options] start|stop|restart|run"
+
+        opts.on('-h', '--help', 'Show this message') do
+          puts opts
+          exit 1
+        end
+        opts.on('-e', '--environment=NAME', 'Specifies the environment to run this delayed jobs under (test/development/production).') do |e|
+          STDERR.puts "The -e/--environment option has been deprecated and has no effect. Use RAILS_ENV and see http://github.com/collectiveidea/delayed_job/issues/#issue/7"
+        end
+        opts.on('--min-priority N', 'Minimum priority of jobs to run.') do |n|
+          @options[:min_priority] = n
+        end
+        opts.on('--max-priority N', 'Maximum priority of jobs to run.') do |n|
+          @options[:max_priority] = n
+        end
+        opts.on('-n', '--number_of_workers=workers', "Number of unique workers to spawn") do |worker_count|
+          @worker_count = worker_count.to_i rescue 1
+        end
+        opts.on('--pid-dir=DIR', 'Specifies an alternate directory in which to store the process ids.') do |dir|
+          @options[:pid_dir] = dir
+        end
+        opts.on('-i', '--identifier=n', 'A numeric identifier for the worker.') do |n|
+          @options[:identifier] = n
+        end
+        opts.on('-m', '--monitor', 'Start monitor process.') do
+          @monitor = true
+        end
+        opts.on('--sleep-delay N', "Amount of time to sleep when no jobs are found") do |n|
+          @options[:sleep_delay] = n
+        end
+        opts.on('-p', '--prefix NAME', "String to be prefixed to worker process names") do |prefix|
+          @options[:prefix] = prefix
+        end
+      end
+      @args = opts.parse!(args)
+    end
+  
+    def daemonize
+      Delayed::Worker.backend.before_fork
+
+      ObjectSpace.each_object(File) do |file|
+        @files_to_reopen << file unless file.closed?
+      end
+      
+      dir = @options[:pid_dir]
+      Dir.mkdir(dir) unless File.exists?(dir)
+      
+      if @worker_count > 1 && @options[:identifier]
+        raise ArgumentError, 'Cannot specify both --number-of-workers and --identifier'
+      elsif @worker_count == 1 && @options[:identifier]
+        process_name = "delayed_job.#{@options[:identifier]}"
+        run_process(process_name, dir)
+      else
+        worker_count.times do |worker_index|
+          process_name = worker_count == 1 ? "delayed_job" : "delayed_job.#{worker_index}"
+          run_process(process_name, dir)
+        end
+      end
+    end
+    
+    def run_process(process_name, dir)
+      Daemons.run_proc(process_name, :dir => dir, :dir_mode => :normal, :monitor => @monitor, :ARGV => @args) do |*args|
+        $0 = File.join(@options[:prefix], process_name) if @options[:prefix]
+        run process_name
+      end
+    end
+    
+    def run(worker_name = nil)
+      Dir.chdir(Rails.root)
+      
+      # Re-open file handles
+      @files_to_reopen.each do |file|
+        begin
+          file.reopen file.path, "a+"
+          file.sync = true
+        rescue ::Exception
+        end
+      end
+      
+      Delayed::Worker.logger = Logger.new(File.join(Rails.root, 'log', 'delayed_job.log'))
+      Delayed::Worker.backend.after_fork
+      
+      worker = Delayed::Worker.new(@options)
+      worker.name_prefix = "#{worker_name} "
+      worker.start
+    rescue => e
+      Rails.logger.fatal e
+      STDERR.puts e.message
+      exit 1
+    end
+    
+  end
+end

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,54 @@
+require 'active_support/basic_object'
+require 'active_support/core_ext/module/aliasing'
+
+module Delayed
+  class DelayProxy < ActiveSupport::BasicObject
+    def initialize(payload_class, target, options)
+      @payload_class = payload_class
+      @target = target
+      @options = options
+    end
+
+    def method_missing(method, *args)
+      Job.enqueue({:payload_object => @payload_class.new(@target, method.to_sym, args)}.merge(@options))
+    end
+  end
+
+  module MessageSending
+    def delay(options = {})
+      DelayProxy.new(PerformableMethod, 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_mailer.rb

@@ -0,0 +1,21 @@
+require 'mail'
+
+module Delayed
+  class PerformableMailer < PerformableMethod
+    def perform
+      object.send(method_name, *args).deliver
+    end
+  end
+
+  module DelayMail
+    def delay(options = {})
+      DelayProxy.new(PerformableMailer, self, options)
+    end
+  end
+end
+
+Mail::Message.class_eval do
+  def delay(*args)
+    raise RuntimeError, "Use MyMailer.delay.mailer_action(args) to delay sending of emails."
+  end
+end

data/lib/delayed/performable_method.rb

@@ -0,0 +1,31 @@
+require 'active_support/core_ext/module/delegation'
+
+module Delayed
+  class PerformableMethod < Struct.new(:object, :method_name, :args)
+    delegate :method, :to => :object
+
+    def initialize(object, method_name, args)
+      raise NoMethodError, "undefined method `#{method_name}' for #{object.inspect}" unless object.respond_to?(method_name, true)
+
+      self.object       = object
+      self.args         = args
+      self.method_name  = method_name.to_sym
+    end
+
+    def display_name
+      "#{object.class}##{method_name}"
+    end
+
+    def perform
+      object.send(method_name, *args) if object
+    end
+
+    def method_missing(symbol, *args)
+      object.send(symbol, *args)
+    end
+
+    def respond_to?(symbol, include_private=false)
+      super || object.respond_to?(symbol, include_private)
+    end
+  end
+end

data/lib/delayed/railtie.rb

@@ -0,0 +1,18 @@
+require 'delayed_job'
+require 'rails'
+
+module Delayed
+  class Railtie < Rails::Railtie
+    initializer :after_initialize do
+      Delayed::Worker.guess_backend
+
+      ActiveSupport.on_load(:action_mailer) do
+        ActionMailer::Base.send(:extend, Delayed::DelayMail)
+      end
+    end
+
+    rake_tasks do
+      load 'delayed/tasks.rb'
+    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_job_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/serialization/active_record.rb

@@ -0,0 +1,13 @@
+class ActiveRecord::Base
+  yaml_as "tag:ruby.yaml.org,2002:ActiveRecord"
+
+  def self.yaml_new(klass, tag, val)
+    klass.find(val['attributes']['id'])
+  rescue ActiveRecord::RecordNotFound
+    raise Delayed::DeserializationError
+  end
+
+  def to_yaml_properties
+    ['@attributes']
+  end
+end

data/lib/delayed/tasks.rb

@@ -0,0 +1,11 @@
+namespace :jobs do
+  desc "Clear the delayed_job queue."
+  task :clear => :environment do
+    Delayed::Job.delete_all
+  end
+
+  desc "Start a delayed_job worker."
+  task :work => :environment do
+    Delayed::Worker.new(:min_priority => ENV['MIN_PRIORITY'], :max_priority => ENV['MAX_PRIORITY'], :quiet => false).start
+  end
+end

data/lib/delayed/worker.rb

@@ -0,0 +1,182 @@
+require 'timeout'
+require 'active_support/core_ext/numeric/time'
+require 'active_support/core_ext/class/attribute_accessors'
+require 'active_support/core_ext/kernel'
+require 'logger'
+
+module Delayed
+  class Worker
+    cattr_accessor :min_priority, :max_priority, :max_attempts, :max_run_time, :default_priority, :sleep_delay, :logger, :delay_jobs
+    self.sleep_delay = 5
+    self.max_attempts = 25
+    self.max_run_time = 4.hours
+    self.default_priority = 0
+    self.delay_jobs = true
+
+    # 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?(Rails)
+      Rails.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/serialization/#{backend}"
+        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 ||= :active_record if defined?(ActiveRecord)
+    end
+
+    def initialize(options={})
+      @quiet = options.has_key?(:quiet) ? options[:quiet] : true
+      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)
+    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
+      job.hook(:completed)
+      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)
+        time ||= job.reschedule_at
+        job.run_at = time
+        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)
+      job.hook(:failure)
+      if job.respond_to?(:on_permanent_failure)
+        warn "[DEPRECATION] The #on_permanent_failure hook has been renamed to #failure."
+      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