Module: ActiveJob::Callbacks::ClassMethods

Relationships & Source Files
Defined in:	activejob/lib/active_job/callbacks.rb

Overview

These methods will be included into any Active Job object, adding callbacks for perform and enqueue methods.

Instance Method Summary

#after_enqueue(*filters, &blk)

Defines a callback that will get called right after the job is enqueued.
#after_perform(*filters, &blk)

Defines a callback that will get called right after the job’s perform method has finished.
#around_enqueue(*filters, &blk)

Defines a callback that will get called around the enqueuing of the job.
#around_perform(*filters, &blk)

Defines a callback that will get called around the job’s perform method.
#before_enqueue(*filters, &blk)

Defines a callback that will get called right before the job is enqueued.
#before_perform(*filters, &blk)

Defines a callback that will get called right before the job’s perform method is executed.
#inherited(klass)

Instance Method Details

#after_enqueue(*filters, &blk)

Defines a callback that will get called right after the job is enqueued.

class VideoProcessJob < ActiveJob::Base
  queue_as :default

  after_enqueue do |job|
    $statsd.increment "enqueue-video-job.success"
  end

  def perform(video_id)
    Video.find(video_id).process
  end
end

[ GitHub ]

# File 'activejob/lib/active_job/callbacks.rb', line 156


def after_enqueue(*filters, &blk)
  set_callback(:enqueue, :after, *filters, &blk)
end

#after_perform(*filters, &blk)

Defines a callback that will get called right after the job’s perform method has finished.

class VideoProcessJob < ActiveJob::Base
  queue_as :default

  after_perform do |job|
    UserMailer.notify_video_processed(job.arguments.first)
  end

  def perform(video_id)
    Video.find(video_id).process
  end
end

[ GitHub ]

# File 'activejob/lib/active_job/callbacks.rb', line 85


def after_perform(*filters, &blk)
  set_callback(:perform, :after, *filters, &blk)
end

#around_enqueue(*filters, &blk)

Defines a callback that will get called around the enqueuing of the job.

class VideoProcessJob < ActiveJob::Base
  queue_as :default

  around_enqueue do |job, block|
    $statsd.time "video-job.process" do
      block.call
    end
  end

  def perform(video_id)
    Video.find(video_id).process
  end
end

[ GitHub ]

# File 'activejob/lib/active_job/callbacks.rb', line 177


def around_enqueue(*filters, &blk)
  set_callback(:enqueue, :around, *filters, &blk)
end

#around_perform(*filters, &blk)

Defines a callback that will get called around the job’s perform method.

class VideoProcessJob < ActiveJob::Base
  queue_as :default

  around_perform do |job, block|
    UserMailer.notify_video_started_processing(job.arguments.first)
    block.call
    UserMailer.notify_video_processed(job.arguments.first)
  end

  def perform(video_id)
    Video.find(video_id).process
  end
end

You can access the return value of the job only if the execution wasn’t halted.

class VideoProcessJob < ActiveJob::Base
  around_perform do |job, block|
    value = block.call
    puts value # => "Hello World!"
  end

  def perform
    "Hello World!"
  end
end

[ GitHub ]

# File 'activejob/lib/active_job/callbacks.rb', line 118


def around_perform(*filters, &blk)
  set_callback(:perform, :around, *filters, &blk)
end

#before_enqueue(*filters, &blk)

Defines a callback that will get called right before the job is enqueued.

class VideoProcessJob < ActiveJob::Base
  queue_as :default

  before_enqueue do |job|
    $statsd.increment "enqueue-video-job.try"
  end

  def perform(video_id)
    Video.find(video_id).process
  end
end

[ GitHub ]

# File 'activejob/lib/active_job/callbacks.rb', line 137


def before_enqueue(*filters, &blk)
  set_callback(:enqueue, :before, *filters, &blk)
end

#before_perform(*filters, &blk)

Defines a callback that will get called right before the job’s perform method is executed.

class VideoProcessJob < ActiveJob::Base
  queue_as :default

  before_perform do |job|
    UserMailer.notify_video_started_processing(job.arguments.first)
  end

  def perform(video_id)
    Video.find(video_id).process
  end
end

[ GitHub ]

# File 'activejob/lib/active_job/callbacks.rb', line 66


def before_perform(*filters, &blk)
  set_callback(:perform, :before, *filters, &blk)
end

#inherited(klass)

[ GitHub ]

# File 'activejob/lib/active_job/callbacks.rb', line 45


def inherited(klass)
  klass.get_callbacks(:enqueue).config[:skip_after_callbacks_if_terminated] = skip_after_callbacks_if_terminated
  klass.get_callbacks(:perform).config[:skip_after_callbacks_if_terminated] = skip_after_callbacks_if_terminated
  super
end