sidekiq-pauzer 4.2.1 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7ba4ea9d9b061ee7d506874e2f6dd7e3128d912f194df3f7eea66e134ee5342
-  data.tar.gz: e7c7a9140a6fb5e450b13ab2f97740908036d4cca4d28a1dbb40cea1210ce7b9
+  metadata.gz: c5f31ae5cfdfd5dd4e693e42c0bb82fbef4012cf9289772542f32131d996ecf7
+  data.tar.gz: 9bf1d72ce135955e7887b0926df8b83e6e3333e2c86f7ba1f7070c1277a4c6fd
 SHA512:
-  metadata.gz: 1abbf6aa4603205e520b197f93b08f6ad485a285c33dd64bb1b7eb01b8e54f80f0622a816d2fabf43b369c16abdf73beda3b220446ea023f9fe197bd11eeb7f0
-  data.tar.gz: f70b7cff1ef0955a932c0df368425213524bcf286d6ec4bc9803cf2486c246b835d2c6ae5c3c1f118b7c7adcc09e929a124295218183e45daf266eebca779535
+  metadata.gz: 3c7d00653876ac75e9cf299ad49152d8818380de5c18e670f023dfa5ffa07c9dd2b2755a8cfab71a9cb37e7b7d46d4e119653b314425ef8ffb57c1ffaa87414c
+  data.tar.gz: 89ab9cc7e4b0b90b4e3fa1b54b6a8e50577f52738faf0b96030edadc5fdddc1f6fd170b49aaf32be88a3538c31136404ee31576bf258ed2c7896584b189061cc

data/README.adoc

@@ -1,5 +1,12 @@
 = Sidekiq::Pauzer
 
+:ci-url: https://github.com/ixti/sidekiq-pauzer/actions/workflows/ci.yml?query=branch%3Amain
+:ci-img: https://github.com/ixti/sidekiq-pauzer/actions/workflows/ci.yml/badge.svg?branch=main
+:codecov-url: https://codecov.io/gh/ixti/sidekiq-pauzer/tree/main
+:codecov-img: https://codecov.io/gh/ixti/sidekiq-pauzer/graph/badge.svg?token=UKXUG2AA89
+
+{ci-url}[image:{ci-img}[CI]]
+{codecov-url}[image:{codecov-img}[codecov]]
 
 == Installation
 
@@ -20,13 +27,9 @@ require "sidekiq"
 require "sidekiq/pauzer"
 
 Sidekiq::Pauzer.configure do |config|
-  # Set redis key prefix.
-  # Default: nil
-  config.key_prefix = "my-app:"
-
   # Set paused queues local cache refresh rate in seconds.
-  # Default: 10
-  config.refresh_rate = 15
+  # Default: 5.0
+  config.refresh_rate = 10.0
 end
 ----
 
@@ -100,8 +103,6 @@ dropped.
 
 This library aims to support and work with following Sidekiq versions:
 
-* Sidekiq 7.0.x
-* Sidekiq 7.1.x
 * Sidekiq 7.2.x
 
 

data/lib/sidekiq/pauzer/config.rb

@@ -3,59 +3,25 @@
 module Sidekiq
   module Pauzer
     class Config
-      REDIS_KEY = "sidekiq-pauzer"
-      private_constant :REDIS_KEY
-
       # Default refresh rate
-      REFRESH_RATE = 10
-
-      # @return [String?]
-      attr_reader :key_prefix
+      REFRESH_RATE = 5.0
 
-      # @return [Integer, Float]
+      # @return [Float]
       attr_reader :refresh_rate
 
-      # Fully qualified Redis key
-      #
-      # @example Without key prefix (default)
-      #   config.redis_key # => "sidekiq-pauzer"
-      #
-      # @example With key prefix
-      #   config.key_prefix = "foobar:"
-      #   config.redis_key # => "foobar:sidekiq-pauzer"
-      #
-      # @return [String]
-      attr_reader :redis_key
-
       def initialize
