sidekiq-debouncer 3.0.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c98e0c985f240350757ce46298f39cb5586d7e01966f78bd3a886c8b4a78b7e0
-  data.tar.gz: e1f7ceda05cd4cc580fc5d318da59ccaf9a8a3f737020524c76a147add5fa5e3
+  metadata.gz: e4a9a96453d838cc36e81e1fe2d68ac8269a86b17d6db437f84aec0b599267cf
+  data.tar.gz: bbd138d4b850c86ecdac14e2d9857444c92ec9811a3612e19627aee3145873e1
 SHA512:
-  metadata.gz: 3175ce8da01db8a593290273a4a7c392133792de93c04a9091662ca96ab24caeea8a60e17e0ab7a7fd16e8b8273d184b62a421deb58374430e26f720f0708927
-  data.tar.gz: 2e42dedd11a4b6c05e9c4af5446803a1fab05daa7fe762b83ef3846b0f5c8cb253bf6f03e1bbbdc8e21311245087526c89098955c088d040c0c09606bba526da
+  metadata.gz: 7d7457e8273f79dac578f78231d5ce73380259076bae636a362124b54c26acd2d4ebc487598dfad7dcb529a023e246beabcf7d24383159f0abde667caec822bc
+  data.tar.gz: 9d730f2c1f36671a550a80a222a1f363f79624b2f0f74ceefc70d7928c06a40ef556a7cb3e360088ee482755d99c610323a9699f3db5b4dfee5de284bd1d9600

data/CHANGELOG.md

@@ -1,9 +1,22 @@
+## [3.2.0] - 2026-02-15
+- Support extra attributes ([#37](https://github.com/paladinsoftware/sidekiq-debouncer/pull/37))
+- Fix loading order issues ([#36](https://github.com/paladinsoftware/sidekiq-debouncer/pull/36))
+- Bump Ruby and Sidekiq versions ([#35](https://github.com/paladinsoftware/sidekiq-debouncer/pull/35))
+
+## [3.1.0] - 2025-03-28
+- Drop support for Ruby < 3.2.0
+- Support for Sidekiq 8 ([#31](https://github.com/paladinsoftware/sidekiq-debouncer/pull/31), [#32](https://github.com/paladinsoftware/sidekiq-debouncer/pull/32))
+- DragonflyDB support ([#29](https://github.com/paladinsoftware/sidekiq-debouncer/pull/29))
+
 ## [3.0.0] - 2024-10-22
 - Complete rewrite of the library ([#25](https://github.com/paladinsoftware/sidekiq-debouncer/pull/25))
 - Read only Web UI ([#26](https://github.com/paladinsoftware/sidekiq-debouncer/pull/26))
 - Drop support for sidekiq 6.x and ruby 2.7 ([#28](https://github.com/paladinsoftware/sidekiq-debouncer/pull/28))
 - Respect sidekiq_options overridden by .set ([#27](https://github.com/paladinsoftware/sidekiq-debouncer/pull/27))
 
+**Upgrade notes:**
+Since the job format changed, V3 won't debounce jobs enqueued with V2, although they'll still get executed
+
 ## [2.0.2] - 2023-03-13
 - support Sidekiq::Testing
 
@@ -11,7 +24,7 @@
 - don't remove debounce key in redis to avoid invalid debouncing
 
 ## [2.0.0] - 2023-02-28
-Complete rewrite of the library:  
+Complete rewrite of the library:
 - Instead of iterating through whole schedule set, sidekiq-debouncer will now cache debounce key in redis with a reference to the job.
 Thanks to that there is a huge performance boost compared to V1. With 1k jobs in schedule set it's over 100x faster.
 The difference is even bigger with larger amount of jobs.

data/README.md

@@ -99,6 +99,12 @@ Sidekiq.configure_client do |config|
 end
 ```
 
+## Middleware context
+
+When multiple jobs are debounced together, the full job hash from the **last job** is preserved. This means any context added by other middlewares (like `acts_as_tenant`, Sidekiq's `CurrentAttributes`, or custom middleware data) will be taken from the most recent job.
+
+For example, if you debounce 3 jobs with different tenant contexts, the final executed job will use the tenant from the 3rd (last) job.
+
 ## Web UI
 Add `require 'sidekiq/debouncer/web'` after `require 'sidekiq/web'`.
 

data/lib/sidekiq/debouncer/enq.rb

@@ -18,11 +18,7 @@ module Sidekiq
           while !@done && (job, score = zpopbyscore_withscore(conn, [Sidekiq::Debouncer::SET], [Time.now.to_f.to_s]))
             job_args = zpopbyscore_multi(conn, [job], [score])
 
-            final_args = job_args.map { |elem| Sidekiq.load_json(elem.split("-", 2)[1]) }
-            job_class = job.split("/")[2]
-            klass = Object.const_get(job_class)
-
-            @client.push({"args" => final_args, "class" => klass, "debounce_key" => job})
+            @client.push(JobBuilder.build(job_args, job))
 
             logger.debug { "enqueued #{Sidekiq::Debouncer::SET}: #{job}" }
           end

data/lib/sidekiq/debouncer/job.rb

@@ -3,13 +3,11 @@
 module Sidekiq
   module Debouncer
     class Job
-      include Sidekiq::JobUtil
-
       attr_reader :key, :score
 
       def initialize(key, score)
         @key = key
-        @score = score
+        @score = Float(score)
       end
 
       def at
@@ -17,12 +15,11 @@ module Sidekiq
       end
 
       def args
-        @_args ||= Sidekiq.redis { |conn| conn.call("ZRANGE", key, "-inf", "+inf", "BYSCORE") }
-          .map { |elem| Sidekiq.load_json(elem.split("-", 2)[1]) }
+        item["args"]
       end
 
       def queue
-        normalized["queue"]
+        item["queue"]
       end
 
       def klass
@@ -31,10 +28,11 @@ module Sidekiq
 
       alias_method :display_class, :klass
 
-      private
-
-      def normalized
-        @_normalized ||= normalize_item({"args" => args, "class" => Object.const_get(klass), "debounce_key" => key})
+      def item
+        @_item ||= begin
+          job_args = Sidekiq.redis { |conn| conn.call("ZRANGE", key, "-inf", "+inf", "BYSCORE") }
+          JobBuilder.build(job_args, key)
+        end
       end
     end
   end

data/lib/sidekiq/debouncer/job_builder.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Sidekiq
+  module Debouncer
+    module JobBuilder
+      extend Sidekiq::JobUtil
+
+      def self.build(job_args, debounce_key)
+        base_job = nil
+        final_args = job_args.map do |elem|
+          if elem.start_with?("{")
+            base_job = Sidekiq.load_json(elem)
+            base_job["args"]
+          else
+            Sidekiq.load_json(elem.split("-", 2)[1])
+          end
+        end
+
+        if base_job
+          base_job.merge("args" => final_args, "debounce_key" => debounce_key)
+        else
+          # Old format fallback - normalize to get queue from class
+          job_class = debounce_key.split("/")[2]
+          normalize_item("args" => final_args, "class" => Object.const_get(job_class), "debounce_key" => debounce_key)
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/debouncer/middleware/client.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "securerandom"
-
 module Sidekiq
   module Debouncer
     module Middleware
@@ -42,10 +40,10 @@ module Sidekiq
 
           return job.merge("args" => [job["args"]], "debounce_key" => key) if testing?
 
-          args_stringified = "#{SecureRandom.hex(12)}-#{Sidekiq.dump_json(job["args"])}"
+          job_stringified = Sidekiq.dump_json(job)
 
           redis do |connection|
-            redis_debounce(connection, [Sidekiq::Debouncer::SET, key], [args_stringified, time, @debounce_key_ttl])
+            redis_debounce(connection, [Sidekiq::Debouncer::SET, key], [job_stringified, time, @debounce_key_ttl])
           end
 
           # prevent normal sidekiq flow

data/lib/sidekiq/debouncer/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module Debouncer
-    VERSION = "3.0.0"
+    VERSION = "3.2.0"
   end
 end

data/lib/sidekiq/debouncer/views/index.html.erb

@@ -1,48 +1,50 @@
-<header class='row'>
-  <div class='col-sm-5 pull-left'>
-    <h3><%= t('Debounces') %></h3>
-  </div>
-  <div class='col-sm-7 pull-right'>
-    <%= erb :_paging, locals: { url: "#{root_path}debounces" } %>
-  </div>
-</header>
-
-<% if @debounces.size > 0 %>
-  <form action="<%= root_path %>debounces" method="post">
-    <%= csrf_tag %>
-    <div class="table_container">
-      <table class="table table-striped table-bordered table-hover">
-        <thead>
-          <tr>
-            <th class="table-checkbox checkbox-column">
-              <label>
-                <input type="checkbox" class="check_all" />
-              </label>
-            </th>
-            <th><%= t('When') %></th>
-            <th><%= t('DebounceKey') %></th>
-          </tr>
-        </thead>
-        <% @debounces.each do |entry| %>
-          <tr>
-            <td class="table-checkbox">
-              <label>
-                <input type='checkbox' name='key[]' value='<%= entry.key %>' class='shift_clickable' />
-              </label>
-            </td>
-            <td>
-              <a href="<%= root_path %>debounces/<%= ::Base64.urlsafe_encode64(entry.key) %>"><%= relative_time(entry.at) %></a>
-            </td>
-            <td>
-              <a href="<%= root_path %>debounces/<%= ::Base64.urlsafe_encode64(entry.key) %>"><%= entry.key %></a>
-            </td>
-          </tr>
-        <% end %>
-      </table>
+<section>
+  <header class='row'>
+    <div class='col-sm-5 pull-left'>
+      <h3><%= t('Debounces') %></h3>
+    </div>
+    <div class='col-sm-7 pull-right'>
+      <%= erb :_paging, locals: { url: "#{root_path}debounces" } %>
     </div>
-<!--    <input class="btn btn-danger pull-right flip" type="submit" name="delete" value="<%#= t('Delete') %>" />-->
-<!--    <input class="btn btn-danger pull-right flip" type="submit" name="add_to_queue" value="<%#= t('AddToQueue') %>" />-->
-  </form>
-<% else %>
-  <div class="alert alert-success"><%= t('NoDebouncesFound') %></div>
-<% end %>
+  </header>
+
+  <% if @debounces.size > 0 %>
+    <form action="<%= root_path %>debounces" method="post">
+      <%= csrf_tag %>
+      <div class="table_container">
+        <table class="table table-striped table-bordered table-hover">
+          <thead>
+            <tr>
+              <th class="table-checkbox checkbox-column">
+                <label>
+                  <input type="checkbox" class="check_all" />
+                </label>
+              </th>
+              <th><%= t('When') %></th>
+              <th><%= t('DebounceKey') %></th>
+            </tr>
+          </thead>
+          <% @debounces.each do |entry| %>
+            <tr>
+              <td class="table-checkbox">
+                <label>
+                  <input type='checkbox' name='key[]' value='<%= entry.key %>' class='shift_clickable' />
+                </label>
+              </td>
+              <td>
+                <a href="<%= root_path %>debounces/<%= ::Base64.urlsafe_encode64(entry.key) %>"><%= relative_time(entry.at) %></a>
+              </td>
+              <td>
+                <a href="<%= root_path %>debounces/<%= ::Base64.urlsafe_encode64(entry.key) %>"><%= entry.key %></a>
+              </td>
+            </tr>
+          <% end %>
+        </table>
+      </div>
+  <!--    <input class="btn btn-danger pull-right flip" type="submit" name="delete" value="<%#= t('Delete') %>" />-->
+  <!--    <input class="btn btn-danger pull-right flip" type="submit" name="add_to_queue" value="<%#= t('AddToQueue') %>" />-->
+    </form>
+  <% else %>
+    <div class="alert alert-success"><%= t('NoDebouncesFound') %></div>
+  <% end %>
+</section>

data/lib/sidekiq/debouncer/views/show.html.erb

@@ -1,38 +1,48 @@
-<div class="header-container">
-  <h3><%= t('Job') %></h3>
-</div>
+<section>
+  <header class="header-container">
+    <h3><%= t('Job') %></h3>
+  </header>
 
-<div class="table_container">
-  <table class="table table-bordered table-striped table-hover">
-    <tbody>
-      <tr>
-        <th><%= t('Queue') %></th>
-        <td><%= @job.queue %></td>
-      </tr>
-      <tr>
-        <th><%= t('When') %></th>
-        <td><%= relative_time(@job.at) %></td>
-      </tr>
-      <tr>
-        <th><%= t('DebounceKey') %></th>
-        <td>
-          <%= @job.key %>
-        </td>
-      </tr>
-      <tr>
-        <th><%= t('Job') %></th>
-        <td>
-          <%= @job.display_class %>
-        </td>
-      </tr>
-      <tr>
-        <th><%= t('Arguments') %></th>
-        <td>
-          <code class="code-wrap">
-            <div class="args-extended"><%= display_args(@job.args, nil) %></div>
-          </code>
-        </td>
-      </tr>
-    </tbody>
-  </table>
-</div>
+  <div class="table_container">
+    <table class="table table-bordered table-striped table-hover">
+      <tbody>
+        <tr>
+          <th><%= t('Queue') %></th>
+          <td><%= @job.queue %></td>
+        </tr>
+        <tr>
+          <th><%= t('When') %></th>
+          <td><%= relative_time(@job.at) %></td>
+        </tr>
+        <tr>
+          <th><%= t('DebounceKey') %></th>
+          <td>
+            <%= @job.key %>
+          </td>
+        </tr>
+        <tr>
+          <th><%= t('Job') %></th>
+          <td>
+            <%= @job.display_class %>
+          </td>
+        </tr>
+        <tr>
+          <th><%= t('Arguments') %></th>
+          <td>
+            <code class="code-wrap">
+              <div class="args-extended"><%= display_args(@job.args, nil) %></div>
+            </code>
+          </td>
+        </tr>
+        <% unless retry_extra_items(@job).empty? %>
+        <tr>
+          <th><%= t('Extras') %></th>
+          <td>
+            <code><%= retry_extra_items(@job).inspect %></code>
+          </td>
+        </tr>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
+</section>

data/lib/sidekiq/debouncer/web.rb

@@ -3,6 +3,24 @@
 if defined?(Sidekiq::Web)
   require "sidekiq/debouncer/web_extension"
 
-  Sidekiq::Web.register Sidekiq::Debouncer::WebExtension
-  Sidekiq::Web.tabs["Debounces"] = "debounces"
+  if Gem::Version.new(Sidekiq::VERSION) >= Gem::Version.new("8.0.0")
+    Sidekiq::Web.configure do |config|
+      config.register(
+        Sidekiq::Debouncer::WebExtension,
+        name: "debounces",
+        tab: "Debounces",
+        index: "debounces"
+      )
+    end
+  elsif Gem::Version.new(Sidekiq::VERSION) >= Gem::Version.new("7.3.0")
+    Sidekiq::Web.register(
+      Sidekiq::Debouncer::WebExtension,
+      name: "debounces",
+      tab: "Debounces",
+      index: "debounces"
+    )
+  else
+    Sidekiq::Web.register Sidekiq::Debouncer::WebExtension
+    Sidekiq::Web.tabs["Debounces"] = "debounces"
+  end
 end

data/lib/sidekiq/debouncer/web_extension.rb

@@ -1,18 +1,46 @@
 # frozen_string_literal: true
 
 require "base64"
+require "sidekiq/api"
+require "sidekiq/debouncer/set"
 
 module Sidekiq
   module Debouncer
     module WebExtension
+      module Helpers
+        def get_route_param(key)
+          if Gem::Version.new(Sidekiq::VERSION) >= Gem::Version.new("8.0.0")
+            route_params(key)
+          else
+            route_params[key]
+          end
+        end
+
+        def get_url_param(key)
+          if Gem::Version.new(Sidekiq::VERSION) >= Gem::Version.new("8.0.0")
+            url_params(key)
+          else
+            params[key]
+          end
+        end
+      end
+
       def self.registered(app)
-        app.settings.locales << File.join(File.expand_path("..", __FILE__), "locales")
+        locales = if Gem::Version.new(Sidekiq::VERSION) >= Gem::Version.new("8.0.0")
+                    Sidekiq::Web.configure.locales
+                  else
+                    app.settings.locales
+                  end
+
+        locales << File.join(File.expand_path("..", __FILE__), "locales")
+
+        app.helpers(Helpers)
 
         app.get "/debounces" do
           view_path = File.join(File.expand_path("..", __FILE__), "views")
 
-          @count = (params["count"] || 25).to_i
-          (@current_page, @total_size, @debounces) = page("debouncer", params["page"], @count)
+          @count = (get_url_param("count") || 25).to_i
+          (@current_page, @total_size, @debounces) = page("debouncer", get_url_param("page"), @count)
           @debounces = @debounces.map { |key, score| Sidekiq::Debouncer::Job.new(key, score) }
 
           render(:erb, File.read(File.join(view_path, "index.html.erb")))
@@ -21,7 +49,7 @@ module Sidekiq
         app.get "/debounces/:key" do
           view_path = File.join(File.expand_path("..", __FILE__), "views")
 
-          @job = Sidekiq::Debouncer::Set.new.fetch_by_key(Base64.urlsafe_decode64(route_params[:key]))
+          @job = Sidekiq::Debouncer::Set.new.fetch_by_key(Base64.urlsafe_decode64(get_route_param(:key)))
 
           render(:erb, File.read(File.join(view_path, "show.html.erb")))
         end

data/lib/sidekiq/debouncer.rb

@@ -3,10 +3,10 @@
 require "sidekiq/debouncer/version"
 require "sidekiq/debouncer/errors"
 require "sidekiq/debouncer/lua_commands"
+require "sidekiq/debouncer/job_builder"
 require "sidekiq/debouncer/middleware/client"
 require "sidekiq/debouncer/middleware/server"
 require "sidekiq/debouncer/job"
-require "sidekiq/debouncer/set"
 
 module Sidekiq
   module Debouncer

data/sidekiq-debouncer.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |gem|
     "sidekiq-debouncer.gemspec"
   ]
 
-  gem.add_dependency "sidekiq", ">= 7.0", "< 8.0"
+  gem.add_dependency "sidekiq", ">= 7.0", "< 9.0"
 
   gem.add_development_dependency "rspec", "~> 3.12.0"
   gem.add_development_dependency "timecop", "~> 0.9.6"
@@ -35,4 +35,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "parallel", "~> 1.22.1"
   gem.add_development_dependency "standard", "~> 1.24.3"
   gem.add_development_dependency "rack-test", "~> 2.1.0"
+  gem.add_development_dependency "rack-session", "~> 2.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-debouncer
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Sebastian Zuchmański
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-22 00:00:00.000000000 Z
+date: 2026-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -20,7 +20,7 @@ dependencies:
         version: '7.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -30,7 +30,7 @@ dependencies:
         version: '7.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -115,6 +115,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: rack-session
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
 description: |
   Sidekiq extension that adds the ability to debounce job execution.
   Worker will postpone its execution after `wait time` have elapsed since the last time it was invoked.
@@ -134,6 +148,7 @@ files:
 - lib/sidekiq/debouncer/enq.rb
 - lib/sidekiq/debouncer/errors.rb
 - lib/sidekiq/debouncer/job.rb
+- lib/sidekiq/debouncer/job_builder.rb
 - lib/sidekiq/debouncer/launcher.rb
 - lib/sidekiq/debouncer/locales/en.yml
 - lib/sidekiq/debouncer/lua/debounce.lua
@@ -169,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Sidekiq extension that adds the ability to debounce job execution