sidekiq-pauzer 1.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fd06c20e80c3054e38f6a1e53154ba2dc039d9d866adc27408356cf22ac4566
-  data.tar.gz: a2cf3bbb0255b83f5e31a9d73eec85c9d3c4cc448cf84bc2e227c60337d37446
+  metadata.gz: 7bfbbdbcf00da656eb48a8dccb0807b68e8554f6a02c6ed54e954f19d0ddd46b
+  data.tar.gz: 4887f3d8e032f2a48327e4e40ded771cf8552620f82e6b2744ce0625b0d89369
 SHA512:
-  metadata.gz: bf1039b0984731d50e3719363aa877bb1d21a4f52fa8b4c1c1b654f4c63279f683b186e9311fbd4c358cbd418b7f4603bf66296ddb9234a087298170fc7d758f
-  data.tar.gz: b87a05f362382c06ba9c985c24e9e2e6678fe977b10c1a2444ed41d68896be307de4b2df938b796ea4f84cad30ab047cc0f23a11ad7b9419d5e059edf658a6ae
+  metadata.gz: 73d2a4ae6200e308e83052947614759ea3db81bf22d481d67ae2d4c83d6531aa1c267f0662e8e231c0bad4e5091d6e99e568ae16e8919af016b55f742d4f243e
+  data.tar.gz: ca0824fa84c56ef904cac670fe5ed43d1f90701c6983ca0710cfa5d71cb01dd9a05ceeed45c8d98c9c32eb4a03192eae19120bf1fd7c7ac8e86f09baaa33bb99

data/README.adoc

@@ -49,7 +49,7 @@ Those translates to:
 
 [source, ruby]
 ----
-Sidekiq::Pauzer.paused?("critical").paused? # => true|false
+Sidekiq::Pauzer.paused?("critical") # => true|false
 Sidekiq::Pauzer.pause!("critical")
 Sidekiq::Pauzer.unpause!("critical")
 ----

data/lib/sidekiq/pauzer/adapters/redis.rb

@@ -13,15 +13,15 @@ module Sidekiq
             false
           end
 
-          def pause!(redis, key, queue)
+          def add(redis, key, queue)
             redis.sadd(key, queue)
           end
 
-          def unpause!(redis, key, queue)
+          def remove(redis, key, queue)
             redis.srem(key, queue)
           end
 
-          def paused_queues(redis, key)
+          def list(redis, key)
             # Cursor is not atomic, so there may be duplicates because of
             # concurrent update operations
             # See: https://redis.io/commands/scan/#scan-guarantees

data/lib/sidekiq/pauzer/adapters/redis_client.rb

@@ -1,31 +1,30 @@
 # frozen_string_literal: true
 
+require_relative "../runtime"
+
 module Sidekiq
   module Pauzer
     module Adapters
       # redis-client adapter
       module RedisClient
-        SIDEKIQ_SEVEN   = Gem::Version.new("7.0.0").freeze
-        SIDEKIQ_VERSION = Gem::Version.new(Sidekiq::VERSION).freeze
-
         class << self
           def adapts?(redis)
-            return true if SIDEKIQ_SEVEN <= SIDEKIQ_VERSION
+            return true if Runtime::SIDEKIQ_SEVEN
             return true if defined?(::RedisClient) && redis.is_a?(::RedisClient)
             return true if defined?(::RedisClient::Decorator::Client) && redis.is_a?(::RedisClient::Decorator::Client)
 
             false
           end
 
-          def pause!(redis, key, queue)
+          def add(redis, key, queue)
             redis.call("SADD", key, queue)
           end
 
-          def unpause!(redis, key, queue)
+          def remove(redis, key, queue)
             redis.call("SREM", key, queue)
           end
 
-          def paused_queues(redis, key)
+          def list(redis, key)
             # Cursor is not atomic, so there may be duplicates because of
             # concurrent update operations
             # See: https://redis.io/commands/scan/#scan-guarantees

data/lib/sidekiq/pauzer/basic_fetch.rb

@@ -13,30 +13,37 @@ module Sidekiq
 
       if Runtime::SIDEKIQ_SEVEN
         def queues_cmd
-          if @strictly_ordered_queues
-            @queues - Pauzer.paused_queues
-          else
-            permute = (@queues - Pauzer.paused_queues)
-            permute.shuffle!
-            permute.uniq!
-            permute
-          end
+          queues =
+            if @strictly_ordered_queues
+              @queues
+            else
+              permute = @queues.dup
+              permute.shuffle!
+              permute.uniq!
+              permute
+            end
+
+          excluding_paused(queues)
         end
       else
         def queues_cmd
           queues =
             if @strictly_ordered_queues
-              @queues[0...-1] - Pauzer.paused_queues
+              @queues[0...-1]
             else
-              permute = (@queues - Pauzer.paused_queues)
+              permute = @queues.dup
               permute.shuffle!
               permute.uniq!
               permute
             end
 
-          queues << { timeout: Sidekiq::BasicFetch::TIMEOUT }
+          excluding_paused(queues) << { timeout: Sidekiq::BasicFetch::TIMEOUT }
         end
       end
+
+      def excluding_paused(queues)
+        queues - Pauzer.paused_queues.map { |name| "queue:#{name}" }
+      end
     end
   end
 end

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

@@ -6,6 +6,7 @@ require "sidekiq/api"
 module Sidekiq
   module Pauzer
     module Patches
+      # @private
       module Queue
         def self.apply!
           Sidekiq::Queue.prepend(self)

data/lib/sidekiq/pauzer/patches/web_action.rb

@@ -8,6 +8,7 @@ require "sidekiq/web"
 module Sidekiq
   module Pauzer
     module Patches
+      # @private
       module WebAction
         PAUZER_QUEUES_TEMPLATE =
           ERB.new(File.read(File.expand_path("../../../../web/views/queues.erb", __dir__))).src

data/lib/sidekiq/pauzer/patches/web_application.rb

@@ -6,6 +6,7 @@ require "sidekiq/web"
 module Sidekiq
   module Pauzer
     module Patches
+      # @private
       module WebApplication
         class << self
           def apply!

data/lib/sidekiq/pauzer/queues.rb

@@ -12,12 +12,10 @@ module Sidekiq
 
       class Refresher < Concurrent::TimerTask; end
 
-      QUEUE_PREFIX = "queue:"
-
       # @param config [Config]
       def initialize(config)
         @mutex     = Mutex.new
-        @queues    = []
+        @names     = []
         @redis_key = config.redis_key
         @refresher = initialize_refresher(config.refresh_rate)
       end
@@ -25,29 +23,29 @@ module Sidekiq
       def each(&block)
         return to_enum __method__ unless block
 
-        @mutex.synchronize { @queues.dup }.each(&block)
+        @mutex.synchronize { @names.dup }.each(&block)
 
         self
       end
 
-      def pause!(queue)
-        queue = normalize_queue_name(queue)
-
-        Sidekiq.redis { |conn| Adapters[conn].pause!(conn, @redis_key, queue) }
+      # @param name [#to_s]
+      def pause!(name)
+        Sidekiq.redis { |conn| Adapters[conn].add(conn, @redis_key, name.to_s) }
 
         refresh
       end
 
-      def unpause!(queue)
-        queue = normalize_queue_name(queue)
-
-        Sidekiq.redis { |conn| Adapters[conn].unpause!(conn, @redis_key, queue) }
+      # @param name [#to_s]
+      def unpause!(name)
+        Sidekiq.redis { |conn| Adapters[conn].remove(conn, @redis_key, name.to_s) }
 
         refresh
       end
 
-      def paused?(queue)
-        include?(normalize_queue_name(queue))
+      # @param name [#to_s]
+      # @return [Boolean]
+      def paused?(name)
+        include?(name.to_s)
       end
 
       def start_refresher
@@ -76,19 +74,13 @@ module Sidekiq
 
       def refresh
         @mutex.synchronize do
-          paused_queues = Sidekiq.redis do |conn|
-            Adapters[conn].paused_queues(conn, @redis_key)
-          end
+          names = Sidekiq.redis { |conn| Adapters[conn].list(conn, @redis_key) }
 
-          @queues.replace(paused_queues)
+          @names.replace(names)
         end
 
         self
       end
-
-      def normalize_queue_name(queue)
-        queue.to_s.dup.delete_prefix(QUEUE_PREFIX)
-      end
     end
   end
 end

data/lib/sidekiq/pauzer/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module Pauzer
-    VERSION = "1.0.0"
+    VERSION = "2.1.0"
   end
 end

data/lib/sidekiq/pauzer.rb

@@ -35,13 +35,67 @@ module Sidekiq
     class << self
       extend Forwardable
 
-      def_delegators :@queues, :pause!, :unpause!, :paused?
+      # @!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!)
+      # @return [void]
+      def pause!(name)
+        @queues.pause!(name)
+
+        nil
+      end
+
+      # @example
+      #   Sidekiq::Pauzer.pause!("minor")
+      #   Sidekiq::Pauzer.paused?("minor") # => true
+      #   Sidekiq::Pauzer.unpause!("minor")
+      #   Sidekiq::Pauzer.paused?("minor") # => false
+      #
+      # @param (see Queues#unpause!)
+      # @return [void]
+      def unpause!(name)
+        @queues.unpause!(name)
+
+        nil
+      end
+
+      # @example
+      #   Sidekiq::Pauzer.pause!("minor")
+      #   Sidekiq::Pauzer.paused?("minor")  # => true
+      #   Sidekiq::Pauzer.paused?("threat") # => false
+      #
+      # @see Queues#paused?
+      def paused?(name)
+        @queues.paused?(name)
+      end
+
+      # @example
+      #   Sidekiq::Pauzer.pause!("minor")
+      #   Sidekiq::Pauzer.paused_queues # => ["minor"]
+      #
+      # @return [Array<String>]
       def paused_queues
-        @queues.map { |queue| "#{Queues::QUEUE_PREFIX}#{queue}" }
+        @queues.to_a
       end
 
+      # @deprecated Use {.paused_queues}
+      alias paused_queue_names paused_queues
+
+      # Yields `config` for a block.
+      #
+      # @example
+      #   Sidekiq::Pauzer.configure do |config|
+      #     config.refresh_rate = 42
+      #   end
+      #
+      # @yieldparam config [Config]
       def configure
         MUTEX.synchronize do
           config = @config.dup

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-pauzer
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Alexey Zapparov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-09 00:00:00.000000000 Z
+date: 2023-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -66,9 +66,9 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://gitlab.com/ixti/sidekiq-pauzer
-  source_code_uri: https://gitlab.com/ixti/sidekiq-pauzer/tree/v1.0.0
+  source_code_uri: https://gitlab.com/ixti/sidekiq-pauzer/tree/v2.1.0
   bug_tracker_uri: https://gitlab.com/ixti/sidekiq-pauzer/issues
-  changelog_uri: https://gitlab.com/ixti/sidekiq-pauzer/blob/v1.0.0/CHANGES.md
+  changelog_uri: https://gitlab.com/ixti/sidekiq-pauzer/blob/v2.1.0/CHANGES.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []