Rails ActiveJob - how to stop job from being enqueued in before_enqueue

Question

I am running Rails 4.2.8 and I want to make my job only run under certain conditions. Currently I am doing that check in the code that is calling the job but it would be much cleaner to contain the logic in the job class. Has anyone done that?

class MyJob < ApplicationJob
  before_enqueue do |job|
    # check and stop job from being enqueued under certain conditions
  end
  def perform(args*)
    # code here
  end
end

I am using Sidekiq 4.2.10 as the background job adapter.

Answer 1

You can use around_enqueue to achieve the same result without raising the exception. This can be useful when not enqueuing is something to be expected by your job.

Ex:

around_enqueue do |_job, block|
   if my_condition 
      block.call # this will enqueue your job
   end
end

OBS: Worth noting that this answer is based on Rails 5 ActiveJob code but must work on Rails 4 as well.

Answer 2

throw :abort from your before_enqueue to halt the execution of the callback chain and perform.

Code: https://github.com/rails/rails/blob/fc20050ea69ba3b8d8bc90171d2dcbf93e9a1dae/activesupport/lib/active_support/callbacks.rb#L23