sidekiq-throttled 1.5.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a601fd050b147fd24ab88416d29273f0cca950c7e540c6303e1c0bb9c47f66d
-  data.tar.gz: 72ebc4a88c60c09faa9922c4f305fbe4374a90ebcafa62f149b83cbae6a356a6
+  metadata.gz: 85023f0d147ed5c41ac214b6f8c907ac4fd8c023271e0def9297659305449b16
+  data.tar.gz: 2f6b2c9c97210185dc91539328b85e108ee07b36770da7eaf87e27d3cff4138c
 SHA512:
-  metadata.gz: a41505e78b80af968f4aa3ab5076298d8acb62ab4b79046bbb8ff3d7cdb83d456546d066c3c431033418d5754b300cb16c30443b4f66bf82c30b14c5043b3ab4
-  data.tar.gz: 95b3c4839f01711aa6ff3fca8f390ab49981f7e7cf1cf3cd9c289276f945943ada4a3ec9adf96413cf1435f58fe9ea8c08f2b31fc3133e4fbbfca646d0c677b0
+  metadata.gz: 9fe961d74fd88be00803879e6a35197be285a80d7d7c289385bf6268a1c58c9e82a81c32ef0fb89070f8eccab6dc8ee963de2b2109695879be0c4b7d75bdc770
+  data.tar.gz: ee02663fa70432081fefbb756b5be9a72917ef3dcee1cf915a221d97c21f7ceb65b04ac0a54d5a3dba0709a484361e04423e3cf7a0750ef7127df5d0d1796f92

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
 
@@ -287,11 +314,9 @@ sidekiq_throttle(concurrency: { limit: 20, ttl: 1.hour.to_i })
 
 This library aims to support and is tested against the following Ruby versions:
 
-* Ruby 2.7.x
-* Ruby 3.0.x
-* Ruby 3.1.x
 * Ruby 3.2.x
 * Ruby 3.3.x
+* Ruby 3.4.x
 
 If something doesn't work on one of these versions, it's a bug.
 
@@ -311,15 +336,11 @@ dropped.
 
 This library aims to support and work with following Sidekiq versions:
 
-* Sidekiq 7.0.x
-* Sidekiq 7.1.x
-* Sidekiq 7.2.x
+* Sidekiq 8.0.x
 
 And the following Sidekiq Pro versions:
 
-* Sidekiq Pro 7.0.x
-* Sidekiq Pro 7.1.x
-* Sidekiq Pro 7.2.x
+* Sidekiq Pro 8.0.x
 
 == Development
 
@@ -334,6 +355,7 @@ If you're working on Sidekiq-Pro support make sure that you have Sidekiq-Pro
 license set either in the global config, or in `BUNDLE_GEMS\__CONTRIBSYS__COM`
 environment variable.
 
+
 == Contributing
 
 * Fork sidekiq-throttled on GitHub

data/lib/sidekiq/throttled/config.rb

@@ -51,7 +51,7 @@ module Sidekiq
 
       # @!attribute [w] default_requeue_options
       def default_requeue_options=(options)
-        requeue_with = options.delete(:with).intern || :enqueue
+        requeue_with = options.delete(:with)&.to_sym || :enqueue
 
         @default_requeue_options = options.merge({ with: requeue_with })
       end

data/lib/sidekiq/throttled/job.rb

@@ -88,8 +88,8 @@ module Sidekiq
         # @param [Hash] requeue What to do with jobs that are throttled
         # @see Registry.add
         # @return [void]
-        def sidekiq_throttle(**kwargs)
-          Registry.add(self, **kwargs)
+        def sidekiq_throttle(**)
+          Registry.add(self, **)
         end
 
         # Adds current worker to preconfigured throttling strategy. Allows

data/lib/sidekiq/throttled/registry.rb

@@ -17,10 +17,10 @@ module Sidekiq
         #
         # @param (see Strategy#initialize)
         # @return [Strategy]
-        def add(name, **kwargs)
+        def add(name, **)
           name = name.to_s
 
-          @strategies[name] = Strategy.new(name, **kwargs)
+          @strategies[name] = Strategy.new(name, **)
         end
 
         # Adds alias for existing strategy.

data/lib/sidekiq/throttled/strategy/concurrency.rb

@@ -58,6 +58,8 @@ module Sidekiq
           return 0.0 if !job_limit || count(*job_args) < job_limit
 
           oldest_jid_with_score = Sidekiq.redis { |redis| redis.zrange(key(job_args), 0, 0, withscores: true) }.first
+          return 0.0 unless oldest_jid_with_score
+
           expiry_time = oldest_jid_with_score.last.to_f
           expiry_time - Time.now.to_f
         end

data/lib/sidekiq/throttled/strategy.rb

@@ -143,24 +143,27 @@ module Sidekiq
                  when NilClass
                    work.queue
                  when String, Symbol
-                   requeue_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.
+      # 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 = target_queue if target_queue
+          work.queue = target_queue
           work.requeue
         else
           # This is the same operation Sidekiq performs upon `Sidekiq::Worker.perform_async` call.
@@ -168,10 +171,13 @@ module Sidekiq
         end
       end
 
+      # 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)
-        message = JSON.parse(work.job)
-        job_class = message.fetch("wrapped") { message.fetch("class") { return false } }
-        job_args = message["args"]
+        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
@@ -179,6 +185,7 @@ module Sidekiq
         # 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(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.1"
+    VERSION = "2.0.0"
   end
 end

data/lib/sidekiq/throttled/web.rb

@@ -1,43 +1,39 @@
 # frozen_string_literal: true
 
-# stdlib
 require "pathname"
 
-# 3rd party
 require "sidekiq"
 require "sidekiq/web"
 
