Code Reading of Sidekiq

This article was originally published on bmf-tech.com.

Overview

A quick read through the Sidekiq code.

Preparation

1. Clone sidekiq
   • https://github.com/sidekiq/sidekiq
2. Start redis
   • docker run --name redis-server -p 6379:6379 -d redis
3. Insert binding.pry where you want to debug
4. Start sidekiq
   • bundle exec sidekiq -r ./examples/blog.rb
5. Enqueue a job
   • bundle exec irb -r ./examples/por.rb

Code Reading

Enqueuing Jobs

1. Call asynchronous processing starting from perform_async
   • sidekiq - lib/sidekiq/job.rb#L205
2. Enqueue the job
   • client_push
     • sidekiq - lib/sidekiq/job.rb#L368
   • push
     • sidekiq - lib/sidekiq/client.rb#L86
   • raw_push
     • sidekiq - lib/sidekiq/client.rb#L239

Executing Jobs

1. Start sidekiq
   • run
     • lib/sidekiq/cli.rb#41
   • launch
     • lib/sidekiq/cli.rb#116
   • run
     • lib/sidekiq/cli.rb#38
2. Fetch jobs
   • run
     • lib/sidekiq/processor.rb#71
   • process_one
     • lib/sidekiq/processor.rb#71
   • process
     • lib/sidekiq/processor.rb#159
     • Process the job
3. Execute the job
   • execute_job
     • lib/sidekiq/processor.rb#185
     • lib/sidekiq/processor.rb#217