sidekiq-corral 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7b439de1e2bbdf25862994d714547b2f5f33a1e44ab7d95129a2635537a1efa4
+  data.tar.gz: 5c7580ca96ec6d8b94eef39b7aaae766182fdf7b6f486628e329de8d3946e14e
+SHA512:
+  metadata.gz: 1d9b1923a16971cc9ad0a185d435a48ba43baed28b401e57c092e6686ed21dbe0cbde308a0c2ece0ec0e556ca5fb19c3782f3151cb791f6fa735dcfdcde515b2
+  data.tar.gz: 4275fa4e6f59f422ce8627c98fd23d2ece312e20895c31459eed20fa3f5f23b09f8e6156a4724b9f5c927251c40691cd4a72ec08f1ff1b84beffcabd9808c19b

data/.rubocop.yml

@@ -0,0 +1,14 @@
+require:
+  - rubocop-minitest
+  - rubocop-rake
+
+inherit_gem:
+  syntax_tree: config/rubocop.yml
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.7
+
+# Match print_width option in .streerc
+Layout/LineLength:
+  Max: 100

data/.streerc

@@ -0,0 +1,2 @@
+--print-width=100
+--plugins=plugin/trailing_comma

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-07-24
+
+- Initial release
+
+[Unreleased]: https://github.com/planningcenter/edna/compare/v1.0.0..main
+[0.1.0]: https://github.com/planningcenter/edna/compare/502876a..v0.1.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# 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, 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 e-mail 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 mo@molawson.com. 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.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Mo Lawson
+
+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,129 @@
+# Sidekiq::Corral
+
+A [Sidekiq](https://github.com/sidekiq/sidekiq) add-on that makes it easy to keep the processing for a job and all of the jobs it enqueues on a single queue.
+
+## But Why?
+Imagine a situation where you need to introduce a new Sidekiq job to do a specific task. But because you're working with a good bit of data, you split up the work into a bunch of small, idempotent jobs, as Sidekiq suggests. And you even go a step further, putting this new job class on its own queue to avoid clogging up one of your standard queues with these specialized jobs.
+
+But these new jobs hardly ever live in isolation. In your existing application you're probably enqueuing jobs from a wide variety of places. And that's great until you realize that your new job enqueues a handful of these preexisting jobs based on lifecycle events or something else a few call sites away from the new job itself. This can quickly lead to a situation where the new jobs are on their own queue, as you intended, but as you churn through enough of them, the other jobs they enqueue start to fill up your other queues!
+
+Wouldn't it be nice to be able to tell a job that not only does it go on a certain queue, but any other job that's enqueued while it's being processed should _also_ go on that same queue, ensuring that all work related to the initial job is processed separately from the other jobs in your application?
+
+That's exactly where Sidekiq::Corral comes in!
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_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:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    
+Install the middleware on application boot (e.g. in a Rails initializer or wherever you're configuring other parts of Sidekiq):
+
+```ruby
+# config/initializers/sidekiq.rb
+
+Sidekiq::Corral.install
+```
+
+This will register the included middleware in the right spots.
+
+## Usage
+
+### Sidekiq::Job.set
+Set the corral when enqueueing a job:
+
+```ruby
+SomeJob.set(corral: "backfill").perform_async(args)
+```
+
+This will both set the corral and the queue for that job and any job enqueued during processing of that `SomeJob` instance.
+
+### Sidekiq::Corral.confine
+If you're enqueueing multiple jobs or calling classes that enqueue jobs of their own and you want to confine everything to a single queue, you can use `Sidekiq::Corral.confine`:
+
+```ruby
+Sidekiq::Corral.confne("backfill") do
+  SomeJob.perform_async(args)
+  ClassThatEnqueuesJobs.new.call(more_args)
+  AnotherJob.peform_async(even_more_args) 
+end
+```
+
+All jobs enqueued within that block (including those enqueued in `ClassThatEnqueuesJobs`, etc.) will be put in the `"backfill"` corral and processed on the `"backfill"` queue.
+
+
+### Exempt Queues
+
+Sometimes a queue is special enough that you always want jobs destined for it to _always_ be processed there, regardless of Sidekiq::Corral's concerns. You can name those queues on setup:
+
+```ruby
+Sidekiq::Corral.install(exempt_queues: ["notifications"])
+```
+
+Doing this will ensure anything destined for the `"notifications"` queue will be processed there. But those jobs will still pass along the corral set either on the job or further up the chain.  So any jobs enqueued while it's processing will use the corral.
+
+For example, given this set of jobs:
+
+```ruby
+class NormalJob
+  include Sidekiq::Job
+  sidekiq_options queue: "default"
+  
+  def perform
+    SpecialJob.perform_async
+  end
+end
+
+class SpecialJob
+  include Sidekiq::Job
+  sidekiq_options queue: "notifications"
+  
+  def peform
+    AnotherNormalJob.perform_async
+  end
+end
+
+class AnotherNormalJob
+  include Sidekiq::Job
+  sidekiq_options queue: "default"
+  
+  def perform
+  end
+end
+```
+
+Enqueuing the NormalJob with a corral would get processed like so:
+
+```ruby
+NormalJob.set(corral: "backfill").perform_async
+
+NormalJob               # queue: "backfill".      corral: "backfill"
+-> SpecialJob           # queue: "notifications"  corral: "backfill"
+   -> AnotherNormalJob  # queue: "backfill"       corral: "backfill"
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/molawson/sidekiq-corral. 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/molawson/sidekiq-corral/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::Corral project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/molawson/sidekiq-corral/blob/main/CODE_OF_CONDUCT.md).
+

data/Rakefile

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "rubocop/rake_task"
+RuboCop::RakeTask.new
+
+require "syntax_tree/rake_tasks"
+SyntaxTree::Rake::CheckTask.new
+SyntaxTree::Rake::WriteTask.new
+
+task default: %i[test]

data/lib/sidekiq/corral/version.rb

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

data/lib/sidekiq/corral.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "sidekiq"
+
+require_relative "corral/version"
+
+module Sidekiq
+  module Corral
+    class Error < StandardError
+    end
+
+    class << self
+      def confine(queue)
+        orig_queue = current
+        self.current = queue
+        yield
+      ensure
+        self.current = orig_queue
+      end
+
+      def current
+        Thread.current[:sidekiq_corral_queue]
+      end
+
+      def install(opts = {})
+        Sidekiq.configure_client do |config|
+          config.client_middleware { |chain| chain.add(Sidekiq::Corral::Client, opts) }
+        end
+
+        Sidekiq.configure_server do |config|
+          config.server_middleware { |chain| chain.add(Sidekiq::Corral::Server) }
+          config.client_middleware { |chain| chain.add(Sidekiq::Corral::Client, opts) }
+        end
+      end
+
+      private
+
+      def current=(queue)
+        Thread.current[:sidekiq_corral_queue] = queue
+      end
+    end
+
+    class Client
+      include Sidekiq::ClientMiddleware
+
+      def initialize(opts)
+        opts = opts.transform_keys(&:to_s)
+        @exempt_queues = Array(opts["exempt_queues"]).map(&:to_s)
+      end
+
+      def call(_worker_class, job, _queue, _redis_pool)
+        job["corral"] = Corral.current if Corral.current
+        job["queue"] = job["corral"] if job["corral"] && !@exempt_queues.include?(job["queue"])
+        yield
+      end
+    end
+
+    class Server
+      include Sidekiq::ServerMiddleware
+
+      def call(_worker, job, _queue, &block)
+        job["corral"] ? Corral.confine(job["corral"], &block) : block.call
+      end
+    end
+  end
+end

data/sig/sidekiq/corral.rbs

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

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-corral
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mo Lawson
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: Send a job to a queue and move all jobs it triggers to that same queue.
+email:
+- mo@molawson.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".streerc"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sidekiq/corral.rb
+- lib/sidekiq/corral/version.rb
+- sig/sidekiq/corral.rbs
+homepage: https://github.com/molawson/sidekiq-corral
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/molawson/sidekiq-corral
+  source_code_uri: https://github.com/molawson/sidekiq-corral
+  changelog_uri: https://github.com/molawson/sidekiq-corral/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Confine a job and its child jobs to a single queue.
+test_files: []