opsb-delayed_job 2.0.3

data/generators/delayed_job/delayed_job_generator.rb

@@ -0,0 +1,22 @@
+class DelayedJobGenerator < Rails::Generator::Base
+  default_options :skip_migration => false
+  
+  def manifest
+    record do |m|
+      m.template 'script', 'script/delayed_job', :chmod => 0755
+      if !options[:skip_migration] && defined?(ActiveRecord)
+        m.migration_template "migration.rb", 'db/migrate',
+                             :migration_file_name => "create_delayed_jobs"
+      end
+    end
+  end
+  
+protected
+
+  def add_options!(opt)
+    opt.separator ''
+    opt.separator 'Options:'
+    opt.on("--skip-migration", "Don't generate a migration") { |v| options[:skip_migration] = v }
+  end
+  
+end

data/generators/delayed_job/templates/migration.rb

@@ -0,0 +1,21 @@
+class CreateDelayedJobs < ActiveRecord::Migration
+  def self.up
+    create_table :delayed_jobs, :force => true do |table|
+      table.integer  :priority, :default => 0      # Allows some jobs to jump to the front of the queue
+      table.integer  :attempts, :default => 0      # Provides for retries, but still fail eventually.
+      table.text     :handler                      # YAML-encoded string of the object that will do work
+      table.text     :last_error                   # reason for last failure (See Note below)
+      table.datetime :run_at                       # When to run. Could be Time.zone.now for immediately, or sometime in the future.
+      table.datetime :locked_at                    # Set when a client is working on this object
+      table.datetime :failed_at                    # Set when all retries have failed (actually, by default, the record is deleted instead)
+      table.string   :locked_by                    # Who is working on this object (if locked)
+      table.timestamps
+    end
+	
+    add_index :delayed_jobs, [:priority, :run_at], :name => 'delayed_jobs_priority'
+  end
+  
+  def self.down
+    drop_table :delayed_jobs  
+  end
+end

data/generators/delayed_job/templates/script

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'config', 'environment'))
+require 'delayed/command'
+Delayed::Command.new(ARGV).daemonize

data/init.rb

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

data/lib/delayed/backend/active_record.rb

@@ -0,0 +1,90 @@
+require 'active_record'
+
+class ActiveRecord::Base
+  def self.load_for_delayed_job(id)
+    if id
+      find(id)
+    else
+      super
+    end
+  end
+  
+  def dump_for_delayed_job
+    "#{self.class};#{id}"
+  end
+end
+
+module Delayed
+  module Backend
+    module ActiveRecord
+      # A job object that is persisted to the database.
+      # Contains the work object as a YAML field.
+      class Job < ::ActiveRecord::Base
+        include Delayed::Backend::Base
+        set_table_name :delayed_jobs
+        
+        before_save :set_default_run_at
+
+        named_scope :ready_to_run, lambda {|worker_name, max_run_time|
+          {:conditions => ['(run_at <= ? AND (locked_at IS NULL OR locked_at < ?) OR locked_by = ?) AND failed_at IS NULL', db_time_now, db_time_now - max_run_time, worker_name]}
+        }
+        named_scope :by_priority, :order => 'priority ASC, run_at ASC'
+        
+        def self.after_fork
+          ::ActiveRecord::Base.connection.reconnect!
+        end
+
+        # When a worker is exiting, make sure we don't have any locked jobs.
+        def self.clear_locks!(worker_name)
+          update_all("locked_by = null, locked_at = null", ["locked_by = ?", worker_name])
+        end
+
+        # Find a few candidate jobs to run (in case some immediately get locked by others).
+        def self.find_available(worker_name, limit = 5, max_run_time = Worker.max_run_time)
+          scope = self.ready_to_run(worker_name, max_run_time)
+          scope = scope.scoped(:conditions => ['priority >= ?', Worker.min_priority]) if Worker.min_priority
+          scope = scope.scoped(:conditions => ['priority <= ?', Worker.max_priority]) if Worker.max_priority
+      
+          ::ActiveRecord::Base.silence do
+            scope.by_priority.all(:limit => limit)
+          end
+        end
+
+        # Lock this job for this worker.
+        # Returns true if we have the lock, false otherwise.
+        def lock_exclusively!(max_run_time, worker)
+          now = self.class.db_time_now
+          affected_rows = if locked_by != worker
+            # We don't own this job so we will update the locked_by name and the locked_at
+            self.class.update_all(["locked_at = ?, locked_by = ?", now, worker], ["id = ? and (locked_at is null or locked_at < ?) and (run_at <= ?)", id, (now - max_run_time.to_i), now])
+          else
+            # We already own this job, this may happen if the job queue crashes.
+            # Simply resume and update the locked_at
+            self.class.update_all(["locked_at = ?", now], ["id = ? and locked_by = ?", id, worker])
+          end
+          if affected_rows == 1
+            self.locked_at    = now
+            self.locked_by    = worker
+            return true
+          else
+            return false
+          end
+        end
+
+        # Get the current time (GMT or local depending on DB)
+        # Note: This does not ping the DB to get the time, so all your clients
+        # must have syncronized clocks.
+        def self.db_time_now
+          if Time.zone
+            Time.zone.now
+          elsif ::ActiveRecord::Base.default_timezone == :utc
+            Time.now.utc
+          else
+            Time.now
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/delayed/backend/base.rb

@@ -0,0 +1,111 @@
+module Delayed
+  module Backend
+    class DeserializationError < StandardError
+    end
+
+    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 || 0
+          run_at   = args[1]
+          self.create(:payload_object => object, :priority => priority.to_i, :run_at => run_at)
+        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 payload_object
+        @payload_object ||= deserialize(self['handler'])
+      end
+
+      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
+      
+      # 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
+      
+    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 => 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