sidekiq-throttled 1.5.0 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d5819912372e26634558752740bc154c4d22899b42925740b86152433744740
-  data.tar.gz: dadcea04012b95e0349728c573a3253d86bae7920ee5844b1df9fb80933c2267
+  metadata.gz: 07f60ab84ab53725f6189d8a142ccb7d5596ea408a5d52087e2665420c92a276
+  data.tar.gz: 489d3d9a5a72dc20af8295d6942d4abdc9a27dfffdf917b753a08af78184d59e
 SHA512:
-  metadata.gz: cf81c1a319d6f4af5c5a06f5df95dd99ad44a405f152cfda5b4c6123d4692b93d23137ab12422d6b83c82090dc422b15b441f34ed43dc1868933d54354c1326d
-  data.tar.gz: f72803ff9a84bb3cc729869dc1105dcc9f9581c7c4c59eb2bb8a28594a7fe0df49e9b064dbae2c1f46020790637769196f98b5b38a0f77f2cb858f1b6d928679
+  metadata.gz: bac5ad071e0de8913f80f8c78cec87ee98c61da77a48c46000ba3680f0eeb684b2970c69d256b61cf5d1b680121f2762a0ae3c9220729ee25140ba6cbf3f9598
+  data.tar.gz: 92d08e2c0f76716816385b24df2c06092fa416ceb22714657967e2e312fe04357000db45fc18ee4f99d5eab57b6c267d93556a8064cb704478590b457ec48f2f

data/README.adoc

@@ -262,6 +262,33 @@ IMPORTANT: Don't forget to specify `:key_suffix` and make it return different
   values if you are using dynamic limit/period options. Otherwise, you risk
   getting into some trouble.
 
+[source,ruby]
+----
+class MyJob
+  include Sidekiq::Job
+  include Sidekiq::Throttled::Job
+
+  sidekiq_options queue: :my_queue
+
+  sidekiq_throttle(
+    concurrency: { limit: 10 },
+    # Allow 500 jobs per minute, 5,000 per hour, and 50,000 per day:
+    threshold: [
+      { limit: 500, period: 1.minute, key_suffix: "minutely" },
+      { limit: 5_000, period: 1.hour, key_suffix: "hourly" },
+      { limit: 50_000, period: 1.day, key_suffix: "daily" },
+    ]
+  )
+
+  def perform(project_id, user_id)
+    # ...
+  end
+end
+----
+
+NOTE: `key_suffix` does not have to be a proc/lambda, it can just be a
+  string value. This can come in handy to set throttle limits for different
+  ranges of time
 
 === Concurrency throttling fine-tuning
 

data/lib/sidekiq/throttled/job.rb

@@ -24,8 +24,6 @@ module Sidekiq
     #
     # @see ClassMethods
     module Job
-      VALID_VALUES_FOR_REQUEUE_WITH = %i[enqueue schedule].freeze
-
       # Extends worker class with {ClassMethods}.
       #
       # @note Using `included` hook with extending worker with {ClassMethods}
@@ -91,13 +89,6 @@ module Sidekiq
         # @see Registry.add
         # @return [void]
         def sidekiq_throttle(**kwargs)
-          requeue_options = Throttled.config.default_requeue_options.merge(kwargs.delete(:requeue) || {})
-          unless VALID_VALUES_FOR_REQUEUE_WITH.include?(requeue_options[:with])
-            raise ArgumentError, "requeue: #{requeue_options[:with]} is not a valid value for :with"
-          end
-
-          self.sidekiq_throttled_requeue_options = requeue_options
-
           Registry.add(self, **kwargs)
         end
 

data/lib/sidekiq/throttled/strategy.rb

@@ -11,7 +11,11 @@ module Sidekiq
     # Meta-strategy that couples {Concurrency} and {Threshold} strategies.
     #
     # @private
-    class Strategy
+    class Strategy # rubocop:disable Metrics/ClassLength
+      # :enqueue means put the job back at the end of the queue immediately
+      # :schedule means schedule enqueueing the job for a later time when we expect to have capacity
+      VALID_VALUES_FOR_REQUEUE_WITH = %i[enqueue schedule].freeze
+
       # @!attribute [r] concurrency
       #   @return [Strategy::Concurrency, nil]
       attr_reader :concurrency
