sidekiq-throttled 0.15.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6dcc92c4940527e645d6a211b068094aef5c1f1cb103ad07d74b9b42132eb80
-  data.tar.gz: c2a8b341bfc9586a97f5f918b19bcf0e35ec4c93b5e2955802d26e5846cb7351
+  metadata.gz: 1a4884da942e03171d7265651258f4da2ca601aa36219192b325a2ce0ff113fd
+  data.tar.gz: 7b1d20e64db0cf3720f4b404a95744b77de186da718feb7f6abd7cd23623e08d
 SHA512:
-  metadata.gz: d587a45dcf488a6ff722082c3ddf27c52bf19f4575fab922789580f36bae4031fe8f20d6825e0490d253f6f36f52a5c026b78bcd8b72de919fe094130c48c609
-  data.tar.gz: cdf97140a7cc3bc78720f59acd629d54ea4fbca2d5a3b8696cb92695b1b73d7b070dc7074a4278af6562a01987eeee3e7ce57c5405b5d23b0fb54afdd04458d3
+  metadata.gz: 93699777efb1fd7794a7e566d6b129b0898f8efb327627b2a17b5e3e595a100fedc8b5a064ab8331b61c553cdd4a3aa2f3ac57c76d9d677c16ef006df18c592d
+  data.tar.gz: 9aaa27dbd6c116fbeac961cb8f8d1413bc1b9ff84241cfa81ce4b63b479a0b2386d6de8c94a6176a461d4f50867ce80957fd4b4569b5bd9db377d41fafbb247c

data/.github/dependabot.yml

@@ -0,0 +1,12 @@
+# 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"

data/.github/workflows/ci.yml

@@ -2,19 +2,19 @@ name: CI
 
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
-    branches: [ master ]
+    branches: [ main ]
 
 jobs:
-  rspec:
+  test:
     name: "rspec (ruby:${{ matrix.ruby }} sidekiq:${{ matrix.sidekiq }})"
 
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ "2.6", "2.7", "3.0" ]
-        sidekiq: [ "5.0", "5.1", "5.2", "6.0", "6.1", "6.2", "6.3" ]
+        ruby: [ "2.7", "3.0", "3.1" ]
+        sidekiq: [ "6.4", "6.5" ]
 
     runs-on: ubuntu-latest
 
@@ -25,27 +25,28 @@ jobs:
         options: "--entrypoint redis-server"
 
     env:
-      GEMFILE: gemfiles/sidekiq_${{ matrix.sidekiq }}.gemfile
+      BUNDLE_GEMFILE: gemfiles/sidekiq_${{ matrix.sidekiq }}.gemfile
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
 
-      - run: bundle exec rspec
+      - name: bundle exec rspec
+        run: bundle exec rspec --format progress --force-colour
 
   rubocop:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: "2.6"
+          ruby-version: "2.7"
           bundler-cache: true
 
       - run: bundle exec rubocop

data/.rubocop.yml

@@ -1,19 +1,20 @@
 require:
   - rubocop-performance
+  - rubocop-rake
   - rubocop-rspec
 
 inherit_from:
   - .rubocop_todo.yml
-  - .rubocop/layout.yml
-  - .rubocop/lint.yml
-  - .rubocop/metrics.yml
-  - .rubocop/performance.yml
-  - .rubocop/rspec.yml
-  - .rubocop/style.yml
+  - rubocop/layout.yml
+  - rubocop/lint.yml
+  - rubocop/metrics.yml
+  - rubocop/performance.yml
+  - rubocop/rspec.yml
+  - rubocop/style.yml
 
 AllCops:
   Exclude:
     - gemfiles/**/*
     - vendor/**/*
   NewCops: enable
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7

data/.rubocop_todo.yml

