sidekiq_job_controller 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cebc12dc71aff628f1242f93184eb2d152c1d2760a24b4b8d5b113f6879d4a7e
+  data.tar.gz: 40414d5a91649fc946f26a4b5b42f156879a11f164c58d1eed2b5923289b2151
+SHA512:
+  metadata.gz: 5eb45047c7108613ff1e4cadbabb7b8cec81d838d67b6f33a45d1dd9c1be543104a8c7c5fb75690258089c74101b3f9cd2f5d1e38b59810fcdcbe25760a402ee
+  data.tar.gz: '0190b71cab0db175b24c9ce95a780435d0b9f36052380283efa4d77abd7bbb1872db93ae1091bb5fd9c96f0d959eefb56f760245aded088e05fc90f8098120bc'

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 2.6

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [0.1.0] - 2024-04-12
+
+- Initial release

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 as an Issue in this repository. 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) 2024 Circle.so
+
+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,81 @@
+# SidekiqJobController
+
+I bet there have been multiple occasions where an specific Job failures go out of control (by an introduced bug, or a broken dependency, external service or whatever) and you didn't have the ability to simply stop processing jobs for that job class or postpone their execution.
+
+Sidekiq has a nice retry mechanism, but it is also too aggressive at first, every job wants to be retried very quickly, and sometimes you need to stop the job from being executed for a while.
+
+Usually, the solution was to create a new Sidekiq queue in `sidekiq.yml`, deploy the change, which would give the ability to stop it, clear it, or whatever.
+Or edit the job class to early return or avoid the error until you figure out what's going on.
+
+That can work, but it can be slow, since you need to deploy the change to your infrastructure.
+
+If you need something you can activate quickly, this Sidekiq Middleware is what you are looking for.
+
+This middleware works for both Sidekiq workers and ActiveJob jobs.
+
+## Installation
+
+`bundle add sidekiq_job_controller`
+
+In your `config/initializers/sidekiq.rb`:
+
+```ruby
+config.server_middleware do |chain|
+  chain.add SidekiqJobController::ServerMiddleware
+end
+````
+
+## Usage
+
+In brief, we are adding a Sidekiq middleware that checks if a job/worker class has to be skipped all together, or re-queued for later execution.
+
+This is useful to run in the console when a job is failing too much (or stressing the database too much), we can skip the execution or delay it for later.
+
+**Example**: There’s a bug in production that causes `SomeJob` to fail many times per minute, causing a lot of errors in your error reporting tool and/or stressing your db.
+
+You would do:
+
+```ruby
+SidekiqJobController::Controller.new(class_name: SomeJob).requeue_job!(45.minutes)
+```
+
+This will push every single `SomeJob` that Sidekiq wants to perform to be executed in 45 minutes instead of now.
+
+Then you have 45 minutes to fix and deploy the changes.
+If you take more than 45 minutes the jobs will be rescheduled for 45 more minutes, no problem.
+
+Once you fix the problem and it’s in production, **`MAKE SURE`** to return the Job to its normal state:
+
+```ruby
+SidekiqJobController::Controller.new(class_name: SomeJob).resume_job!
+```
+
+If for any reason you need or prefer to just skip (discard, drop) the jobs execution (equivalent to return nil in the `perform`’s  first line of code) you would need to run:
+
+```ruby
+SidekiqJobController::Controller.new(class_name: SomeJob).skip_job!
+```
+
+You can always check the status of a job using:
+
+```ruby
+SidekiqJobController::Controller.new(class_name: SomeJob).status
+```
+
+## 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/circleco/sidekiq_job_controller. 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/circleco/sidekiq_job_controller/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 SidekiqJobController project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/circleco/sidekiq_job_controller/blob/main/CODE_OF_CONDUCT.md).

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_job_controller/controller.rb

@@ -0,0 +1,57 @@
+module SidekiqJobController
+  class Controller
+    attr_reader :class_name, :job, :payload
+
+    def initialize(class_name:, job: nil, payload: nil)
+      @class_name = class_name
+      @job = job
+      @payload = payload
+    end
+
+    def resume_job!
+      Sidekiq.redis do |conn|
+        conn.del(job_controller_key)
+      end
+      status
+    end
+
+    def skip_job!
+      Sidekiq.redis do |conn|
+        conn.mapped_hmset(job_controller_key, { action: :skip })
+      end
+      status
+    end
+
+    def requeue_job!(seconds)
+      Sidekiq.redis do |conn|
+        conn.mapped_hmset(job_controller_key, { action: :requeue, in: seconds.to_i })
+      end
+      status
+    end
+
+    def status
+      "#{class_name} jobs are #{current_state}"
+    end
+
+    def fetch_execution_action
+      Sidekiq.redis do |conn|
+        conn.hgetall(job_controller_key)
+      end
+    end
+
+    private
+    def job_controller_key
+      "sidekiq:job_controller:#{class_name}"
+    end
+
+    def current_state
+      controller_result = fetch_execution_action
+
+      return "running" unless controller_result.present?
+      return "skipped" if controller_result["action"] == "skip"
+      return "requeued in #{controller_result["in"].to_i} seconds" if controller_result["action"] == "requeue"
+
+      "in unknown state: #{controller_result["action"]}"
+    end
+  end
+end

data/lib/sidekiq_job_controller/server_middleware.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module SidekiqJobController
+  class ServerMiddleware
+    def call(job, payload, _queue)
+      class_name = payload["wrapped"] || payload["class"]
+
+      controller_result = SidekiqJobController::Controller.new(
+        class_name: class_name, job: job, payload: payload
+      ).fetch_execution_action
+
+      if controller_result.blank?
+        yield
+      elsif controller_result["action"] == "skip"
+        log("FORCED SKIP ACTIVATED: Skipped performing job #{class_name} - #{job.jid}")
+      elsif controller_result["action"] == "requeue"
+        log("FORCED REQUEUE ACTIVATED: Requeuing job in #{controller_result["in"].to_i} seconds - #{class_name} - #{job.jid}")
+        Sidekiq::Client.push(payload.merge("at" => Time.now.to_i + controller_result["in"].to_i))
+      else
+        log("UNEXPECTED ACTION: #{controller_result["action"]} is not recognized in #{class_name} - #{job.jid}")
+        yield
+      end
+    end
+
+    private
+
+    def log(message)
+      if defined?(Rails)
+        Rails.logger.info message
+      else
+        puts message
+      end
+    end
+  end
+end

data/lib/sidekiq_job_controller/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SidekiqJobController
+  VERSION = "0.1.0"
+end

data/lib/sidekiq_job_controller.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "sidekiq"
+require "active_job"
+
+module SidekiqJobController
+end
+
+require "sidekiq_job_controller/controller"
+require "sidekiq_job_controller/server_middleware"
+

data/sidekiq_job_controller.gemspec

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative "lib/sidekiq_job_controller/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "sidekiq_job_controller"
+  spec.version = SidekiqJobController::VERSION
+  spec.authors = ["Benjamín Silva"]
+
+  spec.summary = "Sidekiq middleware to manually skip or delay Sidekiq jobs."
+  spec.description = "Sidekiq middleware that allows for immediate control over job processing in Sidekiq, providing tools to skip, delay, or modify job executions directly from the console, ideal for handling job failures or system stress without needing deployment."
+  spec.homepage = "https://github.com/circleco/sidekiq_job_controller"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/circleco/sidekiq_job_controller"
+  spec.metadata["changelog_uri"] = "https://github.com/circleco/sidekiq_job_controller/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Gem dependencies
+  spec.add_runtime_dependency "sidekiq", "~> 6.0"
+  spec.add_runtime_dependency "activejob", "~> 6.0"
+
+  # Development dependencies
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "standard"
+  spec.add_development_dependency "activesupport"
+  spec.add_development_dependency "fakeredis"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/sidekiq_job_controller.rbs

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

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq_job_controller
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Benjamín Silva
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-04-15 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'
+- !ruby/object:Gem::Dependency
+  name: activejob
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakeredis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Sidekiq middleware that allows for immediate control over job processing
+  in Sidekiq, providing tools to skip, delay, or modify job executions directly from
+  the console, ideal for handling job failures or system stress without needing deployment.
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sidekiq_job_controller.rb
+- lib/sidekiq_job_controller/controller.rb
+- lib/sidekiq_job_controller/server_middleware.rb
+- lib/sidekiq_job_controller/version.rb
+- sidekiq_job_controller.gemspec
+- sig/sidekiq_job_controller.rbs
+homepage: https://github.com/circleco/sidekiq_job_controller
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/circleco/sidekiq_job_controller
+  source_code_uri: https://github.com/circleco/sidekiq_job_controller
+  changelog_uri: https://github.com/circleco/sidekiq_job_controller/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.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Sidekiq middleware to manually skip or delay Sidekiq jobs.
+test_files: []