sidekiq-throttled 0.13.0 → 0.16.0

data/lib/sidekiq/throttled/worker.rb

@@ -1,128 +1,13 @@
 # frozen_string_literal: true
 
-# internal
-require "sidekiq/throttled/registry"
+require "sidekiq/throttled/job"
 
 module Sidekiq
   module Throttled
-    # Adds helpers to your worker classes
-    #
-    # @example Usage
-    #
-    #     class MyWorker
-    #       include Sidekiq::Worker
-    #       include Sidekiq::Throttled::Worker
-    #
-    #       sidkiq_options :queue => :my_queue
-    #       sidekiq_throttle :threshold => { :limit => 123, :period => 1.hour }
-    #
-    #       def perform
-    #         # ...
-    #       end
-    #     end
-    #
-    # @see ClassMethods
-    module Worker
-      # Extends worker class with {ClassMethods}.
-      #
-      # @note Using `included` hook with extending worker with {ClassMethods}
-      #   in order to make API inline with `include Sidekiq::Worker`.
-      #
-      # @private
-      def self.included(worker)
-        worker.send(:extend, ClassMethods)
-      end
-
-      # Helper methods added to the singleton class of destination
-      module ClassMethods
-        # Registers some strategy for the worker.
-        #
-        # @example Allow max 123 MyWorker jobs per hour
-        #
-        #     class MyWorker
-        #       include Sidekiq::Worker
-        #       include Sidekiq::Throttled::Worker
-        #
-        #       sidekiq_throttle({
-        #         :threshold => { :limit => 123, :period => 1.hour }
-        #       })
-        #     end
-        #
-        # @example Allow max 10 concurrently running MyWorker jobs
-        #
-        #     class MyWorker
-        #       include Sidekiq::Worker
-        #       include Sidekiq::Throttled::Worker
-        #
-        #       sidekiq_throttle({
-        #         :concurrency => { :limit => 10 }
-        #       })
-        #     end
-        #
-        # @example Allow max 10 concurrent MyWorker jobs and max 123 per hour
-        #
-        #     class MyWorker
-        #       include Sidekiq::Worker
-        #       include Sidekiq::Throttled::Worker
-        #
-        #       sidekiq_throttle({
-        #         :threshold => { :limit => 123, :period => 1.hour },
-        #         :concurrency => { :limit => 10 }
-        #       })
-        #     end
-        #
-        # @see Registry.add
-        # @return [void]
-        def sidekiq_throttle(**kwargs)
-          Registry.add(self, **kwargs)
-        end
-
-        # Adds current worker to preconfigured throtttling strtegy. Allows
-        # sharing same pool for multiple workers.
-        #
-        # First of all we need to create shared throttling strategy:
-        #
-        #     # Create google_api throttling strategy
-        #     Sidekiq::Throttled::Registry.add(:google_api, {
-        #       :threshold => { :limit => 123, :period => 1.hour },
-        #       :concurrency => { :limit => 123 }
-        #     })
-        #
-        # Now we can assign it to our workers:
-        #
-        #     class FetchProfileJob
-        #       include Sidekiq::Worker
-        #       include Sidekiq::Throttled::Worker
-        #
-        #       sidekiq_throttle_as :google_api
-        #     end
-        #
-        #     class FetchCommentsJob
-        #       include Sidekiq::Worker
-        #       include Sidekiq::Throttled::Worker
-        #
-        #       sidekiq_throttle_as :google_api
-        #     end
-        #
-        # With the above configuration we ensure that there are maximum 10
-        # concurrently running jobs of FetchProfileJob or FetchCommentsJob
-        # allowed. And only 123 jobs of those are executed per hour.
-        #
-        # In other words, it will allow:
-        #
-        # - only `X` concurrent `FetchProfileJob`s
-        # - max `XX` `FetchProfileJob` per hour
-        # - only `Y` concurrent `FetchCommentsJob`s
-        # - max `YY` `FetchCommentsJob` per hour
-        #
-        # Where `(X + Y) == 10` and `(XX + YY) == 123`
-        #
-        # @see Registry.add_alias
-        # @return [void]
-        def sidekiq_throttle_as(name)
-          Registry.add_alias(self, name)
-        end
-      end
-    end
+    # A new module, Sidekiq::Job, was added in Sidekiq version 6.3.0 as a
+    # simple alias for Sidekiq::Worker as the term "worker" was considered
+    # too generic and confusing. Many people call a Sidekiq process a "worker"
+    # whereas others call the thread that executes jobs a "worker".
+    Worker = Job
   end
 end

data/lib/sidekiq/throttled.rb

@@ -9,6 +9,7 @@ require "sidekiq/throttled/communicator"
 require "sidekiq/throttled/configuration"
 require "sidekiq/throttled/queues_pauser"
 require "sidekiq/throttled/registry"
+require "sidekiq/throttled/job"
 require "sidekiq/throttled/worker"
 require "sidekiq/throttled/utils"
 
@@ -74,10 +75,11 @@ module Sidekiq
       #
       # @param [String] message Job's JSON payload
       # @return [Boolean]
-      def throttled?(message)
+      def throttled?(message) # rubocop:disable Metrics/MethodLength
         message = JSON.parse message
-        job = message.fetch("class") { return false }
-        jid = message.fetch("jid") { return false }
+        job = message.fetch("class")   { return false }
+        job = message.fetch("wrapped") { return false } if job == "ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper"
+        jid = message.fetch("jid")     { return false }
 
         preload_constant! job
 

data/rubocop/layout.yml

@@ -0,0 +1,24 @@
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/FirstHashElementIndentation:
+  Enabled: true
+  EnforcedStyle: consistent
+
+Layout/HashAlignment:
+  Enabled: true
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: true
+  EnforcedStyle: indented

