1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
rails--rails/activejob/lib/active_job/enqueuing.rb

81 lines
2.8 KiB
Ruby
Raw Normal View History

2017-07-09 13:49:52 -04:00
# frozen_string_literal: true
require "active_job/arguments"
2014-05-19 06:06:09 -04:00
module ActiveJob
# Provides behavior for enqueuing jobs.
2014-05-19 06:06:09 -04:00
module Enqueuing
extend ActiveSupport::Concern
2014-05-30 19:19:30 -04:00
# Includes the +perform_later+ method for job initialization.
module ClassMethods
# Push a job onto the queue. By default the arguments must be either String,
# Integer, Float, NilClass, TrueClass, FalseClass, BigDecimal, Symbol, Date,
# Time, DateTime, ActiveSupport::TimeWithZone, ActiveSupport::Duration,
# Hash, ActiveSupport::HashWithIndifferentAccess, Array or
# GlobalID::Identification instances, although this can be extended by adding
# custom serializers.
#
# Returns an instance of the job class queued with arguments available in
# Job#arguments.
2014-08-25 10:34:50 -04:00
def perform_later(*args)
job_or_instantiate(*args).enqueue
end
private
def job_or_instantiate(*args) # :doc:
2014-08-25 10:34:50 -04:00
args.first.is_a?(self) ? args.first : new(*args)
end
end
2014-05-30 19:19:30 -04:00
# Enqueues the job to be performed by the queue adapter.
2014-08-25 10:34:50 -04:00
#
# ==== Options
# * <tt>:wait</tt> - Enqueues the job with the specified delay
# * <tt>:wait_until</tt> - Enqueues the job at the time specified
2014-08-25 10:34:50 -04:00
# * <tt>:queue</tt> - Enqueues the job on the specified queue
2015-03-18 05:48:26 -04:00
# * <tt>:priority</tt> - Enqueues the job with the specified priority
2014-08-25 10:34:50 -04:00
#
# ==== Examples
#
# my_job_instance.enqueue
# my_job_instance.enqueue wait: 5.minutes
2014-08-25 10:34:50 -04:00
# my_job_instance.enqueue queue: :important
# my_job_instance.enqueue wait_until: Date.tomorrow.midnight
2015-03-18 05:48:26 -04:00
# my_job_instance.enqueue priority: 10
def enqueue(options = {})
self.scheduled_at = options[:wait].seconds.from_now.to_f if options[:wait]
self.scheduled_at = options[:wait_until].to_f if options[:wait_until]
2014-08-25 10:34:50 -04:00
self.queue_name = self.class.queue_name_from_part(options[:queue]) if options[:queue]
2015-03-18 05:48:26 -04:00
self.priority = options[:priority].to_i if options[:priority]
successfully_enqueued = false
2014-08-25 10:34:50 -04:00
run_callbacks :enqueue do
if scheduled_at
self.class.queue_adapter.enqueue_at self, scheduled_at
2014-08-25 10:34:50 -04:00
else
self.class.queue_adapter.enqueue self
end
successfully_enqueued = true
end
if successfully_enqueued
self
else
if self.class.return_false_on_aborted_enqueue
false
else
ActiveSupport::Deprecation.warn(
"Rails 6.1 will return false when the enqueuing is aborted. Make sure your code doesn't depend on it" \
" returning the instance of the job and set `config.active_job.return_false_on_aborted_enqueue = true`" \
" to remove the deprecations."
)
self
end
2014-08-25 10:34:50 -04:00
end
end
2014-05-19 06:06:09 -04:00
end
2014-05-19 16:13:40 -04:00
end