yetanothernguyen-delayed_job 0.0.1

data/lib/delayed/backend/base.rb

@@ -0,0 +1,135 @@
+module Delayed
+  module Backend
+    module Base
+      def self.included(base)
+        base.extend ClassMethods
+      end
+      
+      module ClassMethods
+        # Add a job to the queue
+        def enqueue(*args)
+          object = args.shift
+          unless object.respond_to?(:perform)
+            raise ArgumentError, 'Cannot enqueue items which do not respond to perform'
+          end
+    
+          priority = args.first || Delayed::Worker.default_priority
+          run_at   = args[1]
+          self.create(:payload_object => object, :priority => priority.to_i, :run_at => run_at)
+        end
+
+        def reserve(worker, max_run_time = Worker.max_run_time)
+          # We get up to 5 jobs from the db. In case we cannot get exclusive access to a job we try the next.
+          # this leads to a more even distribution of jobs across the worker processes
+          find_available(worker.name, 5, max_run_time).detect do |job|
+            job.lock_exclusively!(max_run_time, worker.name)
+          end
+        end
+
+        # Hook method that is called before a new worker is forked
+        def before_fork
+        end
+        
+        # Hook method that is called after a new worker is forked
+        def after_fork
+        end
+        
+        def work_off(num = 100)
+          warn "[DEPRECATION] `Delayed::Job.work_off` is deprecated. Use `Delayed::Worker.new.work_off instead."
+          Delayed::Worker.new.work_off(num)
+        end
+      end
+      
+      ParseObjectFromYaml = /\!ruby\/\w+\:([^\s]+)/
+
+      def failed?
+        failed_at
+      end
+      alias_method :failed, :failed?
+
+      def name
+        @name ||= begin
+          payload = payload_object
+          if payload.respond_to?(:display_name)
+            payload.display_name
+          else
+            payload.class.name
+          end
+        end
+      end
+
+      def payload_object=(object)
+        self['handler'] = object.to_yaml
+      end
+      
+      def payload_object
+        @payload_object ||= deserialize(self['handler'])
+      end
+
+      # Moved into its own method so that new_relic can trace it.
+      def invoke_job
+        payload_object.perform
+      end
+      
+      # Unlock this job (note: not saved to DB)
+      def unlock
+        self.locked_at    = nil
+        self.locked_by    = nil
+      end
+
+      def hook(name, *args)
+        if payload_object.respond_to?(name)
+          method = payload_object.method(name)
+          method.arity == 0 ? method.call : method.call(self, *args)
+        end
+      rescue DeserializationError
+        # do nothing
+      end
+    
+      def reschedule_at
+        payload_object.respond_to?(:reschedule_at) ? 
+          payload_object.reschedule_at(self.class.db_time_now, attempts) :
+          self.class.db_time_now + (attempts ** 4) + 5
+      end
+
+      def max_attempts
+        payload_object.max_attempts if payload_object.respond_to?(:max_attempts)
+      end
+      
+    private
+
+      def deserialize(source)
+        handler = YAML.load(source) rescue nil
+
+        unless handler.respond_to?(:perform)
+          if handler.nil? && source =~ ParseObjectFromYaml
+            handler_class = $1
+          end
+          attempt_to_load(handler_class || handler.class)
+          handler = YAML.load(source)
+        end
+
+        return handler if handler.respond_to?(:perform)
+
+        raise DeserializationError,
+          'Job failed to load: Unknown handler. Try to manually require the appropriate file.'
+      rescue TypeError, LoadError, NameError, ArgumentError => e
+        raise DeserializationError,
+          "Job failed to load: #{e.message}. Try to manually require the required file."
+      end
+
+      # Constantize the object so that ActiveSupport can attempt
+      # its auto loading magic. Will raise LoadError if not successful.
+      def attempt_to_load(klass)
+         klass.constantize
+      end
+      
+    protected
+
+      def set_default_run_at
+        self.run_at ||= self.class.db_time_now
+      end    
+
+    end
+  end
+end

data/lib/delayed/backend/data_mapper.rb

