sidekiq-limit_fetch 4.4.0 → 4.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60f78289f95ff030e04baa2f82f05adb60e40a022ca338f06a3c7bffcd69a348
-  data.tar.gz: 237c99bbf64fc49dcb85452bfcbca459ef4745b467455a34c8662e1f523a0663
+  metadata.gz: a8b031f9486e9a497f130f2b2ed58058980cdc14985895c4cfa9ab29dbb16509
+  data.tar.gz: 5c5c8c2d5b144405fc5a57bf5de67dda9709939c59bdcc7870f92ae43b95de55
 SHA512:
-  metadata.gz: bbc1b8489daab83e229590f24a5bd3213804e7fd51b9bb74c1c299812c551e0df06145ae03f9c5f60c993209cd294864d3b044d2b30c27ec138b4ba20fab546c
-  data.tar.gz: 54c0ba14c23a84e8167855c0c759bdb9df315af8aa090bca2d59e930bbfa22011520e7788990c27a5aacb6661b61db7a6a6abdf30afec4de6a5a38fffff60a04
+  metadata.gz: 1a1cb3a5542dd9888fce9bddaabc7e8e862df7741750b9323ae637970c08be263bab2e662965b89fefb8a02f830e5f4493d46bad2e0dc6330d143cc801c2dc15
+  data.tar.gz: 760cc8e8bd550b7dbcd3caaa03340d9d5629f83746197254e486f07c01f52b05afb6c964afb5eb4fc4c3a95a64c1425fc358d5e806a54bf38ae4521a6ed48d06

data/.github/workflows/ci.yml

@@ -36,6 +36,8 @@ jobs:
         bundler-cache: false
     - name: Bundle for Appraisal
       run: bundle
+    - name: Run Rubocop linting
+      run: bundle exec rubocop
     - name: Install Appraisal dependencies
       run: bundle exec appraisal sidekiq-${{ matrix.appraisal }} bundle
     - name: Run tests

data/.rubocop.yml

@@ -0,0 +1,29 @@
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 2.7
+  Exclude:
+    - 'gemfiles/*'
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+    - 'demo/Rakefile'
+
+Metrics/ModuleLength:
+  Exclude:
+    - 'lib/sidekiq/limit_fetch/queues.rb'
+
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/sidekiq/limit_fetch/global/semaphore.rb'
+
+Naming/VariableNumber:
+  EnforcedStyle: snake_case
+
+Naming/FileName:
+  Exclude:
+    - lib/sidekiq-limit_fetch.rb

data/Appraisals

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 appraise 'sidekiq-6.0' do
   gem 'sidekiq', '~> 6.0.0'
 end

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 gemspec
 

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/bench/compare.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'benchmark'
 require 'sidekiq/cli'
 require 'sidekiq/api'
@@ -9,11 +11,11 @@ limit       = ARGV.shift
 if limit
   limit = nil if limit == 'nil'
 
-  $:.unshift File.expand_path '../lib'
+  $LOAD_PATH.unshift File.expand_path '../lib'
   require 'sidekiq-limit_fetch'
   Sidekiq::Queue['inline'].limit = limit
-  Sidekiq.redis {|it| it.del 'limit_fetch:probed:inline' }
-  Sidekiq::LimitFetch::Queues.send(:define_method, :set) {|*| }
+  Sidekiq.redis { |it| it.del 'limit_fetch:probed:inline' }
+  Sidekiq::LimitFetch::Queues.send(:define_method, :set) { |*| } # rubocop:disable Lint/EmptyBlock
 end
 
 Sidekiq::Queue.new('inline').clear
@@ -22,8 +24,8 @@ class FastJob
   include Sidekiq::Worker
   sidekiq_options queue: :inline
 
-  def perform(i)
-    puts "job N#{i} is finished"
+  def perform(index)
+    puts "job N#{index} is finished"
   end
 end
 
