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.



306
307
308
309
310
311
 
# File 'lib/sidekiq/api.rb', line 306

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)

Returns the value of attribute item.



303
304
305
 
# File 'lib/sidekiq/api.rb', line 303

def item
  @item
end

#queue ⇒ Object (readonly)

Returns the value of attribute queue.



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

def queue
  @queue
end

#value ⇒ Object (readonly)

Returns the value of attribute value.



304
305
306
 
# File 'lib/sidekiq/api.rb', line 304

def value
  @value
end

Instance Method Details

#[](name) ⇒ Object 



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

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 



375
376
377
 
# File 'lib/sidekiq/api.rb', line 375

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

#created_at ⇒ Object 



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

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

#delete ⇒ Object

Remove this job from the queue.



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

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

#display_args ⇒ Object 



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/sidekiq/api.rb', line 348

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 (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["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 



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/sidekiq/api.rb', line 328

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 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

#enqueued_at ⇒ Object 



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

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

#error_backtrace ⇒ Object 



395
396
397
398
399
400
401
402
403
 
# File 'lib/sidekiq/api.rb', line 395

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 



379
380
381
 
# File 'lib/sidekiq/api.rb', line 379

def jid
  self["jid"]
end

#klass ⇒ Object 



324
325
326
 
# File 'lib/sidekiq/api.rb', line 324

def klass
  self["class"]
end

#latency ⇒ Object 



407
408
409
410
 
# File 'lib/sidekiq/api.rb', line 407

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

#parse(item) ⇒ Object 



313
314
315
316
317
318
319
320
321
322
 
# File 'lib/sidekiq/api.rb', line 313

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 



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

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