-        @key_prefix   = nil
-        @redis_key    = REDIS_KEY
         @refresh_rate = REFRESH_RATE
       end
 
-      # Set redis key prefix.
-      #
-      # @see redis_key
-      # @param value [String?] String that should be prepended to redis key
-      # @return [void]
-      def key_prefix=(value)
-        raise ArgumentError, "expected String, or nil; got #{value.class}" unless value.is_a?(String) || value.nil?
-
-        @redis_key  = [value, REDIS_KEY].compact.join.freeze
-        @key_prefix = value&.then(&:-@) # Don't freeze original String value if it was unfrozen
-      end
-
       # Set paused queues local cache refresh rate in seconds.
       #
-      # @param value [Float, Integer] refresh interval in seconds
+      # @param value [Float] refresh interval in seconds
       # @return [void]
       def refresh_rate=(value)
-        unless value.is_a?(Integer) || value.is_a?(Float)
-          raise ArgumentError, "expected Integer, or Float; got #{value.class}"
+        unless value.is_a?(Float) && value.positive?
+          raise ArgumentError, "expected positive Float; got #{value.inspect}"
         end
 
-        raise ArgumentError, "expected positive value; got #{value.inspect}" unless value.positive?
-
         @refresh_rate = value
       end
     end

data/lib/sidekiq/pauzer/queues.rb

@@ -6,97 +6,54 @@ require "concurrent"
 module Sidekiq
   module Pauzer
     # @api internal
+    # Eventually consistent list of paused queues. Used by Sidekiq fetchers to
+    # avoid hitting Redis on every fetch call.
     class Queues
-      extend Forwardable
       include Enumerable
 
-      # @!attribute [r] redis_key
-      #   @see (Config#redis_key)
-      def_delegators :@config, :redis_key
-
-      # @!attribute [r] refresh_rate
-      #   @see (Config#refresh_rate)
-      def_delegators :@config, :refresh_rate
-
-      # @param config [Config]
-      def initialize(config)
-        @config          = config
-        @names           = [].freeze
-        @names_mutex     = Mutex.new
-        @refresher       = nil
-        @refresher_mutex = Mutex.new
+      # @param refresh_rate [Float]
+      # @param repository [Repository]
+      def initialize(refresh_rate, repository:)
+        @names     = [].freeze
+        @refresher = Concurrent::TimerTask.new(execution_interval: refresh_rate, run_now: true) do
+          @names = repository.to_a.freeze
+        end
       end
 
+      # @overload each
+      #   @return [Enumerator<String>]
+      #
+      # @overload each(&block)
+      #   For a block { |queue_name| ... }
+      #   @yieldparam queue_name [String]
+      #   @return [self]
       def each(&block)
         return to_enum __method__ unless block
 
         start_refresher unless refresher_running?
-        @names_mutex.synchronize { @names.dup }.each(&block)
-
-        self
-      end
+        @names.each(&block)
 
-      # @param name [#to_s]
-      # @return [Queues] self
-      def pause!(name)
-        redis_call("SADD", redis_key, name.to_s)
-        refresh
         self
       end
 
-      # @param name [#to_s]
-      # @return [Queues] self
-      def unpause!(name)
-        redis_call("SREM", redis_key, name.to_s)
-        refresh
-        self
-      end
-
-      # @param name [#to_s]
-      # @return [Boolean]
-      def paused?(name)
-        include?(name.to_s)
-      end
-
+      # Starts paused queues list async poller.
+      #
+      # @return [self]
       def start_refresher
-        @refresher_mutex.synchronize do
-          @refresher&.shutdown
-          @refresher = Concurrent::TimerTask.execute(execution_interval: refresh_rate, run_now: true) { refresh }
-        end
-
+        @refresher.execute
         self
       end
 
+      # Stops paused queues list async poller.
+      #
+      # @return [self]
       def stop_refresher
-        @refresher_mutex.synchronize do
-          @refresher&.shutdown
-          @refresher = nil
-        end
-
+        @refresher.shutdown
         self
       end
 
       def refresher_running?
