class Sidekiq::Processor

The Processor is a standalone thread which:

  1. fetches a job from Redis

  2. executes the job

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

A Processor can exit due to shutdown or due to an error during job execution.

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

Constants

FAILURE
PROCESSED
WORK_STATE

Attributes

job[R]
thread[R]

Public Class Methods

new(options, &block) click to toggle source
# File lib/sidekiq/processor.rb, line 30
def initialize(options, &block)
  @callback = block
  @down = false
  @done = false
  @job = nil
  @thread = nil
  @config = options
  @strategy = options[:fetch]
  @reloader = options[:reloader] || proc { |&block| block.call }
  @job_logger = (options[:job_logger] || Sidekiq::JobLogger).new
  @retrier = Sidekiq::JobRetry.new(options)
end

Public Instance Methods

kill(wait = false) click to toggle source
# 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
start() click to toggle source
# File lib/sidekiq/processor.rb, line 61
def start
  @thread ||= safe_thread("processor", &method(:run))
end
terminate(wait = false) click to toggle source
# File lib/sidekiq/processor.rb, line 43
def terminate(wait = false)
  @done = true
  return unless @thread
  @thread.value if wait
end

Private Instance Methods

constantize(str) click to toggle source
# File lib/sidekiq/processor.rb, line 273
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, jobstr) { |inst| ... } click to toggle source
# File lib/sidekiq/processor.rb, line 114
def dispatch(job_hash, queue, jobstr)
  # since middleware can mutate the job hash
  # we need to clone it to report the original
  # job structure to the Web UI
  # or to push back to redis when retrying.
  # To avoid costly and, most of the time, useless cloning here,
  # we pass original String of JSON to respected methods
  # to re-parse it there if we need access to the original, untouched job

  @job_logger.prepare(job_hash) do
    @retrier.global(jobstr, queue) do
      @job_logger.call(job_hash, queue) do
        stats(jobstr, 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"])
            inst = klass.new
            inst.jid = job_hash["jid"]
            @retrier.local(inst, jobstr, queue) do
              yield inst
            end
          end
        end
      end
    end
  end
end
execute_job(inst, cloned_args) click to toggle source
# File lib/sidekiq/processor.rb, line 201
def execute_job(inst, cloned_args)
  inst.perform(*cloned_args)
end
fetch() click to toggle source
# File lib/sidekiq/processor.rb, line 94
def fetch
  j = get_one
  if j && @done
    j.requeue
    nil
  else
    j
  end
end
get_one() click to toggle source
# File lib/sidekiq/processor.rb, line 82
def get_one
  uow = @strategy.retrieve_work
  if @down
    logger.info { "Redis is online, #{::Process.clock_gettime(::Process::CLOCK_MONOTONIC) - @down} sec downtime" }
    @down = nil
  end
  uow
rescue Sidekiq::Shutdown
rescue => ex
  handle_fetch_exception(ex)
end
handle_fetch_exception(ex) click to toggle source
# 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
process(uow) click to toggle source
# File lib/sidekiq/processor.rb, line 145
def process(uow)
  jobstr = uow.job
  queue = uow.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})
    now = Time.now.to_f
    config.redis do |conn|
      conn.multi do |xa|
        xa.zadd("dead", now.to_s, jobstr)
        xa.zremrangebyscore("dead", "-inf", now - config[:dead_timeout_in_seconds])
        xa.zremrangebyrank("dead", 0, - config[:dead_max_jobs])
      end
    end
    return uow.acknowledge
  end

  ack = false
  begin
    dispatch(job_hash, queue, jobstr) do |inst|
      @config.server_middleware.invoke(inst, job_hash, queue) do
        execute_job(inst, 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})
    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 ex
  ensure
    if ack
      # We don't want a shutdown signal to interrupt job acknowledgment.
      Thread.handle_interrupt(Sidekiq::Shutdown => :never) do
        uow.acknowledge
      end
    end
  end
end
process_one(&block) click to toggle source
# File lib/sidekiq/processor.rb, line 76
def process_one(&block)
  @job = fetch
  process(@job) if @job
  @job = nil
end
run() click to toggle source
# File lib/sidekiq/processor.rb, line 67
def run
  process_one until @done
  @callback.call(self)
rescue Sidekiq::Shutdown
  @callback.call(self)
rescue Exception => ex
  @callback.call(self, ex)
end
stats(jobstr, queue) { || ... } click to toggle source
# File lib/sidekiq/processor.rb, line 259
def stats(jobstr, queue)
  WORK_STATE.set(tid, {queue: queue, payload: jobstr, run_at: Time.now.to_i})

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