sidekiq-amigo 1.7.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cf72dfd7e1bbcc7217536a2344ce5ecdec41c0ae8769b44ec91b210b9a41d0b
-  data.tar.gz: 19f5fd437e47f5f2dc706877289f05fd7ee0d50426d4de42ac2bbdc304f9d882
+  metadata.gz: 330ead7f8face652362d632c9c127aa57b298d5587d1da392769b0458d1f8915
+  data.tar.gz: 7c0b0b9b1658eecfd202ef294580417233421edf4233eef522b747ce9c411f52
 SHA512:
-  metadata.gz: 970fa43283e3361af6b7caa12241ad1848426af476d0023a38148d435dbb07b7eabe31a79c2e0c23bce380097e1c5f9282eb16ef16a6e6372e6185fa1243744b
-  data.tar.gz: 7e421c9750235136306e8ae9010101d2611c4e8cf54a0cf8192407adba26e160ec17247db045d1e6c9c85c89cc67a383379bc625f01c88f81da683ca338ce860
+  metadata.gz: 898c24b82de6313c33e50b58a2c4d64ca365918a0aee2b223b452fea9428cc4d265b15975ebc2f7c7e689f547898e65b7c52d3e50edbe9bcdb062f3b25f3f0b6
+  data.tar.gz: a5ffcb482859fcddd6727a9869bef3ed00c8edb5b1b44f0cde84b31eddb44c6f84fbac6b45d8b8fccf06c712f6792a8ce3e211b4a49083fe8c0bab76474a5d38

data/lib/amigo/autoscaler/heroku.rb

@@ -81,7 +81,6 @@ module Amigo
         app_id_or_app_name: ENV.fetch("HEROKU_APP_NAME"),
         formation_id_or_formation_type: "worker"
       )
-
         @heroku = heroku
         @max_additional_workers = max_additional_workers
         @app_id_or_app_name = app_id_or_app_name

data/lib/amigo/autoscaler.rb

@@ -92,6 +92,13 @@ module Amigo
     # Proc/callable called with (level, message, params={}).
     # By default, use +Amigo.log+ (which logs to the Sidekiq logger).
     attr_reader :log
+    # Proc called with an exception that occurs while the thread is running.
+    # If the handler returns +true+, then the thread will keep going.
+    # All other values will kill the thread, which breaks autoscaling.
+    # Note that Amigo automatically logs unhandled exceptions at :error level.
+    # If you use an error reporter like Sentry, you can pass in something like:
+    #   -> (e) { Sentry.capture_exception(e) }
+    attr_reader :on_unhandled_exception
 
     def initialize(
       poll_interval: 20,
@@ -101,9 +108,9 @@ module Amigo
       alert_interval: 120,
       latency_restored_threshold: latency_threshold,
       latency_restored_handlers: [:log],
-      log: ->(level, message, params={}) { Amigo.log(nil, level, message, params) }
+      log: ->(level, message, params={}) { Amigo.log(nil, level, message, params) },
+      on_unhandled_exception: nil
     )
-
       raise ArgumentError, "latency_threshold must be > 0" if
         latency_threshold <= 0
       raise ArgumentError, "latency_restored_threshold must be >= 0" if
@@ -118,8 +125,10 @@ module Amigo
       @latency_restored_threshold = latency_restored_threshold
       @latency_restored_handlers = latency_restored_handlers.freeze
       @log = log
+      @on_unhandled_exception = on_unhandled_exception
     end
 
+    # @return [Thread]
     def polling_thread
       return @polling_thread
     end
@@ -189,6 +198,14 @@ module Amigo
     end
 
     def check
+      self._check
+    rescue StandardError => e
+      self._log(:error, "async_autoscaler_unhandled_error", exception: e)
+      handled = self.on_unhandled_exception&.call(e)
+      raise e unless handled.eql?(true)
+    end
+
+    def _check
       now = Time.now
       skip_check = now < (@last_alerted + self.alert_interval)
       if skip_check

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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-amigo
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Lithic Technology
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-12 00:00:00.000000000 Z
+date: 2025-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq