sidekiq-rerouting 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebea5ac549b2661e67c1aa3cbc6c387021704376fc169f6578daef26cbf30d64
-  data.tar.gz: 42cbc382bac80ac07156d982cc395588da2357914d0a6a256de0b1acf1d128a4
+  metadata.gz: a6b33ce67524b43eeb69f383ac34528f0d31f7d26df43fa5ab1bd84f8b5d5d52
+  data.tar.gz: 80f81ed20b959d9cdb00bb32553e482becc753d834e071f9d3de5ec22f4fd692
 SHA512:
-  metadata.gz: 4be3c9613717b52d8593d5df299b02fca2d2cd195b1870f31965ce513add925b76f44ee5a7fb0e33464bb7a9af24b11a2c58fffd6882f67ccc17dd1560a563c0
-  data.tar.gz: 6154bbd5d5055ead93650ebbd5e79f39b929a15d10defba1f9f998895d6881060f755eb527f15af72090d45166381df5f23776734633a90918a8341b2eb3bc2f
+  metadata.gz: aa9a5eeb4e93350104159fc2e844fed05d26a28fc558328b4a11243e8759cf615509d2815a5f94ae21e9652ee9c7f84aaf0dc786d7ebe6c663a8d5640ad41fec
+  data.tar.gz: bce4f1c97fe84ee5234de594e6b044a30f2d5c0e9ba267d25d8e0980da20bdcda2d4d6dd7b7927fe8dd6b29c82e54a59f4850532909f49b5b39b9e477fcb233e

data/CHANGELOG.md

@@ -1,9 +1,17 @@
-## [Unreleased]
+# Changelog
 
-## [0.2.0] - 2025-09-22
+## [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
+## [0.1.0]: 2025-09-22
 
 - Initial release

data/README.md

@@ -1,6 +1,6 @@
 # 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.
 
@@ -23,7 +23,7 @@ gem install sidekiq-rerouting
 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
@@ -38,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 to be rerouted
-client.remove_rerouting("different_queue", :class, "SomeJobClass")
+# Unmark an entire job class for rerouting
+client.remove_rerouting(: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
@@ -88,9 +93,23 @@ 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.
+
+- `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
 
@@ -110,9 +129,9 @@ 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
 
@@ -131,6 +150,7 @@ Everyone interacting in the Sidekiq::Rerouting project's codebases, issue tracke
 - [`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,6 +2,7 @@
 
 require "sidekiq"
 require_relative "../rerouting"
+require_relative "router"
 
 module Sidekiq
   module Rerouting
@@ -13,14 +14,13 @@ module Sidekiq
         @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.2.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.2.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