delayed_job_hooked 2.1.5

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2005 Tobias Luetke
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOa AND
+NONINFRINGEMENT. IN NO EVENT SaALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,243 @@
+h1. Delayed::Job
+
+Delated_job (or DJ) encapsulates the common pattern of asynchronously executing longer tasks in the background.
+
+It is a direct extraction from Shopify where the job table is responsible for a multitude of core tasks. Amongst those tasks are:
+
+* sending massive newsletters
+* image resizing
+* http downloads
+* updating smart collections
+* updating solr, our search server, after product changes
+* batch imports
+* spam checks
+
+h2. Installation
+
+delayed_job 2.1 only supports Rails 3.0+. See the "2.0 branch":https://github.com/collectiveidea/delayed_job/tree/v2.0 for Rails 2.
+
+To install, add delayed_job to your @Gemfile@ and run `bundle install`:
+
+<pre>
+gem 'delayed_job'
+</pre>
+
+After delayed_job is installed, you will need to setup the backend.
+
+h3. Backends
+
+delayed_job supports multiple backends for storing the job queue. "See the wiki for other backends":http://wiki.github.com/collectiveidea/delayed_job/backends besides Active Record.
+
+The default is Active Record, which requires a jobs table.
+
+<pre>
+$ script/rails generate delayed_job
+$ rake db:migrate
+</pre>
+
+h2. Queuing Jobs
+
+Call @.delay.method(params)@ on any object and it will be processed in the background.
+
+<pre>
+# without delayed_job
+@user.activate!(@device)
+
+# with delayed_job
+@user.delay.activate!(@device)
+</pre>
+
+If a method should always be run in the background, you can call @#handle_asynchronously@ after the method declaration:
+
+<pre>
+class Device
+  def deliver
+    # long running method
+  end
+  handle_asynchronously :deliver
+end
+
+device = Device.new
+device.deliver
+</pre>
+
+handle_asynchronously can take as options anything you can pass to delay. In addition the values can be Proc objects allowing call time evaluation of the value. For some examples:
+
+<pre>
+class LongTasks
+  def send_mailer
+    # Some other code
+  end
+  handle_asynchronously :send_mailer, :priority => 20
+
+  def in_the_future
+    # Some other code
+  end
+  # 5.minutes.from_now will be evaluated when in_the_future is called
+  handle_asynchronously :in_the_future, :run_at => Proc.new { 5.minutes.from_now }
+
+  def self.when_to_run
+    2.hours.from_now
+  end
+
+  def call_a_class_method
+    # Some other code
+  end
+  handle_asynchronously :call_a_class_method, :run_at => Proc.new { when_to_run }
+
+  attr_reader :how_important
+
+  def call_an_instance_method
+    # Some other code
+  end
+  handle_asynchronously :call_an_instance_method, :priority => Proc.new {|i| i.how_important }
+end
+</pre>
+
+h3. Rails 3 Mailers
+
+Due to how mailers are implemented in Rails 3, we had to do a little work around to get delayed_job to work.
+
+<pre>
+# without delayed_job
+Notifier.signup(@user).deliver
+
+# with delayed_job
+Notifier.delay.signup(@user)
+</pre>
+
+Remove the @.deliver@ method to make it work. It's not ideal, but it's the best we could do for now.
+
+h2. Running Jobs
+
+@script/delayed_job@ can be used to manage a background process which will start working off jobs.  Make sure you've run `script/generate delayed_job`.
+
+<pre>
+$ RAILS_ENV=production script/delayed_job start
+$ RAILS_ENV=production script/delayed_job stop
+
+# Runs two workers in separate processes.
+$ RAILS_ENV=production script/delayed_job -n 2 start
+$ RAILS_ENV=production script/delayed_job stop
+</pre>
+
+Workers can be running on any computer, as long as they have access to the database and their clock is in sync. Keep in mind that each worker will check the database at least every 5 seconds.
+
+You can also invoke @rake jobs:work@ which will start working off jobs. You can cancel the rake task with @CTRL-C@.
+
+h2. Custom Jobs
+
+Jobs are simple ruby objects with a method called perform. Any object which responds to perform can be stuffed into the jobs table. Job objects are serialized to yaml so that they can later be resurrected by the job runner.
+
+<pre>
+class NewsletterJob < Struct.new(:text, :emails)
+  def perform
+    emails.each { |e| NewsletterMailer.deliver_text_to_email(text, e) }
+  end
+end
+
+Delayed::Job.enqueue NewsletterJob.new('lorem ipsum...', Customers.find(:all).collect(&:email))
+</pre>
+
+h2. Hooks
+
+You can define hooks on your job that will be called at different stages in the process:
+
+<pre>
+class ParanoidNewsletterJob < NewsletterJob
+  def enqueue(job)
+    record_stat 'newsletter_job/enqueue'
+  end
+
+  def perform
+    emails.each { |e| NewsletterMailer.deliver_text_to_email(text, e) }
+  end
+
+  def before(job)
+    record_stat 'newsletter_job/start'
+  end
+
+  def after(job)
+    record_stat 'newsletter_job/after'
+  end
+
+  def success(job)
+    record_stat 'newsletter_job/success'
+  end
+
+  def error(job, exception)
+    notify_hoptoad(exception)
+  end
+
+  def failure
+    page_sysadmin_in_the_middle_of_the_night
+  end
+end
+</pre>
+
+h2. Gory Details
+
+The library evolves around a delayed_jobs table which looks as follows:
+
+<pre>
+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
+</pre>
+
+On failure, the job is scheduled again in 5 seconds + N ** 4, where N is the number of retries.
+
+The default Worker.max_attempts is 25. After this, the job either deleted (default), or left in the database with "failed_at" set.
+With the default of 25 attempts, the last retry will be 20 days later, with the last interval being almost 100 hours.
+
+The default Worker.max_run_time is 4.hours. If your job takes longer than that, another computer could pick it up. It's up to you to
+make sure your job doesn't exceed this time. You should set this to the longest time you think the job could take.
+
+By default, it will delete failed jobs (and it always deletes successful jobs). If you want to keep failed jobs, set
+Delayed::Worker.destroy_failed_jobs = false. The failed jobs will be marked with non-null failed_at.
+
+By default all jobs are scheduled with priority = 0, which is top priority. You can change this by setting Delayed::Worker.default_priority to something else. Lower numbers have higher priority.
+
+It is possible to disable delayed jobs for testing purposes. Set Delayed::Worker.delay_jobs = false to execute all jobs realtime.
+
+Here is an example of changing job parameters in Rails:
+
+<pre>
+# config/initializers/delayed_job_config.rb
+Delayed::Worker.destroy_failed_jobs = false
+Delayed::Worker.sleep_delay = 60
+Delayed::Worker.max_attempts = 3
+Delayed::Worker.max_run_time = 5.minutes
+Delayed::Worker.delay_jobs = !Rails.env.test?
+</pre>
+
+h3. Cleaning up
+
+You can invoke @rake jobs:clear@ to delete all jobs in the queue.
+
+h2. Mailing List
+
+Join us on the mailing list at http://groups.google.com/group/delayed_job
+
+h2. How to contribute
+
+If you find what looks like a bug:
+
+# Search the "mailing list":http://groups.google.com/group/delayed_job to see if anyone else had the same issue.
+# Check the "GitHub issue tracker":http://github.com/collectiveidea/delayed_job/issues/ to see if anyone else has reported issue.
+# If you don't see anything, create an issue with information on how to reproduce it.
+
+If you want to contribute an enhancement or a fix:
+
+# Fork the project on github.
+# Make your changes with tests.
+# Commit the changes without making changes to the Rakefile or any other files that aren't related to your enhancement or fix
+# Send a pull request.

data/contrib/delayed_job.monitrc

@@ -0,0 +1,14 @@
+# an example Monit configuration file for delayed_job
+# See: http://stackoverflow.com/questions/1226302/how-to-monitor-delayedjob-with-monit/1285611
+#
+# To use:
+# 1. copy to /var/www/apps/{app_name}/shared/delayed_job.monitrc
+# 2. replace {app_name} as appropriate
+# 3. add this to your /etc/monit/monitrc
+#
+#   include /var/www/apps/{app_name}/shared/delayed_job.monitrc
+
+check process delayed_job
+  with pidfile /var/www/apps/{app_name}/shared/pids/delayed_job.pid
+  start program = "/usr/bin/env RAILS_ENV=production /var/www/apps/{app_name}/current/script/delayed_job start"
+  stop program = "/usr/bin/env RAILS_ENV=production /var/www/apps/{app_name}/current/script/delayed_job stop"

data/contrib/delayed_job_multiple.monitrc

@@ -0,0 +1,23 @@
+# an example Monit configuration file for delayed_job running multiple processes
+#
+# To use:
+# 1. copy to /var/www/apps/{app_name}/shared/delayed_job.monitrc
+# 2. replace {app_name} as appropriate
+# 3. add this to your /etc/monit/monitrc
+#
+#   include /var/www/apps/{app_name}/shared/delayed_job.monitrc
+
+check process delayed_job_0
+  with pidfile /var/www/apps/{app_name}/shared/pids/delayed_job.0.pid
+  start program = "/usr/bin/env RAILS_ENV=production /var/www/apps/{app_name}/current/script/delayed_job start -i 0"
+  stop program = "/usr/bin/env RAILS_ENV=production /var/www/apps/{app_name}/current/script/delayed_job stop -i 0"
+  
+check process delayed_job_1
+  with pidfile /var/www/apps/{app_name}/shared/pids/delayed_job.1.pid
+  start program = "/usr/bin/env RAILS_ENV=production /var/www/apps/{app_name}/current/script/delayed_job start -i 1"
+  stop program = "/usr/bin/env RAILS_ENV=production /var/www/apps/{app_name}/current/script/delayed_job stop -i 1"
+  
+check process delayed_job_2
+  with pidfile /var/www/apps/{app_name}/shared/pids/delayed_job.2.pid
+  start program = "/usr/bin/env RAILS_ENV=production /var/www/apps/{app_name}/current/script/delayed_job start -i 2"
+  stop program = "/usr/bin/env RAILS_ENV=production /var/www/apps/{app_name}/current/script/delayed_job stop -i 2"

