sidekiq-rerouting 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82bc960f510cb4d9d214ee89111b292015a5d9c1f6871e27ed5df98c6733b733
-  data.tar.gz: 6075abebe883247848cfbba437251fd8fc17c0c0005c2ff85ed4889a8df4f526
+  metadata.gz: a6b33ce67524b43eeb69f383ac34528f0d31f7d26df43fa5ab1bd84f8b5d5d52
+  data.tar.gz: 80f81ed20b959d9cdb00bb32553e482becc753d834e071f9d3de5ec22f4fd692
 SHA512:
-  metadata.gz: c7a77cbc8402503850d5083207e8f4789a4ad58b03e894c27fa1a5832f34dd3c2e188cdbb4712041aec7a51e994431c80d26eea7d6b210314a8180127d087576
-  data.tar.gz: d634d71d8616958ac051312145487d48cd8013d48419a9b89b20bbd817564b39c1ffa0a0d525290c12a8df0e3fd85abfcefd833fb9c360398bef649e086caa8c
+  metadata.gz: aa9a5eeb4e93350104159fc2e844fed05d26a28fc558328b4a11243e8759cf615509d2815a5f94ae21e9652ee9c7f84aaf0dc786d7ebe6c663a8d5640ad41fec
+  data.tar.gz: bce4f1c97fe84ee5234de594e6b044a30f2d5c0e9ba267d25d8e0980da20bdcda2d4d6dd7b7927fe8dd6b29c82e54a59f4850532909f49b5b39b9e477fcb233e

data/CHANGELOG.md

@@ -1,5 +1,17 @@
-## [Unreleased]
+# Changelog
 
-## [0.1.0] - 2025-09-19
+## [Unreleased]:
+
+## [0.3.0]: 2025-11-10
+
+- Added support for Sidekiq Pro's Batch feature.
+- **Breaking**: the `on_reroute` callback's `job` parameter is now the rerouted job instead of the original job.
+    Meaning the `job["queue"]` will be the rerouted queue, not the original queue.
+
+## [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

@@ -1,23 +1,21 @@
 # Sidekiq::Rerouting
 
