sidekiq-throttled 0.16.2 → 1.4.0

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/registry.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
 # internal
-require "sidekiq/throttled/strategy"
-require "sidekiq/throttled/utils"
+require_relative "./strategy"
 
 module Sidekiq
   module Throttled
@@ -14,8 +13,6 @@ module Sidekiq
       @aliases    = {}
 
       class << self
-        include Utils
-
         # Adds strategy to the registry.
         #
         # @param (see Strategy#initialize)
@@ -105,9 +102,7 @@ module Sidekiq
         # @param name [Class, #to_s]
         # @return [Strategy, nil]
         def find_by_class(name)
-          return unless Throttled.configuration.inherit_strategies?
-
-          const = name.is_a?(Class) ? name : constantize(name)
+          const = name.is_a?(Class) ? name : Object.const_get(name)
           return unless const.is_a?(Class)
 
           const.ancestors.each do |m|
@@ -115,6 +110,8 @@ module Sidekiq
             return strategy if strategy
           end
 
+          nil
+        rescue NameError
           nil
         end
       end

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

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

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

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require "redis/prescription"
+require "redis_prescription"
 
-require "sidekiq/throttled/strategy/base"
+require_relative "./base"
 
 module Sidekiq
   module Throttled
@@ -20,7 +20,7 @@ module Sidekiq
         #       PUSH(@key, @jid)
         #       return 0
         #     end
-        SCRIPT = Redis::Prescription.read "#{__dir__}/concurrency.lua"
+        SCRIPT = RedisPrescription.new(File.read("#{__dir__}/concurrency.lua"))
         private_constant :SCRIPT
 
         # @param [#to_s] strategy_key
@@ -49,9 +49,7 @@ module Sidekiq
           keys = [key(job_args)]
           argv = [jid.to_s, job_limit, @ttl, Time.now.to_f]
 
-          Sidekiq.redis do |redis|
-            1 == SCRIPT.eval(redis, :keys => keys, :argv => argv)
-          end
+          Sidekiq.redis { |redis| 1 == SCRIPT.call(redis, keys: keys, argv: argv) }
         end
 
         # @return [Integer] Current count of jobs

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

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require "redis/prescription"
+require "redis_prescription"
 
-require "sidekiq/throttled/strategy/base"
+require_relative "./base"
 
 module Sidekiq
   module Throttled
@@ -30,7 +30,7 @@ module Sidekiq
         #
         #     increase!
         #     return 0
-        SCRIPT = Redis::Prescription.read "#{__dir__}/threshold.lua"
+        SCRIPT = RedisPrescription.new(File.read("#{__dir__}/threshold.lua"))
         private_constant :SCRIPT
 
         # @param [#to_s] strategy_key
@@ -66,9 +66,7 @@ module Sidekiq
           keys = [key(job_args)]
           argv = [job_limit, period(job_args), Time.now.to_f]
 
-          Sidekiq.redis do |redis|
-            1 == SCRIPT.eval(redis, :keys => keys, :argv => argv)
-          end
+          Sidekiq.redis { |redis| 1 == SCRIPT.call(redis, keys: keys, argv: argv) }
         end
 
         # @return [Integer] Current count of jobs

data/lib/sidekiq/throttled/strategy.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 # internal
-require "sidekiq/throttled/errors"
-require "sidekiq/throttled/strategy_collection"
-require "sidekiq/throttled/strategy/concurrency"
-require "sidekiq/throttled/strategy/threshold"
+require_relative "./errors"
+require_relative "./strategy_collection"
+require_relative "./strategy/concurrency"
+require_relative "./strategy/threshold"
 
 module Sidekiq
   module Throttled
@@ -35,14 +35,14 @@ module Sidekiq
         @observer = observer
 
         @concurrency = StrategyCollection.new(concurrency,
-          :strategy   => Concurrency,
-          :name       => name,
-          :key_suffix => key_suffix)
+          strategy:   Concurrency,
+          name:       name,
+          key_suffix: key_suffix)
 
         @threshold = StrategyCollection.new(threshold,
-          :strategy   => Threshold,
-          :name       => name,
-          :key_suffix => key_suffix)
+          strategy:   Threshold,
+          name:       name,
+          key_suffix: key_suffix)
 
         return if @concurrency.any? || @threshold.any?
 

data/lib/sidekiq/throttled/strategy_collection.rb

@@ -19,16 +19,15 @@ module Sidekiq
       # @param [#to_s] name
       # @param [#call] key_suffix Dynamic key suffix generator.
       def initialize(strategies, strategy:, name:, key_suffix:)
-        strategies = (strategies.is_a?(Hash) ? [strategies] : Array(strategies))
-        @strategies = strategies.map do |options|
+        @strategies = (strategies.is_a?(Hash) ? [strategies] : Array(strategies)).map do |options|
           make_strategy(strategy, name, key_suffix, options)
         end
       end
 
       # @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
@@ -38,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
@@ -61,7 +60,7 @@ module Sidekiq
         return unless options
 
         strategy.new("throttled:#{name}",
-          :key_suffix => key_suffix,
+          key_suffix: key_suffix,
           **options)
       end
     end

data/lib/sidekiq/throttled/version.rb

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

data/lib/sidekiq/throttled/web.rb

@@ -8,9 +8,8 @@ require "sidekiq"
 require "sidekiq/web"
 
 # internal
-require "sidekiq/throttled/registry"
-require "sidekiq/throttled/web/stats"
-require "sidekiq/throttled/web/summary_fix"
+require_relative "./registry"
+require_relative "./web/stats"
 
 module Sidekiq
   module Throttled
@@ -18,31 +17,11 @@ module Sidekiq
     module Web
       VIEWS         = Pathname.new(__dir__).join("web")
       THROTTLED_TPL = VIEWS.join("throttled.html.erb").read.freeze
-      QUEUES_TPL    = VIEWS.join("queues.html.erb").read.freeze
 
       class << self
-        # Replace default Queues tab with enhanced one.
-        def enhance_queues_tab!
-          SummaryFix.enabled = true
-          Sidekiq::Web::DEFAULT_TABS["Queues"] = "enhanced-queues"
-          Sidekiq::Web.tabs.delete("Enhanced Queues")
-        end
-
-        # Restore original Queues tab.
-        #
-        # @api There's next to absolutely no value in this method for real
-        #   users. The only it's purpose is to restore virgin state in specs.
-        def restore_queues_tab!
-          SummaryFix.enabled = false
-          Sidekiq::Web::DEFAULT_TABS["Queues"] = "queues"
-          Sidekiq::Web.tabs["Enhanced Queues"] = "enhanced-queues"
-        end
-
         # @api private
         def registered(app)
-          SummaryFix.apply! app
           register_throttled_tab app
-          register_enhanced_queues_tab app
         end
 
         private
@@ -55,27 +34,6 @@ module Sidekiq
             redirect "#{root_path}throttled"
           end
         end
-
-        # rubocop:disable Metrics/AbcSize
-        def register_enhanced_queues_tab(app) # rubocop:disable Metrics/MethodLength
-          pauser = QueuesPauser.instance
-
-          app.get("/enhanced-queues") do
-            @queues = Sidekiq::Queue.all
-            erb QUEUES_TPL.dup
-          end
-
-          app.post("/enhanced-queues/:name") do
-            case params[:action]
-            when "delete" then Sidekiq::Queue.new(params[:name]).clear
-            when "pause"  then pauser.pause!(params[:name])
-            else               pauser.resume!(params[:name])
-            end
-
-            redirect "#{root_path}enhanced-queues"
-          end
-        end
-        # rubocop:enable Metrics/AbcSize
       end
     end
   end
@@ -83,4 +41,3 @@ end
 
 Sidekiq::Web.register Sidekiq::Throttled::Web
 Sidekiq::Web.tabs["Throttled"] = "throttled"
-Sidekiq::Web.tabs["Enhanced Queues"] = "enhanced-queues"

data/lib/sidekiq/throttled/worker.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "sidekiq/throttled/job"
+require_relative "./job"
 
 module Sidekiq
   module Throttled

data/lib/sidekiq/throttled.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 
-# 3rd party
 require "sidekiq"
 
-# internal
-require "sidekiq/throttled/version"
-require "sidekiq/throttled/communicator"
-require "sidekiq/throttled/configuration"
-require "sidekiq/throttled/queues_pauser"
-require "sidekiq/throttled/registry"
-require "sidekiq/throttled/job"
-require "sidekiq/throttled/worker"
-require "sidekiq/throttled/utils"
+require_relative "./throttled/config"
+require_relative "./throttled/cooldown"
+require_relative "./throttled/job"
+require_relative "./throttled/message"
+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"
 
 # @see https://github.com/mperham/sidekiq/
 module Sidekiq
@@ -20,7 +20,6 @@ module Sidekiq
   # Just add somewhere in your bootstrap:
   #
   #     require "sidekiq/throttled"
-  #     Sidekiq::Throttled.setup!
   #
   # Once you've done that you can include {Sidekiq::Throttled::Job} to your
   # job classes and configure throttling:
@@ -46,28 +45,29 @@ module Sidekiq
     MUTEX = Mutex.new
     private_constant :MUTEX
 
-    class << self
-      include Utils
+    @config   = Config.new.freeze
+    @cooldown = Cooldown[@config]
 
-      # @return [Configuration]
-      def configuration
-        @configuration ||= Configuration.new
-      end
+    class << self
+      # @api internal
+      #
+      # @return [Cooldown, nil]
+      attr_reader :cooldown
 
-      # Hooks throttler into sidekiq.
+      # @example
+      #   Sidekiq::Throttled.configure do |config|
+      #     config.cooldown_period = nil # Disable queues cooldown manager
+      #   end
       #
-      # @return [void]
-      def setup!
-        Communicator.instance.setup!
-        QueuesPauser.instance.setup!
+      # @yieldparam config [Config]
+      def configure
+        MUTEX.synchronize do
+          config = @config.dup
 
-        Sidekiq.configure_server do |config|
-          setup_strategy!(config)
+          yield config
 
-          require "sidekiq/throttled/middleware"
-          config.server_middleware do |chain|
-            chain.add Sidekiq::Throttled::Middleware
-          end
+          @config   = config.freeze
+          @cooldown = Cooldown[@config]
         end
       end
 
@@ -76,56 +76,35 @@ module Sidekiq
       # @param [String] message Job's JSON payload
       # @return [Boolean]
       def throttled?(message)
-        message = JSON.parse message
-        job = message.fetch("wrapped") { message.fetch("class") { return false } }
-        jid = message.fetch("jid") { return false }
+        message = Message.new(message)
+        return false unless message.job_class && message.job_id
 
-        preload_constant! job
-
-        Registry.get job do |strategy|
-          return strategy.throttled?(jid, *message["args"])
+        Registry.get(message.job_class) do |strategy|
+          return strategy.throttled?(message.job_id, *message.job_args)
         end
 
         false
-      rescue
+      rescue StandardError
         false
       end
 
-      private
-
-      # @return [void]
-      def setup_strategy!(sidekiq_config)
-        require "sidekiq/throttled/fetch"
-
-        sidekiq_version = Gem::Version.new(Sidekiq::VERSION)
-
-        # https://github.com/mperham/sidekiq/commit/67daa7a408b214d593100f782271ed108686c147
-        sidekiq_config = sidekiq_config.options if sidekiq_version < Gem::Version.new("6.5.0")
+      # @deprecated Will be removed in 2.0.0
+      def setup!
+        warn "Sidekiq::Throttled.setup! was deprecated"
 
-        # https://github.com/mperham/sidekiq/commit/fce05c9d4b4c0411c982078a4cf3a63f20f739bc
-        sidekiq_config[:fetch] =
-          if Gem::Version.new(Sidekiq::VERSION) < Gem::Version.new("6.1.0")
-            Sidekiq::Throttled::Fetch
-          else
-            Sidekiq::Throttled::Fetch.new(sidekiq_config)
+        Sidekiq.configure_server do |config|
+          config.server_middleware do |chain|
+            chain.remove(Sidekiq::Throttled::Middlewares::Server)
+            chain.add(Sidekiq::Throttled::Middlewares::Server)
           end
-      end
-
-      # Tries to preload constant by it's name once.
-      #
-      # Somehow, sometimes, some classes are not eager loaded upon Rails init,
-      # leading to throttling config not being registered prior job perform.
-      # And that leaves us with concurrency limit + 1 situation upon Sidekiq
-      # server restart (becomes normal after all Sidekiq processes handled
-      # at leas onr job of that class).
-      #
-      # @return [void]
-      def preload_constant!(job)
-        MUTEX.synchronize do
-          @preloaded      ||= {}
-          @preloaded[job] ||= constantize(job) || true
         end
       end
     end
   end
+
+  configure_server do |config|
+    config.server_middleware do |chain|
+      chain.add(Sidekiq::Throttled::Middlewares::Server)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-throttled
 version: !ruby/object:Gem::Version
-  version: 0.16.2
+  version: 1.4.0
 platform: ruby
 authors:
 - Alexey Zapparov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-19 00:00:00.000000000 Z
+date: 2024-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -16,100 +16,62 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: redis-prescription
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.0'
-description: Concurrency and threshold throttling for Sidekiq.
+        version: '6.5'
+description:
 email:
 - alexey@zapparov.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".coveralls.yml"
-- ".github/dependabot.yml"
-- ".github/workflows/ci.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".rubocop_todo.yml"
-- ".travis.yml"
-- ".yardopts"
-- Appraisals
-- CHANGES.md
-- Gemfile
-- Guardfile
-- LICENSE.md
-- README.md
-- Rakefile
-- gemfiles/sidekiq_6.0.gemfile
-- gemfiles/sidekiq_6.1.gemfile
-- gemfiles/sidekiq_6.2.gemfile
-- gemfiles/sidekiq_6.3.gemfile
-- gemfiles/sidekiq_6.4.gemfile
-- gemfiles/sidekiq_6.5.gemfile
+- LICENSE.txt
+- README.adoc
 - lib/sidekiq/throttled.rb
-- lib/sidekiq/throttled/communicator.rb
-- lib/sidekiq/throttled/communicator/callbacks.rb
-- lib/sidekiq/throttled/communicator/exception_handler.rb
-- lib/sidekiq/throttled/communicator/listener.rb
-- lib/sidekiq/throttled/configuration.rb
+- lib/sidekiq/throttled/config.rb
+- lib/sidekiq/throttled/cooldown.rb
 - lib/sidekiq/throttled/errors.rb
-- lib/sidekiq/throttled/expirable_list.rb
-- lib/sidekiq/throttled/fetch.rb
-- lib/sidekiq/throttled/fetch/unit_of_work.rb
+- lib/sidekiq/throttled/expirable_set.rb
 - lib/sidekiq/throttled/job.rb
-- lib/sidekiq/throttled/middleware.rb
-- lib/sidekiq/throttled/patches/queue.rb
-- lib/sidekiq/throttled/queue_name.rb
-- lib/sidekiq/throttled/queues_pauser.rb
+- lib/sidekiq/throttled/message.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
@@ -118,27 +80,19 @@ files:
 - lib/sidekiq/throttled/strategy/threshold.lua
 - lib/sidekiq/throttled/strategy/threshold.rb
 - lib/sidekiq/throttled/strategy_collection.rb
-- lib/sidekiq/throttled/testing.rb
-- lib/sidekiq/throttled/utils.rb
 - lib/sidekiq/throttled/version.rb
 - lib/sidekiq/throttled/web.rb
-- lib/sidekiq/throttled/web/queues.html.erb
 - lib/sidekiq/throttled/web/stats.rb
-- lib/sidekiq/throttled/web/summary_fix.js
-- lib/sidekiq/throttled/web/summary_fix.rb
 - lib/sidekiq/throttled/web/throttled.html.erb
 - lib/sidekiq/throttled/worker.rb
-- rubocop/layout.yml
-- rubocop/lint.yml
-- rubocop/metrics.yml
-- rubocop/performance.yml
-- rubocop/rspec.yml
-- rubocop/style.yml
-- sidekiq-throttled.gemspec
 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.4.0
+  bug_tracker_uri: https://github.com/ixti/sidekiq-throttled/issues
+  changelog_uri: https://github.com/ixti/sidekiq-throttled/blob/v1.4.0/CHANGES.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -155,8 +109,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.5.4
 signing_key:
 specification_version: 4
-summary: Concurrency and threshold throttling for Sidekiq.
+summary: Concurrency and rate-limit throttling for Sidekiq
 test_files: []

data/.coveralls.yml

@@ -1 +0,0 @@
-service_name: travis-ci

data/.github/dependabot.yml

@@ -1,12 +0,0 @@
-# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
-
-version: 2
-updates:
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule:
-      interval: "daily"
-  - package-ecosystem: "bundler"
-    directory: "/"
-    schedule:
-      interval: "daily"