Class: Sidekiq::Job

Inherits:
Object
  • Object
show all
Defined in:
lib/sidekiq/api.rb

Overview

Encapsulates a pending job within a Sidekiq queue or sorted set.

The job should be considered immutable but may be removed from the queue via Job#delete.

Direct Known Subclasses

SortedEntry

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(item, queue_name = nil) ⇒ Job

Returns a new instance of Job.


318
319
320
321
322
323
# File 'lib/sidekiq/api.rb', line 318

def initialize(item, queue_name=nil)
  @args = nil
  @value = item
  @item = item.is_a?(Hash) ? item : parse(item)
  @queue = queue_name || @item['queue']
end

Instance Attribute Details

#itemObject (readonly)

Returns the value of attribute item


315
316
317
# File 'lib/sidekiq/api.rb', line 315

def item
  @item
end

#valueObject (readonly)

Returns the value of attribute value


316
317
318
# File 'lib/sidekiq/api.rb', line 316

def value
  @value
end

Instance Method Details

#[](name) ⇒ Object


418
419
420
421
422
423
# File 'lib/sidekiq/api.rb', line 418

def [](name)
  # nil will happen if the JSON fails to parse.
  # We don't guarantee Sidekiq will work with bad job JSON but we should
  # make a best effort to minimize the damage.
  @item ? @item[name] : nil
end

#argsObject


384
385
386
# File 'lib/sidekiq/api.rb', line 384

def args
  @args || @item['args']
end

#created_atObject


396
397
398
# File 'lib/sidekiq/api.rb', line 396

def created_at
  Time.at(self['created_at'] || self['enqueued_at'] || 0).utc
end

#deleteObject

Remove this job from the queue.


411
412
413
414
415
416
# File 'lib/sidekiq/api.rb', line 411

def delete
  count = Sidekiq.redis do |conn|
    conn.lrem("queue:#{@queue}", 1, @value)
  end
  count != 0
end

#display_argsObject


360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
# File 'lib/sidekiq/api.rb', line 360

def display_args  # Unwrap known wrappers so they show up in a human-friendly manner in the Web UI

  @display_args ||= case klass
            when /\ASidekiq::Extensions::Delayed/
              safe_load(args[0], args) do |_, _, arg|
                arg
              end
            when "ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper"
              job_args = self['wrapped'] ? args[0]["arguments"] : []
              if 'ActionMailer::DeliveryJob' == (self['wrapped'] || args[0])                # remove MailerClass, mailer_method and 'deliver_now'

                job_args.drop(3)
              else
                job_args
              end
            else
              if self['encrypt']                # no point in showing 150+ bytes of random garbage

                args[-1] = '[encrypted data]'
              end
              args
            end
end

#display_classObject


340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
# File 'lib/sidekiq/api.rb', line 340

def display_class  # Unwrap known wrappers so they show up in a human-friendly manner in the Web UI

  @klass ||= case klass
             when /\ASidekiq::Extensions::Delayed/
               safe_load(args[0], klass) do |target, method, _|
                 "#{target}.#{method}"
               end
             when "ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper"
               job_class = @item['wrapped'] || args[0]
               if 'ActionMailer::DeliveryJob' == job_class                 # MailerClass#mailer_method

                 args[0]['arguments'][0..1].join('#')
               else
                job_class
               end
             else
               klass
             end
end

#enqueued_atObject


392
393
394
# File 'lib/sidekiq/api.rb', line 392

def enqueued_at
  self['enqueued_at'] ? Time.at(self['enqueued_at']).utc : nil
end

#jidObject


388
389
390
# File 'lib/sidekiq/api.rb', line 388

def jid
  self['jid']
end

#klassObject


336
337
338
# File 'lib/sidekiq/api.rb', line 336

def klass
  self['class']
end

#latencyObject


404
405
406
407
# File 'lib/sidekiq/api.rb', line 404

def latency
  now = Time.now.to_f
  now - (@item['enqueued_at'] || @item['created_at'] || now)
end

#parse(item) ⇒ Object


325
326
327
328
329
330
331
332
333
334
# File 'lib/sidekiq/api.rb', line 325

def parse(item)
  Sidekiq.load_json(item)
rescue JSON::ParserError  # If the job payload in Redis is invalid JSON, we'll load
  # the item as an empty hash and store the invalid JSON as
  # the job 'args' for display in the Web UI.

  @invalid = true
  @args = [item]
  {}
end

#queueObject


400
401
402
# File 'lib/sidekiq/api.rb', line 400

def queue
  @queue
end