Class: Sidekiq::Processor

Inherits:
Object
  • Object
show all
Includes:
Util
Defined in:
lib/sidekiq/processor.rb

Overview

The Processor is a standalone thread which:

  1. fetches a job from Redis

  2. executes the job

a. instantiate the Worker
b. run the middleware chain
c. call #perform

A Processor can exit due to shutdown (processor_stopped) or due to an error during job execution (processor_died)

If an error occurs in the job execution, the Processor calls the Manager to create a new one to replace itself and exits.

Defined Under Namespace

Classes: Counter, SharedWorkerState

Constant Summary collapse

PROCESSED =
Counter.new
FAILURE =
Counter.new
WORKER_STATE =
SharedWorkerState.new

Constants included from Util

Util::EXPIRY

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Util

#fire_event, #hostname, #identity, #logger, #process_nonce, #redis, #safe_thread, #tid, #watchdog

Methods included from ExceptionHandler

#handle_exception

Constructor Details

#initialize(mgr) ⇒ Processor

Returns a new instance of Processor.


31
32
33
34
35
36
37
38
39
40
41
# File 'lib/sidekiq/processor.rb', line 31

def initialize(mgr)
  @mgr = mgr
  @down = false
  @done = false
  @job = nil
  @thread = nil
  @strategy = (mgr.options[:fetch] || Sidekiq::BasicFetch).new(mgr.options)
  @reloader = Sidekiq.options[:reloader]
  @job_logger = (mgr.options[:job_logger] || Sidekiq::JobLogger).new
  @retrier = Sidekiq::JobRetry.new
end

Instance Attribute Details

#jobObject (readonly)

Returns the value of attribute job


29
30
31
# File 'lib/sidekiq/processor.rb', line 29

def job
  @job
end

#threadObject (readonly)

Returns the value of attribute thread


28
29
30
# File 'lib/sidekiq/processor.rb', line 28

def thread
  @thread
end

Instance Method Details

#constantize(str) ⇒ Object


264
265
266
267
268
269
270
271
272
273
274
275
# File 'lib/sidekiq/processor.rb', line 264

def constantize(str)
  return Object.const_get(str) unless str.include?("::")

  names = str.split("::")
  names.shift if names.empty? || names.first.empty?

  names.inject(Object) do |constant, name|
    # the false flag limits search for name to under the constant namespace
    #   which mimics Rails' behaviour
    constant.const_get(name, false)
  end
end

#dispatch(job_hash, queue) ⇒ Object


114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
# File 'lib/sidekiq/processor.rb', line 114

def dispatch(job_hash, queue)
  # since middleware can mutate the job hash
  # we clone here so we report the original
  # job structure to the Web UI
  pristine = json_clone(job_hash)

  @job_logger.prepare(job_hash) do
    @retrier.global(pristine, queue) do
      @job_logger.call(job_hash, queue) do
        stats(pristine, queue) do
          # Rails 5 requires a Reloader to wrap code execution.  In order to
          # constantize the worker and instantiate an instance, we have to call
          # the Reloader.  It handles code loading, db connection management, etc.
          # Effectively this block denotes a "unit of work" to Rails.
          @reloader.call do
            klass = constantize(job_hash["class"])
            worker = klass.new
            worker.jid = job_hash["jid"]
            @retrier.local(worker, pristine, queue) do
              yield worker
            end
          end
        end
      end
    end
  end
end

#execute_job(worker, cloned_args) ⇒ Object


192
193
194
# File 'lib/sidekiq/processor.rb', line 192

def execute_job(worker, cloned_args)
  worker.perform(*cloned_args)
end

#fetchObject


94
95
96
97
98
99
100
101
102
# File 'lib/sidekiq/processor.rb', line 94

def fetch
  j = get_one
  if j && @done
    j.requeue
    nil
  else
    j
  end
end

#get_oneObject


82
83
84
85
86
87
88
89
90
91
92
# File 'lib/sidekiq/processor.rb', line 82

def get_one
  work = @strategy.retrieve_work
  if @down
    logger.info { "Redis is online, #{::Process.clock_gettime(::Process::CLOCK_MONOTONIC) - @down} sec downtime" }
    @down = nil
  end
  work
rescue Sidekiq::Shutdown
rescue => ex
  handle_fetch_exception(ex)
end

#handle_fetch_exception(ex) ⇒ Object


104
105
106
107
108
109
110
111
112
# File 'lib/sidekiq/processor.rb', line 104

def handle_fetch_exception(ex)
  unless @down
    @down = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
    logger.error("Error fetching job: #{ex}")
    handle_exception(ex)
  end
  sleep(1)
  nil
