Module: ActiveJob::Core
Relationships & Source Files | |
Namespace Children | |
Modules:
| |
Extension / Inclusion / Inheritance Descendants | |
Included In:
| |
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
self,
::ActiveSupport::Concern
|
|
Defined in: | activejob/lib/active_job/core.rb |
Overview
Provides general behavior that will be included into every Active Job object that inherits from Base
.
Class Method Summary
::ActiveSupport::Concern
- Extended
class_methods | Define class methods from given block. |
included | Evaluate given block in context of base class, so that you can write class macros here. |
prepended | Evaluate given block in context of base class, so that you can write class macros here. |
append_features, prepend_features |
Instance Attribute Summary
-
#arguments
rw
Job arguments.
-
#enqueue_error
rw
Track any exceptions raised by the backend so callers can inspect the errors.
-
#enqueued_at
rw
Track when a job was enqueued.
-
#exception_executions
rw
::Hash
that contains the number of times this job handled errors for each specific retry_on declaration. -
#executions
rw
Number of times this job has been executed (which increments on every retry, like after an exception).
-
#job_id
rw
Job Identifier.
-
#locale
rw
I18n.locale
to be used during the job. -
#priority=(value)
writeonly
Priority that the job will have (lower is more priority).
-
#provider_job_id
rw
ID optionally provided by adapter.
-
#queue_name=(value)
writeonly
Queue in which the job will reside.
-
#scheduled_at
rw
::Time
when the job should be performed. - #serialized_arguments=(value) writeonly
- #successfully_enqueued? ⇒ Boolean rw
-
#timezone
rw
Timezone to be used during the job.
- #arguments_serialized? ⇒ Boolean readonly private
-
#successfully_enqueued=(value)
rw
Internal use only
Track whether the adapter received the job successfully.
Instance Method Summary
-
#deserialize(job_data)
Attaches the stored job data to the current instance.
-
#initialize(*arguments)
Creates a new job instance.
-
#serialize
Returns a hash with the job data that can safely be passed to the queuing adapter.
- #deserialize_arguments(serialized_args) private
- #deserialize_arguments_if_needed private
- #serialize_arguments(arguments) private
- #serialize_arguments_if_needed(arguments) private
-
#set(options = {})
Internal use only
Configures the job with the given options.
Instance Attribute Details
#arguments (rw)
Job arguments
# File 'activejob/lib/active_job/core.rb', line 12
attr_accessor :arguments
#arguments_serialized? ⇒ Boolean
(readonly, private)
[ GitHub ]
# File 'activejob/lib/active_job/core.rb', line 198
def arguments_serialized? @serialized_arguments end
#enqueue_error (rw)
Track any exceptions raised by the backend so callers can inspect the errors.
# File 'activejob/lib/active_job/core.rb', line 56
attr_accessor :enqueue_error
#enqueued_at (rw)
Track when a job was enqueued
# File 'activejob/lib/active_job/core.rb', line 46
attr_accessor :enqueued_at
#exception_executions (rw)
::Hash
that contains the number of times this job handled errors for each specific retry_on declaration. Keys are the string representation of the exceptions listed in the retry_on declaration, while its associated value holds the number of executions where the corresponding retry_on declaration handled one of its listed exceptions.
# File 'activejob/lib/active_job/core.rb', line 37
attr_accessor :exception_executions
#executions (rw)
Number of times this job has been executed (which increments on every retry, like after an exception).
# File 'activejob/lib/active_job/core.rb', line 31
attr_accessor :executions
#job_id (rw)
Job Identifier
# File 'activejob/lib/active_job/core.rb', line 19
attr_accessor :job_id
#locale (rw)
I18n.locale
to be used during the job.
# File 'activejob/lib/active_job/core.rb', line 40
attr_accessor :locale
#priority=(value) (writeonly)
Priority that the job will have (lower is more priority).
# File 'activejob/lib/active_job/core.rb', line 25
attr_writer :priority
#provider_job_id (rw)
ID optionally provided by adapter
# File 'activejob/lib/active_job/core.rb', line 28
attr_accessor :provider_job_id
#queue_name=(value) (writeonly)
Queue in which the job will reside.
# File 'activejob/lib/active_job/core.rb', line 22
attr_writer :queue_name
#scheduled_at (rw)
::Time
when the job should be performed
# File 'activejob/lib/active_job/core.rb', line 16
attr_accessor :scheduled_at
#serialized_arguments=(value) (writeonly)
[ GitHub ]# File 'activejob/lib/active_job/core.rb', line 13
attr_writer :serialized_arguments
#successfully_enqueued=(value) (rw)
Track whether the adapter received the job successfully.
# File 'activejob/lib/active_job/core.rb', line 49
attr_writer :successfully_enqueued # :nodoc:
#successfully_enqueued? ⇒ Boolean
(rw)
[ GitHub ]
# File 'activejob/lib/active_job/core.rb', line 51
def successfully_enqueued? @successfully_enqueued end
#timezone (rw)
Timezone to be used during the job.
# File 'activejob/lib/active_job/core.rb', line 43
attr_accessor :timezone
Instance Method Details
#deserialize(job_data)
Attaches the stored job data to the current instance. Receives a hash returned from #serialize
Examples
class DeliverWebhookJob < ActiveJob::Base
attr_writer :attempt_number
def attempt_number
@attempt_number ||= 0
end
def serialize
super.merge('attempt_number' => attempt_number + 1)
end
def deserialize(job_data)
super
self.attempt_number = job_data['attempt_number']
end
rescue_from(Timeout::Error) do |exception|
raise exception if attempt_number > 5
retry_job(wait: 10)
end
end
# File 'activejob/lib/active_job/core.rb', line 150
def deserialize(job_data) self.job_id = job_data["job_id"] self.provider_job_id = job_data["provider_job_id"] self.queue_name = job_data["queue_name"] self.priority = job_data["priority"] self.serialized_arguments = job_data["arguments"] self.executions = job_data["executions"] self.exception_executions = job_data["exception_executions"] self.locale = job_data["locale"] || I18n.locale.to_s self.timezone = job_data["timezone"] || Time.zone&.name self.enqueued_at = Time.iso8601(job_data["enqueued_at"]) if job_data["enqueued_at"] self.scheduled_at = Time.iso8601(job_data["scheduled_at"]) if job_data["scheduled_at"] end
#deserialize_arguments(serialized_args) (private)
[ GitHub ]# File 'activejob/lib/active_job/core.rb', line 194
def deserialize_arguments(serialized_args) Arguments.deserialize(serialized_args) end
#deserialize_arguments_if_needed (private)
[ GitHub ]# File 'activejob/lib/active_job/core.rb', line 183
def deserialize_arguments_if_needed if arguments_serialized? @arguments = deserialize_arguments(@serialized_arguments) @serialized_arguments = nil end end
#initialize(*arguments)
Creates a new job instance. Takes the arguments that will be passed to the perform method.
# File 'activejob/lib/active_job/core.rb', line 93
def initialize(*arguments) @arguments = arguments @job_id = SecureRandom.uuid @queue_name = self.class.queue_name @scheduled_at = nil @priority = self.class.priority @executions = 0 @exception_executions = {} @timezone = Time.zone&.name end
#serialize
Returns a hash with the job data that can safely be passed to the queuing adapter.
# File 'activejob/lib/active_job/core.rb', line 107
def serialize { "job_class" => self.class.name, "job_id" => job_id, "provider_job_id" => provider_job_id, "queue_name" => queue_name, "priority" => priority, "arguments" => serialize_arguments_if_needed(arguments), "executions" => executions, "exception_executions" => exception_executions, "locale" => I18n.locale.to_s, "timezone" => timezone, "enqueued_at" => Time.now.utc.iso8601(9), "scheduled_at" => scheduled_at ? scheduled_at.utc.iso8601(9) : nil, } end
#serialize_arguments(arguments) (private)
[ GitHub ]#serialize_arguments_if_needed(arguments) (private)
[ GitHub ]# File 'activejob/lib/active_job/core.rb', line 175
def serialize_arguments_if_needed(arguments) if arguments_serialized? @serialized_arguments else serialize_arguments(arguments) end end
#set(options = {})
Configures the job with the given options.
# File 'activejob/lib/active_job/core.rb', line 165
def set( = {}) # :nodoc: self.scheduled_at = [:wait].seconds.from_now if [:wait] self.scheduled_at = [:wait_until] if [:wait_until] self.queue_name = self.class.queue_name_from_part( [:queue]) if [:queue] self.priority = [:priority].to_i if [:priority] self end