@@ -36,17 +38,19 @@ class FinishJob
   end
 end
 
-total.times {|i| FastJob.perform_async i+1 }
+total.times { |i| FastJob.perform_async i + 1 }
 FinishJob.perform_async
 
 Sidekiq::CLI.instance.tap do |cli|
-  %w(validate! boot_system).each {|stub| cli.define_singleton_method(stub) {}}
+  %w[validate! boot_system].each { |stub| cli.define_singleton_method(stub) {} } # rubocop:disable Lint/EmptyBlock
   cli.parse ['-q inline', '-q other', "-c #{concurrency}"]
 
-  puts Benchmark.measure {
-    begin
-      cli.run
-    rescue Exception
-    end
-  }
+  # rubocop:disable Lint/RescueException
+  # rubocop:disable Lint/SuppressedException
+  puts Benchmark.measure do
+    cli.run
+  rescue Exception
+  end
+  # rubocop:enable Lint/SuppressedException
+  # rubocop:enable Lint/RescueException
 end

data/demo/Gemfile

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
-gem 'rails'
 gem 'launchy'
+gem 'rails'
 gem 'sidekiq', github: 'mperham/sidekiq'
 gem 'sidekiq-limit_fetch', path: '..'
-

data/demo/Rakefile

@@ -1,4 +1,6 @@
-require File.expand_path('../config/application', __FILE__)
+# frozen_string_literal: true
+
+require File.expand_path('config/application', __dir__)
 Demo::Application.load_tasks
 
 namespace :demo do
@@ -63,7 +65,7 @@ namespace :demo do
   end
   def with_sidekiq_config(config)
     whitespace_offset = config[/\A */].size