@@ -24,6 +28,10 @@ module Sidekiq
       #   @return [Proc, nil]
       attr_reader :observer
 
+      # @!attribute [r] requeue_options
+      #   @return [Hash, nil]
+      attr_reader :requeue_options
+
       # @param [#to_s] name
       # @param [Hash] concurrency Concurrency options.
       #   See keyword args of {Strategy::Concurrency#initialize} for details.
@@ -31,7 +39,8 @@ module Sidekiq
       #   See keyword args of {Strategy::Threshold#initialize} for details.
       # @param [#call] key_suffix Dynamic key suffix generator.
       # @param [#call] observer Process called after throttled.
-      def initialize(name, concurrency: nil, threshold: nil, key_suffix: nil, observer: nil)
+      # @param [#call] requeue What to do with jobs that are throttled.
+      def initialize(name, concurrency: nil, threshold: nil, key_suffix: nil, observer: nil, requeue: nil) # rubocop:disable Metrics/MethodLength, Metrics/ParameterLists
         @observer = observer
 
         @concurrency = StrategyCollection.new(concurrency,
@@ -44,7 +53,9 @@ module Sidekiq
           name:       name,
           key_suffix: key_suffix)
 
-        raise ArgumentError, "Neither :concurrency nor :threshold given" unless @concurrency.any? || @threshold.any?
+        @requeue_options = Throttled.config.default_requeue_options.merge(requeue || {})
+
+        validate!
       end
 
       # @return [Boolean] whenever strategy has dynamic config
@@ -72,26 +83,30 @@ module Sidekiq
         false
       end
 
-      # Return throttled job to be executed later. Implementation depends on the value of `with`:
-      # :enqueue means put the job back at the end of the queue immediately
-      # :schedule means schedule enqueueing the job for a later time when we expect to have capacity
-      #
-      # @param [#to_s, #call] with How to handle the throttled job
-      # @param [#to_s, #call] to Name of the queue to re-queue the job to.
-      #                          If not specified, will use the job's original queue.
+      # @return [Proc, Symbol] How to requeue the throttled job
+      def requeue_with
+        requeue_options[:with]
+      end
+
+      # @return [String, nil] Name of the queue to re-queue the job to.
+      def requeue_to
+        requeue_options[:to]
+      end
+
+      # Return throttled job to be executed later. Implementation depends on the strategy's `requeue` options.
       # @return [void]
-      def requeue_throttled(work, with:, to: nil) # rubocop:disable Metrics/MethodLength
-        # Resolve :with and :to arguments, calling them if they are Procs
+      def requeue_throttled(work) # rubocop:disable Metrics/MethodLength
+        # Resolve :with and :to options, calling them if they are Procs
         job_args = JSON.parse(work.job)["args"]
-        requeue_with = with.respond_to?(:call) ? with.call(*job_args) : with
-        target_queue = calc_target_queue(work, to)
+        with = requeue_with.respond_to?(:call) ? requeue_with.call(*job_args) : requeue_with
+        target_queue = calc_target_queue(work)
 
-        case requeue_with
+        case with
         when :enqueue
           re_enqueue_throttled(work, target_queue)
         when :schedule
           # Find out when we will next be able to execute this job, and reschedule for then.
-          reschedule_throttled(work, requeue_to: target_queue)
+          reschedule_throttled(work, target_queue)
         else
           raise "unrecognized :with option #{with}"
         end
@@ -112,49 +127,65 @@ module Sidekiq
 
       private
 
-      def calc_target_queue(work, to) # rubocop:disable Metrics/MethodLength
-        target = case to
+      def validate!
+        unless VALID_VALUES_FOR_REQUEUE_WITH.include?(@requeue_options[:with]) ||
+               @requeue_options[:with].respond_to?(:call)
+          raise ArgumentError, "requeue: #{@requeue_options[:with]} is not a valid value for :with"
+        end
+
+        raise ArgumentError, "Neither :concurrency nor :threshold given" unless @concurrency.any? || @threshold.any?
+      end
+
+      def calc_target_queue(work) # rubocop:disable Metrics/MethodLength
+        target = case requeue_to
                  when Proc, Method
-                   to.call(*JSON.parse(work.job)["args"])
+                   requeue_to.call(*JSON.parse(work.job)["args"])
                  when NilClass
                    work.queue
                  when String, Symbol