end

#json_clone(obj) ⇒ Object

Deep clone the arguments passed to the worker so that if the job fails, what is pushed back onto Redis hasn't been mutated by the worker.


280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
# File 'lib/sidekiq/processor.rb', line 280

def json_clone(obj)
  if Integer === obj || Float === obj || TrueClass === obj || FalseClass === obj || NilClass === obj
    return obj
  elsif String === obj
    return obj.dup
  elsif Array === obj
    duped = Array.new(obj.size)
    obj.each_with_index do |value, index|
      duped[index] = json_clone(value)
    end
  elsif Hash === obj
    duped = obj.dup
    duped.each_pair do |key, value|
      duped[key] = json_clone(value)
    end
  else
    duped = obj.dup
  end

  duped
end

#kill(wait = false) ⇒ Object


49
50
51
52
53
54
55
56
57
58
59
# File 'lib/sidekiq/processor.rb', line 49

def kill(wait = false)
  @done = true
  return unless @thread
  # unlike the other actors, terminate does not wait
  # for the thread to finish because we don't know how
  # long the job will take to finish.  Instead we
  # provide a `kill` method to call after the shutdown
  # timeout passes.
  @thread.raise ::Sidekiq::Shutdown
  @thread.value if wait
end

#process(work) ⇒ Object


142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
# File 'lib/sidekiq/processor.rb', line 142

def process(work)
  jobstr = work.job
  queue = work.queue_name

  # Treat malformed JSON as a special case: job goes straight to the morgue.
  job_hash = nil
  begin
    job_hash = Sidekiq.load_json(jobstr)
  rescue => ex
    handle_exception(ex, {context: "Invalid JSON for job", jobstr: jobstr})
    # we can't notify because the job isn't a valid hash payload.
    DeadSet.new.kill(jobstr, notify_failure: false)
    return work.acknowledge
  end

  ack = false
  begin
    dispatch(job_hash, queue) do |worker|
      Sidekiq.server_middleware.invoke(worker, job_hash, queue) do
        execute_job(worker, job_hash["args"])
      end
    end
    ack = true
  rescue Sidekiq::Shutdown
    # Had to force kill this job because it didn't finish
    # within the timeout.  Don't acknowledge the work since
    # we didn't properly finish it.
  rescue Sidekiq::JobRetry::Handled => h
    # this is the common case: job raised error and Sidekiq::JobRetry::Handled
    # signals that we created a retry successfully.  We can acknowlege the job.
    ack = true
    e = h.cause || h
    handle_exception(e, {context: "Job raised exception", job: job_hash, jobstr: jobstr})
    raise e
  rescue Exception => ex
    # Unexpected error!  This is very bad and indicates an exception that got past
    # the retry subsystem (e.g. network partition).  We won't acknowledge the job
    # so it can be rescued when using Sidekiq Pro.
    handle_exception(ex, {context: "Internal exception!", job: job_hash, jobstr: jobstr})
    raise e
  ensure
    if ack
      # We don't want a shutdown signal to interrupt job acknowledgment.
      Thread.handle_interrupt(Sidekiq::Shutdown => :never) do
        work.acknowledge
      end
    end
  end
end

#process_oneObject


76
77
78
79
80
# File 'lib/sidekiq/processor.rb', line 76

def process_one
  @job = fetch
  process(@job) if @job
  @job = nil
end

#runObject


67
68
69
70
71
72
73
74
# File 'lib/sidekiq/processor.rb', line 67

def run
  process_one until @done
  @mgr.processor_stopped(self)
rescue Sidekiq::Shutdown
  @mgr.processor_stopped(self)
rescue Exception => ex
  @mgr.processor_died(self, ex)
end

#startObject


61
62
63
# File 'lib/sidekiq/processor.rb', line 61

def start
  @thread ||= safe_thread("processor", &method(:run))
end

#stats(job_hash, queue) ⇒ Object


250
251
252
253
254
255
256
257
258
259
260
261
262
# File 'lib/sidekiq/processor.rb', line 250

def stats(job_hash, queue)
  WORKER_STATE.set(tid, {queue: queue, payload: job_hash, run_at: Time.now.to_i})

  begin
    yield
  rescue Exception
    FAILURE.incr
    raise
  ensure
    WORKER_STATE.delete(tid)
    PROCESSED.incr
  end
end

#terminate(wait = false) ⇒ Object


43
44
45
46
47
# File 'lib/sidekiq/processor.rb', line 43

def terminate(wait = false)
  @done = true
  return unless @thread
  @thread.value if wait
end