sidekiq-throttled 0.16.1 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51d312add58d0286d72087cefbdd49eac85a07c5416034e731f5c755f9fe702a
-  data.tar.gz: f7774ca65a0a26bb499dde8e34622d9e055b5112009228637a1f4b7696ad44bc
+  metadata.gz: 1a4884da942e03171d7265651258f4da2ca601aa36219192b325a2ce0ff113fd
+  data.tar.gz: 7b1d20e64db0cf3720f4b404a95744b77de186da718feb7f6abd7cd23623e08d
 SHA512:
-  metadata.gz: 0e7170c5e6dbe4a5664523ab04794b2f921296c690fbac05e6a2966bc0285612374441ec86d561cf48a45d36369c8c2fe0154c99aa2b9ed347cec642a0c4d22a
-  data.tar.gz: a7c8ff62bb1ff8e09f609f8d341ab57539e3db8aa8112c29d09f052b487310c5969e98c5e80c5cc6f1b4e1dbd13a278f7d117bb4ff13e28ee0e2f75743044b74
+  metadata.gz: 93699777efb1fd7794a7e566d6b129b0898f8efb327627b2a17b5e3e595a100fedc8b5a064ab8331b61c553cdd4a3aa2f3ac57c76d9d677c16ef006df18c592d
+  data.tar.gz: 9aaa27dbd6c116fbeac961cb8f8d1413bc1b9ff84241cfa81ce4b63b479a0b2386d6de8c94a6176a461d4f50867ce80957fd4b4569b5bd9db377d41fafbb247c

data/.github/workflows/ci.yml

@@ -14,7 +14,7 @@ jobs:
       fail-fast: false
       matrix:
         ruby: [ "2.7", "3.0", "3.1" ]
-        sidekiq: [ "6.0", "6.1", "6.2", "6.3", "6.4", "6.5" ]
+        sidekiq: [ "6.4", "6.5" ]
 
     runs-on: ubuntu-latest
 

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,21 +1,5 @@
 # frozen_string_literal: true
 
-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"
-end
-
 appraise "sidekiq-6.4" do
   gem "sidekiq", "~> 6.4.0"
 end

data/README.md

@@ -36,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
 
@@ -59,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
@@ -97,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
 
@@ -119,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
 
@@ -147,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
 
@@ -252,10 +266,6 @@ dropped.
 
 This library aims to support work with following [Sidekiq][sidekiq] versions:
 
-* Sidekiq 6.0.x
-* Sidekiq 6.1.x
-* Sidekiq 6.2.x
-* Sidekiq 6.3.x
 * Sidekiq 6.4.x
 * Sidekiq 6.5.x
 

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

@@ -12,33 +12,6 @@ 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 do |conn|
-            conn.pipelined do |pipeline|
-              units.each { |unit| unit.requeue(pipeline) }
-            end
-          end
-          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
@@ -77,6 +50,20 @@ module Sidekiq
         nil
       end
 
+      def bulk_requeue(units, _options)
+        return if units.empty?
+
+        Sidekiq.logger.debug { "Re-queueing terminated jobs" }
+        Sidekiq.redis do |conn|
+          conn.pipelined do |pipeline|
+            units.each { |unit| unit.requeue(pipeline) }
+          end
+        end
+        Sidekiq.logger.info("Pushed #{units.size} jobs back to Redis")
+      rescue => e
+        Sidekiq.logger.warn("Failed to requeue #{units.size} jobs: #{e}")
+      end
+
       private
 
       # Tries to pop pair of `queue` and job `message` out of sidekiq queues.
@@ -91,7 +78,7 @@ module Sidekiq
           return
         end
 
-        Sidekiq.redis { |conn| conn.brpop(*queues, TIMEOUT) }
+        Sidekiq.redis { |conn| conn.brpop(*queues, :timeout => TIMEOUT) }
       end
 
       # Returns list of queues to try to fetch jobs from.

data/lib/sidekiq/throttled/job.rb

@@ -9,9 +9,9 @@ module Sidekiq
     #
     # @example Usage
     #
-    #     class MyWorker
-    #       include Sidekiq::Worker
-    #       include Sidekiq::Throttled::Worker
+    #     class MyJob
+    #       include Sidekiq::Job
+    #       include Sidekiq::Throttled::Job
     #
     #       sidkiq_options :queue => :my_queue
     #       sidekiq_throttle :threshold => { :limit => 123, :period => 1.hour }
@@ -26,7 +26,7 @@ module Sidekiq
       # Extends worker class with {ClassMethods}.
       #
       # @note Using `included` hook with extending worker with {ClassMethods}
-      #   in order to make API inline with `include Sidekiq::Worker`.
+      #   in order to make API inline with `include Sidekiq::Job`.
       #
       # @private
       def self.included(worker)
@@ -37,33 +37,33 @@ module Sidekiq
       module ClassMethods
         # Registers some strategy for the worker.
         #
-        # @example Allow max 123 MyWorker jobs per hour
+        # @example Allow max 123 MyJob jobs per hour
         #