data/rubocop/lint.yml

@@ -0,0 +1,41 @@
+Lint/BinaryOperatorWithIdenticalOperands:
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/DuplicateElsifCondition:
+  Enabled: true
+
+Lint/DuplicateRescueException:
+  Enabled: true
+
+Lint/EmptyConditionalBody:
+  Enabled: true
+
+Lint/FloatComparison:
+  Enabled: true
+
+Lint/MissingSuper:
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+Lint/OutOfRangeRegexpRef:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/SelfAssignment:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Lint/TopLevelReturnWithArgument:
+  Enabled: true
+
+Lint/UnreachableLoop:
+  Enabled: true

data/rubocop/metrics.yml

@@ -0,0 +1,4 @@
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*_spec.rb"
+    - "**/*.gemspec"

data/rubocop/performance.yml

@@ -0,0 +1,25 @@
+Performance/AncestorsInclude:
+  Enabled: true
+
+Performance/BigDecimalWithNumericArgument:
+  Enabled: true
+
+Performance/RedundantSortBlock:
+  Enabled: true
+
+Performance/RedundantStringChars:
+  Enabled: true
+
+Performance/ReverseFirst:
+  Enabled: true
+
+Performance/SortReverse:
+  Enabled: true
+
+Performance/Squeeze:
+  Enabled: true
+
+Performance/StringInclude:
+  Enabled: true
+
+

data/rubocop/rspec.yml

@@ -0,0 +1,3 @@
+RSpec/ExampleLength:
+  Enabled: true
+  Max: 15

data/rubocop/style.yml

@@ -0,0 +1,84 @@
+Style/AccessorGrouping:
+  Enabled: true
+
+Style/ArrayCoercion:
+  Enabled: true
+
+Style/BisectedAttrAccessor:
+  Enabled: true
+
+Style/CaseLikeIf:
+  Enabled: true
+
+Style/Documentation:
+  Enabled: false
+
+Style/ExplicitBlockArgument:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/GlobalStdStream:
+  Enabled: true
+
+Style/HashAsLastArrayItem:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashLikeCase:
+  Enabled: true
+
+Style/HashSyntax:
+  Enabled: true
+  EnforcedStyle: hash_rockets
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/OptionalBooleanParameter:
+  Enabled: true
+
+Style/RedundantAssignment:
+  Enabled: true
+
+Style/RedundantFetchBlock:
+  Enabled: true
+
+Style/RedundantFileExtensionInRequire:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+Style/RegexpLiteral:
+  Enabled: true
+  EnforcedStyle: percent_r
+
+Style/RescueStandardError:
+  Enabled: true
+  EnforcedStyle: implicit
+
+Style/SingleArgumentDig:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true
+
+Style/StringConcatenation:
+  Enabled: true
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/YodaCondition:
+  Enabled: false

data/sidekiq-throttled.gemspec

@@ -8,25 +8,29 @@ require "sidekiq/throttled/version"
 Gem::Specification.new do |spec|
   spec.name          = "sidekiq-throttled"
   spec.version       = Sidekiq::Throttled::VERSION
-  spec.authors       = ["Alexey V Zapparov"]
-  spec.email         = ["ixti@member.fsf.org"]
+  spec.authors       = ["Alexey Zapparov"]
+  spec.email         = ["alexey@zapparov.com"]
 
   spec.summary       = "Concurrency and threshold throttling for Sidekiq."
   spec.description   = "Concurrency and threshold throttling for Sidekiq."
-  spec.homepage      = "https://github.com/sensortower/sidekiq-throttled"
+  spec.homepage      = "https://github.com/ixti/sidekiq-throttled"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match %r{^(test|spec|features)/}
   end
 
+  spec.metadata["rubygems_mfa_required"] = "true"
+
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = ">= 2.7"
+
   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.13.0
+  version: 0.16.0
 platform: ruby
 authors:
-- Alexey V Zapparov
-autorequire: 
+- Alexey Zapparov
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-07-28 00:00:00.000000000 Z
+date: 2022-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -56,19 +56,19 @@ 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.
 email:
-- ixti@member.fsf.org
+- alexey@zapparov.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -88,20 +88,23 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
-- 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
+- gemfiles/sidekiq_6.4.gemfile
+- gemfiles/sidekiq_6.5.gemfile
 - lib/sidekiq/throttled.rb
 - lib/sidekiq/throttled/communicator.rb
 - lib/sidekiq/throttled/communicator/callbacks.rb
+- lib/sidekiq/throttled/communicator/exception_handler.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
 - lib/sidekiq/throttled/fetch/unit_of_work.rb
+- lib/sidekiq/throttled/job.rb
 - lib/sidekiq/throttled/middleware.rb
 - lib/sidekiq/throttled/patches/queue.rb
 - lib/sidekiq/throttled/queue_name.rb
@@ -113,6 +116,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
@@ -123,12 +127,19 @@ files:
 - lib/sidekiq/throttled/web/summary_fix.rb
 - lib/sidekiq/throttled/web/throttled.html.erb
 - lib/sidekiq/throttled/worker.rb
+- rubocop/layout.yml
+- rubocop/lint.yml
+- rubocop/metrics.yml
+- rubocop/performance.yml
+- rubocop/rspec.yml
+- rubocop/style.yml
 - sidekiq-throttled.gemspec
-homepage: https://github.com/sensortower/sidekiq-throttled
+homepage: https://github.com/ixti/sidekiq-throttled
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -136,15 +147,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Concurrency and threshold throttling for Sidekiq.
 test_files: []