Class: Sidekiq::Status::ClientMiddleware

Inherits:

Object

• Object
• Sidekiq::Status::ClientMiddleware

Includes:

Storage

Defined in:

lib/sidekiq-status/client_middleware.rb

Overview

Should be in the client middleware chain

Constant Summary

Constants included from Storage

Storage::BATCH_LIMIT, Storage::RESERVED_FIELDS

Instance Method Summary

• #call(worker_class, msg, queue, redis_pool = nil) ⇒ Object

  Uses msg id and puts :queued status in the job’s Redis hash.

• #initialize(opts = {}) ⇒ ClientMiddleware constructor

  Parameterized initialization, use it when adding middleware to client chain chain.add Sidekiq::Status::ClientMiddleware, :expiration => 60 * 5.

Constructor Details

#initialize(opts = {}) ⇒ ClientMiddleware

Parameterized initialization, use it when adding middleware to client chain chain.add Sidekiq::Status::ClientMiddleware, :expiration => 60 * 5

Parameters:

• opts (Hash) (defaults to: {}) —

  middleware initialization options

Options Hash (opts):

• :expiration (Fixnum) —

  ttl for complete jobs

# File 'lib/sidekiq-status/client_middleware.rb', line 10

def initialize(opts = {})
  @expiration = opts[:expiration]
end

Instance Method Details

#call(worker_class, msg, queue, redis_pool = nil) ⇒ Object

Uses msg id and puts :queued status in the job’s Redis hash

Parameters:

• worker_class (Class) —

  if includes Sidekiq::Status::Worker, the job gets processed with the plugin

• msg (Array) —

  job arguments

• queue (String) —

  the queue’s name

• redis_pool (ConnectionPool) (defaults to: nil) —

  optional redis connection pool

# File 'lib/sidekiq-status/client_middleware.rb', line 19

def call(worker_class, msg, queue, redis_pool=nil)
  initial_metadata = { 
    jid: msg['jid'],
    status: :queued,
    worker: worker_class, 
    args: msg['args'].to_a.empty? ? nil : msg['args'].to_json
  }
  store_for_id msg['jid'], initial_metadata, @expiration, redis_pool
  yield
end