Module: Sidekiq::Worker

Included in:
Extensions::DelayedClass, Extensions::DelayedMailer, Extensions::DelayedModel
Defined in:
lib/sidekiq/worker.rb,
lib/sidekiq/testing.rb

Overview

Include this module in your worker class and you can easily create asynchronous jobs:

class HardWorker
  include Sidekiq::Worker
  sidekiq_options queue: 'critical', retry: 5

  def perform(*args)
    # do some work
  end
end

Then in your Rails app, you can do this:

HardWorker.perform_async(1, 2, 3)

Note that perform_async is a class method, perform is an instance method.

Sidekiq::Worker also includes several APIs to provide compatibility with ActiveJob.

class SomeWorker
  include Sidekiq::Worker
  queue_as :critical

  def perform(...)
  end
end

SomeWorker.set(wait_until: 1.hour).perform_async(123)

Note that arguments passed to the job must still obey Sidekiq’s best practice for simple, JSON-native data types. Sidekiq will not implement ActiveJob’s more complex argument serialization. For this reason, we don’t implement ‘perform_later` as our call semantics are very different.

Defined Under Namespace

Modules: ClassMethods, Options Classes: Setter

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#jid ⇒ Object

Returns the value of attribute jid.



156
157
158
 
# File 'lib/sidekiq/worker.rb', line 156

def jid
  @jid
end

Class Method Details

.clear_all ⇒ Object

Clear all queued jobs across all workers



310
311
312
 
# File 'lib/sidekiq/testing.rb', line 310

def clear_all
  Queues.clear_all
end

.drain_all ⇒ Object

Drain all queued jobs across all workers



315
316
317
318
319
320
321
322
323
 
# File 'lib/sidekiq/testing.rb', line 315

def drain_all
  while jobs.any?
    worker_classes = jobs.map { |job| job["class"] }.uniq

    worker_classes.each do |worker_class|
      Sidekiq::Testing.constantize(worker_class).drain
    end
  end
end

.included(base) ⇒ Object

Raises:

  • (ArgumentError) 


158
159
160
161
162
163
 
# File 'lib/sidekiq/worker.rb', line 158

def self.included(base)
  raise ArgumentError, "Sidekiq::Worker cannot be included in an ActiveJob: #{base.name}" if base.ancestors.any? { |c| c.name == "ActiveJob::Base" }

  base.include(Options)
  base.extend(ClassMethods)
end

.jobs ⇒ Object

:nodoc:



305
306
307
 
# File 'lib/sidekiq/testing.rb', line 305

def jobs # :nodoc:
  Queues.jobs_by_queue.values.flatten
end

Instance Method Details

#logger ⇒ Object 



165
166
167
 
# File 'lib/sidekiq/worker.rb', line 165

def logger
  Sidekiq.logger
end