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.

Practice

1. What is the correct way to set Sidekiq as the background job adapter in a Rails application?

easy

A. config.sidekiq.adapter = :active_job

B. config.active_job.queue_adapter = :sidekiq

C. config.background_jobs = :sidekiq

D. config.queue_adapter = :sidekiq

Solution

1. Step 1: Understand Rails Active Job configuration

   Rails uses config.active_job.queue_adapter to set the background job processor.

2. Step 2: Identify the correct adapter setting for Sidekiq

   To use Sidekiq, you assign the symbol :sidekiq to config.active_job.queue_adapter.

3. Final Answer:

   config.active_job.queue_adapter = :sidekiq -> Option B

4. Quick Check:

   Set adapter with config.active_job.queue_adapter = :sidekiq [OK]

Hint: Remember: Active Job adapter is set via config.active_job.queue_adapter [OK]

Common Mistakes:

• Using config.sidekiq.adapter instead of config.active_job.queue_adapter
• Assigning string 'sidekiq' instead of symbol :sidekiq
• Setting config.queue_adapter without active_job prefix

2. Which of the following is the correct syntax to configure Sidekiq as the queue adapter in config/application.rb?

easy

A. config.active_job.queue_adapter = sidekiq

B. config.active_job.queue_adapter = 'sidekiq'

C. config.active_job.queue_adapter = :sidekiq

D. config.active_job.queue_adapter = Sidekiq

Solution

1. Step 1: Identify correct Ruby symbol usage

   In Ruby, symbols are prefixed with a colon, so :sidekiq is the correct way to specify the adapter.

2. Step 2: Check the syntax for setting the adapter

   Assigning a string or constant without colon will cause errors or unexpected behavior.

3. Final Answer:

   config.active_job.queue_adapter = :sidekiq -> Option C

4. Quick Check:

   Use symbol :sidekiq for adapter setting [OK]

Hint: Use a colon before sidekiq to make it a symbol [OK]

Common Mistakes:

• Using quotes around sidekiq instead of a symbol
• Using a bare word without colon causing NameError
• Using capitalized Sidekiq which is a constant, not a symbol

3. Given the following Rails configuration snippet, what will be the output when a job is enqueued?

config.active_job.queue_adapter = :sidekiq

class MyJob < ApplicationJob
  def perform
    puts 'Job is running'
  end
end

MyJob.perform_later

medium

A. Job is running printed immediately in the console

B. SyntaxError due to missing Sidekiq setup

C. No output because perform_later does not run the job

D. Job is running printed asynchronously by Sidekiq worker

Solution

1. Step 1: Understand perform_later behavior with Sidekiq

   Using perform_later enqueues the job to Sidekiq to run asynchronously, not immediately.

2. Step 2: Recognize output timing

   The job's puts runs when Sidekiq worker processes the job, so output appears asynchronously in Sidekiq logs or console.

3. Final Answer:

   Job is running printed asynchronously by Sidekiq worker -> Option D

4. Quick Check:

   perform_later enqueues job; output appears when Sidekiq runs it [OK]

Hint: perform_later queues job; output shows when Sidekiq runs it [OK]

Common Mistakes:

• Thinking perform_later runs job immediately
• Expecting output in main Rails console instantly
• Confusing perform_now with perform_later

4. You set config.active_job.queue_adapter = :sidekiq but your jobs are not running. Which of the following is the most likely cause?

medium

A. Redis server is not running or unreachable

B. You forgot to restart Rails server after setting adapter

C. Sidekiq gem is not included in Gemfile

D. Jobs are running but output is hidden by default

Solution

1. Step 1: Understand Sidekiq dependency on Redis

   Sidekiq uses Redis to manage job queues, so Redis must be running and accessible.

2. Step 2: Identify common failure cause

   If Redis is down, Sidekiq cannot process jobs, causing them to remain queued and not run.

3. Final Answer:

   Redis server is not running or unreachable -> Option A

4. Quick Check:

   Sidekiq needs Redis running to process jobs [OK]

Hint: Check Redis service is running when Sidekiq jobs don't run [OK]

Common Mistakes:

• Assuming Rails server restart fixes Sidekiq job processing
• Forgetting to add Sidekiq gem causing load errors
• Thinking jobs run but output is hidden without checking Redis

5. You want to ensure your Rails app uses Sidekiq only for specific jobs, while others use the default async adapter. How do you configure this selectively?

hard

A. Set config.active_job.queue_adapter = :async and override self.queue_adapter = :sidekiq in specific job classes

B. Set config.active_job.queue_adapter = :sidekiq and override self.queue_adapter = :async in specific job classes

C. Use perform_async for Sidekiq jobs and perform_later for async jobs

D. Configure Sidekiq in config/sidekiq.yml to exclude certain jobs

Solution

1. Step 1: Set default adapter to async for general jobs

   Set config.active_job.queue_adapter = :async in application config to use async adapter by default.

2. Step 2: Override adapter in specific job classes

   In jobs that should use Sidekiq, add self.queue_adapter = :sidekiq to override the default adapter.

3. Final Answer:

   Set config.active_job.queue_adapter = :async and override self.queue_adapter = :sidekiq in specific job classes -> Option A

4. Quick Check:

   Default adapter async; override with self.queue_adapter = :sidekiq [OK]

Hint: Set default adapter, override per job with self.queue_adapter [OK]

Common Mistakes:

• Setting Sidekiq as default and trying to override with async (not supported)
• Using perform_async instead of perform_later in Active Job
• Trying to configure exclusions in sidekiq.yml which doesn't control adapter per job