-        #     class MyWorker
-        #       include Sidekiq::Worker
-        #       include Sidekiq::Throttled::Worker
+        #     class MyJob
+        #       include Sidekiq::Job
+        #       include Sidekiq::Throttled::Job
         #
         #       sidekiq_throttle({
         #         :threshold => { :limit => 123, :period => 1.hour }
         #       })
         #     end
         #
-        # @example Allow max 10 concurrently running MyWorker jobs
+        # @example Allow max 10 concurrently running MyJob jobs
         #
-        #     class MyWorker
-        #       include Sidekiq::Worker
-        #       include Sidekiq::Throttled::Worker
+        #     class MyJob
+        #       include Sidekiq::Job
+        #       include Sidekiq::Throttled::Job
         #
         #       sidekiq_throttle({
         #         :concurrency => { :limit => 10 }
         #       })
         #     end
         #
-        # @example Allow max 10 concurrent MyWorker jobs and max 123 per hour
+        # @example Allow max 10 concurrent MyJob jobs and max 123 per hour
         #
-        #     class MyWorker
-        #       include Sidekiq::Worker
-        #       include Sidekiq::Throttled::Worker
+        #     class MyJob
+        #       include Sidekiq::Job
+        #       include Sidekiq::Throttled::Job
         #
         #       sidekiq_throttle({
         #         :threshold => { :limit => 123, :period => 1.hour },
@@ -91,15 +91,15 @@ module Sidekiq
         # Now we can assign it to our workers:
         #
         #     class FetchProfileJob
-        #       include Sidekiq::Worker
-        #       include Sidekiq::Throttled::Worker
+        #       include Sidekiq::Job
+        #       include Sidekiq::Throttled::Job
         #
         #       sidekiq_throttle_as :google_api
         #     end
         #
         #     class FetchCommentsJob
-        #       include Sidekiq::Worker
-        #       include Sidekiq::Throttled::Worker
+        #       include Sidekiq::Job
+        #       include Sidekiq::Throttled::Job
         #
         #       sidekiq_throttle_as :google_api
         #     end

data/lib/sidekiq/throttled/version.rb

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

data/lib/sidekiq/throttled.rb

@@ -22,12 +22,12 @@ module Sidekiq
   #     require "sidekiq/throttled"
   #     Sidekiq::Throttled.setup!
   #
-  # 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:
   #
-  #     class MyWorker
-  #       include Sidekiq::Worker
-  #       include Sidekiq::Throttled::Worker
+  #     class MyJob
+  #       include Sidekiq::Job
+  #       include Sidekiq::Throttled::Job
   #
   #       sidekiq_options :queue => :my_queue
   #
@@ -62,7 +62,7 @@ module Sidekiq
         QueuesPauser.instance.setup!
 
         Sidekiq.configure_server do |config|
-          setup_strategy!
+          setup_strategy!(config)
 
           require "sidekiq/throttled/middleware"
           config.server_middleware do |chain|
@@ -94,16 +94,13 @@ module Sidekiq
       private
 
       # @return [void]
-      def setup_strategy!
+      def setup_strategy!(sidekiq_config)
         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
+        # https://github.com/mperham/sidekiq/commit/67daa7a408b214d593100f782271ed108686c147
+        sidekiq_config = sidekiq_config.options if Gem::Version.new(Sidekiq::VERSION) < Gem::Version.new("6.5.0")
+
+        sidekiq_config[:fetch] = Sidekiq::Throttled::Fetch.new(sidekiq_config)
       end
 
       # Tries to preload constant by it's name once.

data/sidekiq-throttled.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "concurrent-ruby"
   spec.add_runtime_dependency "redis-prescription"
-  spec.add_runtime_dependency "sidekiq"
+  spec.add_runtime_dependency "sidekiq", ">= 6.4"
 
   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.16.1
+  version: 0.17.0
 platform: ruby
 authors:
 - Alexey Zapparov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-14 00:00:00.000000000 Z
+date: 2022-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -89,10 +89,6 @@ files:
 - 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
 - lib/sidekiq/throttled.rb
@@ -155,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: Concurrency and threshold throttling for Sidekiq.

data/gemfiles/sidekiq_6.0.gemfile

@@ -1,33 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "appraisal"
-gem "rake"
-gem "rspec"
-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 "puma"
-  gem "rack-test"
-  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_6.1.gemfile

@@ -1,33 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "appraisal"
-gem "rake"
-gem "rspec"
-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 "puma"
-  gem "rack-test"
-  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_6.2.gemfile

@@ -1,33 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "appraisal"
-gem "rake"
-gem "rspec"
-gem "sidekiq", "~> 6.2.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 "puma"
-  gem "rack-test"
-  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_6.3.gemfile

@@ -1,33 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "appraisal"
-gem "rake"
-gem "rspec"
-gem "sidekiq", "~> 6.3.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 "puma"
-  gem "rack-test"
-  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: "../"