kubra-sidekiq-throttled 1.5.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c8b57e15f1580876256ff151b057c188cea5816b035add8a9ee758031c54b79
-  data.tar.gz: 0fdcbdf93cf808e475f7a01c41658edc08d7e9e256eb7581d793fb72a87a4cf0
+  metadata.gz: 98dc070784c42ddf555bbf84a5df49cf460efe2e5ccde93887498ca6295a5bc7
+  data.tar.gz: f2241d460e0879cb2153eac52ea4d06fd109ffd92a960d74f04fc75193d429db
 SHA512:
-  metadata.gz: 4a59f04af06b3a5c97f331fe4963d0ab769e5496a04c47bb139290b1ee0b9f8b8e183bd0c5b32a1b03e1115bc04332a13cfb0cb496b51b8a21d8c503e84e95c4
-  data.tar.gz: 7860e9a98c711808b662121e219991636225e39708cbc7e81045211d172723a8fe61474deba3a2116465363d715cc9237aa4a714d86ccbed6f6f5c1f33a07e65
+  metadata.gz: bdacff8274dcbda5d30fcc798935e25ea5cdf4e1533f5895dd29346d42aacdfdb14bf5d99ea1edd95907dfcd43a7c492f8bca14393b8044d9f0b45f78ad8c5bf
+  data.tar.gz: 69de366c927ffdc47d18cc74753b5c325821ad8ffafa9786b4ff2344502b75ea343f630914ac22908de7240499cf07d8e349c8c6a8e1f83ba0db88052b713803

data/README.adoc

@@ -351,11 +351,9 @@ sidekiq_throttle(
 
 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.
 
@@ -375,15 +373,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
 
@@ -398,6 +392,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/base.rb

@@ -14,7 +14,11 @@ module Sidekiq
           key = @base_key.dup
           return key unless @key_suffix
 
-          key << ":#{@key_suffix.call(*job_args)}"
+          key << ":#{key_suffix(job_args)}"
+        end
+
+        def key_suffix(job_args)
+          @key_suffix.respond_to?(:call) ? @key_suffix.call(*job_args) : @key_suffix
         rescue StandardError => e
           Sidekiq.logger.error "Failed to get key suffix: #{e}"
           raise e

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

@@ -19,8 +19,8 @@ end
 -- can cause unnecessary delays in job processing. Underestimates are much
 -- safer as they only increase workload of sidekiq processors. 
 local function est_current_backlog_size()
-  local old_size = tonumber(redis.call("HGET", backlog_info_key, "size") or 0)
-  local old_timestamp = tonumber(redis.call("HGET", backlog_info_key, "timestamp") or now)
+  local old_size = tonumber(redis.call("HGET", backlog_info_key, "size")) or 0
+  local old_timestamp = tonumber(redis.call("HGET", backlog_info_key, "timestamp")) or now
   
   local jobs_lost_since_old_timestamp = (now - old_timestamp) / lost_job_threshold * lmt
 

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

@@ -31,13 +31,18 @@ module Sidekiq
         # @param [#to_i] lost_job_threshold Seconds to wait before considering
         #   a job lost or dead. Default: 900 or 3 * avg_job_duration
         # @param [Proc] key_suffix Dynamic key suffix generator.
+        # @param [#to_i] max_delay Maximum number of seconds to delay a job when it
+        #   throttled. This prevents jobs from being schedule very far in the future
+        #   when the backlog is large. Default: the smaller of 30 minutes or 10 * avg_job_duration
         # @deprecated @param [#to_i] ttl Obsolete alias for `lost_job_threshold`.
         #   Default: 900 or 3 * avg_job_duration
-        def initialize(strategy_key, limit:, avg_job_duration: nil, ttl: nil, lost_job_threshold: ttl, key_suffix: nil) # rubocop:disable Metrics/ParameterLists
+        def initialize(strategy_key, limit:, avg_job_duration: nil, ttl: nil, # rubocop:disable Metrics/ParameterLists
+                       lost_job_threshold: ttl, key_suffix: nil, max_delay: nil)
           @base_key = "#{strategy_key}:concurrency.v2"
           @limit = limit
           @avg_job_duration, @lost_job_threshold = interp_duration_args(avg_job_duration, lost_job_threshold)
           @key_suffix = key_suffix
+          @max_delay = max_delay || [(10 * @avg_job_duration), 1_800].min
 
           raise(ArgumentError, "lost_job_threshold must be greater than avg_job_duration") if
             @lost_job_threshold <= @avg_job_duration
@@ -57,7 +62,7 @@ module Sidekiq
           keys = [key(job_args), backlog_info_key(job_args)]
           argv = [jid.to_s, job_limit, @lost_job_threshold, Time.now.to_f]
 
-          Sidekiq.redis { |redis| (1 == SCRIPT.call(redis, keys: keys, argv: argv)) }
+          Sidekiq.redis { |redis| 1 == SCRIPT.call(redis, keys: keys, argv: argv) }
         end
 
         # @return [Float] How long, in seconds, before we'll next be able to take on jobs
@@ -65,7 +70,8 @@ module Sidekiq
           job_limit = limit(job_args)
           return 0.0 if !job_limit || count(*job_args) < job_limit
 
-          estimated_backlog_size(job_args) * @avg_job_duration / limit(job_args)
+          (estimated_backlog_size(job_args) * @avg_job_duration / limit(job_args))
+            .then { |delay_sec| @max_delay * (1 - Math.exp(-delay_sec / @max_delay)) } # limit to max_delay
         end
 
         # @return [Integer] Current count of jobs
@@ -99,17 +105,13 @@ module Sidekiq
           old_size = (old_size_str || 0).to_f
           old_timestamp = (old_timestamp_str || Time.now).to_f
 
-          nonneg(old_size - jobs_lost_since(old_timestamp, job_args))
+          (old_size - jobs_lost_since(old_timestamp, job_args)).clamp(0, Float::INFINITY)
         end
 
         def jobs_lost_since(timestamp, job_args)
           (Time.now.to_f - timestamp) / @lost_job_threshold * limit(job_args)
         end
 
-        def nonneg(number)
-          [number, 0].max
-        end
-
         def interp_duration_args(avg_job_duration, lost_job_threshold)
           if avg_job_duration && lost_job_threshold
             [avg_job_duration.to_i, lost_job_threshold.to_i]

data/lib/sidekiq/throttled/version.rb

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

data/lib/sidekiq/throttled/web/stats.rb

@@ -62,12 +62,13 @@ module Sidekiq
 
         # @return [String]
         def humanize_integer(int)
-          digits = int.to_s.chars
-          str    = digits.shift(digits.count % 3).join
-
-          str << " " << digits.shift(3).join while digits.count.positive?
-
-          str.strip
+          int.to_s.chars
+            .reverse
+            .each_slice(3)
+            .map(&:reverse)
+            .reverse
+            .map(&:join)
+            .join(",")
         end
       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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kubra-sidekiq-throttled
 version: !ruby/object:Gem::Version
-  version: 1.5.3
+  version: 2.0.0
 platform: ruby
 authors:
 - Peter Williams
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-25 00:00:00.000000000 Z
+date: 2025-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -45,18 +45,17 @@ 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:
-- peter.williams@kubra.com
-- alexey@zapparov.com
+- pezra@barelyenough.org
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -85,16 +84,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
-homepage: https://github.com/pezra/sidekiq-throttled
+- web/views/index.erb
+homepage: https://github.com/ixti/sidekiq-throttled
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/pezra/sidekiq-throttled
-  source_code_uri: https://github.com/pezra/sidekiq-throttled/tree/v1.5.3
-  bug_tracker_uri: https://github.com/pezra/sidekiq-throttled/issues
-  changelog_uri: https://github.com/pezra/sidekiq-throttled/blob/v1.5.3/CHANGES.md
+  homepage_uri: https://github.com/ixti/sidekiq-throttled
+  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/v2.0.0/CHANGES.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -104,16 +103,15 @@ 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.1.6
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
-summary: Concurrency and rate-limit throttling for Sidekiq (w/ high volume throttling
-  improvements) )
+summary: Concurrency and rate-limit throttling for Sidekiq (with improvements)
 test_files: []

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>