Module: Delayed::Backend::Base

Included in:
Job
Defined in:
lib/delayed/backend/base.rb

Defined Under Namespace

Modules: ClassMethods

Constant Summary collapse

HOOKS = 
%i(before success error after failure).freeze
ParseObjectFromYaml =

rubocop:disable Naming/ConstantName

%r{!ruby/\w+:([^\s]+)}

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#error ⇒ Object

Returns the value of attribute error.



109
110
111
 
# File 'lib/delayed/backend/base.rb', line 109

def error
  @error
end

Class Method Details

.included(base) ⇒ Object 



6
7
8
 
# File 'lib/delayed/backend/base.rb', line 6

def self.included(base)
  base.extend ClassMethods
end

Instance Method Details

#destroy_failed_jobs? ⇒ Boolean

Returns:

  • (Boolean) 


202
203
204
205
206
 
# File 'lib/delayed/backend/base.rb', line 202

def destroy_failed_jobs?
  payload_object.respond_to?(:destroy_failed_jobs?) ? payload_object.destroy_failed_jobs? : Delayed::Worker.destroy_failed_jobs
rescue DeserializationError
  Delayed::Worker.destroy_failed_jobs
end

#fail! ⇒ Object 



208
209
210
211
 
# File 'lib/delayed/backend/base.rb', line 208

def fail!
  self.failed_at = self.class.db_time_now
  save!
end

#failed? ⇒ Boolean Also known as: failed

Returns:

  • (Boolean) 


116
117
118
 
# File 'lib/delayed/backend/base.rb', line 116

def failed?
  !!failed_at
end

#hook(name, *args) ⇒ Object 



169
170
171
172
173
174
175
176
177
 
# File 'lib/delayed/backend/base.rb', line 169

def hook(name, *args)
  raise ArgumentError, "Unknown hook: #{name.inspect}" unless HOOKS.include?(name)

  if payload_object.respond_to?(name)
    method = payload_object.method(name)
    method.arity.zero? ? method.call : method.call(self, *args)
  end
rescue DeserializationError
end

#invoke_job ⇒ Object 



150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/delayed/backend/base.rb', line 150

def invoke_job
  Delayed::Worker.lifecycle.run_callbacks(:invoke_job, self) do
    hook :before
    payload_object.perform
    hook :success
  rescue Exception => e # rubocop:disable Lint/RescueException
    hook :error, e
    raise e
  ensure
    hook :after
  end
end

#max_attempts ⇒ Object 



187
188
189
 
# File 'lib/delayed/backend/base.rb', line 187

def max_attempts
  payload_object.max_attempts if payload_object.respond_to?(:max_attempts)
end

#max_run_time ⇒ Object 



191
192
193
194
195
196
197
198
199
200
 
# File 'lib/delayed/backend/base.rb', line 191

def max_run_time
  return unless payload_object.respond_to?(:max_run_time)
  return unless (run_time = payload_object.max_run_time)

  if run_time > Delayed::Worker.max_run_time
    Delayed::Worker.max_run_time
  else
    run_time
  end
end

#name ⇒ Object 



123
124
125
126
127
128
129
 
# File 'lib/delayed/backend/base.rb', line 123

def name
  if self.class.name_assignable?
    super || display_name
  else
    display_name # [feat:NameColumn] remove fallback once the "name" column is required.
  end
end

#payload_object ⇒ Object 



144
145
146
147
148
 
# File 'lib/delayed/backend/base.rb', line 144

def payload_object
  @payload_object ||= YAML.load_dj(handler)
rescue TypeError, LoadError, NameError, ArgumentError, SyntaxError, Psych::SyntaxError => e
  raise DeserializationError, "Job failed to load: #{e.message}. Handler: #{handler.inspect}"
end

#payload_object=(object) ⇒ Object 



139
140
141
142
 
# File 'lib/delayed/backend/base.rb', line 139

def payload_object=(object)
  @payload_object = object
  self.handler = YAML.dump_dj(object)
end

#priority ⇒ Object 



131
132
133
 
# File 'lib/delayed/backend/base.rb', line 131

def priority
  Priority.new(super)
end

#priority=(value) ⇒ Object 



135
136
137
 
# File 'lib/delayed/backend/base.rb', line 135

def priority=(value)
  super(Priority.new(value))
end

#reschedule_at ⇒ Object 



179
180
181
182
183
184
185
 
# File 'lib/delayed/backend/base.rb', line 179

def reschedule_at
  if payload_object.respond_to?(:reschedule_at)
    payload_object.reschedule_at(self.class.db_time_now, attempts)
  else
    self.class.db_time_now + (attempts**4) + 5
  end
end

#unlock ⇒ Object

Unlock this job (note: not saved to DB)



164
165
166
167
 
# File 'lib/delayed/backend/base.rb', line 164

def unlock
  self.locked_at    = nil
  self.locked_by    = nil
end