@@ -1,12 +1,40 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-09-14 13:53:26 UTC using RuboCop version 0.90.0.
+# on 2022-06-13 00:11:28 UTC using RuboCop version 1.30.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 68
+# Offense count: 3
+# Configuration parameters: AllowComments, AllowEmptyLambdas.
+Lint/EmptyBlock:
+  Exclude:
+    - 'spec/sidekiq/throttled/middleware_spec.rb'
+    - 'spec/sidekiq/throttled/registry_spec.rb'
+
+# Offense count: 2
+# Configuration parameters: EnforcedStyleForLeadingUnderscores.
+# SupportedStylesForLeadingUnderscores: disallowed, required, optional
+Naming/MemoizedInstanceVariableName:
+  Exclude:
+    - 'lib/sidekiq/throttled/communicator.rb'
+    - 'lib/sidekiq/throttled/queues_pauser.rb'
+
+# Offense count: 2
+Performance/MethodObjectAsBlock:
+  Exclude:
+    - 'lib/sidekiq/throttled/queues_pauser.rb'
+
+# Offense count: 2
+# Configuration parameters: Include, CustomTransform, IgnoreMethods, SpecSuffixOnly.
+# Include: **/*_spec*rb*, **/spec/**/*
+RSpec/FilePath:
+  Exclude:
+    - 'spec/sidekiq/throttled/web/queues_spec.rb'
+    - 'spec/sidekiq/throttled/web/throttled_spec.rb'
+
+# Offense count: 69
 # Configuration parameters: .
 # SupportedStyles: have_received, receive
 RSpec/MessageSpies:
@@ -25,8 +53,16 @@ RSpec/MultipleMemoizedHelpers:
 RSpec/NestedGroups:
   Max: 5
 
-# Offense count: 4
+# Offense count: 5
+RSpec/StubbedMock:
+  Exclude:
+    - 'spec/sidekiq/throttled/expirable_list_spec.rb'
+    - 'spec/sidekiq/throttled/fetch_spec.rb'
+    - 'spec/sidekiq/throttled/queues_pauser_spec.rb'
+
+# Offense count: 6
 RSpec/SubjectStub:
   Exclude:
     - 'spec/sidekiq/throttled/communicator_spec.rb'
+    - 'spec/sidekiq/throttled/fetch_spec.rb'
     - 'spec/sidekiq/throttled/queues_pauser_spec.rb'

data/.travis.yml

@@ -33,7 +33,5 @@ matrix:
       gemfile: Gemfile
 
 gemfile:
-  - gemfiles/sidekiq_5.0.gemfile
-  - gemfiles/sidekiq_5.1.gemfile
-  - gemfiles/sidekiq_5.2.gemfile
-  - gemfiles/sidekiq_6.0.gemfile
+  - gemfiles/sidekiq_6.4.gemfile
+  - gemfiles/sidekiq_6.5.gemfile

data/Appraisals

@@ -1,29 +1,9 @@
 # frozen_string_literal: true
 
-appraise "sidekiq-5.0" do
-  gem "sidekiq", "~> 5.0.0"
+appraise "sidekiq-6.4" do
+  gem "sidekiq", "~> 6.4.0"
 end
 
-appraise "sidekiq-5.1" do
-  gem "sidekiq", "~> 5.1.0"
-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
-
-appraise "sidekiq-6.2" do
-  gem "sidekiq", "~> 6.2.0"
-end
-
-appraise "sidekiq-6.3" do
-  gem "sidekiq", "~> 6.3.0"
+appraise "sidekiq-6.5" do
+  gem "sidekiq", "~> 6.5.0"
 end

data/CHANGES.md

