sidekiq-poison-pill-remedy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 605930770e6feca4c2a522fb9e4470c2d5e60e33c7ef105f6d246de851afa586
+  data.tar.gz: bb34229844977f3233a5ffc0f3a368ee59b2f1e8c917611139564d6b0fee6f5a
+SHA512:
+  metadata.gz: 31049fa306e9d54bae85bbde4b2a78f2a19ee82d9c74c5a92bae3ddf6d94b94c6e89f325e6fd7374eccdd1dcf8abe2e63635810d20c37af372bf7e6663c902b8
+  data.tar.gz: 0a5c4a97360716ffaf39287a666470cba3c58e4b910e9b720b66634fe2f9b7c9c6d380d0ce3003aadcebbf981cc723f5d52046df4af6933565475fa9c971b30a

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,115 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+inherit_mode:
+  merge:
+    - Exclude
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.1
+  Exclude:
+    - "db/**/*"
+    - "bin/**/*"
+    - "tmp/**/*"
+    - "log/**/*"
+    - "vendor/**/*"
+    - "spec/rails_helper.rb" 
+
+Layout/FrozenStringLiteralComment:
+  Enabled: true
+
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/ArrayAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/EmptyLineBetweenDefs:
+  AllowAdjacentOneLineDefs: true
+
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable
+
+Layout/FirstArgumentIndentation:
+  EnforcedStyle: consistent
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/SpaceBeforeBrackets:
+  Enabled: false
+
+
+Lint/UnusedMethodArgument:
+  AllowUnusedKeywordArguments: true
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'spec/**/*'  
+
+
+Naming/FileName:
+  EnforcedStyle: snake_case
+  Exclude:
+    - 'lib/sidekiq-poison-pill-remedy.rb' 
+
+Naming/VariableNumber:
+  EnforcedStyle: snake_case
+
+
+RSpec/MultipleExpectations:
+  Max: 20
+
+RSpec/NestedGroups:
+  Max: 10
+
+RSpec/ExampleLength:
+  Max: 15
+  Exclude:
+    - 'spec/sidekiq_poison_pill_remedy_spec.rb'
+
+RSpec/VerifiedDoubles:
+  Exclude:
+    - 'spec/**/*.rb'  
+
+
+Metrics/AbcSize:
+  Max: 15
+  Exclude:
+    - 'lib/sidekiq_poison_pill_remedy.rb' 
+  
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/BlockLength:
+  Exclude:
+    - 'lib/sidekiq_poison_pill_remedy.rb' 
+
+Layout/LineLength:
+  Max: 125
+
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  ConsistentQuotesInMultiline: true
+
+Style/Documentation:
+  Enabled: false
+
+RSpec/AnyInstance:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-10-29
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Karol Galanciak
+
+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,42 @@
+# SidekiqPoisonPillRemedy
+
+The Sidekiq Poison Pill Remedy gem enhances Sidekiq's job processing by automatically handling and rescheduling failed jobs (poison pills) with integrated logging and error tracking through Sentry, ultimately improving reliability and performance optimization.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+`gem 'sidekiq-poison-pill-remedy'`
+
+And then execute:
+
+`$ bundle install`
+
+Or install it yourself as:
+
+`$ gem install sidekiq-poison-pill-remedy`
+
+## Usage
+
+The gem is supposed to be used in the following way when added to the application
+
+Check Sidekiq super_fetch:[here](https://github.com/sidekiq/sidekiq/wiki/Reliability#using-super_fetch)
+
+Remedy is supposed to be use like:
+`config.super_fetch!(&SidekiqPoisonPillRemedy.remedy)`
+
+When a job is considered a poison pill by Sidekiq, SidekiqPoisonPillRemedy prevents it from being moved to DeadSet and moves it to a dedicated queue to make sure the job will be processed after capturing team's attention with Sentry notification
+
+## 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/BookingSync/sidekiq-poison-pill-remedy.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/sidekiq-poison-pill-remedy.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "sidekiq_poison_pill_remedy"
+require "active_support"
+require "active_support/inflector"

data/lib/sidekiq_poison_pill_remedy.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module SidekiqPoisonPillRemedy
+  def self.remedy
+    proc do |_jobstr, pill|
+      next unless pill
+
+      job = Sidekiq::DeadSet.new.find_job(pill.jid)
+
+      if job.queue == "poison_pill"
+        capture_sentry_message(
+          "#{job.klass} failed in the `#{job.queue}`, this means that it has to be urgently optimized on memory usage",
+          level: :critical,
+          job_item: job.item
+        )
+      else
+        capture_sentry_message(
+          "#{job.klass} was marked as `poison pill`, please create the job memory optimizations ticket timely",
+          level: :warning,
+          job_item: job.item
+        )
+        job.klass.constantize.set(queue: :poison_pill).perform_async(*job.args)
+        job.delete
+      end
+    end
+  end
+
+  def self.capture_sentry_message(message, level:, job_item:)
+    if defined?(Sentry)
+      Sentry.capture_message(
+        message,
+        level:,
+        extra: { job_item: }
+      )
+    end
+
+    Sidekiq.logger.fatal(message)
+  end
+end

data/lib/version.rb

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

data/sig/sidekiq/poison/pill/remedy.rbs

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

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-poison-pill-remedy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Karol Galanciak
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Enhances Sidekiq's job processing by automatically handling and rescheduling
+  poison pills
+email:
+- karol.galanciak@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sidekiq-poison-pill-remedy.rb
+- lib/sidekiq_poison_pill_remedy.rb
+- lib/version.rb
+- sig/sidekiq/poison/pill/remedy.rbs
+homepage: https://github.com/BookingSync/sidekiq-poison-pill-remedy
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/BookingSync/sidekiq-poison-pill-remedy
+  source_code_uri: https://github.com/BookingSync/sidekiq-poison-pill-remedy
+  changelog_uri: https://github.com/BookingSync/sidekiq-poison-pill-remedy/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Enhances Sidekiq's job processing by automatically handling and rescheduling
+  poison pills
+test_files: []