Sidekiq adapter setup in Ruby on Rails - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is Sidekiq in a Rails application?

Sidekiq is a background job processor for Rails that uses threads to handle many jobs at the same time, making tasks run outside the main web request cycle.

beginner

How do you configure Rails to use Sidekiq as the Active Job adapter?

In the Rails configuration file (usually config/application.rb or an environment file), set config.active_job.queue_adapter = :sidekiq to tell Rails to use Sidekiq for background jobs.

intermediate

What file do you typically create or modify to configure Sidekiq settings like concurrency or queues?

You create or edit config/sidekiq.yml to set options like concurrency, queues, and retry behavior for Sidekiq workers.

beginner

Why is it important to run the Sidekiq process separately from the Rails server?

Sidekiq runs in its own process to handle background jobs independently, so it doesn't block or slow down the web server that handles user requests.

beginner

What command do you use to start Sidekiq in a Rails project after setup?

Run bundle exec sidekiq in the terminal to start the Sidekiq process and begin processing jobs.

Which line sets Sidekiq as the background job adapter in Rails?

A config.sidekiq.adapter = :rails

B config.background_jobs = :sidekiq

C config.active_job.queue_adapter = :sidekiq

D config.job_processor = :sidekiq

The correct way is to set config.active_job.queue_adapter = :sidekiq in Rails configuration.

Where do you usually configure Sidekiq options like concurrency?

A config/initializers/sidekiq.rb

B config/database.yml

C config/routes.rb

D config/sidekiq.yml

Sidekiq options like concurrency and queues are typically set in config/sidekiq.yml.

Why should Sidekiq run in a separate process from the Rails server?

A Because Rails cannot run Sidekiq internally

B To avoid blocking web requests by running jobs in the background

C To save memory by sharing processes

D To speed up database queries

Running Sidekiq separately prevents background jobs from slowing down web request handling.

What command starts the Sidekiq worker process?

A bundle exec sidekiq

B rails server

C sidekiq start

D rails sidekiq

You start Sidekiq with the command bundle exec sidekiq.

Which gem must be included in your Gemfile to use Sidekiq?

A gem 'sidekiq'

B gem 'delayed_job'

C gem 'resque'

D gem 'puma'

The Sidekiq gem is required to use Sidekiq in a Rails app.

Explain how to set up Sidekiq as the background job adapter in a Rails app.

Think about gem installation, configuration, and running the process.

Why is using Sidekiq beneficial for handling background jobs in Rails?

Consider performance and user experience improvements.

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