-                   to.to_s
+                   requeue_to
                  else
                    raise ArgumentError, "Invalid argument for `to`"
                  end
 
         target = work.queue if target.nil? || target.empty?
 
-        target.start_with?("queue:") ? target : "queue:#{target}"
+        target.to_s
       end
 
       # Push the job back to the head of the queue.
-      def re_enqueue_throttled(work, requeue_to)
+      # The queue name is expected to include the "queue:" prefix, so we add it if it's missing.
+      def re_enqueue_throttled(work, target_queue)
+        target_queue = "queue:#{target_queue}" unless target_queue.start_with?("queue:")
+
         case work.class.name
         when "Sidekiq::Pro::SuperFetch::UnitOfWork"
           # Calls SuperFetch UnitOfWork's requeue to remove the job from the
           # temporary queue and push job back to the head of the target queue, so that
           # the job won't be tried immediately after it was requeued (in most cases).
-          work.queue = requeue_to if requeue_to
+          work.queue = target_queue
           work.requeue
         else
           # This is the same operation Sidekiq performs upon `Sidekiq::Worker.perform_async` call.
-          Sidekiq.redis { |conn| conn.lpush(requeue_to, work.job) }
+          Sidekiq.redis { |conn| conn.lpush(target_queue, work.job) }
         end
       end
 
-      def reschedule_throttled(work, requeue_to:)
-        message = JSON.parse(work.job)
-        job_class = message.fetch("wrapped") { message.fetch("class") { return false } }
-        job_args = message["args"]
+      # Reschedule the job to be executed later in the target queue.
+      # The queue name should NOT include the "queue:" prefix, so we remove it if it's present.
+      def reschedule_throttled(work, target_queue)
+        target_queue = target_queue.delete_prefix("queue:")
+        message      = JSON.parse(work.job)
+        job_class    = message.fetch("wrapped") { message.fetch("class") { return false } }
+        job_args     = message["args"]
 
         # Re-enqueue the job to the target queue at another time as a NEW unit of work
         # AND THEN mark this work as done, so SuperFetch doesn't think this instance is orphaned
         # Technically, the job could processed twice if the process dies between the two lines,
         # but your job should be idempotent anyway, right?
         # The job running twice was already a risk with SuperFetch anyway and this doesn't really increase that risk.
-        Sidekiq::Client.enqueue_to_in(requeue_to, retry_in(work), Object.const_get(job_class), *job_args)
+        Sidekiq::Client.enqueue_to_in(target_queue, retry_in(work), Object.const_get(job_class), *job_args)
+
         work.acknowledge
       end
 

data/lib/sidekiq/throttled/strategy_collection.rb

@@ -43,7 +43,7 @@ module Sidekiq
 
       # @return [Float] How long, in seconds, before we'll next be able to take on jobs
       def retry_in(*args)
-        max { |s| s.retry_in(*args) }
+        map { |s| s.retry_in(*args) }.max
       end
 
       # Marks job as being processed.

data/lib/sidekiq/throttled/version.rb

@@ -3,6 +3,6 @@
 module Sidekiq
   module Throttled
     # Gem version
-    VERSION = "1.5.0"
+    VERSION = "1.5.2"
   end
 end

data/lib/sidekiq/throttled.rb

@@ -102,7 +102,7 @@ module Sidekiq
         job_class = Object.const_get(message.fetch("wrapped") { message.fetch("class") { return false } })
 
         Registry.get job_class do |strategy|
-          strategy.requeue_throttled(work, **job_class.sidekiq_throttled_requeue_options)
+          strategy.requeue_throttled(work)
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-throttled
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.2
 platform: ruby
 authors:
 - Alexey Zapparov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-17 00:00:00.000000000 Z
+date: 2025-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -90,9 +90,9 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/ixti/sidekiq-throttled
-  source_code_uri: https://github.com/ixti/sidekiq-throttled/tree/v1.5.0
+  source_code_uri: https://github.com/ixti/sidekiq-throttled/tree/v1.5.2
   bug_tracker_uri: https://github.com/ixti/sidekiq-throttled/issues
-  changelog_uri: https://github.com/ixti/sidekiq-throttled/blob/v1.5.0/CHANGES.md
+  changelog_uri: https://github.com/ixti/sidekiq-throttled/blob/v1.5.2/CHANGES.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -109,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Concurrency and rate-limit throttling for Sidekiq