-        @refresher_mutex.synchronize do
-          @refresher&.running? || false
-        end
-      end
-
-      private
-
-      # @return [nil]
-      def refresh
-        names = redis_call("SMEMBERS", redis_key).to_a
-
-        @names_mutex.synchronize do
-          @names = names.each(&:freeze).freeze
-        end
-
-        nil
-      end
-
-      def redis_call(...)
-        Sidekiq.redis { |conn| conn.call(...) }
+        @refresher.running?
       end
     end
   end

data/lib/sidekiq/pauzer/repository.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Sidekiq
+  module Pauzer
+    class Repository
+      include Enumerable
+
+      REDIS_KEY = "sidekiq-pauzer"
+
+      # @overload each
+      #   @return [Enumerator<String>]
+      #
+      # @overload each(&block)
+      #   For a block { |queue_name| ... }
+      #   @yieldparam queue_name [String]
+      #   @return [self]
+      def each
+        return to_enum __method__ unless block_given?
+
+        redis_call("SMEMBERS", REDIS_KEY).each { yield _1.freeze }
+
+        self
+      end
+
+      # @param queue_name [#to_s]
+      # @return [void]
+      def add(queue_name)
+        redis_call("SADD", REDIS_KEY, queue_name.to_s)
+        nil
+      end
+
+      # @param queue_name [#to_s]
+      # @return [void]
+      def delete(queue_name)
+        redis_call("SREM", REDIS_KEY, queue_name.to_s)
+        nil
+      end
+
+      # @param name [#to_s]
+      # @return [void]
+      def include?(queue_name)
+        redis_call("SISMEMBER", REDIS_KEY, queue_name.to_s).positive?
+      end
+
+      private
+
+      def redis_call(...)
+        Sidekiq.redis { _1.call(...) }
+      end
+    end
+  end
+end

data/lib/sidekiq/pauzer/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module Pauzer
-    VERSION = "4.2.1"
+    VERSION = "5.1.0"
   end
 end

data/lib/sidekiq/pauzer.rb

@@ -1,54 +1,51 @@
 # frozen_string_literal: true
 
-require "forwardable"
 require "sidekiq"
 require "sidekiq/api"
 
-require_relative "./pauzer/config"
-require_relative "./pauzer/patches/basic_fetch"
-require_relative "./pauzer/patches/queue"
-require_relative "./pauzer/queues"
-require_relative "./pauzer/version"
-
 begin
+  # :nocov:
   require "sidekiq-ent/version"
+  raise "sidekiq-pauzer is incompatible with Sidekiq Enterprise"
+  # :nocov:
 rescue LoadError
   # All good - no compatibility issues
 end
 
 begin
+  # :nocov:
   require "sidekiq/pro/version"
+  raise "sidekiq-pauzer is incompatible with Sidekiq Pro"
+  # :nocov:
 rescue LoadError
   # All good - no compatibility issues
 end
 
-raise "sidekiq-pauzer is incompatible with Sidekiq Pro"        if Sidekiq.pro?
-raise "sidekiq-pauzer is incompatible with Sidekiq Enterprise" if Sidekiq.ent?
+require_relative "./pauzer/config"
+require_relative "./pauzer/patches/basic_fetch"
+require_relative "./pauzer/patches/queue"
+require_relative "./pauzer/queues"
+require_relative "./pauzer/repository"
+require_relative "./pauzer/version"
 
 module Sidekiq
   module Pauzer
     MUTEX = Mutex.new
+    private_constant :MUTEX
 
-    @config = Config.new.freeze
-    @queues = Queues.new(@config)
+    @config     = Config.new.freeze
+    @repository = Repository.new
+    @queues     = Queues.new(@config.refresh_rate, repository: @repository)
 
     class << self
-      extend Forwardable
-
-      # @!attribute [r] redis_key
-      #   @see Config#redis_key
-      #   @return [String]
-      def_delegators :@config, :redis_key
-
       # @example
       #   Sidekiq::Pauzer.pause!("minor")
       #   Sidekiq::Pauzer.paused?("minor") # => true
       #
