sidekiq-amigo 1.13.0 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70bb0febcaf8c1a36e19fc4dd56fb766be4fa046c941b1f2aa66b7dcf5372872
-  data.tar.gz: 620b2c3a6bf664931eb8a6e84cc7d8762597f4aae91aa17765bc1d1fb0b432ad
+  metadata.gz: 07551fc97532f4e4e819cb1f027b406df1c3144e98984cde26e90893420cf8fa
+  data.tar.gz: 67f0eb863e5d471897bc5c418c6ce8bdc4d118b54a6e135b32a97806159b91e6
 SHA512:
-  metadata.gz: 20bcdab3b140069cd0eeb6a559032e8e4d986ffdc6bdd7ed03030a45b5b83a50600bb7d465736a0a7dcdd2e369a2a054bb2f968a77111ec5cef807876d19d8f0
-  data.tar.gz: ddbb6ac910db1687c6e5f471f965d2b5f2dc78b650564f28c24153e8ce1d1d7b350f03da4b0571673084865ac8c9c5f9a27453e090ad94f6b12f9507649dde6d
+  metadata.gz: 2a8dfd02d648d865945e4491594c591c6304b015e1c7bcf51274c1126e4a7566ae9e9fab9a958b378a78d286d2889d84248396b497efa7502f68dd80b27ac5cd
+  data.tar.gz: 4a5391e68c465616da4cc95baaee0cbd676188a0ab62275ce4fcdd691260be10c0bdd7718fca26e72ef59f8c9657031341572ab3b141fc4f792240edac004de2

data/lib/amigo/retry.rb

@@ -59,6 +59,14 @@ module Amigo
     # Raise this class, or a subclass of it, to:
     # - Use +Retry+ exception semantics while the current attempt is <= +attempts+, or
     # - Use +Die+ exception semantics if the current attempt is > +attempts+.
+    #
+    # Callers can provide a subclass with two methods that are looked for:
+    #
+    # If on_retry is defined, it is called with (worker instance, job hash).
+    # If on_retry returns +:skip+, do NOT retry (do not send to the retry set).
+    #
+    # If on_die is defined, it is called with (worker instance, job hash).
+    # If on_die returns +:skip+, do NOT send to the dead set.
     class OrDie < Error
       attr_reader :attempts, :interval_or_timestamp, :wrapped
 
@@ -99,13 +107,27 @@ module Amigo
       end
 
       def handle_retry(worker, job, e)
+        if e.respond_to?(:on_retry)
+          callback_result = e.on_retry(worker, job)
+          if callback_result == :skip
+            Sidekiq.logger.warn("skipping_retryset_schedule")
+            return
+          end
+        end
         Sidekiq.logger.info("scheduling_retry")
         job["error_class"] = e.class.to_s
         job["error_message"] = e.to_s
         self.amigo_retry_in(worker.class, job, e.interval_or_timestamp)
       end
 
-      def handle_die(_worker, job, e)
+      def handle_die(worker, job, e)
+        if e.respond_to?(:on_die)
+          callback_result = e.on_die(worker, job)
+          if callback_result == :skip
+            Sidekiq.logger.warn("skipping_deadset_send")
+            return
+          end
+        end
         Sidekiq.logger.warn("sending_to_deadset")
         job["error_class"] = e.class.to_s
         job["error_message"] = e.to_s

data/lib/amigo/spec_helpers.rb

@@ -72,7 +72,7 @@ module Amigo
         true
       end
 
-      def matches?(given_proc)
+      def matches?(given_proc, negative_expectation=false)
         unless given_proc.respond_to?(:call)
           warn "publish matcher used with non-proc object #{given_proc.inspect}"
           return false
@@ -88,24 +88,41 @@ module Amigo
           given_proc.call
         end
 
-        self.match_expected_events
+        self.match_expected_events(negative_expectation)
 
         return @error.nil? && @missing.empty?
       end
 
+      # rubocop:disable Naming/PredicatePrefix
+      def does_not_match?(given_proc)
+        !matches?(given_proc, true)
+      end
+      # rubocop:enable Naming/PredicatePrefix
+
       def on_publish_error(err)
         @error = err
       end
 
-      def match_expected_events
+      def match_expected_events(negative_expectation)
         @expected_events.each do |expected_event, expected_payload|
+          if expected_event.nil? && !negative_expectation
+            RSpec::Expectations.configuration.false_positives_handler.call(
+              "Using the `publish` matcher without providing a specific " \
+              "event name risks false positives, since `publish` " \
+              "will match any event. Instead, provide the name " \
+              "of the event you are matching against."\
+              "This message can be suppressed by setting: " \
+              "`RSpec::Expectations.configuration.on_potential_false" \
+              "_positives = :nothing`",
+            )
+          end
           match = @recorded_events.find do |recorded|
             self.event_names_match?(expected_event, recorded.name) &&
               self.payloads_match?(expected_payload, recorded.payload)
           end
 
           if match
-            self.add_matched(expected_event, expected_payload)
+            self.add_matched(expected_event, expected_payload, match)
           else
             self.add_missing(expected_event, expected_payload)
           end
@@ -113,6 +130,7 @@ module Amigo
       end
 
       def event_names_match?(expected, actual)
+        return true if expected.nil?
         return expected.matches?(actual) if expected.respond_to?(:matches?)
         return expected.match?(actual) if expected.respond_to?(:match?)
         return expected == actual
@@ -123,8 +141,8 @@ module Amigo
         return expected.nil? || expected.empty? || expected == actual
       end
 
-      def add_matched(event, payload)
-        @matched << [event, payload]
+      def add_matched(topic, payload, event)
+        @matched << [topic, payload, event]
       end
 
       def add_missing(event, payload)
@@ -156,10 +174,12 @@ module Amigo
 
       def failure_message_when_negated
         messages = []
-        @matched.each do |event, _payload|
-          message = "expected a '%s' event not to be fired" % [event]
-          message << (" with a payload of %p" % [@expected_payload]) if @expected_payload
-          message << " but one was."
+        @matched.each do |topic, payload, event|
+          message = "expected a '#{topic || event.name}' event not to be fired"
+          message << " with a payload of #{payload.inspect}" if payload
+          message << " but one was"
+          event.payload.any? && message << ": #{event.payload.inspect}"
+          message << "."
           messages << message
         end
 

data/lib/amigo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Amigo
-  VERSION = "1.13.0"
+  VERSION = "1.14.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-amigo
 version: !ruby/object:Gem::Version
-  version: 1.13.0
+  version: 1.14.0
 platform: ruby
 authors:
 - Lithic Technology