Module: Delayed::Backend::Base

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

Defined Under Namespace

Modules: ClassMethods

Constant Summary collapse

ParseObjectFromYaml = 
/\!ruby\/\w+\:([^\s]+)/

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object 



4
5
6
 
# File 'lib/delayed/backend/base.rb', line 4

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

Instance Method Details

#fail! ⇒ Object 



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

def fail!
  update_attributes(:failed_at => self.class.db_time_now)
end

#failed? ⇒ Boolean Also known as: failed

Returns:

  • (Boolean) 


68
69
70
 
# File 'lib/delayed/backend/base.rb', line 68

def failed?
  !!failed_at
end

#hook(name, *args) ⇒ Object 



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

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

#invoke_job ⇒ Object 



101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/delayed/backend/base.rb', line 101

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

#max_attempts ⇒ Object 



137
138
139
 
# File 'lib/delayed/backend/base.rb', line 137

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

#name ⇒ Object 



75
76
77
78
79
80
81
 
# File 'lib/delayed/backend/base.rb', line 75

def name
  @name ||= payload_object.respond_to?(:display_name) ?
              payload_object.display_name :
              payload_object.class.name
rescue DeserializationError
  ParseObjectFromYaml.match(handler)[1]
end

#payload_object ⇒ Object 



88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/delayed/backend/base.rb', line 88

def payload_object
  if YAML.respond_to?(:unsafe_load)
    #See https://github.com/dtao/safe_yaml
    #When the method is there, we need to load our YAML like this...
    @payload_object ||= YAML.load(self.handler, :safe => false)
  else
    @payload_object ||= YAML.load(self.handler)
  end
rescue TypeError, LoadError, NameError, ArgumentError => e
  raise DeserializationError,
    "Job failed to load: #{e.message}. Handler: #{handler.inspect}"
end

#payload_object=(object) ⇒ Object 



83
84
85
86
 
# File 'lib/delayed/backend/base.rb', line 83

def payload_object=(object)
  @payload_object = object
  self.handler = object.to_yaml
end

#reschedule_at ⇒ Object 



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

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

#unlock ⇒ Object

Unlock this job (note: not saved to DB)



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

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