Clarification about Sidekiq::Job#interrupted?

[fxn]

Hi! The wiki documents this pattern for graceful exits, available to Pro users using Super Fetch (edited for brevity):

# config/initializers/sidekiq.rb
$shutdown_pending = false
Sidekiq.configure_server do |config|
  config.on(:quiet) do
    $shutdown_pending = true
  end
end

# some_job.rb
def perform
  models.find_each do |model|
    process(model)
    raise Sidekiq::Shutdown if $shutdown_pending
  end
end

However, looking at the API of Sidekiq::Job I see there is an interrupted? predicate. But it depends on an internal context object I am not familiar with. Safe navigation is used, so I guess the context can even be nil (but I do not know when).

In any case, could we simplify the code above removing the callback and checking the predicate in perform?

def perform
  models.find_each do |model|
    process(model)
    raise Sidekiq::Shutdown if interrupted?
  end
end

[mperham]

Yes, that interrupted? method was added as part of Iterable Jobs in 7.3. Since the documentation is unversioned and I'd rather not fill the wiki with version-specific code, we typically don't update the docs to use cutting edge stuff without waiting a year or two. It's been long enough now.

[mperham]

I've updated the wiki.

[fxn]

Awesome! Thanks Mike! This new API is much nicer.