sidekiq-throttled 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a187d7a0ab7f55794f909da549082fb32ec06acca0e75928fa970fd2312a63e
-  data.tar.gz: c6acd8c1ebe40741e0285e6de82c0384b60a7a03ccee602b8de29309cb8bc313
+  metadata.gz: 433460cfaea479faf45edc665c6f8d7d025b3e35ccdf18a32061a0b3d3c42e68
+  data.tar.gz: 4e36f4c938d7145646e04f1de6d483bdec5a4c18254c3153be3556285b779fbf
 SHA512:
-  metadata.gz: 6f777dff16dc389b43a089c4e392228afc695830bea0bedb4a4aa4b04d49b44a0ae5b60d643a255548947f90eeb198aaf91219f9f282de29b8c7c009626e6e4f
-  data.tar.gz: 86b28f4fa073f7930254269e766576da4bf3412a262d9e0329285221b1376437dc6f072e9aa93be1402da7e06f3f5501ce416b241d134c666546ae3abb7397fe
+  metadata.gz: 3ba640f6b15fa32eb21eccda8a319357439b7367fea6c0e4d4125e0e2cd5e91fbb822768d2171c57ac0cfbe0ba640b1d21960c6e2ea317997869c8f06187aec9
+  data.tar.gz: bd28f31c6222b3f378e1e7a2d081cc9f05c4feb13b7be8b1b54ee91976a66b2263884837f3149dddcc6b047129a0311b65135433511b0dc3ed29d47ed88346ea

data/README.adoc

@@ -107,7 +107,7 @@ end
 * `Sidekiq::Throttled::Middlewares::Server`
 
 The middleware is automatically injected when you require `sidekiq/throttled`.
-In rare cases this might be an issue. You can change to order manually:
+In rare cases, when this causes an issue, you can change middleware order manually:
 
 [source,ruby]
 ----
@@ -115,8 +115,7 @@ Sidekiq.configure_server do |config|
   # ...
 
   config.server_middleware do |chain|
-    chain.remove(Sidekiq::Throttled::Middlewares::Server)
-    chain.add(Sidekiq::Throttled::Middlewares::Server)
+    chain.prepend(Sidekiq::Throttled::Middlewares::Server)
   end
 end
 ----
@@ -271,6 +270,7 @@ This library aims to support and is tested against the following Ruby versions:
 * Ruby 3.0.x
 * Ruby 3.1.x
 * Ruby 3.2.x
+* Ruby 3.3.x
 
 If something doesn't work on one of these versions, it's a bug.
 
@@ -295,6 +295,11 @@ This library aims to support and work with following Sidekiq versions:
 * Sidekiq 7.1.x
 * Sidekiq 7.2.x
 
+And the following Sidekiq Pro versions:
+
+* Sidekiq Pro 7.0.x
+* Sidekiq Pro 7.1.x
+* Sidekiq Pro 7.2.x
 
 == Development
 
@@ -303,6 +308,11 @@ This library aims to support and work with following Sidekiq versions:
   bundle exec appraisal install
   bundle exec rake
 
+=== Sidekiq-Pro
+
+If you're working on Sidekiq-Pro support make sure to copy `.rspec-sidekiq-pro`
+to `.rspec-local` and that you have Sidekiq-Pro license in the global config,
+or in the `BUNDLE_GEMS\__CONTRIBSYS__COM` env variable.
 
 == Contributing
 

data/lib/sidekiq/throttled/patches/basic_fetch.rb

@@ -3,25 +3,14 @@
 require "sidekiq"
 require "sidekiq/fetch"
 
+require_relative "./throttled_retriever"
+
 module Sidekiq
   module Throttled
     module Patches
       module BasicFetch
-        # Retrieves job from redis.
-        #
-        # @return [Sidekiq::Throttled::UnitOfWork, nil]
-        def retrieve_work
-          work = super
-
-          if work && Throttled.throttled?(work.job)
-            Throttled.cooldown&.notify_throttled(work.queue)
-            requeue_throttled(work)
-            return nil
-          end
-
-          Throttled.cooldown&.notify_admitted(work.queue) if work
-
-          work
+        def self.prepended(base)
+          base.prepend(ThrottledRetriever)
         end
 
         private
@@ -43,7 +32,10 @@ module Sidekiq
         # @param [Array<String>] queues
         # @return [Array<String>]
         def queues_cmd
-          super - (Throttled.cooldown&.queues || [])
+          throttled_queues = Throttled.cooldown&.queues
+          return super if throttled_queues.nil? || throttled_queues.empty?
+
+          super - throttled_queues
         end
       end
     end

