sidekiq-pauzer 5.0.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64adf3a12da0acaeaffcb603aae15d37e3895822a01bd3128b82f16d429181f9
-  data.tar.gz: c8246993271ccbe1723fe89e8e5955a80660a950f273d4b5b251763a6958c1b5
+  metadata.gz: 98787fef3e8c9b2177b4d60ddff1c6f5cd9183bd574581606b545f3415073b8f
+  data.tar.gz: b9d2a052d852cf0b44d07bafd4162dbe76170d14586614a5fe7b5123d39e6513
 SHA512:
-  metadata.gz: be9f0cb3175391264e3fb005a39fd4c17e9fa9a9374a2e667155e113b0c626a17f522b973162a6b4e3c37c84b886738c436666baf1c12691c6134d915d033d94
-  data.tar.gz: 628d2cea3110e4bda2a61112bd529bb44513e2fd7cf9de1795a45c0236309666e6fbc7f2bcea3f05af0ac72855c1e5e5e2651371f7efafd92b87b3cbb6990500
+  metadata.gz: ba93ae7964585e0a89692ba06143704c52d45854ae51df91e7ff3cbe6596cae3ad1e58f505b352bf2f5abc35e4e9854c3a54294d7dbb5f6862698d34fb92057b
+  data.tar.gz: 978230c92240e7762db583e1854bcecdaa61496167ffb14d5f92dffcff655bb618566919a915b3c26e94ca2daba0ecd482a6da94d5ae67f6847903ba038ee632

data/README.adoc

@@ -77,35 +77,38 @@ NOTE: If you are using custom Sidekiq views path, then you will need to call
   (after requiring `sidekiq/pauzer/web`): `Sidekiq::Pauzer::Web.unpatch_views!`.
 
 
-== Supported Ruby Versions
-
-This library aims to support and is tested against the following Ruby versions:
-
-* Ruby 3.0.x
-* Ruby 3.1.x
-* Ruby 3.2.x
+== Compatibility
+
+This library aims to support and is tested against:
+
+* https://www.ruby-lang.org[Ruby]
+** MRI 3.0.x
+** MRI 3.1.x
+** MRI 3.2.x
+** MRI 3.3.x
+* https://github.com/sidekiq/sidekiq[Sidekiq]
+** 7.2.x
+** 7.3.x
+* https://redis.io[Redis]
+** 6.2.x
+** 7.0.x
+** 7.2.x
 
 If something doesn't work on one of these versions, it's a bug.
 
-This library may inadvertently work (or seem to work) on other Ruby versions,
-however support will only be provided for the versions listed above.
+This library may inadvertently work (or seem to work) on other Ruby, Redis, and
+Sidekiq versions, however support will only be provided for the versions listed
+above.
 
-If you would like this library to support another Ruby version or
-implementation, you may volunteer to be a maintainer. Being a maintainer
-entails making sure all tests run and pass on that implementation. When
-something breaks on your implementation, you will be responsible for providing
-patches in a timely fashion. If critical issues for a particular implementation
-exist at the time of a major release, support for that Ruby version may be
+If you would like this library to support another Ruby, Redis, or Sidekiq
+version, you may volunteer to be a maintainer. Being a maintainer entails making
+sure all tests run and pass on that implementation. When something breaks on
+your implementation, you will be responsible for providing patches in a timely
+fashion. If critical issues for a particular implementation exist at the time of
+a major release, support for that Ruby, Redis, and/or Sidekiq version may be
 dropped.
 
 
-== Supported Sidekiq Versions
-
-This library aims to support and work with following Sidekiq versions:
-
-* Sidekiq 7.2.x
-
-
 == Development
 
   bundle install

data/lib/sidekiq/pauzer/queues.rb

@@ -6,93 +6,53 @@ 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] 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:)
+        @refresher = Concurrent::TimerTask.new(execution_interval: refresh_rate, run_now: true) do
+          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
-
-      # @param name [#to_s]
-      # @return [Queues] self
-      def pause!(name)
-        redis_call("SADD", Pauzer::REDIS_KEY, name.to_s)
-        refresh
-        self
-      end
+        @refresher.value&.each(&block)
 
-      # @param name [#to_s]
-      # @return [Queues] self
-      def unpause!(name)
-        redis_call("SREM", Pauzer::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", Pauzer::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 = "5.0.0"
+    VERSION = "5.2.0"
   end
 end

data/lib/sidekiq/pauzer.rb

@@ -1,52 +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
-    REDIS_KEY = "sidekiq-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
-
       # @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
 
@@ -56,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
 
@@ -69,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"]
@@ -121,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-pauzer
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.2.0
 platform: ruby
 authors:
 - Alexey Zapparov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-09 00:00:00.000000000 Z
+date: 2024-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -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/v5.0.0
+  source_code_uri: https://github.com/ixti/sidekiq-pauzer/tree/v5.2.0
   bug_tracker_uri: https://github.com/ixti/sidekiq-pauzer/issues
-  changelog_uri: https://github.com/ixti/sidekiq-pauzer/blob/v5.0.0/CHANGES.md
+  changelog_uri: https://github.com/ixti/sidekiq-pauzer/blob/v5.2.0/CHANGES.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -82,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Enhance Sidekiq with queue pausing