sidekiq-silent-retry 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f673b762a982f01dabfede33d32ee8c6fb8522fd756d241c3e316d8a83f8a616
+  data.tar.gz: a1ffe3dcb79d7f17c3565da923d22e481c05eb80d111c86708b4d12c572efc1c
+SHA512:
+  metadata.gz: d8dc657046bdce2d80ebe93ef862157f04c837f621dc3f199fc1bcb6be917b58a9106fe2cecc148edaaa15d873f1c8cb89b12c2c6a7f6210298edb75717aa8dd
+  data.tar.gz: c0d360133302af73f4eab53572cfc3eaf31a2e4a9f987c35eaf3360970f76b0cdb28f7f68c6dad1f4b2302d04bdb63d5921d86d4c719f83bd444f4a12e4d7ead

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## [0.3.0] - 2024-10-28
+
+- Fix: error when retry_count is 0
+- Change: Support push to Rubygems
+
+## [0.1.0] - 2024-07-02
+
+- 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) 2024 Trusted Health
+
+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,83 @@
+# Sidekiq::SilentRetry
+
+[![Ruby](https://github.com/trusted/sidekiq-silent-retry/actions/workflows/main.yml/badge.svg)](https://github.com/trusted/sidekiq-silent-retry/actions/workflows/main.yml)
+
+`sidekiq-silent-retry` is a middleware for Sidekiq that allows for silent retries of jobs. This gem intercepts exceptions raised during job execution and re-raises under a different exception class, so that tracing services can ignore them. Only the last exception is raised with the original exception.
+
+## Instalation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq-silent-retry'
+```
+
+And then execute:
+
+```shell
+$ bundle install
+```
+
+## Usage
+
+### Configuration
+
+#### 1. Specify the error class for Silent Retry (optional)
+
+You can specify a custom error class for silent retries. This is useful for making error tracing services ignore these errors.
+
+Create an initializer file (e.g., config/initializers/sidekiq_silent_retry.rb) and add the following:
+
+```ruby
+Sidekiq::SilentRetry.silent_retry_error_class = MySilentRetryError
+```
+
+#### 2. Mark jobs for Silent Retry
+
+In your Sidekiq job class, configure the silent_retry option to control silent retries. The silent_retry option can be:
+
+- `false` / `nil`: Disabled (default).
+- `true`: Always enabled, no matter the error.
+- Some class / Array of classes: Only exceptions of said class(es) will be silently retried.
+
+You can also set `warn_after` option to start raise warnings after a number of retries instead of only the last one.
+
+```ruby
+class MyJob
+  include Sidekiq::Job
+
+  sidekiq_options silent_retry: true
+
+  def perform(*args)
+    # Your job logic here
+  end
+end
+
+class MyJob
+  include Sidekiq::Job
+
+  sidekiq_options silent_retry: [CommonError, CommonError2], warn_after: 2
+
+  def perform(*args)
+    # Your job logic here
+  end
+end
+```
+
+
+## Dependencies
+
+- [Sidekiq](https://github.com/mperham/sidekiq) 6.0 or later
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/trusted/sidekiq-silent-retry. 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/trusted/sidekiq-silent-retry/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::SilentRetry project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/trusted/sidekiq-silent-retry/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/lib/sidekiq/silent/retry.rb

@@ -0,0 +1 @@
+require_relative '../silent_retry'

data/lib/sidekiq/silent_retry/server_middleware.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Sidekiq
+  module SilentRetry
+    class ServerMiddleware
+      include Sidekiq::ServerMiddleware
+
+      def call(_job_instance, job_payload, _queue)
+        yield
+      rescue StandardError => e
+        raise e unless silent_retry_enabled?(job_payload, e)
+        raise e if should_warn?(job_payload)
+
+        raise Sidekiq::SilentRetry.silent_retry_error_class, e.message
+      end
+
+      private
+
+      def should_warn?(job_payload)
+        (job_payload["retry_count"] || 0) >= warn_after(job_payload)
+      end
+
+      def warn_after(job_payload)
+        job_payload["warn_after"]&.to_i || job_payload["retry"] - 1
+      end
+
+      def silent_retry_enabled?(job_payload, error)
+        option = job_payload["silent_retry"]
+
+        case option
+        when TrueClass, FalseClass
+          option
+        when Class
+          error.is_a?(option)
+        when String
+          error.is_a?(Kernel.const_get(option))
+        when Array
+          option.any? { |klass| error.is_a?(Kernel.const_get(klass)) }
+        else
+          false
+        end
+      end
+    end
+  end
+end
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.prepend Sidekiq::SilentRetry::ServerMiddleware
+  end
+end

data/lib/sidekiq/silent_retry/version.rb

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

data/lib/sidekiq/silent_retry.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'sidekiq'
+
+require_relative "silent_retry/version"
+require_relative "silent_retry/server_middleware"
+
+module Sidekiq
+  module SilentRetry
+    class SilentError < StandardError; end
+
+    def self.silent_retry_error_class
+      @silent_retry_error_class ||= SilentError
+    end
+
+    def self.silent_retry_error_class=(error_class)
+      @silent_retry_error_class = error_class
+    end
+  end
+end

data/sig/sidekiq/silent_retry/server_middleware.rbs

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Sidekiq
+  module SilentRetry
+    class ServerMiddleware
+      def call: (job_instance: untyped, job_payload: Hash[String, untyped], queue: String) -> void
+    end
+  end
+end

data/sig/sidekiq/silent_retry.rbs

@@ -0,0 +1,12 @@
+module Sidekiq
+  module SilentRetry
+    SilentError: Exception
+    VERSION: String
+
+    @silent_retry_error_class: Exception
+
+    def self.silent_retry_error_class: -> Exception
+
+    def self.silent_retry_error_class=: (error_class: Exception) -> void
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-silent-retry
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Gustavo Diel
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-10-28 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: |
+  This gems silences all of Sidekiq exceptions in retryable jobs, except the last one.
+  Specially useful when you know you job is most likely going to fail often (scrapers, api calls, etc)
+email:
+- gustavo.diel@trustedhealth.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sidekiq/silent/retry.rb
+- lib/sidekiq/silent_retry.rb
+- lib/sidekiq/silent_retry/server_middleware.rb
+- lib/sidekiq/silent_retry/version.rb
+- sig/sidekiq/silent_retry.rbs
+- sig/sidekiq/silent_retry/server_middleware.rbs
+homepage: https://github.com/trusted/sidekiq-silent-retry
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/trusted/sidekiq-silent-retry
+  changelog_uri: https://github.com/trusted/sidekiq-silent-retry/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.5.3
+signing_key:
+specification_version: 4
+summary: Silence all but last retry in Sidekiq jobs.
+test_files: []