data/lib/sidekiq/throttled/patches/super_fetch.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "sidekiq"
+
+require_relative "./throttled_retriever"
+
+module Sidekiq
+  module Throttled
+    module Patches
+      module SuperFetch
+        def self.prepended(base)
+          base.prepend(ThrottledRetriever)
+        end
+
+        private
+
+        # Calls SuperFetch UnitOfWork's requeue to remove the job from the
+        # temporary queue and push job back to the head of the queue, so that
+        # the job won't be tried immediately after it was requeued (in most cases).
+        #
+        # @note This is triggered when job is throttled.
+        #
+        # @return [void]
+        def requeue_throttled(work)
+          # SuperFetch UnitOfWork's requeue will remove it from the temporary
+          # queue and then requeue it, so no acknowledgement call is needed.
+          work.requeue
+        end
+
+        # Returns list of non-paused queues to try to fetch jobs from.
+        #
+        # @note It may return an empty array.
+        # @return [Array<Array(String, String)>]
+        def active_queues
+          # Create a hash of throttled queues for fast lookup
+          throttled_queues = Throttled.cooldown&.queues&.to_h { |queue| [queue, true] }
+          return super if throttled_queues.nil? || throttled_queues.empty?
+
+          # Reject throttled queues from the list of active queues
+          super.reject { |queue, _private_queue| throttled_queues[queue] }
+        end
+      end
+    end
+  end
+end
+
+begin
+  require "sidekiq/pro/super_fetch"
+  Sidekiq::Pro::SuperFetch.prepend(Sidekiq::Throttled::Patches::SuperFetch)
+rescue LoadError
+  # Sidekiq Pro is not available
+end

data/lib/sidekiq/throttled/patches/throttled_retriever.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Sidekiq
+  module Throttled
+    module Patches
+      module ThrottledRetriever
+        # Retrieves job from redis.
+        #
+        # @return [Sidekiq::BasicFetch::UnitOfWork, nil]
+        def retrieve_work
+          work = super
+
+          if work && Throttled.throttled?(work.job)
+            Throttled.cooldown&.notify_throttled(work.queue)
+            requeue_throttled(work)
+            return nil
+          end
+
+          Throttled.cooldown&.notify_admitted(work.queue) if work
+
+          work
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/throttled/strategy_collection.rb

@@ -26,8 +26,8 @@ module Sidekiq
 
       # @param [#call] block
       # Iterates each strategy in collection
-      def each(&block)
-        @strategies.each(&block)
+      def each(...)
+        @strategies.each(...)
       end
 
       # @return [Boolean] whenever any strategy in collection has dynamic config
@@ -37,14 +37,14 @@ module Sidekiq
 
       # @return [Boolean] whenever job is throttled or not
       # by any strategy in collection.
-      def throttled?(*args)
-        any? { |s| s.throttled?(*args) }
+      def throttled?(...)
+        any? { |s| s.throttled?(...) }
       end
 
       # Marks job as being processed.
       # @return [void]
-      def finalize!(*args)
-        each { |c| c.finalize!(*args) }
+      def finalize!(...)
+        each { |c| c.finalize!(...) }
       end
 
       # Resets count of jobs of all avaliable strategies

data/lib/sidekiq/throttled/version.rb

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

data/lib/sidekiq/throttled.rb

@@ -7,6 +7,7 @@ require_relative "./throttled/cooldown"
 require_relative "./throttled/job"
 require_relative "./throttled/middlewares/server"
 require_relative "./throttled/patches/basic_fetch"
+require_relative "./throttled/patches/super_fetch"
 require_relative "./throttled/registry"
 require_relative "./throttled/version"
 require_relative "./throttled/worker"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-throttled
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Alexey Zapparov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-18 00:00:00.000000000 Z
+date: 2024-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -69,6 +69,8 @@ files:
 - lib/sidekiq/throttled/job.rb
 - lib/sidekiq/throttled/middlewares/server.rb
 - lib/sidekiq/throttled/patches/basic_fetch.rb
+- lib/sidekiq/throttled/patches/super_fetch.rb
+- lib/sidekiq/throttled/patches/throttled_retriever.rb
 - lib/sidekiq/throttled/registry.rb
 - lib/sidekiq/throttled/strategy.rb
 - lib/sidekiq/throttled/strategy/base.rb
@@ -87,9 +89,9 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/ixti/sidekiq-throttled
-  source_code_uri: https://github.com/ixti/sidekiq-throttled/tree/v1.2.0
+  source_code_uri: https://github.com/ixti/sidekiq-throttled/tree/v1.3.0
   bug_tracker_uri: https://github.com/ixti/sidekiq-throttled/issues
-  changelog_uri: https://github.com/ixti/sidekiq-throttled/blob/v1.2.0/CHANGES.md
+  changelog_uri: https://github.com/ixti/sidekiq-throttled/blob/v1.3.0/CHANGES.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -106,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.5.4
 signing_key:
 specification_version: 4
 summary: Concurrency and rate-limit throttling for Sidekiq