@@ -0,0 +1,125 @@
+require 'dm-core'
+require 'dm-observer'
+require 'dm-aggregates'
+
+module DataMapper
+  module Resource
+    module ClassMethods
+      def load_for_delayed_job(id)
+        find!(id)
+      end
+    end
+
+    module InstanceMethods
+      def dump_for_delayed_job
+        "#{self.class};#{id}"
+      end
+    end
+  end
+end
+
+module Delayed
+  module Backend
+    module DataMapper
+      class Job
+        include ::DataMapper::Resource
+        include Delayed::Backend::Base
+        
+        storage_names[:default] = 'delayed_jobs'
+        
+        property :id,          Serial
+        property :priority,    Integer, :default => 0, :index => :run_at_priority
+        property :attempts,    Integer, :default => 0
+        property :handler,     Text, :lazy => false
+        property :run_at,      Time, :index => :run_at_priority
+        property :locked_at,   Time, :index => true
+        property :locked_by,   String
+        property :failed_at,   Time
+        property :last_error,  Text
+                
+        def self.db_time_now
+          Time.now
+        end
+                
+        def self.find_available(worker_name, limit = 5, max_run_time = Worker.max_run_time)
+          
+          simple_conditions = { :run_at.lte => db_time_now, :limit => limit, :failed_at => nil, :order => [:priority.asc, :run_at.asc]  }
+
+          # respect priorities
+          simple_conditions[:priority.gte] = Worker.min_priority if Worker.min_priority
+          simple_conditions[:priority.lte] = Worker.max_priority if Worker.max_priority
+          
+          # lockable 
+          lockable = (
+            # not locked or past the max time
+            ( all(:locked_at => nil ) | all(:locked_at.lt => db_time_now - max_run_time)) |
+
+            # OR locked by our worker
+            all(:locked_by => worker_name))
+            
+          # plus some other boring junk 
+          (lockable).all( simple_conditions )
+        end
+        
+        # When a worker is exiting, make sure we don't have any locked jobs.
+        def self.clear_locks!(worker_name)
+          all(:locked_by => worker_name).update(:locked_at => nil, :locked_by => nil)
+        end
+        
+        # Lock this job for this worker.
+        # Returns true if we have the lock, false otherwise.
+        def lock_exclusively!(max_run_time, worker = worker_name)
+
+          now = self.class.db_time_now
+          overtime = now - max_run_time
+          
+          # FIXME - this is a bit gross
+          # DM doesn't give us the number of rows affected by a collection update
+          # so we have to circumvent some niceness in DM::Collection here
+          collection = locked_by != worker ?
+            (self.class.all(:id => id, :run_at.lte => now) & ( self.class.all(:locked_at => nil) | self.class.all(:locked_at.lt => overtime) ) ) :
+            self.class.all(:id => id, :locked_by => worker)
+          
+          attributes = collection.model.new(:locked_at => now, :locked_by => worker).dirty_attributes
+          affected_rows = self.repository.update(attributes, collection)
+            
+          if affected_rows == 1
+            self.locked_at = now
+            self.locked_by = worker
+            return true
+          else
+            return false
+          end
+        end
+        
+        # these are common to the other backends, so we provide an implementation
+        def self.delete_all
+          Delayed::Job.auto_migrate!
+        end
+        
+        def self.find id
+          get id
+        end
+        
+        def update_attributes(attributes)
+          attributes.each do |k,v|
+            self[k] = v
+          end
+          self.save
+        end
+        
+        
+      end
+      
+      class JobObserver
+        include ::DataMapper::Observer
+
+        observe Job
+
+        before :save do
+          self.run_at ||= self.class.db_time_now
+        end  
+      end
+    end
+  end
+end

data/lib/delayed/backend/mongo_mapper.rb

@@ -0,0 +1,110 @@
+require 'mongo_mapper'
+
+module ::MongoMapper
+  module Document
+    module ClassMethods
+      def load_for_delayed_job(id)
+        find!(id)
+      end
+    end
+
+    module InstanceMethods
+      def dump_for_delayed_job
+        "#{self.class};#{id}"
+      end
+    end
+  end
+end
+
+module Delayed
+  module Backend
+    module MongoMapper
+      class Job
+        include ::MongoMapper::Document
+        include Delayed::Backend::Base
+        set_collection_name 'delayed_jobs'
+        
+        key :priority,    Integer, :default => 0
+        key :attempts,    Integer, :default => 0
+        key :handler,     String
+        key :run_at,      Time
+        key :locked_at,   Time
+        key :locked_by,   String, :index => true
+        key :failed_at,   Time
+        key :last_error,  String
+        timestamps!
+        
+        before_save :set_default_run_at
+
+        ensure_index [[:priority, 1], [:run_at, 1]]
+        
+        def self.before_fork
+          ::MongoMapper.connection.close
+        end
+        
+        def self.after_fork
+          ::MongoMapper.connect(RAILS_ENV)
+        end
+        
+        def self.db_time_now
+          Time.now.utc
+        end
+        
+        def self.find_available(worker_name, limit = 5, max_run_time = Worker.max_run_time)
+          right_now = db_time_now
+
+          conditions = {
+            :run_at => {"$lte" => right_now},
+            :limit => -limit, # In mongo, positive limits are 'soft' and negative are 'hard'
+            :failed_at => nil,
+            :sort => [['priority', 1], ['run_at', 1]]
+          }
+
+          where = "this.locked_at == null || this.locked_at < #{make_date(right_now - max_run_time)}"
+          
+          (conditions[:priority] ||= {})['$gte'] = Worker.min_priority.to_i if Worker.min_priority
+          (conditions[:priority] ||= {})['$lte'] = Worker.max_priority.to_i if Worker.max_priority
+
+          results = all(conditions.merge(:locked_by => worker_name))
+          results += all(conditions.merge('$where' => where)) if results.size < limit
+          results
+        end
+        
+        # When a worker is exiting, make sure we don't have any locked jobs.
+        def self.clear_locks!(worker_name)
+          collection.update({:locked_by => worker_name}, {"$set" => {:locked_at => nil, :locked_by => nil}}, :multi => true)
+        end
+        
+        # Lock this job for this worker.
+        # Returns true if we have the lock, false otherwise.
+        def lock_exclusively!(max_run_time, worker = worker_name)
+          right_now = self.class.db_time_now
+          overtime = right_now - max_run_time.to_i
+          
+          query = "this.locked_at == null || this.locked_at < #{make_date(overtime)} || this.locked_by == #{worker.to_json}"
+          conditions = {:_id => id, :run_at => {"$lte" => right_now}, "$where" => query}
+
+          collection.update(conditions, {"$set" => {:locked_at => right_now, :locked_by => worker}})
+          affected_rows = collection.find({:_id => id, :locked_by => worker}).count
+          if affected_rows == 1
+            self.locked_at = right_now
+            self.locked_by = worker
+            return true
+          else
+            return false
+          end
+        end
+        
+      private
+      
+        def self.make_date(date_or_seconds)
+          "new Date(#{date_or_seconds.to_f * 1000})"
+        end
+
+        def make_date(date)
+          self.class.make_date(date)
+        end
+      end
+    end
+  end
+end

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