Sidekiq::Sequence - Sequential Sidekiq jobs.

Sidekiq is awesome, but it doesn't provide any support for sequential jobs, where a sequence of jobs must be run in a set order.

Sidekiq::Sequence provides a simple yet powerful framework to run a sequence of Sidekiq jobs, where each job runs only when the previous job successfully completes. It relies on Sidekiq's retry functionality to handle failed jobs. So if a job fails, any subsequent jobs will not run. Once the job is retried and is successful, the next job will start.

NOTE: Sidekiq::Sequence is currently only intended for use in Rails applications.

Add this line to your application's Gemfile:

gem 'sidekiq-sequence'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install sidekiq-sequence

Run the Rails generator to install the database migration:

$ rails g sidekiq_sequence:install
$ rails db:migrate

Start with a Sequence class which inherits from Sidekiq::Sequence::Base, and define each step of the sequence:

class ContactFormSequence < Sidekiq::Sequence::Base
  step CreateMessage
  step AssignMessage
end

Each step should be a class that includes Sidekiq::Sequence::Worker, and behaves just like a regular Sidekiq Worker:

class ContactFormSequence::CreateMessage
  include Sidekiq::Sequence::Worker

  def perform
    # Perform your job
  end
end

Each Step is run in the order they are defined, and each is a Sidekiq worker. If a worker fails, subsequent steps will not be run, and the worker will be placed in the Sidekiq retry queue. Once it succeeds, the next step will be run, and so on.

Start a Sequence by simply initializing the Sequence class you created:

ContactFormSequence.new name: 'Joel', github: 'joelmoss'

You can pass named arguments, and these will be persisted and available in the Sequence and its workers:

class ContactFormSequence::CreateMessage
  include Sidekiq::Sequence::Worker

  def perform
    @data # -> { name: 'Joel', github: 'joelmoss' }
  end
end

You can also modify Sequence data in any worker, which is great for passing data to subsequent steps:

class ContactFormSequence::AssignMessage
  include Sidekiq::Sequence::Worker

  def perform
    @data[:message] = 'my message' # @data is now { name: 'Joel', github: 'joelmoss', message: 'my message' }
  end
end

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/joelmoss/sidekiq-sequence. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

The gem is available as open source under the terms of the MIT License.

Everyone interacting in the Sidekiq::Sequence project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.