Module: ActiveJob::Core

Extended by:
ActiveSupport::Concern
Included in:
Base
Defined in:
activejob/lib/active_job/core.rb

Overview

Active Job Core

Provides general behavior that will be included into every Active Job object that inherits from ActiveJob::Base.

Defined Under Namespace

Modules: ClassMethods

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from ActiveSupport::Concern

append_features, class_methods, extended, included, prepend_features, prepended

Instance Attribute Details

#arguments ⇒ Object

Job arguments



12
13
14
 
# File 'activejob/lib/active_job/core.rb', line 12

def arguments
  @arguments
end

#enqueue_error ⇒ Object

Track any exceptions raised by the backend so callers can inspect the errors.



56
57
58
 
# File 'activejob/lib/active_job/core.rb', line 56

def enqueue_error
  @enqueue_error
end

#enqueued_at ⇒ Object

Track when a job was enqueued



46
47
48
 
# File 'activejob/lib/active_job/core.rb', line 46

def enqueued_at
  @enqueued_at
end

#exception_executions ⇒ Object

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.



37
38
39
 
# File 'activejob/lib/active_job/core.rb', line 37

def exception_executions
  @exception_executions
end

#executions ⇒ Object

Number of times this job has been executed (which increments on every retry, like after an exception).



31
32
33
 
# File 'activejob/lib/active_job/core.rb', line 31

def executions
  @executions
end

#job_id ⇒ Object

Job Identifier



19
20
21
 
# File 'activejob/lib/active_job/core.rb', line 19

def job_id
  @job_id
end

#locale ⇒ Object

I18n.locale to be used during the job.



40
41
42
 
# File 'activejob/lib/active_job/core.rb', line 40

def locale
  @locale
end

#priority=(value) ⇒ Object (writeonly)

Priority that the job will have (lower is more priority).



25
26
27
 
# File 'activejob/lib/active_job/core.rb', line 25

def priority=(value)
  @priority = value
end

#provider_job_id ⇒ Object

ID optionally provided by adapter



28
29
30
 
# File 'activejob/lib/active_job/core.rb', line 28

def provider_job_id
  @provider_job_id
end

#queue_name=(value) ⇒ Object (writeonly)

Queue in which the job will reside.



22
23
24
 
# File 'activejob/lib/active_job/core.rb', line 22

def queue_name=(value)
  @queue_name = value
end

#scheduled_at ⇒ Object

Timestamp when the job should be performed



16
17
18
 
# File 'activejob/lib/active_job/core.rb', line 16

def scheduled_at
  @scheduled_at
end

#serialized_arguments=(value) ⇒ Object (writeonly)

Sets the attribute serialized_arguments

Parameters:

  • value —

    the value to set the attribute serialized_arguments to.



13
14
15
 
# File 'activejob/lib/active_job/core.rb', line 13

def serialized_arguments=(value)
  @serialized_arguments = value
end

#successfully_enqueued=(value) ⇒ Object (writeonly)

Track whether the adapter received the job successfully.



49
50
51
 
# File 'activejob/lib/active_job/core.rb', line 49

def successfully_enqueued=(value)
  @successfully_enqueued = value
end

#timezone ⇒ Object

Timezone to be used during the job.



43
44
45
 
# File 'activejob/lib/active_job/core.rb', line 43

def timezone
  @timezone
end

Instance Method Details

#deserialize(job_data) ⇒ Object

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



148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'activejob/lib/active_job/core.rb', line 148

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          = job_data["enqueued_at"]
end

#initialize(*arguments) ⇒ Object

Creates a new job instance. Takes the arguments that will be passed to the perform method.



93
94
95
96
97
98
99
100
101
 
# File 'activejob/lib/active_job/core.rb', line 93

def initialize(*arguments)
  @arguments  = arguments
  @job_id     = SecureRandom.uuid
  @queue_name = self.class.queue_name
  @priority   = self.class.priority
  @executions = 0
  @exception_executions = {}
  @timezone   = Time.zone&.name
end

#serialize ⇒ Object

Returns a hash with the job data that can safely be passed to the queuing adapter.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'activejob/lib/active_job/core.rb', line 106

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)
  }
end

#set(options = {}) ⇒ Object

Configures the job with the given options.



162
163
164
165
166
167
168
169
 
# File 'activejob/lib/active_job/core.rb', line 162

def set(options = {}) # :nodoc:
  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]
  self.queue_name   = self.class.queue_name_from_part(options[:queue]) if options[:queue]
  self.priority     = options[:priority].to_i if options[:priority]

  self
end

#successfully_enqueued? ⇒ Boolean

Returns:

  • (Boolean) 


51
52
53
 
# File 'activejob/lib/active_job/core.rb', line 51

def successfully_enqueued?
  @successfully_enqueued
end