sidekiq-rerouting 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82bc960f510cb4d9d214ee89111b292015a5d9c1f6871e27ed5df98c6733b733
-  data.tar.gz: 6075abebe883247848cfbba437251fd8fc17c0c0005c2ff85ed4889a8df4f526
+  metadata.gz: ebea5ac549b2661e67c1aa3cbc6c387021704376fc169f6578daef26cbf30d64
+  data.tar.gz: 42cbc382bac80ac07156d982cc395588da2357914d0a6a256de0b1acf1d128a4
 SHA512:
-  metadata.gz: c7a77cbc8402503850d5083207e8f4789a4ad58b03e894c27fa1a5832f34dd3c2e188cdbb4712041aec7a51e994431c80d26eea7d6b210314a8180127d087576
-  data.tar.gz: d634d71d8616958ac051312145487d48cd8013d48419a9b89b20bbd817564b39c1ffa0a0d525290c12a8df0e3fd85abfcefd833fb9c360398bef649e086caa8c
+  metadata.gz: 4be3c9613717b52d8593d5df299b02fca2d2cd195b1870f31965ce513add925b76f44ee5a7fb0e33464bb7a9af24b11a2c58fffd6882f67ccc17dd1560a563c0
+  data.tar.gz: 6154bbd5d5055ead93650ebbd5e79f39b929a15d10defba1f9f998895d6881060f755eb527f15af72090d45166381df5f23776734633a90918a8341b2eb3bc2f

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
-## [0.1.0] - 2025-09-19
+## [0.2.0] - 2025-09-22
+
+- **Breaking**: Change configuration of middleware to work with `Sidekiq::Middleware::Chain` API
+
+## [0.1.0] - 2025-09-22
 
 - Initial release

data/README.md

@@ -6,18 +6,16 @@ A [Sidekiq][sidekiq] extension to set Sidekiq jobs to be rerouted to a different
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle add sidekiq-rerouting
 ```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+gem install sidekiq-rerouting
 ```
 
 ## Usage
@@ -58,13 +56,57 @@ Clearing all reroutes marks can be done in one fell swoop as well.
 client.remove_rerouting_for_all
 ```
 
+## Configuration
+
+With `sidekiq-rerouting` installed, [register its Sidekiq server middleware][sidekiq-register-middleware].
+Typically this is done via `config/initializers/sidekiq.rb` in a Rails app.
+
+```ruby
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add Sidekiq::Rerouting::ServerMiddleware
+  end
+end
+```
+
+This piece of middleware checks each job, after it's been dequeued, but before its `#perform` has been called, to see if it should be rerouted.
+If the job is marked for rerouting (by job ID or job class), a new job (with the same job ID) is enqueued into the intended destination and the current job exits early.
+
+### Callback
+
+If you'd like to do something when a job is rerouted,
+you can optionally pass in an object that responds to `.call` (like a `Proc`) when adding the middleware:
+
+```ruby
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add(Sidekiq::Rerouting::ServerMiddleware, on_reroute: -> { |job:, old_queue:, new_queue:|
+      puts "Job with jid=#{job["jid"]} was rerouted from #{old_queue} to #{new_queue}"
+    })
+  end
+end
+```
+
+It yields the following keyword arguments:
+* `job`: the serialized job that is being rerouted; see [Sidekiq's docs][job-format] for more details.
+* `old_queue`: the queue *from which* the job is being rerouted.
+* `new_queue`: the queue *to which* the job is being rerouted.
+
 ### Non-Reroutable Jobs
 
 By default all Jobs are reroutable.
-However, checking if a specific Job should be rerouted is not free; it requires round trip(s) to Redis.
-Therefore, you might want to make some Jobs non-reroutable to avoid these extra round trips.
+However, checking if a specific job should be rerouted is not free; it requires round trip(s) to Redis.
+Therefore, you might want to make some jobs non-reroutable to avoid these extra round trips.
 Or because there are some Jobs that simply should never be rerouted for… _reasons_.
 
+This is done via a job's `sidekiq_options`.
+
+```ruby
+sidekiq_options reroutable: false
+```
+
+With that in place, the server middleware will ignore the Job, and pass it down the middleware Chain.
+No extra Redis calls, no funny business.
 
 ## Development
 
@@ -84,4 +126,11 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 Everyone interacting in the Sidekiq::Rerouting project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hibachrach/sidekiq-rerouting/blob/main/CODE_OF_CONDUCT.md).
 
+## See Also
+
+- [`sidekiq-disposal`][sidekiq-disposal]
+
 [sidekiq]: https://sidekiq.org "Simple, efficient background jobs for Ruby."
+[sidekiq-disposal]: https://github.com/hibachrach/sidekiq-disposal "A Sidekiq extension to mark Sidekiq jobs to be disposed of."
+[sidekiq-register-middleware]: https://github.com/sidekiq/sidekiq/wiki/Middleware#registering-middleware "Registering Sidekiq Middleware"
+[job-format]: https://github.com/sidekiq/sidekiq/wiki/Job-Format "How Sidekiq jobs are serialized"

data/lib/sidekiq/rerouting/server_middleware.rb

@@ -8,9 +8,9 @@ module Sidekiq
     class ServerMiddleware
       include ::Sidekiq::ServerMiddleware
 
-      def initialize(client = Client.new, &blk)
-        @client = client
-        @on_reroute = blk
+      def initialize(opts = {})
+        @client = opts.fetch(:client, Client.new)
+        @on_reroute = opts.fetch(:on_reroute, nil)
       end
 
       def call(job_instance, job, queue)

data/lib/sidekiq/rerouting/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module Rerouting
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-rerouting
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Hazel Bachrach