Merge branch 'feature/sidekiq-6-5-compatibility' into 'master'

Sidekiq 6.5.6 compatibility

See merge request strawberry-4/gems/sidekiq-queue-pause!3

Author: bigzed

.gitignore

@@ -0,0 +1,3 @@
+doc
+.yardoc
+coverage

.rubocop.yml

@@ -0,0 +1,5 @@
+require: standard
+inherit_gem:
+  standard: config/base.yml
+AllCops:
+  DisabledByDefault: true

.solargraph.yml

@@ -0,0 +1,16 @@
+---
+include:
+  - "**/*.rb"
+exclude:
+  - test/**/*
+  - vendor/**/*
+  - ".bundle/**/*"
+require: []
+domains: []
+reporters:
+  - standardrb
+  - require_not_found
+require_paths: []
+plugins:
+  - solargraph-standardrb
+max_files: 5000

Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

Gemfile.lock

@@ -0,0 +1,195 @@
+PATH
+  remote: .
+  specs:
+    sidekiq-queue-pause (0.1.0)
+      sidekiq (>= 6.0, < 7.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    backport (1.2.0)
+    benchmark (0.2.1)
+    coderay (1.1.3)
+    connection_pool (2.3.0)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    e2mmap (0.1.0)
+    faraday (2.7.4)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    ffi (1.15.5)
+    formatador (1.1.0)
+    gitlab (4.19.0)
+      httparty (~> 0.20)
+      terminal-table (>= 1.5.1)
+    guard (2.18.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
+      multi_xml (>= 0.5.2)
+    jaro_winkler (1.5.4)
+    json (2.6.3)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    language_server-protocol (3.17.0.2)
+    listen (3.8.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    multi_xml (0.6.0)
+    nenv (0.3.0)
+    nokogiri (1.14.0-x86_64-linux)
+      racc (~> 1.4)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    octokit (6.0.1)
+      faraday (>= 1, < 3)
+      sawyer (~> 0.9)
+    parallel (1.22.1)
+    parser (3.2.0.0)
+      ast (~> 2.4.1)
+    pronto (0.11.1)
+      gitlab (>= 4.4.0, < 5.0)
+      httparty (>= 0.13.7, < 1.0)
+      octokit (>= 4.7.0, < 7.0)
+      rainbow (>= 2.2, < 4.0)
+      rexml (>= 3.2.5, < 4.0)
+      rugged (>= 0.23.0, < 2.0)
+      thor (>= 0.20.3, < 2.0)
+    pronto-simplecov (0.11.0)
+      pronto (~> 0.11.0)
+      simplecov
+    pronto-standardrb (0.1.2)
+      pronto
+      rubocop
+      standard
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (5.0.1)
+    racc (1.6.2)
+    rack (2.2.6.2)
+    rainbow (3.1.1)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    redis (4.8.0)
+    regexp_parser (2.6.2)
+    reverse_markdown (2.1.1)
+      nokogiri
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.42.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.15.2)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    rugged (1.5.1)
+    sawyer (0.9.2)
+      addressable (>= 2.3.5)
+      faraday (>= 0.17.3, < 3)
+    shellany (0.0.1)
+    sidekiq (6.5.8)
+      connection_pool (>= 2.2.5, < 3)
+      rack (~> 2.0)
+      redis (>= 4.5.0, < 5)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    solargraph (0.48.0)
+      backport (~> 1.2)
+      benchmark
+      bundler (>= 1.17.2)
+      diff-lcs (~> 1.4)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      parser (~> 3.0)
+      reverse_markdown (>= 1.0.5, < 3)
+      rubocop (>= 0.52)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
+    solargraph-standardrb (0.0.4)
+      solargraph (>= 0.39.1)
+      standard (>= 0.4.1)
+    standard (1.22.1)
+      language_server-protocol (~> 3.17.0.2)
+      rubocop (= 1.42.0)
+      rubocop-performance (= 1.15.2)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    thor (1.2.1)
+    tilt (2.0.11)
+    unicode-display_width (2.4.2)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  guard (~> 2.18)
+  guard-rspec (~> 4.7)
+  pronto (~> 0.11)
+  pronto-simplecov (~> 0.11)
+  pronto-standardrb (~> 0.1)
+  rspec (~> 3)
+  sidekiq-queue-pause!
+  simplecov (~> 0.21)
+  solargraph (~> 0.44)
+  solargraph-standardrb (~> 0.0.4)
+  standard (~> 1.4)
+
+BUNDLED WITH
+   2.3.23

Guardfile

@@ -0,0 +1,42 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

lib/sidekiq-queue-pause.rb

@@ -1,21 +1,16 @@
-begin
-  require 'celluloid'
-rescue LoadError
-  # Sidekiq 4.2+
-end
-require 'sidekiq'
-require 'sidekiq/fetch'
+require "sidekiq"
+require "sidekiq/fetch"
 
 module Sidekiq
   module QueuePause
-    PREFIX = 'queue_pause'
+    PREFIX = "queue_pause"
 
     class << self
       attr_accessor :retry_after
-      attr_writer   :process_key
+      attr_writer :process_key
 
       def process_key(&block)
-        if block_given?
+        if block
           @process_key = block
         else
           @process_key.is_a?(Proc) ? @process_key.call : @process_key
@@ -62,11 +57,16 @@ def retrieve_work_for_queues(qcmd)
         UnitOfWork.new(*work) if work
       end
 
+      # Returns the list of unpause queue names.
+      #
+      # @return [Array<String>] The list of unpaused queue names.
       def unpaused_queues_cmd
         queues = queues_cmd
         queues.reject do |q|
-          q != Sidekiq::BasicFetch::TIMEOUT &&
-            Sidekiq::QueuePause.paused?(q.gsub('queue:', ''), Sidekiq::QueuePause.process_key)
+          next if q.is_a?(Integer)
+          next if q.is_a?(Hash)
+
+          Sidekiq::QueuePause.paused?(q.gsub("queue:", ""), Sidekiq::QueuePause.process_key)
         end
       end
     end

sidekiq-queue-pause.gemspec

@@ -1,15 +1,26 @@
 Gem::Specification.new do |s|
-  s.name          = 'sidekiq-queue-pause'
-  s.version       = '0.1.0'
-  s.summary       = 'Pause a Sidekiq queue'
-  s.description   = 'Let\'s you pause/unpause individual sidekiq queues.'
-  s.license       = 'MIT'
-  s.authors       = ['Projective Technology GmbH']
-  s.email         = 'technology@projective.io'
-  s.homepage      = 'https://github.com/projectivetech/sidekiq-queue-pause'
+  s.name = "sidekiq-queue-pause"
+  s.version = "0.1.0"
+  s.summary = "Pause a Sidekiq queue"
+  s.description = "Let's you pause/unpause individual sidekiq queues."
+  s.license = "MIT"
+  s.authors = ["Projective Technology GmbH"]
+  s.email = "technology@projective.io"
+  s.homepage = "https://github.com/projectivetech/sidekiq-queue-pause"
 
-  s.require_paths = ['lib']
-  s.files         = Dir['lib/**/*rb']
+  s.require_paths = ["lib"]
+  s.files = Dir["lib/**/*rb"]
 
-  s.add_dependency 'sidekiq', '>= 6.0', '< 7.0'
+  s.add_dependency "sidekiq", ">= 6.0", "< 7.0"
+
+  s.add_development_dependency "rspec", "~> 3"
+  s.add_development_dependency "simplecov", "~> 0.21"
+  s.add_development_dependency "solargraph", "~> 0.44"
+  s.add_development_dependency "solargraph-standardrb", "~> 0.0.4"
+  s.add_development_dependency "standard", "~> 1.4"
+  s.add_development_dependency "guard", "~> 2.18"
+  s.add_development_dependency "guard-rspec", "~> 4.7"
+  s.add_development_dependency "pronto", "~> 0.11"
+  s.add_development_dependency "pronto-standardrb", "~> 0.1"
+  s.add_development_dependency "pronto-simplecov", "~> 0.11"
 end

spec/sidekiq-queue-pause_spec.rb

@@ -0,0 +1,35 @@
+require "spec_helper"
+
+describe Sidekiq::QueuePause do
+  describe Sidekiq::QueuePause::PausingFetch do
+    describe "#unpause_queues_cmd" do
+      let(:queuename) { "some_queue" }
+      let(:config) { {queues: [queuename], strict: true} }
+      let(:pausing_fetch) { described_class.new(config) }
+
+      context "with Sidekiq > 6.5.6 the queues list can contain Hashes" do
+        let(:queue_list) { ["queue:#{queuename}", {timeout: 2}] }
+
+        before { allow(pausing_fetch).to receive(:queues_cmd).and_return(queue_list) }
+
+        it "does not checked whether the Hash is paused" do
+          expect(Sidekiq::QueuePause).to receive(:paused?).with(queuename, Sidekiq::QueuePause.process_key).and_return(false)
+
+          expect(pausing_fetch.unpaused_queues_cmd).to match_array(queue_list)
+        end
+      end
+
+      context "with Sidekiq < 6.5.6 the queues list can contain an Integer" do
+        let(:queue_list) { ["queue:#{queuename}", 2] }
+
+        before { allow(pausing_fetch).to receive(:queues_cmd).and_return(queue_list) }
+
+        it "does not check whether the Integer is paused" do
+          expect(Sidekiq::QueuePause).to receive(:paused?).with(queuename, Sidekiq::QueuePause.process_key).and_return(false)
+
+          expect(pausing_fetch.unpaused_queues_cmd).to match_array(queue_list)
+        end
+      end
+    end
+  end
+end