sidekiq-throttled 0.18.0 → 1.1.0

data/lib/sidekiq/throttled/middleware.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-# internal
-require "sidekiq/throttled/registry"
-
-module Sidekiq
-  module Throttled
-    # Server middleware that notifies strategy that job was finished.
-    #
-    # @private
-    class Middleware
-      # Called within Sidekiq job processing
-      def call(_worker, msg, _queue)
-        yield
-      ensure
-        Registry.get msg["class"] do |strategy|
-          strategy.finalize!(msg["jid"], *msg["args"])
-        end
-      end
-    end
-  end
-end

data/lib/sidekiq/throttled/patches/queue.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module Sidekiq
-  module Throttled
-    module Patches
-      module Queue
-        def paused?
-          QueuesPauser.instance.paused? name
-        end
-
-        def self.apply!
-          require "sidekiq/api"
-          ::Sidekiq::Queue.send(:prepend, self)
-        end
-      end
-    end
-  end
-end

data/lib/sidekiq/throttled/queue_name.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module Sidekiq
-  module Throttled
-    # Queue name utility belt.
-    #
-    # @private
-    module QueueName
-      # RegExp used to stip out any redisr-namespace prefixes with `queue:`.
-      QUEUE_NAME_PREFIX_RE = %r{.*queue:}.freeze
-      private_constant :QUEUE_NAME_PREFIX_RE
-
-      class << self
-        # Strips redis-namespace and `queue:` prefix from given queue name.
-        #
-        # @example
-        #
-        #   QueueName.normalize "queue:default"
-        #   # => "default"
-        #
-        #   QueueName.normalize "queue:queue:default"
-        #   # => "default"
-        #
-        #   QueueName.normalize "foo:bar:queue:default"
-        #   # => "default"
-        #
-        # @param [#to_s]
-        # @return [String]
-        def normalize(queue)
-          -queue.to_s.sub(QUEUE_NAME_PREFIX_RE, "")
-        end
-
-        # Prepends `queue:` prefix to given `queue` name.
-        #
-        # @note It does not normalizes queue before expanding it, thus
-        #   double-call of this method will potentially do some harm.
-        #
-        # @param [#to_s] queue Queue name
-        # @return [String]
-        def expand(queue)
-          -"queue:#{queue}"
-        end
-      end
-    end
-  end
-end

data/lib/sidekiq/throttled/queues_pauser.rb

