Sidekiq adapter setup in Ruby on Rails - Step-by-Step Execution

Concept Flow - Sidekiq adapter setup

Add Sidekiq gem to Gemfile

↓

Run bundle install

↓

Configure Active Job to use Sidekiq adapter

↓

Create Sidekiq initializer (optional)

↓

Start Sidekiq process

↓

Enqueue jobs using Active Job

↓

Sidekiq processes jobs in background

This flow shows how to set up Sidekiq as the background job processor in a Rails app using Active Job.

Execution Sample

Ruby on Rails

gem 'sidekiq'

# config/application.rb
module YourAppName
  class Application < Rails::Application
    config.active_job.queue_adapter = :sidekiq
  end
end

# Start Sidekiq
bundle exec sidekiq

This code adds Sidekiq, sets it as the job adapter, and starts the Sidekiq worker process.

Execution Table

Step	Action	Result	Notes
1	Add 'sidekiq' gem to Gemfile	Gemfile updated	Sidekiq code becomes available
2	Run 'bundle install'	Sidekiq gem installed	Dependencies resolved
3	Set 'config.active_job.queue_adapter = :sidekiq'	Active Job uses Sidekiq	Jobs will be sent to Sidekiq
4	Start Sidekiq with 'bundle exec sidekiq'	Sidekiq process runs	Ready to process jobs
5	Enqueue a job via Active Job	Job added to Sidekiq queue	Job waits for processing
6	Sidekiq picks job from queue	Job executed in background	Work done asynchronously
7	No more jobs in queue	Sidekiq waits idle	Process continues running

💡 Sidekiq process runs continuously until stopped; jobs processed as they arrive

Variable Tracker

Variable	Start	After Step 3	After Step 5	After Step 6	Final
queue_adapter	default (async)	sidekiq	sidekiq	sidekiq	sidekiq
sidekiq_process	not running	not running	running	running	running
job_queue	empty	empty	1 job enqueued	0 jobs (processing)	empty

Key Moments - 3 Insights

Why do we need to set 'config.active_job.queue_adapter = :sidekiq'?

This tells Rails to send background jobs to Sidekiq instead of the default async adapter, as shown in execution_table step 3.

What happens if Sidekiq process is not running?

Jobs will be enqueued but not processed, because Sidekiq must be running to pick jobs from the queue (see step 6).

Is it necessary to add Sidekiq gem before configuring the adapter?

Yes, because without the gem installed, Rails cannot use Sidekiq as the adapter (see steps 1 and 2).

Visual Quiz - 3 Questions

Look at the execution_table, what is the state of 'job_queue' after step 5?

A 1 job enqueued

B Empty

C Job processing

D Sidekiq stopped

💡 Hint

Check variable_tracker row for 'job_queue' after step 5

At which step does Sidekiq start running to process jobs?

A Step 3

B Step 4

C Step 5

D Step 6

💡 Hint

Look at execution_table step 4 and variable_tracker 'sidekiq_process'

If we skip adding the Sidekiq gem, what happens when setting the adapter?

A Rails uses default async adapter

B Sidekiq adapter works anyway

C Error occurs because Sidekiq is missing

D Jobs run immediately in main thread

💡 Hint

Refer to key_moments about gem installation necessity

Concept Snapshot

Sidekiq adapter setup in Rails:
1. Add 'sidekiq' gem and run bundle install.
2. Set config.active_job.queue_adapter = :sidekiq.
3. Start Sidekiq process with 'bundle exec sidekiq'.
4. Enqueue jobs via Active Job; Sidekiq processes them asynchronously.
Remember: Sidekiq must run to process jobs.

Full Transcript

To set up Sidekiq as the background job processor in a Rails app, first add the 'sidekiq' gem to your Gemfile and run 'bundle install' to install it. Then, configure your Rails application by setting 'config.active_job.queue_adapter = :sidekiq' in your application configuration file. Next, start the Sidekiq process using the command 'bundle exec sidekiq' to begin processing jobs. When you enqueue jobs using Active Job, they are sent to Sidekiq's queue and processed asynchronously in the background. Sidekiq must be running to pick up and execute these jobs. Without the Sidekiq gem installed or the process running, jobs will not be processed. This setup allows your Rails app to handle background tasks efficiently.