-# internal
 require_relative "./registry"
 require_relative "./web/stats"
 
 module Sidekiq
   module Throttled
-    # Provides Sidekiq tab to monitor and reset throttled stats.
     module Web
-      VIEWS         = Pathname.new(__dir__).join("web")
-      THROTTLED_TPL = VIEWS.join("throttled.html.erb").read.freeze
+      ROOT  = Pathname.new(__dir__).join("../../../web").expand_path.realpath.freeze
+      VIEWS = ROOT.join("views").freeze
 
-      class << self
-        # @api private
-        def registered(app)
-          register_throttled_tab app
+      def self.registered(app)
+        app.get("/throttled") do
+          erb :index, views: VIEWS
         end
 
-        private
-
-        def register_throttled_tab(app)
-          app.get("/throttled") { erb THROTTLED_TPL.dup }
-
-          app.post("/throttled/:id/reset") do
-            Registry.get(params[:id], &:reset!)
-            redirect "#{root_path}throttled"
-          end
+        app.post("/throttled/:id/reset") do
+          Registry.get(route_params(:id), &:reset!)
+          redirect "#{root_path}throttled"
         end
       end
     end
   end
 end
 
-Sidekiq::Web.register Sidekiq::Throttled::Web
-Sidekiq::Web.tabs["Throttled"] = "throttled"
+Sidekiq::Web.configure do |config|
+  config.register_extension(
+    Sidekiq::Throttled::Web,
+    name:     "throttled",
+    tab:      %w[Throttled],
+    index:    %w[throttled],
+    root_dir: Sidekiq::Throttled::Web::ROOT.to_s
+  )
+end

data/web/views/index.erb

@@ -0,0 +1,41 @@
+<section>
+  <header>
+    <h1>Throttled</h1>
+  </header>
+
+  <div class="table_container">
+    <table class="throttled">
+      <thead>
+        <tr>
+          <th>Name</th>
+          <th>Concurrency</th>
+          <th>Threshold</th>
+          <th>Actions</th>
+        </tr>
+      </thead>
+      <tbody>
+        <% Sidekiq::Throttled::Registry.each_with_static_keys do |name, strategy| %>
+          <tr>
+            <td style="vertical-align:middle;"><%= name %></td>
+            <td style="vertical-align:middle;text-align:center;">
+              <% strategy.concurrency.each do |concurrency| %>
+                <%= Sidekiq::Throttled::Web::Stats.new(concurrency).to_html %>
+              <% end %>
+            </td>
+            <td style="vertical-align:middle;text-align:center;">
+              <% strategy.threshold.each do |threshold| %>
+                <%= Sidekiq::Throttled::Web::Stats.new(threshold).to_html %>
+              <% end %>
+            </td>
+            <td style="vertical-align:middle;text-align:center;">
+              <form action="<%= root_path %>throttled/<%= CGI.escape name %>/reset" method="post">
+                <%= csrf_tag %>
+                <button class="btn btn-danger" type="submit">Reset</button>
+              </form>
+            </td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
+</section>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-throttled
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Alexey Zapparov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-09 00:00:00.000000000 Z
+date: 2025-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.5'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.5'
+        version: '8.0'
 description:
 email:
 - alexey@zapparov.com
@@ -83,16 +83,16 @@ files:
 - lib/sidekiq/throttled/version.rb
 - lib/sidekiq/throttled/web.rb
 - lib/sidekiq/throttled/web/stats.rb
-- lib/sidekiq/throttled/web/throttled.html.erb
 - lib/sidekiq/throttled/worker.rb
+- web/views/index.erb
 homepage: https://github.com/ixti/sidekiq-throttled
 licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/ixti/sidekiq-throttled
-  source_code_uri: https://github.com/ixti/sidekiq-throttled/tree/v1.5.1
+  source_code_uri: https://github.com/ixti/sidekiq-throttled/tree/v2.0.0
   bug_tracker_uri: https://github.com/ixti/sidekiq-throttled/issues
-  changelog_uri: https://github.com/ixti/sidekiq-throttled/blob/v1.5.1/CHANGES.md
+  changelog_uri: https://github.com/ixti/sidekiq-throttled/blob/v2.0.0/CHANGES.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -102,14 +102,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Concurrency and rate-limit throttling for Sidekiq

data/lib/sidekiq/throttled/web/throttled.html.erb

@@ -1,35 +0,0 @@
-<h3>Throttled</h3>
-
-<div class="table_container">
-  <table class="table table-hover table-bordered table-striped table-white">
-    <thead>
-      <tr>
-        <th>Name</th>
-        <th style="text-align:center;">Concurrency</th>
-        <th style="text-align:center;">Threshold</th>
-        <th style="text-align:center;">Actions</th>
-      </tr>
-    </thead>
-    <% Sidekiq::Throttled::Registry.each_with_static_keys do |name, strategy| %>
-      <tr>
-        <td style="vertical-align:middle;"><%= name %></td>
-        <td style="vertical-align:middle;text-align:center;">
-          <% strategy.concurrency.each do |concurrency| %>
-            <%= Sidekiq::Throttled::Web::Stats.new(concurrency).to_html %>
-          <% end %>
-        </td>
-        <td style="vertical-align:middle;text-align:center;">
-          <% strategy.threshold.each do |threshold| %>
-            <%= Sidekiq::Throttled::Web::Stats.new(threshold).to_html %>
-          <% end %>
-        </td>
-        <td style="vertical-align:middle;text-align:center;">
-          <form action="<%= root_path %>throttled/<%= CGI.escape name %>/reset" method="post">
-            <%= csrf_tag %>
-            <button class="btn btn-danger" type="submit">Reset</button>
-          </form>
-        </td>
-      </tr>
-    <% end %>
-  </table>
-</div>