@@ -1,152 +0,0 @@
-# frozen_string_literal: true
-
-require "set"
-require "singleton"
-require "concurrent/timer_task"
-
-require "sidekiq/throttled/patches/queue"
-require "sidekiq/throttled/communicator"
-require "sidekiq/throttled/queue_name"
-
-module Sidekiq
-  module Throttled
-    # Singleton class used to pause queues from being processed.
-    # For the sake of efficiency it uses {Communicator} behind the scene
-    # to notify all processes about paused/resumed queues.
-    #
-    # @private
-    class QueuesPauser
-      include Singleton
-
-      # Redis key of Set with paused queues.
-      #
-      # @return [String]
-      PAUSED_QUEUES = "throttled:X:paused_queues"
-      private_constant :PAUSED_QUEUES
-
-      # {Communicator} message used to notify that queue needs to be paused.
-      #
-      # @return [String]
-      PAUSE_MESSAGE = "pause"
-      private_constant :PAUSE_MESSAGE
-
-      # {Communicator} message used to notify that queue needs to be resumed.
-      #
-      # @return [String]
-      RESUME_MESSAGE = "resume"
-      private_constant :RESUME_MESSAGE
-
-      # Initializes singleton instance.
-      def initialize
-        @paused_queues = Set.new
-        @communicator  = Communicator.instance
-        @mutex         = Mutex.new
-      end
-
-      # Configures Sidekiq server to keep actual list of paused queues.
-      #
-      # @private
-      # @return [void]
-      def setup!
-        Patches::Queue.apply!
-
-        Sidekiq.configure_server do |config|
-          config.on(:startup) { start_watcher }
-          config.on(:quiet) { stop_watcher }
-
-          @communicator.receive(PAUSE_MESSAGE, &method(:add))
-          @communicator.receive(RESUME_MESSAGE, &method(:delete))
-          @communicator.ready { sync! }
-        end
-      end
-
-      # Returns queues list with paused queues being stripped out.
-      #
-      # @private
-      # @return [Array<String>]
-      def filter(queues)
-        @mutex.synchronize { queues - @paused_queues.to_a }
-      rescue => e
-        Sidekiq.logger.error { "[#{self.class}] Failed filter queues: #{e}" }
-        queues
-      end
-
-      # Returns list of paused queues.
-      #
-      # @return [Array<String>]
-      def paused_queues
-        Sidekiq.redis { |conn| conn.smembers(PAUSED_QUEUES).to_a }
-      end
-
-      # Pauses given `queue`.
-      #
-      # @param [#to_s] queue
-      # @return [void]
-      def pause!(queue)
-        queue = QueueName.normalize queue.to_s
-
-        Sidekiq.redis do |conn|
-          conn.sadd(PAUSED_QUEUES, queue)
-          @communicator.transmit(conn, PAUSE_MESSAGE, queue)
-        end
-      end
-
-      # Checks if given `queue` is paused.
-      #
-      # @param queue [#to_s]
-      # @return [Boolean]
-      def paused?(queue)
-        queue = QueueName.normalize queue.to_s
-        Sidekiq.redis { |conn| conn.sismember(PAUSED_QUEUES, queue) }
-      end
-
-      # Resumes given `queue`.
-      #
-      # @param [#to_s] queue
-      # @return [void]
-      def resume!(queue)
-        queue = QueueName.normalize queue.to_s
-
-        Sidekiq.redis do |conn|
-          conn.srem(PAUSED_QUEUES, queue)
-          @communicator.transmit(conn, RESUME_MESSAGE, queue)
-        end
-      end
-
-      private
-
-      def add(queue)
-        @mutex.synchronize do
-          @paused_queues << QueueName.expand(queue)
-        end
-      end
-
-      def delete(queue)
-        @mutex.synchronize do
-          @paused_queues.delete QueueName.expand(queue)
-        end
-      end
-
-      def sync!
-        @mutex.synchronize do
-          @paused_queues.replace(paused_queues.map { |q| QueueName.expand q })
-        end
-      end
-
-      def start_watcher
-        @mutex.synchronize do
-          @watcher ||= Concurrent::TimerTask.execute({
-            :run_now            => true,
-            :execution_interval => 60
-          }) { sync! }
-        end
-      end
-
-      def stop_watcher
-        @mutex.synchronize do
-          defined?(@watcher) && @watcher&.shutdown
-        end
-      end
-    end
-  end
-end

data/lib/sidekiq/throttled/testing.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require "sidekiq/throttled/registry"
-
-RSpec.configure do |config|
-  config.before :example do
-    Sidekiq::Throttled::Registry.instance_eval do
-      @strategies.clear
-      @aliases.clear
-    end
-  end
-end

data/lib/sidekiq/throttled/utils.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Sidekiq
-  module Throttled
-    module Utils
-      module_function
-
-      # Resolve constant from it's name
-      # @param name [#to_s] Constant name
-      # @return [Object, nil] Resolved constant or nil if failed.
-      def constantize(name)
-        name.to_s.sub(%r{^::}, "").split("::").inject(Object, &:const_get)
-      rescue NameError
-        Sidekiq.logger.warn { "Failed to constantize: #{name}" }
-        nil
-      end
-    end
-  end
-end

data/lib/sidekiq/throttled/web/queues.html.erb

