Class: Delayed::Worker

Inherits:
Object
  • Object
show all
Defined in:
lib/delayed/worker.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Worker

Returns a new instance of Worker.



80
81
82
83
84
85
86
87
88
 
# File 'lib/delayed/worker.rb', line 80

def initialize(options={})
  @quiet = options.has_key?(:quiet) ? options[:quiet] : true
  self.class.min_priority = options[:min_priority] if options.has_key?(:min_priority)
  self.class.max_priority = options[:max_priority] if options.has_key?(:max_priority)
  self.class.sleep_delay = options[:sleep_delay] if options.has_key?(:sleep_delay)
  self.class.queues = options[:queues] if options.has_key?(:queues)

  self.plugins.each { |klass| klass.new }
end

Instance Attribute Details

#name_prefix ⇒ Object

name_prefix is ignored if name is set directly



34
35
36
 
# File 'lib/delayed/worker.rb', line 34

def name_prefix
  @name_prefix
end

Class Method Details

.after_fork ⇒ Object 



63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/delayed/worker.rb', line 63

def self.after_fork
  # Re-open file handles
  @files_to_reopen.each do |file|
    begin
      file.reopen file.path, "a+"
      file.sync = true
    rescue ::Exception
    end
  end

  backend.after_fork
end

.backend=(backend) ⇒ Object 



38
39
40
41
42
43
44
45
46
 
# File 'lib/delayed/worker.rb', line 38

def self.backend=(backend)
  if backend.is_a? Symbol
    require "delayed/serialization/#{backend}"
    require "delayed/backend/#{backend}"
    backend = "Delayed::Backend::#{backend.to_s.classify}::Job".constantize
  end
  @@backend = backend
  silence_warnings { ::Delayed.const_set(:Job, backend) }
end

.before_fork ⇒ Object 



52
53
54
55
56
57
58
59
60
61
 
# File 'lib/delayed/worker.rb', line 52

def self.before_fork
  unless @files_to_reopen
    @files_to_reopen = []
    ObjectSpace.each_object(File) do |file|
      @files_to_reopen << file unless file.closed?
    end
  end

  backend.before_fork
end

.guess_backend ⇒ Object 



48
49
50
 
# File 'lib/delayed/worker.rb', line 48

def self.guess_backend
  warn "[DEPRECATION] guess_backend is deprecated. Please remove it from your code."
end

.lifecycle ⇒ Object 



76
77
78
 
# File 'lib/delayed/worker.rb', line 76

def self.lifecycle
  @lifecycle ||= Delayed::Lifecycle.new
end

Instance Method Details

#failed(job) ⇒ Object 



189
190
191
192
193
194
 
# File 'lib/delayed/worker.rb', line 189

def failed(job)
  self.class.lifecycle.run_callbacks(:failure, self, job) do
    job.hook(:failure)
    self.class.destroy_failed_jobs ? job.destroy : job.fail!
  end
end

#max_attempts(job) ⇒ Object 



202
203
204
 
# File 'lib/delayed/worker.rb', line 202

def max_attempts(job)
  job.max_attempts || self.class.max_attempts
end

#name ⇒ Object

Every worker has a unique name which by default is the pid of the process. There are some advantages to overriding this with something which survives worker retarts: Workers can# safely resume working on tasks which are locked by themselves. The worker will assume that it crashed before.



94
95
96
97
 
# File 'lib/delayed/worker.rb', line 94

def name
  return @name unless @name.nil?
  "#{@name_prefix}host:#{Socket.gethostname} pid:#{Process.pid}" rescue "#{@name_prefix}pid:#{Process.pid}"
end

#name=(val) ⇒ Object

Sets the name of the worker. Setting the name to nil will reset the default worker name



101
102
103
 
# File 'lib/delayed/worker.rb', line 101

def name=(val)
  @name = val
end

#reschedule(job, time = nil) ⇒ Object

Reschedule the job in the future (when a job fails). Uses an exponential scale depending on the number of failed attempts.



177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/delayed/worker.rb', line 177

def reschedule(job, time = nil)
  if (job.attempts += 1) < max_attempts(job)
    time ||= job.reschedule_at
    job.run_at = time
    job.unlock
    job.save!
  else
    say "PERMANENTLY removing #{job.name} because of #{job.attempts} consecutive failures.", Logger::INFO
    failed(job)
  end
end

#run(job) ⇒ Object 



160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/delayed/worker.rb', line 160

def run(job)
  runtime =  Benchmark.realtime do
    Timeout.timeout(self.class.max_run_time.to_i) { job.invoke_job }
    job.destroy
  end
  say "#{job.name} completed after %.4f" % runtime
  return true  # did work
rescue DeserializationError => error
  job.last_error = "{#{error.message}\n#{error.backtrace.join("\n")}"
  failed(job)
rescue Exception => error
  self.class.lifecycle.run_callbacks(:error, self, job){ handle_failed_job(job, error) }
  return false  # work failed
end

#say(text, level = Logger::INFO) ⇒ Object 



196
197
198
199
200
 
# File 'lib/delayed/worker.rb', line 196

def say(text, level = Logger::INFO)
  text = "[Worker(#{name})] #{text}"
  puts text unless @quiet
  logger.add level, "#{Time.now.strftime('%FT%T%z')}: #{text}" if logger
end

#start ⇒ Object 



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/delayed/worker.rb', line 105

def start
  trap('TERM') { say 'Exiting...'; stop }
  trap('INT')  { say 'Exiting...'; stop }

  say "Starting job worker"

  self.class.lifecycle.run_callbacks(:execute, self) do
    loop do
      self.class.lifecycle.run_callbacks(:loop, self) do
        result = nil

        realtime = Benchmark.realtime do
          result = work_off
        end

        count = result.sum

        break if @exit

        if count.zero?
          sleep(self.class.sleep_delay)
        else
          say "#{count} jobs processed at %.4f j/s, %d failed ..." % [count / realtime, result.last]
        end
      end

      break if @exit
    end
  end
end

#stop ⇒ Object 



136
137
138
 
# File 'lib/delayed/worker.rb', line 136

def stop
  @exit = true
end

#work_off(num = 100) ⇒ Object

Do num jobs and return stats on success/failure. Exit early if interrupted.



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/delayed/worker.rb', line 142

def work_off(num = 100)
  success, failure = 0, 0

  num.times do
    case reserve_and_run_one_job
    when true
        success += 1
    when false
        failure += 1
    else
      break  # leave if no work could be done
    end
    break if $exit # leave if we're exiting
  end

  return [success, failure]
end