diff --git a/Changes.md b/Changes.md index 970a65fa..3aa6dbc2 100644 --- a/Changes.md +++ b/Changes.md @@ -5,6 +5,16 @@ HEAD --------- +- **FEATURE**: Add `Sidekiq::Job` alias for `Sidekiq::Worker`, to better + reflect industry standard terminology. You can now do this: +```ruby +class MyJob + include Sidekiq::Job + sidekiq_options ... + def perform(args) + end +end +``` - **FEATURE**: Support for serializing ActiveSupport::CurrentAttributes into each job. [#4982] ```ruby # config/initializers/sidekiq.rb diff --git a/lib/sidekiq.rb b/lib/sidekiq.rb index 188013dd..92d6cf2e 100644 --- a/lib/sidekiq.rb +++ b/lib/sidekiq.rb @@ -6,6 +6,7 @@ fail "Sidekiq #{Sidekiq::VERSION} does not support Ruby versions below 2.5.0." i require "sidekiq/logger" require "sidekiq/client" require "sidekiq/worker" +require "sidekiq/job" require "sidekiq/redis_connection" require "sidekiq/delay" diff --git a/lib/sidekiq/job.rb b/lib/sidekiq/job.rb index d2fc5a78..c8ccc794 100644 --- a/lib/sidekiq/job.rb +++ b/lib/sidekiq/job.rb @@ -1,8 +1,13 @@ require "sidekiq/worker" module Sidekiq - # Sidekiq::Job is a new alias for Sidekiq::Worker, coming in 6.3.0. - # You can opt into this by requiring 'sidekiq/job' in your initializer - # and then using `include Sidekiq::Job` rather than `Sidekiq::Worker`. + # Sidekiq::Job is a new alias for Sidekiq::Worker as of Sidekiq 6.3.0. + # Use `include Sidekiq::Job` rather than `include Sidekiq::Worker`. + # + # The term "worker" is too generic and overly confusing, used in several + # different contexts meaning different things. Many people call a Sidekiq + # process a "worker". Some people call the thread that executes jobs a + # "worker". This change brings Sidekiq closer to ActiveJob where your job + # classes extend ApplicationJob. Job = Worker end