sidekiq-amigo 1.6.2 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5224634ebf95a2fcaefc764d07114cc77b2feed22a15e736eec934d8eba84b0
-  data.tar.gz: 2e49a507f4e6d47e7ce25b676293738591807bc47dadf47e1fdbcb634d5a9df5
+  metadata.gz: a32299bc84d87b6c497414b4fcb6b89278e2993543eff1ba07bcf1a9fb75c59f
+  data.tar.gz: 27acf41f1e0235536da93d7dfd0b2a5ad1f65e4e993f428967e8072e7213f83f
 SHA512:
-  metadata.gz: fa9617859526003317496d860e07119a11e8d0d58e66382360078a74463760b78da8516d215a0922fd40ee5bcc4d5e35421be2aa393df1f0a0709c941c367560
-  data.tar.gz: 99876ed52f35b972bdc1a68a507c29b87f6a0aa5db6c2ae7738e203da8c66cb5dd01a4c2489fd4a923f117e84af308ea121f2be40ea95e5a3426485da114f216
+  metadata.gz: 47e75ba71d67411a80e7d5ae20f06c0b3bb4e0fb056356e63fb47ec3cd84cdb72f0deb6e2bd00f5cc0cd091267dc30725e4607ae018b7f29a31093c4c9e82ebd
+  data.tar.gz: 761f7febdba270fe365f39cb740f734615118bd8c160485ac9296119f00124458f1970e159dbdd0ed8a6fbecd4c66df8bfe07f86803a14e2982e738fbe69115c

data/lib/amigo/retry.rb

@@ -17,18 +17,29 @@ require "sidekiq/api"
 #   end
 module Amigo
   module Retry
-    class Error < StandardError; end
+    class Error < StandardError
+      protected def exc_or_msg(timing_msg, obj)
+        return timing_msg if obj.nil?
+        return obj.to_s unless obj.is_a?(Exception)
+        return "#{timing_msg} (#{obj.class}: #{obj.message})"
+      end
+
+      protected def exc?(ex)
+        return ex.is_a?(Exception) ? ex : nil
+      end
+    end
 
     # Raise this class, or a subclass of it, to schedule a later retry,
     # rather than using an error to trigger Sidekiq's default retry behavior.
     # The benefit here is that it allows a consistent, customizable behavior,
     # so is better for 'expected' errors like rate limiting.
     class Retry < Error
-      attr_accessor :interval_or_timestamp
+      attr_accessor :interval_or_timestamp, :wrapped
 
       def initialize(interval_or_timestamp, msg=nil)
         @interval_or_timestamp = interval_or_timestamp
-        super(msg || "retry job in #{interval_or_timestamp}")
+        @wrapped = exc?(msg)
+        super(exc_or_msg("retry job in #{interval_or_timestamp.to_i}s", msg))
       end
     end
 
@@ -37,18 +48,25 @@ module Amigo
     # This allows jobs to hard-fail when there is something like a total outage,
     # rather than retrying.
     class Die < Error
+      attr_accessor :wrapped
+
+      def initialize(msg=nil)
+        @wrapped = exc?(msg)
+        super(exc_or_msg("kill job", msg))
+      end
     end
 
     # 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+.
     class OrDie < Error
-      attr_reader :attempts, :interval_or_timestamp
+      attr_reader :attempts, :interval_or_timestamp, :wrapped
 
       def initialize(attempts, interval_or_timestamp, msg=nil)
+        @wrapped = exc?(msg)
         @attempts = attempts
         @interval_or_timestamp = interval_or_timestamp
-        super(msg || "retry every #{interval_or_timestamp} up to #{attempts} times")
+        super(exc_or_msg("retry every #{interval_or_timestamp.to_i}s up to #{attempts} times", msg))
       end
     end
 
@@ -56,6 +74,12 @@ module Amigo
     # from deep in a job and they want to jump out of the whole thing.
     # Usually you should log before raising this!
     class Quit < Error
+      attr_accessor :wrapped
+
+      def initialize(msg=nil)
+        @wrapped = exc?(msg)
+        super(exc_or_msg("quit job", msg))
+      end
     end
 
     class ServerMiddleware

data/lib/amigo/spec_helpers.rb

@@ -101,7 +101,8 @@ module Amigo
       def match_expected_events
         @expected_events.each do |expected_event, expected_payload|
           match = @recorded_events.find do |recorded|
-            recorded.name == expected_event && self.payloads_match?(expected_payload, recorded.payload)
+            self.event_names_match?(expected_event, recorded.name) &&
+              self.payloads_match?(expected_payload, recorded.payload)
           end
 
           if match
@@ -112,9 +113,15 @@ module Amigo
         end
       end
 
-      def payloads_match?(expected, recorded)
-        return expected.matches?(recorded) if expected.respond_to?(:matches?)
-        return expected.nil? || expected.empty? || expected == recorded
+      def event_names_match?(expected, actual)
+        return expected.matches?(actual) if expected.respond_to?(:matches?)
+        return expected.match?(actual) if expected.respond_to?(:match?)
+        return expected == actual
+      end
+
+      def payloads_match?(expected, actual)
+        return expected.matches?(actual) if expected.respond_to?(:matches?)
+        return expected.nil? || expected.empty? || expected == actual
       end
 
       def add_matched(event, payload)

data/lib/amigo/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-amigo
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.8.0
 platform: ruby
 authors:
 - Lithic Technology
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-16 00:00:00.000000000 Z
+date: 2024-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -200,7 +200,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="