Missing Sidekiq::Batch::Status#success? method

[rafaelmillan]

I found myself trying to figure out if a batch and its children batches were successful, and I realized that there is no Sidekiq::Batch::Status#success? method (despite there being a Sidekiq::Batch::Status#complete? method).

I imagine something like this would work:

def success?
  complete? && failures == 0 && @props["cbdeath"].to_i == 0
end

What do you think?

[mperham]

Once a batch is successful, it is deleted from Redis so it’s pretty hard to safely provide that method. You should determine success based on side effects, ie something in your app database, set your own marker in Redis, etc.

[rafaelmillan]

I didn't think of that. I was meaning to use it in the parent batch's callback (while the batch is still in Redis) to send notifications:

def on_complete(sidekiq_status, _options)
  if sidekiq_status.success?
    # Notify that all jobs/batches are done and successful
  else
    # Notify that all jobs/batches are done with failures
  end
end

I suppose that if it's too specific I could implement it myself for my use case.

[mperham]

You can definitely use a success callback in the batch or parent batch to send notifications, you just can't get a batch success reliably outside of the batch because of the success/deletion race condition.

[rafaelmillan]

Ok, thanks a lot for your input 🙌