sidekiq-throttled 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '05945dcd1de433dd74010e8fa402c6fb2e6100fb6306aef386536da24cd2e08b'
-  data.tar.gz: fe07b3c6409e7749f2af3b85d36e27dcda5d53b92c771e050a951f6175cec407
+  metadata.gz: 6112ba7b54891bb2026f3e01a299c61d063b4f7efae86ace8c189606ca9ecabf
+  data.tar.gz: 01e999a1093465e5ef702b4553215e1371b86c6dc024b2218b40988ad388ec91
 SHA512:
-  metadata.gz: 2965642d0564eaf45c033b6c6d6ddfe5b80804eebfbfef7908c4f81bbc450baec4e71d1b70fe21bf6515336d173b3a95e74c4b97aa26d35a3947b7b24ba02c1e
-  data.tar.gz: 149ba3f6d29c9963c52f96d7ea1b6be23424726a7791afe7c3fad4ab95bf82b2db0df274ee3a26842e7726e1f403afff2d99c997f1033f2ddb63a95f9790d698
+  metadata.gz: ba63bb6792f530028d937f629afc3e64be80fa03be250f986e1172af76b826ffbf5c23f43424f919ee83fd5d6d6b76f50589bfc656f642440b75c9c5f94b9aa8
+  data.tar.gz: b4df934846e581d6f06aee42f24142c556972a30b5b063906b86f01bc74f046b78520a30b5ca68770eac92849f60636bf55515eb7d928437cb3e1354e48815a3

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

@@ -14,24 +14,41 @@ AllCops:
 
 ## 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
@@ -23,6 +22,7 @@ rvm:
   - 2.4
   - 2.5
   - 2.6
+  - 2.7
 
 matrix:
   fast_finish: true
@@ -36,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,7 @@ end
 appraise "sidekiq-5.2" do
   gem "sidekiq", "~> 5.2.0"
 end
+
+appraise "sidekiq-6.0" do
+  gem "sidekiq", "~> 6.0.0"
+end

data/CHANGES.md

@@ -1,3 +1,14 @@
+## 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)
@@ -201,3 +212,5 @@
 [@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

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:
 
@@ -88,7 +91,7 @@ end
 ```
 
 Observer will receive `strategy, *args` arguments, where `strategy` is a Symbol
-`:concurrency` or `:threshold`, and `*args` are the arguements that were passed
+`:concurrency` or `:threshold`, and `*args` are the arguments that were passed
 to the job.
 
 
@@ -231,6 +234,7 @@ 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
 
 
 ## Contributing
@@ -258,7 +262,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/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/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

@@ -17,11 +17,19 @@ module Sidekiq
       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

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

data/lib/sidekiq/throttled/registry.rb

@@ -74,6 +74,7 @@ module Sidekiq
         #   @return [Registry]
         def each
           return to_enum(__method__) unless block_given?
+
           @strategies.each { |*args| yield(*args) }
           self
         end
@@ -88,6 +89,7 @@ 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

data/lib/sidekiq/throttled/strategy.rb

@@ -86,10 +86,7 @@ module Sidekiq
       def make_strategy(strategy, name, key_suffix, options)
         return unless options
 
-        strategy.new("throttled:#{name}", {
-          :key_suffix => key_suffix,
-          **options
-        })
+        strategy.new("throttled:#{name}", :key_suffix => key_suffix, **options)
       end
     end
   end

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

@@ -46,12 +46,12 @@ module Sidekiq
           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
 
@@ -62,12 +63,12 @@ module Sidekiq
           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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-throttled
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Alexey V Zapparov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-23 00:00:00.000000000 Z
+date: 2020-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -74,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".coveralls.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -90,6 +91,7 @@ files:
 - gemfiles/sidekiq_5.0.gemfile
 - gemfiles/sidekiq_5.1.gemfile
 - gemfiles/sidekiq_5.2.gemfile
+- gemfiles/sidekiq_6.0.gemfile
 - lib/sidekiq/throttled.rb
 - lib/sidekiq/throttled/communicator.rb
 - lib/sidekiq/throttled/communicator/callbacks.rb
@@ -140,7 +142,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: Concurrency and threshold throttling for Sidekiq.