-      # @param (see Queues#pause!)
+      # @param (see Repository#add)
       # @return [void]
-      def pause!(name)
-        @queues.pause!(name)
-
+      def pause!(queue_name)
+        @repository.add(queue_name)
         nil
       end
 
@@ -58,11 +55,10 @@ module Sidekiq
       #   Sidekiq::Pauzer.unpause!("minor")
       #   Sidekiq::Pauzer.paused?("minor") # => false
       #
-      # @param (see Queues#unpause!)
+      # @param (see Repository#delete)
       # @return [void]
-      def unpause!(name)
-        @queues.unpause!(name)
-
+      def unpause!(queue_name)
+        @repository.delete(queue_name)
         nil
       end
 
@@ -71,11 +67,13 @@ module Sidekiq
       #   Sidekiq::Pauzer.paused?("minor")  # => true
       #   Sidekiq::Pauzer.paused?("threat") # => false
       #
-      # @see Queues#paused?
-      def paused?(name)
-        @queues.paused?(name)
+      # @return (see Repository#include?)
+      def paused?(queue_name)
+        @repository.include?(queue_name)
       end
 
+      # Eventually consistent list of paused queues.
+      #
       # @example
       #   Sidekiq::Pauzer.pause!("minor")
       #   Sidekiq::Pauzer.paused_queues # => ["minor"]
@@ -123,7 +121,7 @@ module Sidekiq
 
       def reinit_queues
         @queues.stop_refresher
-        @queues = Queues.new(@config)
+        @queues = Queues.new(@config.refresh_rate, repository: @repository)
       end
     end
   end

data/web/views/queues.erb

@@ -20,8 +20,12 @@
             <span class="label label-danger"><%= t('Paused') %></span>
           <% end %>
         </td>
-        <td><%= number_with_delimiter(queue.size) %> </td>
-        <td><% queue_latency = queue.latency %><%= number_with_delimiter(queue_latency.round(2)) %><%= (queue_latency < 60) ? '' : " (#{relative_time(Time.at(Time.now.to_f - queue_latency))})" %> </td>
+        <td class="num"><%= number_with_delimiter(queue.size) %> </td>
+        <td class="num">
+          <% queue_latency = queue.latency %>
+          <%= (queue_latency < 60) ? '' : " (#{relative_time(Time.at(Time.now.to_f - queue_latency))})" %>
+          <%= number_with_delimiter(queue_latency, precision: 2) %>
+        </td>
         <td class="delete-confirm">
           <form action="<%=root_path %>queues/<%= CGI.escape(queue.name) %>" method="post">
             <%= csrf_tag %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-pauzer
 version: !ruby/object:Gem::Version
-  version: 4.2.1
+  version: 5.1.0
 platform: ruby
 authors:
 - Alexey Zapparov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-26 00:00:00.000000000 Z
+date: 2023-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.2'
 description:
 email:
 - alexey@zapparov.com
@@ -55,6 +55,7 @@ files:
 - lib/sidekiq/pauzer/patches/web_action.rb
 - lib/sidekiq/pauzer/patches/web_application.rb
 - lib/sidekiq/pauzer/queues.rb
+- lib/sidekiq/pauzer/repository.rb
 - lib/sidekiq/pauzer/version.rb
 - lib/sidekiq/pauzer/web.rb
 - web/views/queues.erb
@@ -63,9 +64,9 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/ixti/sidekiq-pauzer
-  source_code_uri: https://github.com/ixti/sidekiq-pauzer/tree/v4.2.1
+  source_code_uri: https://github.com/ixti/sidekiq-pauzer/tree/v5.1.0
   bug_tracker_uri: https://github.com/ixti/sidekiq-pauzer/issues
-  changelog_uri: https://github.com/ixti/sidekiq-pauzer/blob/v4.2.1/CHANGES.md
+  changelog_uri: https://github.com/ixti/sidekiq-pauzer/blob/v5.1.0/CHANGES.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []