sidekiq-rerouting 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 82bc960f510cb4d9d214ee89111b292015a5d9c1f6871e27ed5df98c6733b733
+  data.tar.gz: 6075abebe883247848cfbba437251fd8fc17c0c0005c2ff85ed4889a8df4f526
+SHA512:
+  metadata.gz: c7a77cbc8402503850d5083207e8f4789a4ad58b03e894c27fa1a5832f34dd3c2e188cdbb4712041aec7a51e994431c80d26eea7d6b210314a8180127d087576
+  data.tar.gz: d634d71d8616958ac051312145487d48cd8013d48419a9b89b20bbd817564b39c1ffa0a0d525290c12a8df0e3fd85abfcefd833fb9c360398bef649e086caa8c

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-09-19
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Hazel Bachrach
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,87 @@
+# Sidekiq::Rerouting
+
+[![CI](https://github.com/hibachrach/sidekiq-disposal/actions/workflows/main.yml/badge.svg)](https://github.com/hibachrach/sidekiq-disposal/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
+```
+
+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
+```
+
+## Usage
+
+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
+```
+
+### Marking to reroute
+
+A job marked to be rerouted means it will be re-enqueued to the destination queue when it's picked up.
+
+```ruby
+# Mark a specific Job to be rerouted by specifying its job ID
+client.reroute("different_queue", :jid, some_job_id)
+
+# Mark an entire job class to be rerouted
+client.reroute("different_queue", :class, "SomeJobClass")
+```
+
+A job or job class can also be removed from rerouting for disposal via a corresponding API.
+
+```ruby
+# Unmark a specific Job to be rerouted by specifying its job ID
+client.remove_rerouting("different_queue", :jid, some_job_id)
+
+# Unmark an entire job class to be rerouted
+client.remove_rerouting("different_queue", :class, "SomeJobClass")
+```
+
+### Clearing all rerouting
+
+Clearing all reroutes marks can be done in one fell swoop as well.
+
+```ruby
+client.remove_rerouting_for_all
+```
+
+### 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.
+Or because there are some Jobs that simply should never be rerouted for… _reasons_.
+
+
+## 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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hibachrach/sidekiq-rerouting. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/hibachrach/sidekiq-rerouting/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+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).
+
+[sidekiq]: https://sidekiq.org "Simple, efficient background jobs for Ruby."

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/sidekiq/rerouting/client.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require "sidekiq"
+
+module Sidekiq
+  module Rerouting
+    # A client for marking enqueued jobs for rerouting. A rerouted job is one
+    # that is re-enqueued as is to a different destination queue.
+    #
+    # This task is accomplished with "markers": A job can be "marked" for
+    # rerouting. This means that a "marker" (a job id/jid or class name) can
+    # be formatted and then added to the relevant target set.
+    #
+    # When a worker picks up the job, the corresponding `ServerMiddleware` will
+    # then re-enqueue the job to the destination queue and exit early (skipping
+    # execution).
+    class Client
+      REDIS_TARGET_HASH = "sidekiq-rerouting:rerouting_targets"
+
+      # The types of markers that are allowed for identifying jobs.
+      # NOTE: The order of this array is important--jobs are matched in
+      # order, so `jid` takes priority over `class`
+      ALLOWED_MARKER_TYPES = %i[jid class].freeze
+
+      def initialize(sidekiq_api = ::Sidekiq)
+        @sidekiq_api = sidekiq_api
+      end
+
+      # @param target_queue [String] The queue to which the job should be rerouted
+      # @param marker_type [:jid, :class] The type of marker being used to identify the job
+      # @param string marker [String] The identifying value of the marker
+      def reroute(target_queue, marker_type, marker)
+        redis do |conn|
+          formatted = formatted_marker(marker_type, marker)
+          conn.hset(REDIS_TARGET_HASH, formatted, target_queue)
+        end
+      end
+
+      # @param marker_type [:jid, :class] The type of marker being used to identify the job
+      # @param string marker [String] The identifying value of the marker
+      def remove_rerouting(marker_type, marker)
+        redis do |conn|
+          conn.hdel(REDIS_TARGET_HASH, formatted_marker(marker_type, marker))
+        end
+      end
+
+      def remove_rerouting_for_all
+        redis do |conn|
+          conn.del(REDIS_TARGET_HASH)
+        end
+      end
+
+      # @returns [Hash<String,String>] A hash of all markers and their destination queues
+      def rerouting_markers
+        redis do |conn|
+          conn.hgetall(REDIS_TARGET_HASH)
+        end
+      end
+
+      # @retruns [String, nil] The destination queue for the given job, or nil if not marked for rerouting
+      def rerouting_destination(job)
+        redis do |conn|
+          conn.hmget(REDIS_TARGET_HASH, formatted_markers(job))
+        end.find(&:itself)
+      end
+
+      private
+
+      def redis(&blk)
+        sidekiq_api.redis(&blk)
+      end
+
+      # @return [Array] A list of identifying formatted_markers/features which
+      #                 indicates a job is targeted for rerouting.
+      def formatted_markers(job)
+        ALLOWED_MARKER_TYPES.map do |marker_type|
+          formatted_marker_for_job(marker_type, job)
+        end.compact
+      end
+
+      # @returns the formatted marker that would be in Redis if this job has
+      # been targeted
+      def formatted_marker_for_job(marker_type, job)
+        formatted_marker(marker_type, job[marker_type.to_s])
+      end
+
+      # @returns the marker as it is stored in Redis
+      def formatted_marker(marker_type, marker)
+        return nil if marker.nil?
+        raise ArgumentError unless ALLOWED_MARKER_TYPES.include?(marker_type.to_sym)
+
+        "#{marker_type}:#{marker}"
+      end
+
+      attr_reader :sidekiq_api
+    end
+  end
+end

data/lib/sidekiq/rerouting/server_middleware.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "sidekiq"
+require_relative "../rerouting"
+
+module Sidekiq
+  module Rerouting
+    class ServerMiddleware
+      include ::Sidekiq::ServerMiddleware
+
+      def initialize(client = Client.new, &blk)
+        @client = client
+        @on_reroute = blk
+      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)
+        else
+          yield
+        end
+      end
+
+      private
+
+      attr_reader :client, :on_reroute
+    end
+  end
+end

data/lib/sidekiq/rerouting/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Sidekiq
+  module Rerouting
+    VERSION = "0.1.0"
+  end
+end

data/lib/sidekiq/rerouting.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "rerouting/version"
+require_relative "rerouting/client"
+require_relative "rerouting/server_middleware"
+
+module Sidekiq
+  # Namespace for everything related to Sidekiq job rerouting: the processing
+  # of putting jobs' markers (i.e. identifying features) into a Redis hash so
+  # they can be "rerouted" (re-enqueued into a different queue during pickup).
+  module Rerouting
+  end
+end

data/sig/sidekiq/rerouting.rbs

@@ -0,0 +1,6 @@
+module Sidekiq
+  module Rerouting
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-rerouting
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hazel Bachrach
+- Steven Harman
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+description: |
+  A mechanism to reroute queued jobs to a different queue on pickup.
+  Can target jobs by job ID or job class.
+email:
+- hibachrach@dropbox.com
+- steven@harmanly.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sidekiq/rerouting.rb
+- lib/sidekiq/rerouting/client.rb
+- lib/sidekiq/rerouting/server_middleware.rb
+- lib/sidekiq/rerouting/version.rb
+- sig/sidekiq/rerouting.rbs
+homepage: https://github.com/hibachrach/sidekiq-rerouting
+licenses:
+- MIT
+metadata:
+  changelog_uri: https://github.com/hibachrach/sidekiq-rerouting/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/hibachrach/sidekiq-rerouting
+  homepage_uri: https://github.com/hibachrach/sidekiq-rerouting
+  source_code_uri: https://github.com/hibachrach/sidekiq-rerouting
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: A mechanism to reroute queued jobs to a different queue on pickup
+test_files: []