sidekiq-rescue 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8bcb824ca2945f9cf090e5cb6adfd0a4bc77366461c068915008e5ea953db31
-  data.tar.gz: 97011a0a37cefea2f6500e7d96147b50059aa46289112de6ce09a5aa9773f963
+  metadata.gz: d1a8899e388b21924f60017c1eb3b724bc129bec25c96f4765a37ab1f1d8e7fb
+  data.tar.gz: 41c934da18716cf917af164e92ce1bccdcab1a5bbce08df1c4cbf6550d5cfe70
 SHA512:
-  metadata.gz: 1f192b50d1b21265ef6902ce095129c0287df13c6684fc4eeaa125a70bdfe722aec40a2d7cc74dd1bbbf937bdeca436e3870ebe00ef1d3b7d818433df6efda08
-  data.tar.gz: 79a2a91abcdb591ed762084676ec58732dfb4ce797fbd7335b42b8497933b1e383ec126ed64b16e5dabd5b7925d8c1b7bf0e931cd7cc71b90051bb6a23a0d045
+  metadata.gz: a644feb9b9c4d3e1eef97d24738b1157c7efc370102d3db19db3df23f2133382878a264818b5a9a99059e1f64e9b60cbe8e4ea8b297757a760e00fb1df71865b
+  data.tar.gz: 678d83f42a1ffff8dd71def36911fcdc42b7cf2186e053e47b02c9d4237ea51efc2bd10ed003c7909ec830006b3e725b5e64253faca3c0d4555d97a8536be114

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.2.1] - 2024-02-27
+
+- Fix readme with correct middleware name
+- Add RSpec matchers
+
 ## [0.2.0] - 2024-02-03
 
 - Rename `Sidekiq::Rescue::DSL` to `Sidekiq::Rescue::Dsl`
@@ -15,6 +20,7 @@
 - Add documentation
 - Add CI
 
-[Unreleased]: https://github.com/moofkit/sidekiq-rescue/compare/v0.2.0...HEAD
+[Unreleased]: https://github.com/moofkit/sidekiq-rescue/compare/v0.2.1...HEAD
+[0.2.1]: https://github.com/moofkit/sidekiq-rescue/releases/tag/v0.2.1
 [0.2.0]: https://github.com/moofkit/sidekiq-rescue/releases/tag/v0.2.0
 [0.1.0]: https://github.com/moofkit/sidekiq-rescue/releases/tag/v0.1.0

data/README.md

@@ -27,7 +27,7 @@ Or install it yourself as:
 ```ruby
 Sidekiq.configure_server do |config|
   config.server_middleware do |chain|
-    chain.add Sidekiq::Rescue::Middleware
+    chain.add Sidekiq::Rescue::ServerMiddleware
   end
 end
 ```
