sidekiq-throttled 0.18.0 → 1.0.0.alpha

data/lib/sidekiq/throttled/version.rb

@@ -3,6 +3,6 @@
 module Sidekiq
   module Throttled
     # Gem version
-    VERSION = "0.18.0"
+    VERSION = "1.0.0.alpha"
   end
 end

data/lib/sidekiq/throttled/web.rb

@@ -8,9 +8,8 @@ require "sidekiq"
 require "sidekiq/web"
 
 # internal
-require "sidekiq/throttled/registry"
-require "sidekiq/throttled/web/stats"
-require "sidekiq/throttled/web/summary_fix"
+require_relative "./registry"
+require_relative "./web/stats"
 
 module Sidekiq
   module Throttled
@@ -18,31 +17,11 @@ module Sidekiq
     module Web
       VIEWS         = Pathname.new(__dir__).join("web")
       THROTTLED_TPL = VIEWS.join("throttled.html.erb").read.freeze
-      QUEUES_TPL    = VIEWS.join("queues.html.erb").read.freeze
 
       class << self
-        # Replace default Queues tab with enhanced one.
-        def enhance_queues_tab!
-          SummaryFix.enabled = true
-          Sidekiq::Web::DEFAULT_TABS["Queues"] = "enhanced-queues"
-          Sidekiq::Web.tabs.delete("Enhanced Queues")
-        end
-
-        # Restore original Queues tab.
-        #
-        # @api There's next to absolutely no value in this method for real
-        #   users. The only it's purpose is to restore virgin state in specs.
-        def restore_queues_tab!
-          SummaryFix.enabled = false
-          Sidekiq::Web::DEFAULT_TABS["Queues"] = "queues"
-          Sidekiq::Web.tabs["Enhanced Queues"] = "enhanced-queues"
-        end
-
         # @api private
         def registered(app)
-          SummaryFix.apply! app
           register_throttled_tab app
-          register_enhanced_queues_tab app
         end
 
         private
@@ -55,27 +34,6 @@ module Sidekiq
             redirect "#{root_path}throttled"
           end
         end
-
-        # rubocop:disable Metrics/AbcSize
-        def register_enhanced_queues_tab(app) # rubocop:disable Metrics/MethodLength
-          pauser = QueuesPauser.instance
-
-          app.get("/enhanced-queues") do
-            @queues = Sidekiq::Queue.all
-            erb QUEUES_TPL.dup
-          end
-
-          app.post("/enhanced-queues/:name") do
-            case params[:action]
-            when "delete" then Sidekiq::Queue.new(params[:name]).clear
-            when "pause"  then pauser.pause!(params[:name])
-            else               pauser.resume!(params[:name])
-            end
-
-            redirect "#{root_path}enhanced-queues"
-          end
-        end
-        # rubocop:enable Metrics/AbcSize
       end
     end
   end
@@ -83,4 +41,3 @@ end
 
 Sidekiq::Web.register Sidekiq::Throttled::Web
 Sidekiq::Web.tabs["Throttled"] = "throttled"
-Sidekiq::Web.tabs["Enhanced Queues"] = "enhanced-queues"

data/lib/sidekiq/throttled/worker.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "sidekiq/throttled/job"
+require_relative "./job"
 
 module Sidekiq
   module Throttled

data/lib/sidekiq/throttled.rb

@@ -4,14 +4,13 @@
 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/job"
-require "sidekiq/throttled/worker"
-require "sidekiq/throttled/utils"
+require_relative "./throttled/version"
+require_relative "./throttled/configuration"
+require_relative "./throttled/fetch"
+require_relative "./throttled/registry"
+require_relative "./throttled/job"
+require_relative "./throttled/middleware"
+require_relative "./throttled/worker"
 
 # @see https://github.com/mperham/sidekiq/
 module Sidekiq
@@ -43,12 +42,7 @@ module Sidekiq
   #       end
   #     end
   module Throttled
-    MUTEX = Mutex.new
-    private_constant :MUTEX
-
     class << self
-      include Utils
-
       # @return [Configuration]
       def configuration
         @configuration ||= Configuration.new
@@ -58,15 +52,11 @@ module Sidekiq
       #
       # @return [void]
       def setup!
-        Communicator.instance.setup!
-        QueuesPauser.instance.setup!
-
         Sidekiq.configure_server do |config|
-          setup_strategy!(config)
-
-          require "sidekiq/throttled/middleware"
-          config.server_middleware do |chain|
-            chain.add Sidekiq::Throttled::Middleware
+          if Gem::Version.new("7.0.0") <= Gem::Version.new(Sidekiq::VERSION)
+            config[:fetch_class] = Sidekiq::Throttled::Fetch
+          else
+            config[:fetch] = Sidekiq::Throttled::Fetch.new(config)
           end
         end
       end
@@ -80,8 +70,6 @@ module Sidekiq
         job = message.fetch("wrapped") { message.fetch("class") { return false } }
         jid = message.fetch("jid") { return false }
 
-        preload_constant! job
-
         Registry.get job do |strategy|
           return strategy.throttled?(jid, *message["args"])
         end
@@ -90,34 +78,12 @@ module Sidekiq
       rescue
         false
       end
+    end
+  end
 
-      private
-
-      # @return [void]
-      def setup_strategy!(sidekiq_config)
-        require "sidekiq/throttled/fetch"
-
-        # 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.
-      #
-      # Somehow, sometimes, some classes are not eager loaded upon Rails init,
-      # leading to throttling config not being registered prior job perform.
-      # And that leaves us with concurrency limit + 1 situation upon Sidekiq
-      # server restart (becomes normal after all Sidekiq processes handled
-      # at leas onr job of that class).
-      #
-      # @return [void]
-      def preload_constant!(job)
-        MUTEX.synchronize do
-          @preloaded      ||= {}
-          @preloaded[job] ||= constantize(job) || true
-        end
-      end
+  configure_server do |config|
+    config.server_middleware do |chain|
+      chain.add Sidekiq::Throttled::Middleware
     end
   end
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-throttled
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 1.0.0.alpha
 platform: ruby
 authors:
 - Alexey Zapparov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-10 00:00:00.000000000 Z
