Class: Sidekiq::JobRecord

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

Overview

Represents a pending job within a Sidekiq queue.

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

Direct Known Subclasses

SortedEntry

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(item, queue_name = nil) ⇒ JobRecord

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

:nodoc:



347
348
349
350
351
352
 
# File 'lib/sidekiq/api.rb', line 347

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

#item ⇒ Object (readonly)

the parsed Hash of job data



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

def item
  @item
end

#Item ⇒ Object (readonly)

the parsed Hash of job data



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

attr_reader :item

#queue ⇒ Object (readonly)

the queue associated with this job



343
344
345
 
# File 'lib/sidekiq/api.rb', line 343

def queue
  @queue
end

#Queue ⇒ Object (readonly)

the queue associated with this job



343
 
# File 'lib/sidekiq/api.rb', line 343

attr_reader :queue

#Value ⇒ Object (readonly)

the underlying String in Redis



340
 
# File 'lib/sidekiq/api.rb', line 340

attr_reader :value

#value ⇒ Object (readonly)

the underlying String in Redis



340
341
342
 
# File 'lib/sidekiq/api.rb', line 340

def value
  @value
end

Instance Method Details

#[](name) ⇒ Object

Access arbitrary attributes within the job hash



460
461
462
463
464
465
 
# File 'lib/sidekiq/api.rb', line 460

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

#args ⇒ Object 



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

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

#bid ⇒ Object 



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

def bid
  self["bid"]
end

#created_at ⇒ Object 



428
429
430
 
# File 'lib/sidekiq/api.rb', line 428

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

#delete ⇒ Object

Remove this job from the queue



452
453
454
455
456
457
 
# File 'lib/sidekiq/api.rb', line 452

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

#display_args ⇒ Object 



390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/sidekiq/api.rb', line 390

def display_args
  # Unwrap known wrappers so they show up in a human-friendly manner in the Web UI
  @display_args ||= if klass == "ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper" || klass == "Sidekiq::ActiveJob::Wrapper"
    job_args = self["wrapped"] ? deserialize_argument(args[0]["arguments"]) : []
    if (self["wrapped"] || args[0]) == "ActionMailer::DeliveryJob"
      # remove MailerClass, mailer_method and 'deliver_now'
      job_args.drop(3)
    elsif (self["wrapped"] || args[0]) == "ActionMailer::MailDeliveryJob"
      # remove MailerClass, mailer_method and 'deliver_now'
      job_args.drop(3).first.values_at("params", "args")
    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_class ⇒ Object 



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/sidekiq/api.rb', line 373

def display_class
  # Unwrap known wrappers so they show up in a human-friendly manner in the Web UI
  @klass ||= self["display_class"] || begin
    if klass == "ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper" || klass == "Sidekiq::ActiveJob::Wrapper"
      job_class = @item["wrapped"] || args[0]
      if job_class == "ActionMailer::DeliveryJob" || job_class == "ActionMailer::MailDeliveryJob"
        # MailerClass#mailer_method
        args[0]["arguments"][0..1].join("#")
      else
        job_class
      end
    else
      klass
    end
  end
end

#enqueued_at ⇒ Object 



424
425
426
 
# File 'lib/sidekiq/api.rb', line 424

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

#error_backtrace ⇒ Object 



436
437
438
439
440
441
442
443
444
 
# File 'lib/sidekiq/api.rb', line 436

def error_backtrace
  # Cache nil values
  if defined?(@error_backtrace)
    @error_backtrace
  else
    value = self["error_backtrace"]
    @error_backtrace = value && uncompress_backtrace(value)
  end
end

#jid ⇒ Object 



416
417
418
 
# File 'lib/sidekiq/api.rb', line 416

def jid
  self["jid"]
end

#klass ⇒ Object

This is the job class which Sidekiq will execute. If using ActiveJob, this class will be the ActiveJob adapter class rather than a specific job.



369
370
371
 
# File 'lib/sidekiq/api.rb', line 369

def klass
  self["class"]
end

#latency ⇒ Object 



446
447
448
449
 
# File 'lib/sidekiq/api.rb', line 446

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

#parse(item) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

:nodoc:



356
357
358
359
360
361
362
363
364
365
 
# File 'lib/sidekiq/api.rb', line 356

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

#tags ⇒ Object 



432
433
434
 
# File 'lib/sidekiq/api.rb', line 432

def tags
  self["tags"] || []
end