@@ -93,6 +93,68 @@ Sidekiq::Rescue.configure do |config|
 end
 ```
 
+### Testing
+
+1. Unit tests (recommended)
+
+In case you want to test the rescue configuration, this gem provides RSpec matchers:
+
+```ruby
+RSpec.cofigure do |config|
+  config.include Sidekiq::Rescue::RSpec::Matchers, type: :job
+end
+
+RSpec.describe MyJob do
+  it "rescues from expected errors" do
+    expect(MyJob).to have_sidekiq_rescue(ExpectedError)
+  end
+end
+```
+
+It also provides a way to test the delay and limit:
+
+```ruby
+RSpec.describe MyJob do
+  it "rescues from expected errors with custom delay and limit" do
+    expect(MyJob).to have_sidekiq_rescue(ExpectedError).with_delay(60).with_limit(5)
+  end
+end
+```
+
+2. Integration tests with `Sidekiq::Testing`
+Firstly, you need to configure `Sidekiq::Testing` to use `Sidekiq::Rescue::ServerMiddleware` middleware:
+
+```ruby
+# spec/spec_helper.rb or spec/rails_helper.rb
+require "sidekiq/testing"
+
+RSpec.configure do |config|
+  config.before(:all) do
+    Sidekiq::Testing.fake!
+
+    Sidekiq::Testing.server_middleware do |chain|
+      chain.add Sidekiq::Rescue::ServerMiddleware
+    end
+  end
+end
+```
+
+And test the job with the next snippet
+
+```ruby
+# spec/jobs/my_job_spec.rb
+RSpec.describe MyJob do
+  before do
+    allow(ApiClient).to receive(:new).and_raise(ApiClient::SomethingWentWrongError)
+  end
+
+  it "retries job if it fails with ExpectedError" do
+    MyJob.perform_async('test')
+    expect { MyJob.perform_one }.not_to raise_error # pefrom_one is a method from Sidekiq::Testing that runs the job once
+  end
+end
+```
+
 ## Use cases
 
 Sidekiq::Rescue is useful when you want to retry jobs that failed due to expected errors and not spam your exception tracker with these errors. For example, you may want to retry a job that failed due to a network error or a temporary outage of a third party service, rather than a bug in your code.

data/lib/sidekiq/rescue/rspec/matchers.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+return unless defined?(RSpec)
+
+require "rspec/matchers"
+
+module Sidekiq
+  module Rescue
+    module RSpec
+      # RSpec matchers for Sidekiq::Rescue
+      module Matchers
+        ::RSpec::Matchers.define :have_sidekiq_rescue do |expected| # rubocop:disable Metrics/BlockLength
+          description { "be rescueable with #{expected}" }
+          failure_message do |actual|
+            str = "expected #{actual} to be rescueable with #{expected}"
+            str += " and delay #{@delay}" if @delay
+            str += " and limit #{@limit}" if @limit
+            str
+          end
+          failure_message_when_negated { |actual| "expected #{actual} not to be rescueable with #{expected}" }
+
+          chain :with_delay do |delay|
+            @delay = delay
+          end
+
+          chain :with_limit do |limit|
+            @limit = limit
+          end
+
+          match do |actual|
+            actual.is_a?(Class) &&
+              actual.include?(Sidekiq::Rescue::Dsl) &&
+              actual.sidekiq_rescue_options[:error].include?(expected) &&
+              (@delay.nil? || actual.sidekiq_rescue_options[:delay] == @delay) &&
+              (@limit.nil? || actual.sidekiq_rescue_options[:limit] == @limit)
+          end
+
+          match_when_negated do |actual|
+            raise NotImplementedError, "it's confusing to use `not_to be_rescueable` with `with_delay`" if @delay
+            raise NotImplementedError, "it's confusing to use `not_to be_rescueable` with `with_limit`" if @limit
+
+            actual.is_a?(Class) &&
+              actual.include?(Sidekiq::Rescue::Dsl) &&
+              !actual.sidekiq_rescue_options[:error].include?(expected)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/rescue/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module Rescue
-    VERSION = "0.2.0"
+    VERSION = "0.2.1"
   end
 end

data/lib/sidekiq_rescue.rb

@@ -7,3 +7,4 @@ require_relative "sidekiq/rescue"
 require_relative "sidekiq/rescue/version"
 require_relative "sidekiq/rescue/dsl"
 require_relative "sidekiq/rescue/server_middleware"
+require_relative "sidekiq/rescue/rspec/matchers"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-rescue
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Dmitrii Ivliev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-03 00:00:00.000000000 Z
+date: 2024-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -39,6 +39,7 @@ files:
 - lib/sidekiq/rescue.rb
 - lib/sidekiq/rescue/config.rb
 - lib/sidekiq/rescue/dsl.rb
+- lib/sidekiq/rescue/rspec/matchers.rb
 - lib/sidekiq/rescue/server_middleware.rb
 - lib/sidekiq/rescue/version.rb
 - lib/sidekiq_rescue.rb
@@ -49,7 +50,7 @@ metadata:
   homepage_uri: https://github.com/moofkit/sidekiq-rescue
   source_code_uri: https://github.com/moofkit/sidekiq-rescue
   changelog_uri: https://github.com/moofkit/sidekiq-rescue/blob/master/CHANGELOG.md
-  documentation_uri: https://rubydoc.info/gems/sidekiq-rescue/0.2.0
+  documentation_uri: https://rubydoc.info/gems/sidekiq-rescue/0.2.1
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []