sidekiq-throttled 0.10.0.alpha → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83591901b017e382b25575720fab1bbcc45ac9e81acec417da1a10cbfa333613
-  data.tar.gz: 1a135a2b18d51b644f7713cdd1d2bcad6ffe34b87ca93b11aa1336e2e1b91a8b
+  metadata.gz: 2b1f0237b14be26ff2b25aeaedd80e4029610cfa7c2be331827c5b865c338f48
+  data.tar.gz: 3a5be191a1f02b2ce21b766be820201b6f4d06b74323456412096a0beef38d11
 SHA512:
-  metadata.gz: 594b29b269f4b8c2351adf7f835cad04d974794ef596fdcd5492202c4e4f6af5d1a06b7ec67baf15a6d393aa2a60093cc7a536f87c8260f3681b25a817d94990
-  data.tar.gz: d4e9d76b8627c86ee7e399e563d7c9ce8bdbabc40444349a88ce88ea3bec136974505feb9b49d905bf47fc9aaf233270e9637ebca027d533e589ca93cc6cb2f5
+  metadata.gz: e9da0e99d328b6825ab3f47e1ea94c255717a01d05e28c90399aaf826a8d43a0e10de82baee329ddd8d846ac4e4ff0cb6f09ef11277fef2143972c50b2c3a55b
+  data.tar.gz: d73d011be01f319460fe87fda608aea9550e1f560bf778dfd5628874f0f074fc2020ad5e2f36ec8413a349c6dcd620f7aaa84a48f15e59dab8bf508e3e769354

data/.github/workflows/ci.yml

@@ -0,0 +1,56 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  rspec:
+    name: "rspec (ruby:${{ matrix.ruby }} sidekiq:${{ matrix.sidekiq }})"
+
+    strategy:
+      matrix:
+        ruby: [ "2.4", "2.5", "2.6", "2.7" ]
+        sidekiq: [ "5.0", "5.1", "5.2", "6.0" ]
+        exclude:
+          - { ruby: "2.4", sidekiq: "6.0" }
+
+    runs-on: ubuntu-latest
+
+    services:
+      redis:
+        image: redis
+        ports: ["6379:6379"]
+        options: "--entrypoint redis-server"
+
+    env:
+      GEMFILE: gemfiles/sidekiq_${{ matrix.sidekiq }}.gemfile
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: bundle install
+        run: bundle install --without development --jobs 4 --retry 3
+
+      - run: bundle exec rspec
+
+  rubocop:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "2.4"
+
+      - name: bundle install
+        run: bundle install --without development --jobs 4 --retry 3
+
+      - run: bundle exec rubocop

data/.rubocop.yml

@@ -8,30 +8,47 @@ require:
 
 AllCops:
   DisplayCopNames: true
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4
   Exclude:
     - "gemfiles/*"
 
 ## Layout ######################################################################
 
-Layout/AlignHash:
-  EnforcedHashRocketStyle: table
-
-Layout/AlignParameters:
+Layout/ArgumentAlignment:
   EnforcedStyle: with_fixed_indentation
 
-Layout/IndentArray:
+Layout/FirstArrayElementIndentation:
   EnforcedStyle: consistent
 
-Layout/IndentHash:
+Layout/FirstHashElementIndentation:
   EnforcedStyle: consistent
 
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+
+Layout/LineLength:
+  Max: 100
+
 Layout/MultilineMethodCallIndentation:
   EnforcedStyle: indented
 
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
 Layout/SpaceInLambdaLiteral:
   EnforcedStyle: require_space
 
+## Lint ########################################################################
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
 ## Metrics #####################################################################
 
 Metrics/BlockLength:
@@ -41,15 +58,24 @@ Metrics/BlockLength:
 
 ## Styles ######################################################################
 
-Style/BracesAroundHashParameters:
-  Enabled: false
-
 Style/Documentation:
   Enabled: false
 
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
 Style/HashSyntax:
   EnforcedStyle: hash_rockets
 
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
 # Follow your heart where it makes sense to use lambda or lambda literal.
 # Enforcing it makes some pieces of code look REALLY terrible, e.g. in
 # case of empty (noop) lambdas: `lambda { |_| }`.

data/.travis.yml

@@ -1,5 +1,4 @@
 language: ruby
-sudo: false
 
 services:
   - redis-server
@@ -9,8 +8,9 @@ cache: bundler
 before_install:
   - gem update --system
   - gem --version
-  - gem install bundler --no-rdoc --no-ri
+  - gem install bundler
   - bundle --version
+  # Install pahantomjs
   - mkdir travis-phantomjs
   - wget https://s3.amazonaws.com/travis-phantomjs/phantomjs-2.0.0-ubuntu-12.04.tar.bz2 -O $PWD/travis-phantomjs/phantomjs-2.0.0-ubuntu-12.04.tar.bz2
   - tar -xvf $PWD/travis-phantomjs/phantomjs-2.0.0-ubuntu-12.04.tar.bz2 -C $PWD/travis-phantomjs
@@ -19,15 +19,16 @@ before_install:
 install: bundle install --without development
 
 rvm:
-  - 2.3
   - 2.4
   - 2.5
+  - 2.6
+  - 2.7
 
 matrix:
   fast_finish: true
   include:
     -
-      rvm: 2.3
+      rvm: 2.4
       env: SUITE="rubocop"
       gemfile: Gemfile
 
@@ -35,3 +36,4 @@ gemfile:
   - gemfiles/sidekiq_5.0.gemfile
   - gemfiles/sidekiq_5.1.gemfile
   - gemfiles/sidekiq_5.2.gemfile
+  - gemfiles/sidekiq_6.0.gemfile

data/Appraisals

@@ -11,3 +11,11 @@ end
 appraise "sidekiq-5.2" do
   gem "sidekiq", "~> 5.2.0"
 end
+
+appraise "sidekiq-6.0" do
+  gem "sidekiq", "~> 6.0.0"
+end
+
+appraise "sidekiq-6.1" do
+  gem "sidekiq", "~> 6.1.0"
+end

data/CHANGES.md

@@ -1,3 +1,42 @@
+## 0.13.0 (2020-07-28)
+
+* [#85](https://github.com/sensortower/sidekiq-throttled/pull/85)
+  Add Sidekiq 6.1+ support.
+  ([@hmaack])
+
+## 0.12.0 (2020-06-22)
+
+* [#80](https://github.com/sensortower/sidekiq-throttled/pull/80)
+  Allow override cooldown timeout of queues with throttled jobs.
+  ([@vaot])
+
+* [#76](https://github.com/sensortower/sidekiq-throttled/pull/76)
+  Fix warnings on Ruby 2.7
+  ([@lenon])
+
+
+## 0.11.0 (2019-08-24)
+
+* [#59](https://github.com/sensortower/sidekiq-throttled/pull/59)
+  Add throttling observer.
+  ([@ogins57])
+
+
+## 0.10.0 (2019-06-22)
+
+* [#60](https://github.com/sensortower/sidekiq-throttled/pull/60)
+  Skip throttling check in redis if limit is 0.
+  ([@mstruve])
+
+* [#58](https://github.com/sensortower/sidekiq-throttled/pull/58)
+  Improve documentation bout TTL.
+  ([@ziaulrehman40])
+
+* Improve reliability of paused queues, by resyncing list of paused queues
+  on schedule.
+  ([@ixti])
+
+
 ## 0.9.0 (2018-09-11)
 
 * Add support of Sidekiq 5.2.x
@@ -176,3 +215,9 @@
 [@palanglung]: https://github.com/palanglung
 [@azach]: https://github.com/azach
 [@iporsut]: https://github.com/iporsut
+[@mstruve]: https://github.com/mstruve
+[@ziaulrehman40]: https://github.com/ziaulrehman40
+[@ogins57]: https://github.com/ogins57
+[@lenon]: https://github.com/lenon
+[@vaot]: https://github.com/vaot
+[@hmaack]: https://github.com/hmaack

data/Gemfile

@@ -5,8 +5,9 @@ source "https://rubygems.org"
 gem "appraisal"
 gem "rake"
 gem "rspec"
-gem "rubocop",       "~> 0.58.0", :require => false
-gem "rubocop-rspec", "~> 1.29.1", :require => false
+gem "rubocop",             "~> 0.82.0", :require => false
+gem "rubocop-performance", "~>1.5.2",   :require => false
+gem "rubocop-rspec",       "~> 1.39.0", :require => false
 gem "sidekiq"
 
 group :development do
@@ -17,13 +18,13 @@ group :development do
 end
 
 group :test do
+  gem "apparition"
   gem "capybara"
   gem "coveralls", :require => false
-  gem "poltergeist"
   gem "puma"
   gem "rack-test"
-  gem "simplecov", ">= 0.9"
-  gem "sinatra", "~> 1.4", ">= 1.4.6"
+  gem "simplecov"
+  gem "sinatra"
   gem "timecop"
 end
 

data/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2018 SensorTower Inc.
+Copyright (c) 2015-2020 SensorTower Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,14 +1,14 @@
 # Sidekiq::Throttled
 
-[![Gem Version](https://badge.fury.io/rb/sidekiq-throttled.svg)](http://rubygems.org/gems/sidekiq-throttled)
-[![Build Status](https://travis-ci.org/sensortower/sidekiq-throttled.svg?branch=master)](https://travis-ci.org/sensortower/sidekiq-throttled)
-[![Code Climate](https://codeclimate.com/github/sensortower/sidekiq-throttled.svg?branch=master)](https://codeclimate.com/github/sensortower/sidekiq-throttled)
-[![Coverage Status](https://coveralls.io/repos/github/sensortower/sidekiq-throttled/badge.svg?branch=master)](https://coveralls.io/github/sensortower/sidekiq-throttled?branch=master)
-[![API Docs](http://inch-ci.org/github/sensortower/sidekiq-throttled.svg?branch=master)](http://inch-ci.org/github/sensortower/sidekiq-throttled)
+[![Latest Version](https://badge.fury.io/rb/sidekiq-throttled.svg)](http://rubygems.org/gems/sidekiq-throttled)
+[![CI Status](https://github.com/sensortower/sidekiq-throttled/workflows/CI/badge.svg?branch=master)](https://github.com/sensortower/sidekiq-throttled/actions?query=workflow%3ACI+branch%3Amaster)
+[![Code Quality](https://codeclimate.com/github/sensortower/sidekiq-throttled.svg?branch=master)](https://codeclimate.com/github/sensortower/sidekiq-throttled)
+[![Code Coverage](https://coveralls.io/repos/github/sensortower/sidekiq-throttled/badge.svg?branch=master)](https://coveralls.io/github/sensortower/sidekiq-throttled?branch=master)
+[![API Docs Quality](http://inch-ci.org/github/sensortower/sidekiq-throttled.svg?branch=master)](http://inch-ci.org/github/sensortower/sidekiq-throttled)
+[![API Docs](https://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/gems/sidekiq-throttled)
 
 Concurrency and threshold throttling for [Sidekiq][sidekiq].
 
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -36,6 +36,9 @@ require "sidekiq/throttled"
 Sidekiq::Throttled.setup!
 ```
 
+Load order can be an issue if you are using other Sidekiq plugins and/or middleware.
+To prevent any problems, add the `.setup!` call to the bottom of your init file.
+
 Once you've done that you can include `Sidekiq::Throttled::Worker` to your
 job classes and configure throttling:
 
@@ -59,6 +62,38 @@ class MyWorker
 end
 ```
 
+### Observer
+
+You can specify an observer that will be called on throttling. To do so pass an
+`:observer` option with callable object:
+
+``` ruby
+class MyWorker
+  include Sidekiq::Worker
+  include Sidekiq::Throttled::Worker
+
+  MY_OBSERVER = lambda do |strategy, *args|
+    # do something
+  end
+
+  sidekiq_options :queue => :my_queue
+
+  sidekiq_throttle({
+    :concurrency => { :limit => 10 },
+    :threshold   => { :limit => 100, :period => 1.hour }
+    :observer    => MY_OBSERVER
+  })
+
+  def perform(*args)
+    # ...
+  end
+end
+```
+
+Observer will receive `strategy, *args` arguments, where `strategy` is a Symbol
+`:concurrency` or `:threshold`, and `*args` are the arguments that were passed
+to the job.
+
 
 ### Dynamic throttling
 
@@ -117,6 +152,25 @@ if you are using dynamic limit/period options. Otherwise you risk getting into
 some trouble.
 
 
+### Concurrency throttling fine-tuning
+
+Concurrency throttling is based on distributed locks. Those locks have default
+time to live (TTL) set to 15 minutes. If your job takes more than 15 minutes
+to finish, lock will be released and you might end up with more jobs running
+concurrently than you expect.
+
+This is done to avoid deadlocks - when by any reason (e.g. Sidekiq process was
+OOM-killed) cleanup middleware wasn't executed and locks were not released.
+
+If your job takes more than 15 minutes to complete, you can tune concurrency
+lock TTL to fit your needs:
+
+``` ruby
+# Set concurrency strategy lock TTL to 1 hour.
+sidekiq_throttle(:concurrency => { :limit => 20, :ttl => 1.hour.to_i })
+```
+
+
 ## Enhanced Queues list
 
 This gem provides ability to pause/resume queues from processing by workers.
@@ -155,9 +209,9 @@ end
 This library aims to support and is [tested against][travis] the following Ruby
 versions:
 
-* Ruby 2.3.x
 * Ruby 2.4.x
 * Ruby 2.5.x
+* Ruby 2.6.x
 
 If something doesn't work on one of these versions, it's a bug.
 
@@ -180,6 +234,8 @@ This library aims to support work with following [Sidekiq][sidekiq] versions:
 * Sidekiq 5.0.x
 * Sidekiq 5.1.x
 * Sidekiq 5.2.x
+* Sidekiq 6.0.x
+* Sidekiq 6.1.x
 
 
 ## Contributing
@@ -207,7 +263,7 @@ Don't forget to run `appraisal update` after any changes to `Gemfile`.
 
 ## Copyright
 
-Copyright (c) 2015-2018 SensorTower Inc.
+Copyright (c) 2015-2020 SensorTower Inc.
 See LICENSE.md for further details.
 
 

data/gemfiles/sidekiq_5.0.gemfile

@@ -5,8 +5,9 @@ source "https://rubygems.org"
 gem "appraisal"
 gem "rake"
 gem "rspec"
-gem "rubocop", "~> 0.58.0", require: false
-gem "rubocop-rspec", "~> 1.29.1", require: false
+gem "rubocop", "~> 0.82.0", require: false
+gem "rubocop-performance", "~>1.5.2", require: false
+gem "rubocop-rspec", "~> 1.39.0", require: false
 gem "sidekiq", "~> 5.0.0"
 
 group :development do
@@ -17,13 +18,13 @@ group :development do
 end
 
 group :test do
+  gem "apparition"
   gem "capybara"
   gem "coveralls", require: false
-  gem "poltergeist"
   gem "puma"
   gem "rack-test"
-  gem "simplecov", ">= 0.9"
-  gem "sinatra", "~> 1.4", ">= 1.4.6"
+  gem "simplecov"
+  gem "sinatra"
   gem "timecop"
 end
 

data/gemfiles/sidekiq_5.1.gemfile

@@ -5,8 +5,9 @@ source "https://rubygems.org"
 gem "appraisal"
 gem "rake"
 gem "rspec"
-gem "rubocop", "~> 0.58.0", require: false
-gem "rubocop-rspec", "~> 1.29.1", require: false
+gem "rubocop", "~> 0.82.0", require: false
+gem "rubocop-performance", "~>1.5.2", require: false
+gem "rubocop-rspec", "~> 1.39.0", require: false
 gem "sidekiq", "~> 5.1.0"
 
 group :development do
@@ -17,13 +18,13 @@ group :development do
 end
 
 group :test do
+  gem "apparition"
   gem "capybara"
   gem "coveralls", require: false
-  gem "poltergeist"
   gem "puma"
   gem "rack-test"
-  gem "simplecov", ">= 0.9"
-  gem "sinatra", "~> 1.4", ">= 1.4.6"
+  gem "simplecov"
+  gem "sinatra"
   gem "timecop"
 end
 

data/gemfiles/sidekiq_5.2.gemfile

@@ -5,8 +5,9 @@ source "https://rubygems.org"
 gem "appraisal"
 gem "rake"
 gem "rspec"
-gem "rubocop", "~> 0.58.0", require: false
-gem "rubocop-rspec", "~> 1.29.1", require: false
+gem "rubocop", "~> 0.82.0", require: false
+gem "rubocop-performance", "~>1.5.2", require: false
+gem "rubocop-rspec", "~> 1.39.0", require: false
 gem "sidekiq", "~> 5.2.0"
 
 group :development do
@@ -17,13 +18,13 @@ group :development do
 end
 
 group :test do
+  gem "apparition"
   gem "capybara"
   gem "coveralls", require: false
-  gem "poltergeist"
   gem "puma"
   gem "rack-test"
-  gem "simplecov", ">= 0.9"
-  gem "sinatra", "~> 1.4", ">= 1.4.6"
+  gem "simplecov"
+  gem "sinatra"
   gem "timecop"
 end
 

data/gemfiles/sidekiq_6.0.gemfile

@@ -0,0 +1,31 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "rake"
+gem "rspec"
+gem "rubocop", "~> 0.82.0", require: false
+gem "rubocop-performance", "~>1.5.2", require: false
+gem "rubocop-rspec", "~> 1.39.0", require: false
+gem "sidekiq", "~> 6.0.0"
+
+group :development do
+  gem "byebug"
+  gem "guard", require: false
+  gem "guard-rspec", require: false
+  gem "guard-rubocop", require: false
+end
+
+group :test do
+  gem "apparition"
+  gem "capybara"
+  gem "coveralls", require: false
+  gem "puma"
+  gem "rack-test"
+  gem "simplecov"
+  gem "sinatra"
+  gem "timecop"
+end
+
+gemspec path: "../"

data/gemfiles/sidekiq_6.1.gemfile

@@ -0,0 +1,31 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "rake"
+gem "rspec"
+gem "rubocop", "~> 0.82.0", require: false
+gem "rubocop-performance", "~>1.5.2", require: false
+gem "rubocop-rspec", "~> 1.39.0", require: false
+gem "sidekiq", "~> 6.1.0"
+
+group :development do
+  gem "byebug"
+  gem "guard", require: false
+  gem "guard-rspec", require: false
+  gem "guard-rubocop", require: false
+end
+
+group :test do
+  gem "apparition"
+  gem "capybara"
+  gem "coveralls", require: false
+  gem "puma"
+  gem "rack-test"
+  gem "simplecov"
+  gem "sinatra"
+  gem "timecop"
+end
+
+gemspec path: "../"

data/lib/sidekiq/throttled.rb

@@ -6,9 +6,11 @@ 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/worker"
+require "sidekiq/throttled/utils"
 
 # @see https://github.com/mperham/sidekiq/
 module Sidekiq
@@ -44,6 +46,13 @@ module Sidekiq
     private_constant :MUTEX
 
     class << self
+      include Utils
+
+      # @return [Configuration]
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
       # Hooks throttler into sidekiq.
       #
       # @return [void]
@@ -52,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|
@@ -84,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,
@@ -99,16 +120,6 @@ module Sidekiq
           @preloaded[job] ||= constantize(job) || true
         end
       end
-
-      # Resolve constant from it's name
-      def constantize(str)
-        str.sub(/^::/, "").split("::").inject(Object) do |const, name|
-          const.const_get(name)
-        end
-      rescue
-        Sidekiq.logger.warn { "Failed to constantize: #{str}" }
-        nil
-      end
     end
   end
 end

data/lib/sidekiq/throttled/communicator/callbacks.rb

@@ -43,6 +43,7 @@ module Sidekiq
         # @return [self]
         def on(event, &handler)
           raise ArgumentError, "No block given" unless handler
+
           @mutex.synchronize { @handlers[event.to_s] << handler }
           self
         end

data/lib/sidekiq/throttled/configuration.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Sidekiq
+  module Throttled
+    # Configuration holder.
+    class Configuration
+      # Class constructor.
+      def initialize
+        reset!
+      end
+
+      # Reset configuration to defaults.
+      #
+      # @return [self]
+      def reset!
+        @inherit_strategies = false
+
+        self
+      end
+
+      # Instructs throttler to lookup strategies in parent classes, if there's
+      # no own strategy:
+      #
+      #     class Foo
+      #       include Sidekiq::Worker
+      #       include Sidekiq::Worker::Throttled
+      #
+      #       sidekiq_throttle :concurrency => { :limit => 42 }
+      #     end
+      #
+      #     class Bar < Foo
+      #     end
+      #
+      # By default in the example above, `Bar` won't have throttling options.
+      # Set this flag to `true` to enable this lookup in initializer, after
+      # that `Bar` will use `Foo` throttling bucket.
+      def inherit_strategies=(value)
+        @inherit_strategies = value ? true : false
+      end
+
+      # Whenever throttled workers should inherit parent's strategies or not.
+      # Default: `false`.
+      #
+      # @return [Boolean]
+      def inherit_strategies?
+        @inherit_strategies
+      end
+    end
+  end
+end

data/lib/sidekiq/throttled/expirable_list.rb

@@ -11,7 +11,7 @@ module Sidekiq
     #
     # ## Implementation
     #
-    # Internally list holds an array of arrays. Thus ecah element is a tuple of
+    # Internally list holds an array of arrays. Thus each element is a tuple of
     # monotonic timestamp (when element was added) and element itself:
     #
     #     [

data/lib/sidekiq/throttled/fetch.rb

@@ -12,16 +12,47 @@ module Sidekiq
     #
     # @private
     class Fetch
+      module BulkRequeue
+        # Requeues all given units as a single operation.
+        #
+        # @see http://www.rubydoc.info/github/redis/redis-rb/master/Redis#pipelined-instance_method
+        # @param [Array<Fetch::UnitOfWork>] units
+        # @return [void]
+        def bulk_requeue(units, _options)
+          return if units.empty?
+
+          Sidekiq.logger.debug { "Re-queueing terminated jobs" }
+          Sidekiq.redis { |conn| conn.pipelined { units.each(&:requeue) } }
+          Sidekiq.logger.info("Pushed #{units.size} jobs back to Redis")
+        rescue => e
+          Sidekiq.logger.warn("Failed to requeue #{units.size} jobs: #{e}")
+        end
+      end
+
+      # https://github.com/mperham/sidekiq/commit/fce05c9d4b4c0411c982078a4cf3a63f20f739bc
+      if Gem::Version.new(Sidekiq::VERSION) < Gem::Version.new("6.1.0")
+        extend BulkRequeue
+      else
+        include BulkRequeue
+      end
       # Timeout to sleep between fetch retries in case of no job received,
       # as well as timeout to wait for redis to give us something to work.
       TIMEOUT = 2
 
       # Initializes fetcher instance.
+      # @param options [Hash]
+      # @option options [Integer] :throttled_queue_cooldown (TIMEOUT)
+      #   Min delay in seconds before queue will be polled again after
+      #   throttled job.
+      # @option options [Boolean] :strict (false)
+      # @option options [Array<#to_s>] :queue
       def initialize(options)
-        @paused = ExpirableList.new(TIMEOUT)
+        @paused = ExpirableList.new(options.fetch(:throttled_queue_cooldown, TIMEOUT))
 
-        @strict = options[:strict]
-        @queues = options[:queues].map { |q| QueueName.expand q }
+        @strict = options.fetch(:strict, false)
+        @queues = options.fetch(:queues).map { |q| QueueName.expand q }
+
+        raise ArgumentError, "empty :queues" if @queues.empty?
 
         @queues.uniq! if @strict
       end
@@ -42,23 +73,6 @@ module Sidekiq
         nil
       end
 
-      class << self
-        # Requeues all given units as a single operation.
-        #
-        # @see http://www.rubydoc.info/github/redis/redis-rb/master/Redis#pipelined-instance_method
-        # @param [Array<Fetch::UnitOfWork>] units
-        # @return [void]
-        def bulk_requeue(units, _options)
-          return if units.empty?
-
-          Sidekiq.logger.debug { "Re-queueing terminated jobs" }
-          Sidekiq.redis { |conn| conn.pipelined { units.each(&:requeue) } }
-          Sidekiq.logger.info("Pushed #{units.size} jobs back to Redis")
-        rescue => e
-          Sidekiq.logger.warn("Failed to requeue #{units.size} jobs: #{e}")
-        end
-      end
-
       private
 
       # Tries to pop pair of `queue` and job `message` out of sidekiq queues.

data/lib/sidekiq/throttled/queue_name.rb

@@ -7,7 +7,7 @@ module Sidekiq
     # @private
     module QueueName
       # RegExp used to stip out any redisr-namespace prefixes with `queue:`.
-      QUEUE_NAME_PREFIX_RE = /.*queue:/
+      QUEUE_NAME_PREFIX_RE = /.*queue:/.freeze
       private_constant :QUEUE_NAME_PREFIX_RE
 
       class << self
@@ -27,7 +27,7 @@ module Sidekiq
         # @param [#to_s]
         # @return [String]
         def normalize(queue)
-          queue.to_s.sub(QUEUE_NAME_PREFIX_RE, "")
+          -queue.to_s.sub(QUEUE_NAME_PREFIX_RE, "")
         end
 
         # Prepends `queue:` prefix to given `queue` name.
@@ -38,7 +38,7 @@ module Sidekiq
         # @param [#to_s] queue Queue name
         # @return [String]
         def expand(queue)
-          "queue:#{queue}"
+          -"queue:#{queue}"
         end
       end
     end

data/lib/sidekiq/throttled/queues_pauser.rb

@@ -2,6 +2,7 @@
 
 require "set"
 require "singleton"
+require "concurrent/timer_task"
 
 require "sidekiq/throttled/patches/queue"
 require "sidekiq/throttled/communicator"
@@ -55,7 +56,7 @@ module Sidekiq
 
           @communicator.receive(PAUSE_MESSAGE, &method(:add))
           @communicator.receive(RESUME_MESSAGE, &method(:delete))
-          @communicator.ready(&method(:sync!))
+          @communicator.ready { sync! }
         end
       end
 
@@ -64,7 +65,10 @@ module Sidekiq
       # @private
       # @return [Array<String>]
       def filter(queues)
-        queues - @paused_queues.to_a
+        @mutex.synchronize { queues - @paused_queues.to_a }
+      rescue => e
+        Sidekiq.logger.error { "[#{self.class}] Failed filter queues: #{e}" }
+        queues
       end
 
       # Returns list of paused queues.

data/lib/sidekiq/throttled/registry.rb

@@ -2,6 +2,7 @@
 
 # internal
 require "sidekiq/throttled/strategy"
+require "sidekiq/throttled/utils"
 
 module Sidekiq
   module Throttled
@@ -13,6 +14,8 @@ module Sidekiq
       @aliases    = {}
 
       class << self
+        include Utils
+
         # Adds strategy to the registry.
         #
         # @note prints a warning to STDERR upon duplicate strategy name
@@ -49,12 +52,15 @@ module Sidekiq
         #
         # @overload get(name, &block)
         #   Yields control to the block if requested strategy was found.
+        #   @param [#to_s] name
         #   @yieldparam [Strategy] strategy
         #   @yield [strategy] Gives found strategy to the block
         #   @return result of a block
         def get(name)
-          strategy = @strategies[name.to_s] || @aliases[name.to_s]
+          strategy = find(name.to_s) || find_by_class(name)
+
           return yield strategy if strategy && block_given?
+
           strategy
         end
 
@@ -68,6 +74,7 @@ module Sidekiq
         #   @return [Registry]
         def each
           return to_enum(__method__) unless block_given?
+
           @strategies.each { |*args| yield(*args) }
           self
         end
@@ -82,10 +89,39 @@ module Sidekiq
         #   @return [Registry]
         def each_with_static_keys
           return to_enum(__method__) unless block_given?
+
           @strategies.each do |name, strategy|
             yield(name, strategy) unless strategy.dynamic?
           end
         end
+
+        private
+
+        # Find strategy by it's name.
+        #
+        # @param name [String]
+        # @return [Strategy, nil]
+        def find(name)
+          @strategies[name] || @aliases[name]
+        end
+
+        # Find strategy by class or it's parents.
+        #
+        # @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)
+          return unless const.is_a?(Class)
+
+          const.ancestors.each do |m|
+            strategy = find(m.name)
+            return strategy if strategy
+          end
+
+          nil
+        end
       end
     end
   end

data/lib/sidekiq/throttled/strategy.rb

@@ -19,26 +19,24 @@ module Sidekiq
       #   @return [Strategy::Threshold, nil]
       attr_reader :threshold
 
+      # @!attribute [r] observer
+      #   @return [Proc, nil]
+      attr_reader :observer
+
       # @param [#to_s] name
       # @param [Hash] concurrency Concurrency options.
       #   See keyword args of {Strategy::Concurrency#initialize} for details.
       # @param [Hash] threshold Threshold options.
       #   See keyword args of {Strategy::Threshold#initialize} for details.
       # @param [#call] key_suffix Dynamic key suffix generator.
-      def initialize(name, concurrency: nil, threshold: nil, key_suffix: nil)
-        key = "throttled:#{name}"
-
-        @concurrency =
-          if concurrency
-            concurrency[:key_suffix] ||= key_suffix
-            Concurrency.new(key, **concurrency)
-          end
-
-        @threshold =
-          if threshold
-            threshold[:key_suffix] ||= key_suffix
-            Threshold.new(key, **threshold)
-          end
+      # @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)
 
         return if @concurrency || @threshold
 
@@ -55,9 +53,13 @@ module Sidekiq
 
       # @return [Boolean] whenever job is throttled or not.
       def throttled?(jid, *job_args)
-        return true if @concurrency&.throttled?(jid, *job_args)
+        if @concurrency&.throttled?(jid, *job_args)
+          @observer&.call(:concurrency, *job_args)
+          return true
+        end
 
         if @threshold&.throttled?(*job_args)
+          @observer&.call(:threshold, *job_args)
           finalize!(jid, *job_args)
           return true
         end
@@ -77,6 +79,15 @@ 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/concurrency.rb

@@ -42,14 +42,16 @@ module Sidekiq
 
         # @return [Boolean] whenever job is throttled or not
         def throttled?(jid, *job_args)
-          return false unless (job_limit = limit(job_args))
+          job_limit = limit(job_args)
+          return false unless job_limit
+          return true if job_limit <= 0
 
-          kwargs = {
-            :keys => [key(job_args)],
-            :argv => [jid.to_s, job_limit, @ttl, Time.now.to_f]
-          }
+          keys = [key(job_args)]
+          argv = [jid.to_s, job_limit, @ttl, Time.now.to_f]
 
-          Sidekiq.redis { |redis| 1 == SCRIPT.eval(redis, kwargs) }
+          Sidekiq.redis do |redis|
+            1 == SCRIPT.eval(redis, :keys => keys, :argv => argv)
+          end
         end
 
         # @return [Integer] Current count of jobs

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

@@ -48,6 +48,7 @@ module Sidekiq
         # @return [Float] Period in seconds
         def period(job_args = nil)
           return @period.to_f unless @period.respond_to? :call
+
           @period.call(*job_args).to_f
         end
 
@@ -58,14 +59,16 @@ module Sidekiq
 
         # @return [Boolean] whenever job is throttled or not
         def throttled?(*job_args)
-          return false unless (job_limit = limit(job_args))
+          job_limit = limit(job_args)
+          return false unless job_limit
+          return true if job_limit <= 0
 
-          kwargs = {
-            :keys => [key(job_args)],
-            :argv => [job_limit, period(job_args), Time.now.to_f]
-          }
+          keys = [key(job_args)]
+          argv = [job_limit, period(job_args), Time.now.to_f]
 
-          Sidekiq.redis { |redis| 1 == SCRIPT.eval(redis, kwargs) }
+          Sidekiq.redis do |redis|
+            1 == SCRIPT.eval(redis, :keys => keys, :argv => argv)
+          end
         end
 
         # @return [Integer] Current count of jobs

data/lib/sidekiq/throttled/utils.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Sidekiq
+  module Throttled
+    module Utils
+      module_function
+
+      # Resolve constant from it's name
+      # @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)
+      rescue NameError
+        Sidekiq.logger.warn { "Failed to constantize: #{name}" }
+        nil
+      end
+    end
+  end
+end

data/lib/sidekiq/throttled/version.rb

@@ -3,6 +3,6 @@
 module Sidekiq
   module Throttled
     # Gem version
-    VERSION = "0.10.0.alpha"
+    VERSION = "0.13.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

@@ -11,7 +11,8 @@ module Sidekiq
           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/sidekiq-throttled.gemspec

@@ -28,5 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "redis-prescription"
   spec.add_runtime_dependency "sidekiq"
 
-  spec.add_development_dependency "bundler", "~> 1.10"
+  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.10.0.alpha
+  version: 0.13.0
 platform: ruby
 authors:
 - Alexey V Zapparov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-21 00:00:00.000000000 Z
+date: 2020-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2.0'
 description: Concurrency and threshold throttling for Sidekiq.
 email:
 - ixti@member.fsf.org
@@ -74,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".coveralls.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -90,10 +91,13 @@ 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
 - lib/sidekiq/throttled.rb
 - lib/sidekiq/throttled/communicator.rb
 - lib/sidekiq/throttled/communicator/callbacks.rb
 - lib/sidekiq/throttled/communicator/listener.rb
+- lib/sidekiq/throttled/configuration.rb
 - lib/sidekiq/throttled/errors.rb
 - lib/sidekiq/throttled/expirable_list.rb
 - lib/sidekiq/throttled/fetch.rb
@@ -110,6 +114,7 @@ files:
 - lib/sidekiq/throttled/strategy/threshold.lua
 - lib/sidekiq/throttled/strategy/threshold.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
@@ -134,12 +139,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Concurrency and threshold throttling for Sidekiq.