@@ -1,49 +0,0 @@
-<h3><%= t('Queues') %></h3>
-
-<div class="table_container">
-  <table class="queues table table-hover table-bordered table-striped table-white">
-    <thead>
-      <th><%= t('Queue') %></th>
-      <th><%= t('Size') %></th>
-      <th><%= t('Actions') %></th>
-    </thead>
-    <% @queues.each do |queue| %>
-      <tr>
-        <td>
-          <a href="<%= root_path %>queues/<%= CGI.escape(queue.name) %>"><%= queue.name %></a>
-        </td>
-        <td><%= number_with_delimiter(queue.size) %> </td>
-        <td width="20%">
-          <form action="<%=root_path %>enhanced-queues/<%= CGI.escape(queue.name) %>" method="post" style="display:inline">
-            <%= csrf_tag %>
-            <% if queue.paused? %>
-              <button class="btn btn-primary btn-pauser-resume btn-xs" type="submit" name="action" value="resume">Resume</button>
-            <% else %>
-              <button class="btn btn-danger btn-pauser-pause btn-xs" type="submit" name="action" value="pause">Pause</button>
-            <% end %>
-
-            <button class="btn btn-danger btn-xs" type="submit" name="action" value="delete" data-confirm="<%= t('AreYouSureDeleteQueue', :queue => h(queue.name)) %>"><%= t('Delete') %></button>
-          </form>
-        </td>
-      </tr>
-    <% end %>
-  </table>
-</div>
-
-<style>
-.btn-pauser-pause {
-  background-image: -webkit-gradient(linear, 50% 0%, 50% 100%, color-stop(0%, #b13e00), color-stop(100%, #983500));
-  background-image: -webkit-linear-gradient(#b13e00, #983500);
-  background-image: -moz-linear-gradient(#b13e00, #983500);
-  background-image: -o-linear-gradient(#b13e00, #983500);
-  background-image: linear-gradient(#b13e00, #983500);
-}
-
-.btn-pauser-resume {
-  background-image: -webkit-gradient(linear, 50% 0%, 50% 100%, color-stop(0%, #00b13e), color-stop(100%, #009835));
-  background-image: -webkit-linear-gradient(#00b13e, #009835);
-  background-image: -moz-linear-gradient(#00b13e, #009835);
-  background-image: -o-linear-gradient(#00b13e, #009835);
-  background-image: linear-gradient(#00b13e, #009835);
-}
-</style>

data/lib/sidekiq/throttled/web/summary_fix.js

@@ -1,10 +0,0 @@
-document.addEventListener("DOMContentLoaded", function () {
-  var elem = document.querySelector(".summary li.enqueued > a"), href;
-
-  if (!elem) {
-    console.warn("[Sidekiq::Threshold] cannot find summary bar link to fix");
-  } else {
-    href = elem.getAttribute("href").toString();
-    elem.setAttribute("href", href.replace(/\/queues$/, "/enhanced-queues"));
-  }
-});

data/lib/sidekiq/throttled/web/summary_fix.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module Sidekiq
-  module Throttled
-    module Web
-      module SummaryFix
-        JAVASCRIPT = [File.read(File.expand_path("summary_fix.js", __dir__)).freeze].freeze
-        HEADERS    = { "Content-Type" => "application/javascript" }.freeze
-
-        class << self
-          attr_accessor :enabled
-
-          def apply!(app)
-            Sidekiq::WebAction.prepend SummaryFix
-
-            app.get("/throttled/summary_fix") do
-              [200, HEADERS.dup, JAVASCRIPT.dup]
-            end
-          end
-        end
-
-        def display_custom_head
-          "#{super}#{summary_fix_script if SummaryFix.enabled}"
-        end
-
-        private
-
-        def summary_fix_script
-          src = "#{root_path}throttled/summary_fix"
-          %(<script type="text/javascript" src="#{src}"></script>)
-        end
-      end
-    end
-  end
-end

data/rubocop/layout.yml

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

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

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

data/rubocop/performance.yml

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

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

data/rubocop/style.yml

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

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-lib = File.expand_path("lib", __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require "sidekiq/throttled/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "sidekiq-throttled"
-  spec.version       = Sidekiq::Throttled::VERSION
-  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/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", "~> 2.2"
-  spec.add_runtime_dependency "sidekiq", "~> 6.4"
-
-  spec.add_development_dependency "bundler", ">= 2.0"
-end