-[![CI](https://github.com/hibachrach/sidekiq-disposal/actions/workflows/main.yml/badge.svg)](https://github.com/hibachrach/sidekiq-disposal/actions)
+[![CI](https://github.com/hibachrach/sidekiq-rerouting/actions/workflows/main.yml/badge.svg)](https://github.com/hibachrach/sidekiq-rerouting/actions)
 
 A [Sidekiq][sidekiq] extension to set Sidekiq jobs to be rerouted to a different queue based on the job ID or job class.
 
 ## 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
@@ -25,7 +23,7 @@ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
 From a console (Rails console, or the like) you need a `Sidekiq::Rerouting::Client` instance, which is used to `#reroute` a job, or job class to be disposed.
 
 ```ruby
-client = Sidekiq::Disposal::Client.new
+client = Sidekiq::Rerouting::Client.new
 ```
 
 ### Marking to reroute
@@ -40,14 +38,19 @@ client.reroute("different_queue", :jid, some_job_id)
 client.reroute("different_queue", :class, "SomeJobClass")
 ```
 
-A job or job class can also be removed from rerouting for disposal via a corresponding API.
+A job or job class can also be removed from rerouting via a corresponding API. This only takes effects for jobs enqueued after the API call.
+Reroute the jobs back to its original queue to affect the previously rerouted jobs still in the queue.
 
 ```ruby
-# Unmark a specific Job to be rerouted by specifying its job ID
-client.remove_rerouting("different_queue", :jid, some_job_id)
+# Unmark a specific Job for rerouting by specifying its job ID
+client.remove_rerouting(:jid, some_job_id)
+
+# Unmark an entire job class for rerouting
+client.remove_rerouting(:class, "SomeJobClass")
 
-# Unmark an entire job class to be rerouted
-client.remove_rerouting("different_queue", :class, "SomeJobClass")
+# Force previously rerouted job class/jid to its original queue
+client.reroute("original_queue", :jid, some_job_id)
+client.reroute("original_queue", :class, "SomeJobClass")
 ```
 
 ### Clearing all rerouting
@@ -58,19 +61,77 @@ 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.
+
+### Sidekiq Pro Batches
+
+If you're using [Sidekiq Pro's Batch feature][sidekiq-batches] you need to be sure to insert the rerouting middleware _after_ the `Batch` middleware.
+This will ensure the batch can be re-opened, and the rereouted job added to it.
+
+```ruby
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.insert_after(Sidekiq::Batch::Server, Sidekiq::Rerouting::ServerMiddleware)
+  end
+end
+```
+
 ### 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
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bin/rake install`. To release a new version, update the version number in `version.rb`, and then run `bin/rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
@@ -84,4 +145,12 @@ 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-batches]: https://github.com/sidekiq/sidekiq/wiki/Batches "Sidekiq Pro Batches"
+[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/batch_api.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "../rerouting"
+
+module Sidekiq
+  module Rerouting
+    class BatchAPI
+      def jobs_in(batch:)
+        batch_api.new(batch).jobs do
+          yield
+        end
+      end
+
+      private
+
+      def batch_api
+        @batch_api ||= defined?(::Sidekiq::Batch) ? ::Sidekiq::Batch : NullBatchAPI
+      end
+
+      class NullBatchAPI
+        def initialize(_batch_id)
+        end
+
+        def jobs
+          yield
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/rerouting/router.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative "../rerouting"
+require_relative "batch_api"
+
+module Sidekiq
+  module Rerouting
+    class Router
+      def initialize(job_instance:, job_payload:, client: Client.new, batch_api: BatchAPI.new)
+        @batch_api = batch_api
+        @client = client
+        @job_instance = job_instance
+        @job_payload = job_payload
+        @original_queue = job_payload["queue"]
+      end
+
+      attr_reader :original_queue
+
+      def reroutable?
+        job_instance && job_instance.class.get_sidekiq_options.fetch("reroutable", true)
+      end
+
+      def rerouted_from?(queue:)
+        rerouted_queue && rerouted_queue != queue
+      end
+
+      def rerouted_playload
+        job_payload.merge("queue" => rerouted_queue)
+      end
+
+      def rerouted_queue
+        return @rerouted_queue if defined?(@rerouted_queue)
+
+        @rerouted_queue = client.rerouting_destination(job_payload)
+      end
+
+      def within_batch_maybe
+        batch_id = job_payload["bid"]
+
+        return yield unless batch_id
+
+        batch_api.jobs_in(batch: batch_id) do
+          yield
+        end
+      end
+
+      private
+
+      attr_reader :batch_api, :client, :job_instance, :job_payload
+    end
+  end
+end

data/lib/sidekiq/rerouting/server_middleware.rb

@@ -2,25 +2,25 @@
 
 require "sidekiq"
 require_relative "../rerouting"
+require_relative "router"
 
 module Sidekiq
   module Rerouting
     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)
-        if job_instance && !job_instance.class.get_sidekiq_options.fetch("reroutable", true)
-          yield
-        elsif job_instance &&
-            (rerouting_destination = client.rerouting_destination(job)) &&
-            rerouting_destination != queue
-          job_instance.class.client_push(job.merge("queue" => rerouting_destination))
-          on_reroute&.call(job:, old_queue: queue, new_queue: rerouting_destination)
+      def call(job_instance, job_payload, queue)
+        router = Router.new(job_instance:, job_payload:, client:)
+
+        if router.reroutable? && router.rerouted_from?(queue:)
+          router.within_batch_maybe do
+            reroute(sidekiq_client: job_instance.class, router: router)
+          end
         else
           yield
         end
@@ -29,6 +29,12 @@ module Sidekiq
       private
 
       attr_reader :client, :on_reroute
+
+      def reroute(sidekiq_client:, router:)
+        sidekiq_client.client_push(router.rerouted_playload)
+
+        on_reroute&.call(job: router.rerouted_playload, old_queue: router.original_queue, new_queue: router.rerouted_queue)
+      end
     end
   end
 end

data/lib/sidekiq/rerouting/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module Rerouting
-    VERSION = "0.1.0"
+    VERSION = "0.3.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.3.0
 platform: ruby
 authors:
 - Hazel Bachrach
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-09-22 00:00:00.000000000 Z
+date: 2025-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -41,7 +41,9 @@ files:
 - README.md
 - Rakefile
 - lib/sidekiq/rerouting.rb
+- lib/sidekiq/rerouting/batch_api.rb
 - lib/sidekiq/rerouting/client.rb
+- lib/sidekiq/rerouting/router.rb
 - lib/sidekiq/rerouting/server_middleware.rb
 - lib/sidekiq/rerouting/version.rb
 - sig/sidekiq/rerouting.rbs
@@ -68,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: A mechanism to reroute queued jobs to a different queue on pickup