+date: 2023-05-30 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: concurrent-ruby
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: redis-prescription
   requirement: !ruby/object:Gem::Requirement
@@ -40,72 +26,34 @@ dependencies:
         version: '2.2'
 - !ruby/object:Gem::Dependency
   name: sidekiq
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.4'
-- !ruby/object:Gem::Dependency
-  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
+        version: '6.5'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
-description: Concurrency and threshold throttling for Sidekiq.
+        version: '6.5'
+description:
 email:
 - alexey@zapparov.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".coveralls.yml"
-- ".github/dependabot.yml"
-- ".github/workflows/ci.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".rubocop_todo.yml"
-- ".travis.yml"
-- ".yardopts"
-- Appraisals
-- CHANGES.md
-- Gemfile
-- Guardfile
-- LICENSE.md
-- README.md
-- Rakefile
-- gemfiles/sidekiq_6.4.gemfile
-- gemfiles/sidekiq_6.5.gemfile
+- LICENSE
+- README.adoc
 - 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/basic_fetch.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
-- lib/sidekiq/throttled/queues_pauser.rb
 - lib/sidekiq/throttled/registry.rb
 - lib/sidekiq/throttled/strategy.rb
 - lib/sidekiq/throttled/strategy/base.rb
@@ -114,27 +62,19 @@ files:
 - 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
 - lib/sidekiq/throttled/web.rb
-- lib/sidekiq/throttled/web/queues.html.erb
 - lib/sidekiq/throttled/web/stats.rb
-- lib/sidekiq/throttled/web/summary_fix.js
-- 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/ixti/sidekiq-throttled
 licenses:
 - MIT
 metadata:
+  homepage_uri: https://github.com/ixti/sidekiq-throttled
+  source_code_uri: https://github.com/ixti/sidekiq-throttled/tree/v1.0.0.alpha
+  bug_tracker_uri: https://github.com/ixti/sidekiq-throttled/issues
+  changelog_uri: https://github.com/ixti/sidekiq-throttled/blob/v1.0.0.alpha/CHANGES.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -147,12 +87,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
-summary: Concurrency and threshold throttling for Sidekiq.
+summary: Concurrency and rate-limit throttling for Sidekiq
 test_files: []

data/.coveralls.yml

@@ -1 +0,0 @@
-service_name: travis-ci

data/.github/dependabot.yml

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

@@ -1,52 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches: [ main ]
-  pull_request:
-    branches: [ main ]
-
-jobs:
-  test:
-    name: "rspec (ruby:${{ matrix.ruby }} sidekiq:${{ matrix.sidekiq }})"
-
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: [ "2.7", "3.0", "3.1" ]
-        sidekiq: [ "6.4", "6.5" ]
-
-    runs-on: ubuntu-latest
-
-    services:
-      redis:
-        image: redis
-        ports: ["6379:6379"]
-        options: "--entrypoint redis-server"
-
-    env:
-      BUNDLE_GEMFILE: gemfiles/sidekiq_${{ matrix.sidekiq }}.gemfile
-
-    steps:
-      - uses: actions/checkout@v3
-
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-
-      - name: bundle exec rspec
-        run: bundle exec rspec --format progress --force-colour
-
-  rubocop:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v3
-
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: "2.7"
-          bundler-cache: true
-
-      - run: bundle exec rubocop

data/.gitignore

@@ -1,12 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/gemfiles/.bundle
-/gemfiles/*.gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-.byebug_history

data/.rspec

@@ -1,5 +0,0 @@
---backtrace
---color
---format=documentation
---order random
---require spec_helper

data/.rubocop.yml

@@ -1,20 +0,0 @@
-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
-
-AllCops:
-  Exclude:
-    - gemfiles/**/*
-    - vendor/**/*
-  NewCops: enable
-  TargetRubyVersion: 2.7

data/.rubocop_todo.yml

@@ -1,68 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# 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: 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:
-  EnforcedStyle: receive
-
-# Offense count: 22
-RSpec/MultipleExpectations:
-  Max: 4
-
-# Offense count: 7
-# Configuration parameters: AllowSubject.
-RSpec/MultipleMemoizedHelpers:
-  Max: 6
-
-# Offense count: 46
-RSpec/NestedGroups:
-  Max: 5
-
-# 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

@@ -1,37 +0,0 @@
-language: ruby
-
-services:
-  - redis-server
-
-cache: bundler
-
-before_install:
-  - gem update --system
-  - gem --version
-  - 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
-  - export PATH=$PWD/travis-phantomjs:$PATH
-
-install: bundle install --without development
-
-rvm:
-  - 2.4
-  - 2.5
-  - 2.6
-  - 2.7
-
-matrix:
-  fast_finish: true
-  include:
-    -
-      rvm: 2.4
-      env: SUITE="rubocop"
-      gemfile: Gemfile
-
-gemfile:
-  - gemfiles/sidekiq_6.4.gemfile
-  - gemfiles/sidekiq_6.5.gemfile

data/.yardopts

@@ -1 +0,0 @@
---no-private - LICENSE.md

data/Appraisals

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-appraise "sidekiq-6.4" do
-  gem "sidekiq", "~> 6.4.0"
-end
-
-appraise "sidekiq-6.5" do
-  gem "sidekiq", "~> 6.5.0"
-end