-    config.gsub! /^ {#{whitespace_offset}}/, ''
+    config.gsub!(/^ {#{whitespace_offset}}/, '')
 
     puts "=> Use sidekiq config:\n#{config}"
     File.write 'config/sidekiq.yml', config
@@ -85,8 +87,8 @@ namespace :demo do
     require 'sidekiq/cli'
     cli = Sidekiq::CLI.instance
 
-    %w(validate! boot_system).each do |stub|
-      cli.define_singleton_method(stub) {}
+    %w[validate! boot_system].each do |stub|
+      cli.define_singleton_method(stub) {} # rubocop:disable Lint/EmptyBlock
     end
 
     with_sidekiq_config options[:config] do
@@ -96,4 +98,3 @@ namespace :demo do
     cli.run
   end
 end
-

data/demo/app/workers/a_worker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class AWorker
   include Sidekiq::Worker
   sidekiq_options queue: :a

data/demo/app/workers/b_worker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class BWorker
   include Sidekiq::Worker
   sidekiq_options queue: :b

data/demo/app/workers/c_worker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class CWorker
   include Sidekiq::Worker
   sidekiq_options queue: :c
@@ -6,4 +8,3 @@ class CWorker
     sleep 10
   end
 end
-

data/demo/app/workers/fast_worker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class FastWorker
   include Sidekiq::Worker
   sidekiq_options queue: :fast

data/demo/app/workers/slow_worker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class SlowWorker
   include Sidekiq::Worker
   sidekiq_options queue: :slow

data/demo/config/application.rb

@@ -1,4 +1,6 @@
-require File.expand_path('../boot', __FILE__)
+# frozen_string_literal: true
+
+require File.expand_path('boot', __dir__)
 
 require 'action_controller/railtie'
 require 'action_mailer/railtie'

data/demo/config/boot.rb

@@ -1,2 +1,4 @@
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
-require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+# frozen_string_literal: true
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])

data/demo/config/environment.rb

@@ -1,2 +1,4 @@
-require File.expand_path('../application', __FILE__)
+# frozen_string_literal: true
+
+require File.expand_path('application', __dir__)
 Demo::Application.initialize!

data/demo/config/environments/development.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Demo::Application.configure do
   config.cache_classes = false
   config.eager_load = false

data/docker-compose.dev.yml

@@ -1,5 +1,5 @@
 version: "3.8"
-services: 
+services:
   redis:
     container_name: redis
     image: "redis:6.2-alpine"
@@ -10,4 +10,4 @@ services:
 
 volumes:
   redis-data:
-    driver: local
+    driver: local

data/lib/sidekiq/extensions/manager.rb

@@ -1,22 +1,25 @@
-class Sidekiq::Manager
-  module InitLimitFetch
-    def initialize(options={})
-      if Sidekiq::LimitFetch.post_7?
-        options.config[:fetch] = Sidekiq::LimitFetch
-      else
-        options[:fetch] = Sidekiq::LimitFetch
+# frozen_string_literal: true
+
+module Sidekiq
+  class Manager
+    module InitLimitFetch
+      def initialize(capsule_or_options)
+        if Sidekiq::LimitFetch.post_7?
+          capsule_or_options.config[:fetch_class] = Sidekiq::LimitFetch
+        else
+          capsule_or_options[:fetch] = Sidekiq::LimitFetch
+        end
+        super
       end
-      
-      super
-    end
 
-    def start
-      # In sidekiq 6.5.0 the variable @options has been renamed to @config
-      Sidekiq::LimitFetch::Queues.start @options || @config
-      Sidekiq::LimitFetch::Global::Monitor.start!
-      super
+      def start
+        # In sidekiq 6.5.0 the variable @options has been renamed to @config
+        Sidekiq::LimitFetch::Queues.start @options || @config
+        Sidekiq::LimitFetch::Global::Monitor.start!
+        super
+      end
     end
-  end
 
-  prepend InitLimitFetch
+    prepend InitLimitFetch
+  end
 end

data/lib/sidekiq/extensions/queue.rb

@@ -1,21 +1,24 @@
+# frozen_string_literal: true
+
 module Sidekiq
   class Queue
-    extend LimitFetch::Instances, Forwardable
+    extend Forwardable
+    extend LimitFetch::Instances
     attr_reader :rname
 
     def_delegators :lock,
-      :limit,         :limit=,         :limit_changed?,
-      :process_limit, :process_limit=,
-      :acquire,       :release,
-      :pause,         :pause_for_ms,   :unpause,
-      :block,         :unblock,
-      :paused?,       :blocking?,
-      :unblocked,     :block_except,
-      :probed,        :busy,
-      :increase_busy, :decrease_busy,
-      :local_busy?,   :explain,
-      :remove_locks_except!,
-      :clear_limits
+                   :limit,         :limit=, :limit_changed?,
+                   :process_limit, :process_limit=,
+                   :acquire,       :release,
+                   :pause,         :pause_for_ms, :unpause,
+                   :block,         :unblock,
+                   :paused?,       :blocking?,
+                   :unblocked,     :block_except,
+                   :probed,        :busy,
+                   :increase_busy, :decrease_busy,
+                   :local_busy?,   :explain,
+                   :remove_locks_except!,
+                   :clear_limits
 
     def lock
       @lock ||= LimitFetch::Global::Semaphore.new name

data/lib/sidekiq/limit_fetch/global/monitor.rb

@@ -1,77 +1,83 @@
-module Sidekiq::LimitFetch::Global
-  module Monitor
-    extend self
+# frozen_string_literal: true
 
-    HEARTBEAT_PREFIX = 'limit:heartbeat:'
-    PROCESS_SET = 'limit:processes'
-    HEARTBEAT_TTL = 20
-    REFRESH_TIMEOUT = 5
+module Sidekiq
+  module LimitFetch
+    module Global
+      module Monitor
+        extend self
 
-    def start!(ttl=HEARTBEAT_TTL, timeout=REFRESH_TIMEOUT)
-      Thread.new do
-        loop do
-          Sidekiq::LimitFetch.redis_retryable do
-            handle_dynamic_queues
-            update_heartbeat ttl
-            invalidate_old_processes
-          end
+        HEARTBEAT_PREFIX = 'limit:heartbeat:'
+        PROCESS_SET = 'limit:processes'
+        HEARTBEAT_TTL = 20
+        REFRESH_TIMEOUT = 5
+
+        def start!(ttl = HEARTBEAT_TTL, timeout = REFRESH_TIMEOUT)
+          Thread.new do
+            loop do
+              Sidekiq::LimitFetch.redis_retryable do
+                handle_dynamic_queues
+                update_heartbeat ttl
+                invalidate_old_processes
+              end
 
-          sleep timeout
+              sleep timeout
+            end
+          end
         end
-      end
-    end
 
-    def all_processes
-      Sidekiq.redis {|it| it.smembers PROCESS_SET }
-    end
+        def all_processes
+          Sidekiq.redis { |it| it.smembers PROCESS_SET }
+        end
 
-    def old_processes
-      all_processes.reject do |process|
-        Sidekiq.redis {|it| it.get heartbeat_key process } == '1'
-      end
-    end
+        def old_processes
+          all_processes.reject do |process|
+            Sidekiq.redis { |it| it.get heartbeat_key process } == '1'
+          end
+        end
 
-    def remove_old_processes!
-      Sidekiq.redis do |it|
-        old_processes.each {|process| it.srem PROCESS_SET, [process] }
-      end
-    end
+        def remove_old_processes!
+          Sidekiq.redis do |it|
+            old_processes.each { |process| it.srem PROCESS_SET, [process] }
+          end
+        end
 
-    def handle_dynamic_queues
-      queues = Sidekiq::LimitFetch::Queues
-      return unless queues.dynamic?
+        def handle_dynamic_queues
+          queues = Sidekiq::LimitFetch::Queues
+          return unless queues.dynamic?
 
-      available_queues = Sidekiq::Queue.all.map(&:name).reject do |it|
-        queues.dynamic_exclude.include? it
-      end
-      queues.handle available_queues
-    end
+          available_queues = Sidekiq::Queue.all.map(&:name).reject do |it|
+            queues.dynamic_exclude.include? it
+          end
+          queues.handle available_queues
+        end
 
-    private
+        private
 
-    def update_heartbeat(ttl)
-      Sidekiq.redis do |it|
-        it.multi do |pipeline|
-          pipeline.set heartbeat_key, '1'
-          pipeline.sadd PROCESS_SET, [Selector.uuid]
-          pipeline.expire heartbeat_key, ttl
+        def update_heartbeat(ttl)
+          Sidekiq.redis do |it|
+            it.multi do |pipeline|
+              pipeline.set heartbeat_key, '1'
+              pipeline.sadd PROCESS_SET, [Selector.uuid]
+              pipeline.expire heartbeat_key, ttl
+            end
+          end
         end
-      end
-    end
 
-    def invalidate_old_processes
-      Sidekiq.redis do |it|
-        remove_old_processes!
-        processes = all_processes
+        def invalidate_old_processes
+          Sidekiq.redis do |_it|
+            remove_old_processes!
+            processes = all_processes
 
-        Sidekiq::Queue.instances.each do |queue|
-          queue.remove_locks_except! processes
+            Sidekiq::Queue.instances.each do |queue|
+              queue.remove_locks_except! processes
+            end
+          end
         end
-      end
-    end
 
-    def heartbeat_key(process=Selector.uuid)
-      HEARTBEAT_PREFIX + process
+        def heartbeat_key(process = Selector.uuid)
+          HEARTBEAT_PREFIX + process
+        end
+      end
     end
   end
 end

data/lib/sidekiq/limit_fetch/global/selector.rb

@@ -1,52 +1,55 @@
-module Sidekiq::LimitFetch::Global
-  module Selector
-    extend self
+# frozen_string_literal: true
 
-    MUTEX_FOR_UUID = Mutex.new
+module Sidekiq
+  module LimitFetch
+    module Global
+      module Selector
+        extend self
 
-    def acquire(queues, namespace)
-      redis_eval :acquire, [namespace, uuid, queues]
-    end
+        MUTEX_FOR_UUID = Mutex.new
 
-    def release(queues, namespace)
-      redis_eval :release, [namespace, uuid, queues]
-    end
+        def acquire(queues, namespace)
+          redis_eval :acquire, [namespace, uuid, queues]
+        end
 
-    def uuid
-      # - if we'll remove "@uuid ||=" from inside of mutex
-      # then @uuid can be overwritten
-      # - if we'll remove "@uuid ||=" from outside of mutex
-      # then each read will lead to mutex
-      @uuid ||= MUTEX_FOR_UUID.synchronize { @uuid || SecureRandom.uuid }
-    end
+        def release(queues, namespace)
+          redis_eval :release, [namespace, uuid, queues]
+        end
 
-    private
-
-    def redis_eval(script_name, args)
-      Sidekiq.redis do |it|
-        begin
-          it.evalsha send("redis_#{script_name}_sha"), [], args
-        rescue Sidekiq::LimitFetch::RedisCommandError => error
-          raise unless error.message.include? 'NOSCRIPT'
-          if Sidekiq::LimitFetch.post_7?
-            it.eval send("redis_#{script_name}_script"), 0, *args
-          else
-            it.eval send("redis_#{script_name}_script"), argv: args
+        def uuid
+          # - if we'll remove "@uuid ||=" from inside of mutex
+          # then @uuid can be overwritten
+          # - if we'll remove "@uuid ||=" from outside of mutex
+          # then each read will lead to mutex
+          @uuid ||= MUTEX_FOR_UUID.synchronize { @uuid || SecureRandom.uuid }
+        end
+
+        private
+
+        def redis_eval(script_name, args)
+          Sidekiq.redis do |it|
+            it.evalsha send("redis_#{script_name}_sha"), [], args
+          rescue Sidekiq::LimitFetch::RedisCommandError => e
+            raise unless e.message.include? 'NOSCRIPT'
+
+            if Sidekiq::LimitFetch.post_7?
+              it.eval send("redis_#{script_name}_script"), 0, *args
+            else
+              it.eval send("redis_#{script_name}_script"), argv: args
+            end
           end
         end
-      end
-    end
 
-    def redis_acquire_sha
-      @acquire_sha ||= OpenSSL::Digest::SHA1.hexdigest redis_acquire_script
-    end
+        def redis_acquire_sha
+          @redis_acquire_sha ||= OpenSSL::Digest::SHA1.hexdigest redis_acquire_script
+        end
 
-    def redis_release_sha
-      @release_sha ||= OpenSSL::Digest::SHA1.hexdigest redis_release_script
-    end
+        def redis_release_sha
+          @redis_release_sha ||= OpenSSL::Digest::SHA1.hexdigest redis_release_script
+        end
 
-    def redis_acquire_script
-      <<-LUA
+        def redis_acquire_script
+          <<-LUA
         local namespace   = table.remove(ARGV, 1)..'limit_fetch:'
         local worker_name = table.remove(ARGV, 1)
         local queues      = ARGV
@@ -110,11 +113,11 @@ module Sidekiq::LimitFetch::Global
         end
 
         return available
-      LUA
-    end
+          LUA
+        end
 
-    def redis_release_script
-      <<-LUA
+        def redis_release_script
+          <<-LUA
         local namespace   = table.remove(ARGV, 1)..'limit_fetch:'
         local worker_name = table.remove(ARGV, 1)
         local queues      = ARGV
@@ -123,7 +126,9 @@ module Sidekiq::LimitFetch::Global
           local probed_key = namespace..'probed:'..queue
           redis.call('lrem', probed_key, 1, worker_name)
         end
-      LUA
+          LUA
+        end
+      end
     end
   end
 end