sidekiq-debouncer 2.0.0 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 939e5397d600c7f5f24b3757f46f0c613369079ef327c8e88bf5adcdf807733f
-  data.tar.gz: 6ee4f636b9297a232a82bcf6c27c1418408cd2ad66ad8e473945fd1fdbc12cb0
+  metadata.gz: bab3413954e727ee13bc4d216f13621d1337df24f1ed970ecf146fae30501ef6
+  data.tar.gz: 883a815a2bb23e08abb175bf04f0231e028684d174c3d60bef6cc1450294764d
 SHA512:
-  metadata.gz: 3b84978f7ea580d81a052719860ef38fc10339d35064c768457ffcccf0effb7dd148a2bd7a6620489a68c5a03705aea400f2ce8f493e2d0e27fa48edcb806082
-  data.tar.gz: f0e2d36120e11883f9b2f29b4de2f4fcbfbae075c72592742b9b6a3f323458a0bf7222fb4853604df45c1755e15ead8b600024630bd976631d3df4b5679f996a
+  metadata.gz: 254b6d10c2cf611d91e6971f9e21cc76964600ab951f718c88aa0d7eacb38fe3fccc4bd4f0e0f971d33e829e5a6ce0997d5c1a7a9886bc95e503a554b57e0241
+  data.tar.gz: 8d5877eec61fb2dbac4305db1815afc320306e0c1af78a872468a5a2218dd48f4b9f8a954e323e59aa3d088b783ae61cc14140a987c3f0785c80a3621c0dcbf7

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## Unreleased
+
+## [2.0.2] - 2023-03-13
+- support Sidekiq::Testing
+
+## [2.0.1] - 2023-03-04
+- don't remove debounce key in redis to avoid invalid debouncing
+
 ## [2.0.0] - 2023-02-28
 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.

data/README.md

@@ -88,8 +88,8 @@ Keep in mind that the result of the debounce method will be converted to string,
 
 In the application, call `MyWorker.perform_async(...)` as usual. Everytime you call this function, `MyWorker`'s execution will be postponed by 5 minutes. After that time `MyWorker` will receive a method call `perform` with an array of arguments that were provided to the `MyWorker.perform_async(...)` calls.
 
-To avoid keeping leftover keys in redis (for example, when job was manually removed from schedule set), all additional keys are created with TTL.
-It's 7 days by default and should be ok in most of the cases. If you are debouncing your jobs in higher interval than that, you can overwrite this setting:
+To avoid keeping leftover keys in redis, all additional keys are created with TTL.
+It's 24 hours by default and should be ok in most of the cases. If you are debouncing your jobs in higher interval than that, you can overwrite this setting:
 
 ```ruby
 Sidekiq.configure_client do |config|
@@ -103,6 +103,15 @@ end
 
 In order to test the behavior of `sidekiq-debouncer` it is necessary to disable testing mode. It is the limitation of internal implementation.
 
+Sidekiq::Debouncer will not debounce the jobs in testing mode, instead they'll be executed like normal jobs (pushed to fake queue or executed inline depending on settings).
+Server middleware needs to be added to `Sidekiq::Testing` chain:
+
+```ruby 
+Sidekiq::Testing.server_middleware do |chain|
+  chain.add Sidekiq::Debouncer::Middleware::Server
+end
+```
+
 ## License
 
 MIT Licensed. See LICENSE.txt for details.

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

@@ -17,7 +17,7 @@ module Sidekiq
         REDIS_ERROR_CLASS = defined?(RedisClient::CommandError) ? RedisClient::CommandError : Redis::CommandError
 
         def initialize(options = {})
-          @debounce_key_ttl = options.fetch(:ttl, 60 * 60 * 24 * 7) # 7 days by default
+          @debounce_key_ttl = options.fetch(:ttl, 60 * 60 * 24) # 24 hours by default
         end
 
         def call(worker_class, job, _queue, _redis_pool)
@@ -28,9 +28,6 @@ module Sidekiq
           return job if !klass.get_sidekiq_options["debounce"] || job["debounce_key"]
 
           debounce(klass, job)
-
-          # prevent normal sidekiq flow
-          false
         end
 
         private
@@ -46,9 +43,14 @@ module Sidekiq
           job["args"] = [job["args"]]
           job.delete("debounce")
 
+          return job if testing?
+
           redis do |connection|
             redis_debounce(connection, keys: ["schedule", key], argv: [Sidekiq.dump_json(job), time, @debounce_key_ttl])
           end
+
+          # prevent normal sidekiq flow
+          false
         end
 
         def debounce_key(klass, job, options)
@@ -79,6 +81,10 @@ module Sidekiq
             retry
           end
         end
+
+        def testing?
+          defined?(Sidekiq::Testing) && Sidekiq::Testing.enabled?
+        end
       end
     end
   end

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

@@ -3,20 +3,13 @@
 module Sidekiq
   module Debouncer
     module Middleware
-      # Server middleware removes debounce key from redis before executing the job
+      # wrap args into array because sidekiq uses splat while calling perform
       class Server
         include Sidekiq::ServerMiddleware
 
         def call(_worker, job, _queue)
           if job.key?("debounce_key")
-            # skip if job comes from dead or retry set
-            unless job.key?("failed_at")
-              redis do |connection|
-                connection.call("DEL", job["debounce_key"])
-              end
-            end
-
-            job["args"] = [job["args"]] # wrap args into array because sidekiq uses splat while calling perform
+            job["args"] = [job["args"]]
           end
 
           yield

data/lib/sidekiq/debouncer/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module Debouncer
-    VERSION = "2.0.0"
+    VERSION = "2.0.2"
   end
 end

data/sidekiq-debouncer.gemspec

@@ -12,6 +12,7 @@ Gem::Specification.new do |gem|
   gem.email = ["sebcioz@gmail.com", "kukicola@gmail.com"]
   gem.summary = "Sidekiq extension that adds the ability to debounce job execution"
   gem.description = <<~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.
     Useful for implementing behavior that should only happen after the input has stopped arriving.
   DESCRIPTION

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-debouncer
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.2
 platform: ruby
 authors:
 - Sebastian Zuchmański
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-28 00:00:00.000000000 Z
+date: 2023-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -102,6 +102,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.24.3
 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.
   Useful for implementing behavior that should only happen after the input has stopped arriving.
 email: