sidekiq-throttled 0.11.0 → 0.15.0

data/lib/sidekiq/throttled/strategy.rb

@@ -2,6 +2,7 @@
 
 # internal
 require "sidekiq/throttled/errors"
+require "sidekiq/throttled/strategy_collection"
 require "sidekiq/throttled/strategy/concurrency"
 require "sidekiq/throttled/strategy/threshold"
 
@@ -30,15 +31,20 @@ module Sidekiq
       #   See keyword args of {Strategy::Threshold#initialize} for details.
       # @param [#call] key_suffix Dynamic key suffix generator.
       # @param [#call] observer Process called after throttled.
-      def initialize(
-        name,
-        concurrency: nil, threshold: nil, key_suffix: nil, observer: nil
-      )
-        @observer    = observer
-        @concurrency = make_strategy(Concurrency, name, key_suffix, concurrency)
-        @threshold   = make_strategy(Threshold, name, key_suffix, threshold)
+      def initialize(name, concurrency: nil, threshold: nil, key_suffix: nil, observer: nil) # rubocop:disable Metrics/MethodLength
+        @observer = observer
 
-        return if @concurrency || @threshold
+        @concurrency = StrategyCollection.new(concurrency,
+          :strategy   => Concurrency,
+          :name       => name,
+          :key_suffix => key_suffix)
+
+        @threshold = StrategyCollection.new(threshold,
+          :strategy   => Threshold,
+          :name       => name,
+          :key_suffix => key_suffix)
+
+        return if @concurrency.any? || @threshold.any?
 
         raise ArgumentError, "Neither :concurrency nor :threshold given"
       end
@@ -60,6 +66,7 @@ module Sidekiq
 
         if @threshold&.throttled?(*job_args)
           @observer&.call(:threshold, *job_args)
+
           finalize!(jid, *job_args)
           return true
         end
@@ -79,18 +86,6 @@ module Sidekiq
         @concurrency&.reset!
         @threshold&.reset!
       end
-
-      private
-
-      # @return [Base, nil]
-      def make_strategy(strategy, name, key_suffix, options)
-        return unless options
-
-        strategy.new("throttled:#{name}", {
-          :key_suffix => key_suffix,
-          **options
-        })
-      end
     end
   end
 end

data/lib/sidekiq/throttled/strategy_collection.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+# internal
+module Sidekiq
+  module Throttled
+    # Collection which transparently group several meta-strategies of one kind
+    #
+    # @private
+    class StrategyCollection
+      include Enumerable
+
+      attr_reader :strategies
+
+      # @param [Hash, Array, nil] strategies Concurrency or Threshold options
+      #   or array of options.
+      #   See keyword args of {Strategy::Concurrency#initialize} for details.
+      #   See keyword args of {Strategy::Threshold#initialize} for details.
+      # @param [Class] strategy class of strategy: Concurrency or Threshold
+      # @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|
+          make_strategy(strategy, name, key_suffix, options)
+        end
+      end
+
+      # @param [#call] block
+      # Iterates each strategy in collection
+      def each(&block)
+        @strategies.each(&block)
+      end
+
+      # @return [Boolean] whenever any strategy in collection has dynamic config
+      def dynamic?
+        any?(&:dynamic?)
+      end
+
+      # @return [Boolean] whenever job is throttled or not
+      # by any strategy in collection.
+      def throttled?(*args)
+        any? { |s| s.throttled?(*args) }
+      end
+
+      # Marks job as being processed.
+      # @return [void]
+      def finalize!(*args)
+        each { |c| c.finalize!(*args) }
+      end
+
+      # Resets count of jobs of all avaliable strategies
+      # @return [void]
+      def reset!
+        each(&:reset!)
+      end
+
+      private
+
+      # @return [Base, nil]
+      def make_strategy(strategy, name, key_suffix, options)
+        return unless options
+
+        strategy.new("throttled:#{name}",
+          :key_suffix => key_suffix,
+          **options)
+      end
+    end
+  end
+end

data/lib/sidekiq/throttled/utils.rb

@@ -9,7 +9,7 @@ module Sidekiq
       # @param name [#to_s] Constant name
       # @return [Object, nil] Resolved constant or nil if failed.
       def constantize(name)
-        name.to_s.sub(/^::/, "").split("::").inject(Object, &:const_get)
+        name.to_s.sub(%r{^::}, "").split("::").inject(Object, &:const_get)
       rescue NameError
         Sidekiq.logger.warn { "Failed to constantize: #{name}" }
         nil

data/lib/sidekiq/throttled/version.rb

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

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

@@ -14,9 +14,7 @@ module Sidekiq
 
         # @param [Strategy::Concurrency, Strategy::Threshold] strategy
         def initialize(strategy)
-          if strategy&.dynamic?
-            raise ArgumentError, "Can't handle dynamic strategies"
-          end
+          raise ArgumentError, "Can't handle dynamic strategies" if strategy&.dynamic?
 
           @strategy = strategy
         end
@@ -27,9 +25,7 @@ module Sidekiq
 
           html = humanize_integer(@strategy.limit) << " jobs"
 
-          if @strategy.respond_to? :period
-            html << " per " << humanize_duration(@strategy.period)
-          end
+          html << " per " << humanize_duration(@strategy.period) if @strategy.respond_to?(:period)
 
           html << "<br />" << colorize_count(@strategy.count, @strategy.limit)
         end

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

@@ -4,14 +4,15 @@ module Sidekiq
   module Throttled
     module Web
       module SummaryFix
-        JAVASCRIPT = [File.read(__FILE__.sub(/\.rb$/, ".js")).freeze].freeze
+        JAVASCRIPT = [File.read(File.expand_path("summary_fix.js", __dir__)).freeze].freeze
         HEADERS    = { "Content-Type" => "application/javascript" }.freeze
 
         class << self
           attr_accessor :enabled
 
           def apply!(app)
-            Sidekiq::WebAction.send(:prepend, SummaryFix)
+            Sidekiq::WebAction.prepend SummaryFix
+
             app.get("/throttled/summary_fix") do
               [200, HEADERS.dup, JAVASCRIPT.dup]
             end

data/lib/sidekiq/throttled/web/throttled.html.erb

@@ -14,10 +14,14 @@
       <tr>
         <td style="vertical-align:middle;"><%= name %></td>
         <td style="vertical-align:middle;text-align:center;">
-          <%= Sidekiq::Throttled::Web::Stats.new(strategy.concurrency).to_html %>
+          <% strategy.concurrency.each do |concurrency| %>
+            <%= Sidekiq::Throttled::Web::Stats.new(concurrency).to_html %>
+          <% end %>
         </td>
         <td style="vertical-align:middle;text-align:center;">
-          <%= Sidekiq::Throttled::Web::Stats.new(strategy.threshold).to_html %>
+          <% 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">

data/lib/sidekiq/throttled/web.rb

@@ -57,7 +57,7 @@ module Sidekiq
         end
 
         # rubocop:disable Metrics/AbcSize
-        def register_enhanced_queues_tab(app)
+        def register_enhanced_queues_tab(app) # rubocop:disable Metrics/MethodLength
           pauser = QueuesPauser.instance
 
           app.get("/enhanced-queues") do

data/lib/sidekiq/throttled/worker.rb

@@ -77,7 +77,7 @@ module Sidekiq
           Registry.add(self, **kwargs)
         end
 
-        # Adds current worker to preconfigured throtttling strtegy. Allows
+        # Adds current worker to preconfigured throttling strategy. Allows
         # sharing same pool for multiple workers.
         #
         # First of all we need to create shared throttling strategy:
@@ -85,7 +85,7 @@ module Sidekiq
         #     # Create google_api throttling strategy
         #     Sidekiq::Throttled::Registry.add(:google_api, {
         #       :threshold => { :limit => 123, :period => 1.hour },
-        #       :concurrency => { :limit => 123 }
+        #       :concurrency => { :limit => 10 }
         #     })
         #
         # Now we can assign it to our workers:

data/lib/sidekiq/throttled.rb

@@ -61,8 +61,7 @@ module Sidekiq
         QueuesPauser.instance.setup!
 
         Sidekiq.configure_server do |config|
-          require "sidekiq/throttled/fetch"
-          Sidekiq.options[:fetch] = Sidekiq::Throttled::Fetch
+          setup_strategy!
 
           require "sidekiq/throttled/middleware"
           config.server_middleware do |chain|
@@ -93,6 +92,19 @@ module Sidekiq
 
       private
 
+      # @return [void]
+      def setup_strategy!
+        require "sidekiq/throttled/fetch"
+
+        # https://github.com/mperham/sidekiq/commit/fce05c9d4b4c0411c982078a4cf3a63f20f739bc
+        Sidekiq.options[:fetch] =
+          if Gem::Version.new(Sidekiq::VERSION) < Gem::Version.new("6.1.0")
+            Sidekiq::Throttled::Fetch
+          else
+            Sidekiq::Throttled::Fetch.new(Sidekiq.options)
+          end
+      end
+
       # Tries to preload constant by it's name once.
       #
       # Somehow, sometimes, some classes are not eager loaded upon Rails init,

data/sidekiq-throttled.gemspec

@@ -24,9 +24,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = ">= 2.6"
+
   spec.add_runtime_dependency "concurrent-ruby"
   spec.add_runtime_dependency "redis-prescription"
   spec.add_runtime_dependency "sidekiq"
 
-  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "bundler", ">= 2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-throttled
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Alexey V Zapparov
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-08-23 00:00:00.000000000 Z
+date: 2021-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -56,14 +56,14 @@ dependencies:
   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.
@@ -74,9 +74,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".coveralls.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".rubocop/layout.yml"
+- ".rubocop/lint.yml"
+- ".rubocop/metrics.yml"
+- ".rubocop/performance.yml"
+- ".rubocop/rspec.yml"
+- ".rubocop/style.yml"
 - ".rubocop_todo.yml"
 - ".travis.yml"
 - ".yardopts"
@@ -90,6 +97,10 @@ files:
 - gemfiles/sidekiq_5.0.gemfile
 - gemfiles/sidekiq_5.1.gemfile
 - gemfiles/sidekiq_5.2.gemfile
+- gemfiles/sidekiq_6.0.gemfile
+- gemfiles/sidekiq_6.1.gemfile
+- gemfiles/sidekiq_6.2.gemfile
+- gemfiles/sidekiq_6.3.gemfile
 - lib/sidekiq/throttled.rb
 - lib/sidekiq/throttled/communicator.rb
 - lib/sidekiq/throttled/communicator/callbacks.rb
@@ -110,6 +121,7 @@ files:
 - lib/sidekiq/throttled/strategy/concurrency.rb
 - 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
@@ -125,7 +137,7 @@ homepage: https://github.com/sensortower/sidekiq-throttled
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -133,15 +145,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Concurrency and threshold throttling for Sidekiq.
 test_files: []