@@ -1,3 +1,40 @@
+## 0.16.1 (2022-06-14)
+
+* [#2](https://github.com/ixti/sidekiq-throttled/pull/2)
+  Support custom ActiveJob adapters.
+  ([@longkt90])
+
+* [#107](https://github.com/sensortower/sidekiq-throttled/pull/107)
+  Log error when key sufix extraction fails.
+  ([@pjungwir])
+
+## 0.16.0 (2022-06-13)
+
+* Drop Ruby 2.6 support.
+
+* Drop Sidekiq 5.X support.
+
+* [#121](https://github.com/sensortower/sidekiq-throttled/pull/121)
+  Sidekiq 6.5 compatibility.
+  ([@hieuk09])
+
+* [#116](https://github.com/sensortower/sidekiq-throttled/pull/116)
+  Unwrap ActiveJob JobWrapper
+  ([@holstvoogd])
+
+* [#115](https://github.com/sensortower/sidekiq-throttled/pull/115)
+  Fix Redis 4.6 deprecation warnings.
+  ([@dbackeus])
+
+* [#113](https://github.com/sensortower/sidekiq-throttled/pull/113)
+  Add Ruby 3.1 to CI.
+  ([@petergoldstein])
+
+* [#103](https://github.com/sensortower/sidekiq-throttled/pull/103)
+  Rename Sidekiq::Throttled::Worker to Sidekiq::Throttled::Job, and alias it
+  as Sidekiq::Throttled::Worker.
+  ([@CHTJonas])
+
 ## 0.15.0 (2021-12-16)
 
 * [#102](https://github.com/sensortower/sidekiq-throttled/pull/102)
@@ -254,3 +291,10 @@
 [@mattiagiuffrida-st]: https://github.com/mattiagiuffrida-st
 [@baptistejub]: https://github.com/baptistejub
 [@ybiquitous]: https://github.com/ybiquitous
+[@hieuk09]: https://github.com/hieuk09
+[@petergoldstein]: https://github.com/petergoldstein
+[@dbackeus]: https://github.com/dbackeus
+[@holstvoogd]: https://github.com/holstvoogd
+[@CHTJonas]: https://github.com/CHTJonas
+[@pjungwir]: https://github.com/pjungwir
+[@longkt90]: https://github.com/longkt90

data/Gemfile

@@ -5,9 +5,6 @@ source "https://rubygems.org"
 gem "appraisal"
 gem "rake"
 gem "rspec"
-gem "rubocop",             "~> 0.90.0", :require => false
-gem "rubocop-performance", "~> 1.8.0",  :require => false
-gem "rubocop-rspec",       "~> 1.43.2", :require => false
 gem "sidekiq"
 
 group :development do
@@ -20,13 +17,18 @@ end
 group :test do
   gem "apparition"
   gem "capybara"
-  gem "coveralls", :require => false
   gem "puma"
   gem "rack-test"
-  gem "simplecov"
   gem "sinatra"
   gem "timecop"
 end
 
+group :lint do
+  gem "rubocop",              :require => false
+  gem "rubocop-performance",  :require => false
+  gem "rubocop-rake",         :require => false
+  gem "rubocop-rspec",        :require => false
+end
+
 # Specify your gem's dependencies in sidekiq-throttled.gemspec
 gemspec

data/LICENSE.md

@@ -1,5 +1,6 @@
 The MIT License (MIT)
 
+Copyright (c) 2022 Alexey Zapparov
 Copyright (c) 2020-2021 Alexey Zapparov, SensorTower Inc.
 Copyright (c) 2015-2020 SensorTower Inc.
 

data/README.md

@@ -1,10 +1,7 @@
 # Sidekiq::Throttled
 
+[![CI Status](https://github.com/ixti/sidekiq-throttled/actions/workflows/ci.yml/badge.svg)](https://github.com/ixti/sidekiq-throttled/actions/workflows/ci.yml)
 [![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].
@@ -39,13 +36,13 @@ 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
+Once you've done that you can include `Sidekiq::Throttled::Job` to your
 job classes and configure throttling:
 
 ``` ruby
-class MyWorker
-  include Sidekiq::Worker
-  include Sidekiq::Throttled::Worker
+class MyJob
+  include Sidekiq::Job
+  include Sidekiq::Throttled::Job
 
   sidekiq_options :queue => :my_queue
 
@@ -62,15 +59,29 @@ class MyWorker
 end
 ```
 
+**NOTE:** `Sidekiq::Throttled::Job` is aliased as `Sidekiq::Throttled::Worker`,
+thus if you're using Sidekiq prior 6.3.0 version, or you using `Sidekiq::Worker`
+naming convention, you can use the alias for consistency:
+
+``` ruby
+class MyWorker
+  include Sidekiq::Worker
+  include Sidekiq::Throttled::Worker
+
+  # ...
+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
+class MyJob
+  include Sidekiq::Job
+  include Sidekiq::Throttled::Job
 
   MY_OBSERVER = lambda do |strategy, *args|
     # do something
@@ -100,9 +111,9 @@ to the job.
 You can throttle jobs dynamically with `:key_suffix` option:
 
 ``` ruby
-class MyWorker
-  include Sidekiq::Worker
-  include Sidekiq::Throttled::Worker
+class MyJob
+  include Sidekiq::Job
+  include Sidekiq::Throttled::Job
 
   sidekiq_options :queue => :my_queue
 
@@ -122,9 +133,9 @@ for these values. The proc will be evaluated at the time the job is fetched
 and will receive the same arguments that are passed to the job.
 
 ``` ruby
-class MyWorker
-  include Sidekiq::Worker
-  include Sidekiq::Throttled::Worker
+class MyJob
+  include Sidekiq::Job
+  include Sidekiq::Throttled::Job
 
   sidekiq_options :queue => :my_queue
 
@@ -150,9 +161,9 @@ end
 You also can use several different keys to throttle one worker.
 
 ``` ruby
-class MyWorker
-  include Sidekiq::Worker
-  include Sidekiq::Throttled::Worker
+class MyJob
+  include Sidekiq::Job
+  include Sidekiq::Throttled::Job
 
   sidekiq_options :queue => :my_queue
 
@@ -230,12 +241,12 @@ end
 
 ## Supported Ruby Versions
 
-This library aims to support and is [tested against][travis] the following Ruby
+This library aims to support and is [tested against][ci] the following Ruby
 versions:
 
-* Ruby 2.6.x
 * Ruby 2.7.x
 * Ruby 3.0.x
+* Ruby 3.1.x
 
 If something doesn't work on one of these versions, it's a bug.
 
@@ -255,13 +266,8 @@ dropped.
 
 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
-* Sidekiq 6.2.x
-* Sidekiq 6.3.x
+* Sidekiq 6.4.x
+* Sidekiq 6.5.x
 
 
 ## Contributing
@@ -287,11 +293,5 @@ bundle exec rubocop             # run static code analysis
 Don't forget to run `appraisal update` after any changes to `Gemfile`.
 
 
-## Copyright
-
-Copyright (c) 2020-2021 Alexey Zapparov, SensorTower Inc.
-See LICENSE.md for further details.
-
-
-[travis]: http://travis-ci.org/sensortower/sidekiq-throttled
+[ci]: https://github.com/ixti/sidekiq-throttled/actions/workflows/ci.yml
 [sidekiq]: https://github.com/mperham/sidekiq

data/Rakefile

@@ -24,4 +24,4 @@ end
 default_suite = ENV["CI"] ? :spec : %i[spec rubocop]
 named_suites  = { "rubocop" => :rubocop, "rspec" => :spec }
 
-task :default => named_suites.fetch(ENV["SUITE"], default_suite)
+task :default => named_suites.fetch(ENV.fetch("SUITE", nil), default_suite)

data/gemfiles/{sidekiq_5.2.gemfile → sidekiq_6.4.gemfile}

@@ -5,10 +5,7 @@ source "https://rubygems.org"
 gem "appraisal"
 gem "rake"
 gem "rspec"
-gem "rubocop", "~> 0.90.0", require: false
-gem "rubocop-performance", "~> 1.8.0", require: false
-gem "rubocop-rspec", "~> 1.43.2", require: false
-gem "sidekiq", "~> 5.2.0"
+gem "sidekiq", "~> 6.4.0"
 
 group :development do
   gem "byebug"
@@ -20,12 +17,17 @@ end
 group :test do
   gem "apparition"
   gem "capybara"
-  gem "coveralls", require: false
   gem "puma"
   gem "rack-test"
-  gem "simplecov"
   gem "sinatra"
   gem "timecop"
 end
 
+group :lint do
+  gem "rubocop", require: false
+  gem "rubocop-performance", require: false
+  gem "rubocop-rake", require: false
+  gem "rubocop-rspec", require: false
+end
+
 gemspec path: "../"

data/gemfiles/{sidekiq_5.1.gemfile → sidekiq_6.5.gemfile}

@@ -5,10 +5,7 @@ source "https://rubygems.org"
 gem "appraisal"
 gem "rake"
 gem "rspec"
-gem "rubocop", "~> 0.90.0", require: false
-gem "rubocop-performance", "~> 1.8.0", require: false
-gem "rubocop-rspec", "~> 1.43.2", require: false
-gem "sidekiq", "~> 5.1.0"
+gem "sidekiq", "~> 6.5.0"
 
 group :development do
   gem "byebug"
@@ -20,12 +17,17 @@ end
 group :test do
   gem "apparition"
   gem "capybara"
-  gem "coveralls", require: false
   gem "puma"
   gem "rack-test"
-  gem "simplecov"
   gem "sinatra"
   gem "timecop"
 end
 
+group :lint do
+  gem "rubocop", require: false
+  gem "rubocop-performance", require: false
+  gem "rubocop-rake", require: false
+  gem "rubocop-rspec", require: false
+end
+
 gemspec path: "../"

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

@@ -2,7 +2,7 @@
 
 require "fiber"
 
-require "sidekiq/exception_handler"
+require "sidekiq/throttled/communicator/exception_handler"
 
 module Sidekiq
   module Throttled

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "sidekiq"
+require "sidekiq/version"
+
+module Sidekiq
+  module Throttled
+    class Communicator
+      if Sidekiq::VERSION >= "6.5.0"
+        module ExceptionHandler
+          def handle_exception(*args)
+            Sidekiq.handle_exception(*args)
+          end
+        end
+
+        # NOTE: `Sidekiq.default_error_handler` is private API
+        Sidekiq.error_handlers << Sidekiq.method(:default_error_handler)
+      else
+        require "sidekiq/exception_handler"
+
+        ExceptionHandler = ::Sidekiq::ExceptionHandler
+      end
+    end
+  end
+end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "sidekiq/exception_handler"
+require "sidekiq/throttled/communicator/exception_handler"
 
 module Sidekiq
   module Throttled

data/lib/sidekiq/throttled/communicator.rb

@@ -2,7 +2,7 @@
 
 require "singleton"
 
-require "sidekiq/exception_handler"
+require "sidekiq/throttled/communicator/exception_handler"
 require "sidekiq/throttled/communicator/listener"
 require "sidekiq/throttled/communicator/callbacks"
 

data/lib/sidekiq/throttled/configuration.rb

@@ -21,14 +21,14 @@ module Sidekiq
       # Instructs throttler to lookup strategies in parent classes, if there's
       # no own strategy:
       #
-      #     class Foo
-      #       include Sidekiq::Worker
-      #       include Sidekiq::Worker::Throttled
+      #     class FooJob
+      #       include Sidekiq::Job
+      #       include Sidekiq::Throttled::Job
       #
       #       sidekiq_throttle :concurrency => { :limit => 42 }
       #     end
       #
-      #     class Bar < Foo
+      #     class BarJob < FooJob
       #     end
       #
       # By default in the example above, `Bar` won't have throttling options.

data/lib/sidekiq/throttled/expirable_list.rb

@@ -2,8 +2,6 @@
 
 require "monitor"
 
-require "concurrent/utility/monotonic_time"
-
 module Sidekiq
   module Throttled
     # List that tracks when elements were added and enumerates over those not
@@ -24,7 +22,6 @@ module Sidekiq
     # It does not deduplicates elements. Eviction happens only upon elements
     # retrieval (see {#each}).
     #
-    # @see http://ruby-concurrency.github.io/concurrent-ruby/Concurrent.html#monotonic_time-class_method
     # @see https://ruby-doc.org/core/Process.html#method-c-clock_gettime
     # @see https://linux.die.net/man/3/clock_gettime
     #
@@ -44,7 +41,7 @@ module Sidekiq
       # @params element [Object]
       # @return [ExpirableList] self
       def <<(element)
-        @mon.synchronize { @arr << [Concurrent.monotonic_time, element] }
+        @mon.synchronize { @arr << [::Process.clock_gettime(::Process::CLOCK_MONOTONIC), element] }
         self
       end
 
@@ -58,7 +55,7 @@ module Sidekiq
         return to_enum __method__ unless block_given?
 
         @mon.synchronize do
-          horizon = Concurrent.monotonic_time - @ttl
+          horizon = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC) - @ttl
 
           # drop all elements older than horizon
           @arr.shift while @arr[0] && @arr[0][0] < horizon

data/lib/sidekiq/throttled/fetch/unit_of_work.rb

@@ -49,9 +49,14 @@ module Sidekiq
         #   process was terminated. It is a reverse of whatever fetcher was
         #   doing to pull the job out of queue.
         #
+        # @param [Redis] pipelined connection for requeing via Redis#pipelined
         # @return [void]
-        def requeue
-          Sidekiq.redis { |conn| conn.rpush(QueueName.expand(queue_name), job) }
+        def requeue(pipeline = nil)
+          if pipeline
+            pipeline.rpush(QueueName.expand(queue_name), job)
+          else
+            Sidekiq.redis { |conn| conn.rpush(QueueName.expand(queue_name), job) }
+          end
         end
 
         # Pushes job back to the head of the queue, so that job won't be tried