data/lib/delayed/backend/active_record.rb

@@ -0,0 +1,82 @@
+require 'active_record'
+
+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
+
+        scope :ready_to_run, lambda {|worker_name, max_run_time|
+          where(['(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])
+        }
+        scope :by_priority, order('priority ASC, run_at ASC')
+
+        def self.before_fork
+          ::ActiveRecord::Base.clear_all_connections!
+        end
+
+        def self.after_fork
+          ::ActiveRecord::Base.establish_connection
+        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
+            self.locked_at_will_change!
+            self.locked_by_will_change!
+            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,128 @@
+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)
+          options = {
+            :priority => Delayed::Worker.default_priority
+          }.merge!(args.extract_options!)
+
+          options[:payload_object] ||= args.shift
+
+          if args.size > 0
+            warn "[DEPRECATION] Passing multiple arguments to `#enqueue` is deprecated. Pass a hash with :priority and :run_at."
+            options[:priority] = args.first || options[:priority]
+            options[:run_at]   = args[1]
+          end
+
+          unless options[:payload_object].respond_to?(:perform)
+            raise ArgumentError, 'Cannot enqueue items which do not respond to perform'
+          end
+          
+          if Delayed::Worker.delay_jobs
+            self.create(options).tap do |job|
+              job.hook(:enqueue)
+            end
+          else
+            options[:payload_object].perform
+          end
+        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
+
+      def failed?
+        failed_at
+      end
+      alias_method :failed, :failed?
+
+      ParseObjectFromYaml = /\!ruby\/\w+\:([^\s]+)/
+
+      def name
+        @name ||= payload_object.respond_to?(:display_name) ?
+                    payload_object.display_name :
+                    payload_object.class.name
+      rescue DeserializationError
+        ParseObjectFromYaml.match(handler)[1]
+      end
+
+      def payload_object=(object)
+        @payload_object = object
+        self.handler = object.to_yaml
+      end
+
+      def payload_object
+        @payload_object ||= YAML.load(self.handler)
+      rescue TypeError, LoadError, NameError, ArgumentError => e
+        raise DeserializationError,
+          "Job failed to load: #{e.message}. Handler: #{handler.inspect}"
+      end
+
+      def invoke_job
+        hook :before
+        payload_object.perform
+        hook :success
+      rescue Exception => e
+        hook :error, e
+        raise e
+      ensure
+        hook :after
+      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
+      
+    protected
+
+      def set_default_run_at
+        self.run_at ||= self.class.db_time_now
+      end
+    end
+  end
+end