sidekiq-grouping 1.0.9 → 1.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 42ade6a2a9e5a211f91f65d138add7f4cbeaeef8
-  data.tar.gz: a230dcc8364303f18e45920294ca9f8c5a5b8895
+SHA256:
+  metadata.gz: fd82358a1dc3ea13dcebc3d113272316e3c334fa3e562dad7eb2828590626988
+  data.tar.gz: 90a9116faf2392b7b5d81ce80346afd3741c897bf60b215eaac43f954e5fcb38
 SHA512:
-  metadata.gz: 8ebcd0fa5c6ec5c6b9428836547c8036db3eb8093567f47830790e1bd2d90622085f17fe10d42a2a35e3d08b06520c90e35f45060be37ec60f7c7dd3f89698a9
-  data.tar.gz: 58a8742715f73757ef98f881df956022ee8341f7bbffb2d724eefbbd345866a5ae6433d07dbc354e0ebdd624459228b36ed884ff93c8f4c663841af421eb74d1
+  metadata.gz: f08a2fe6ed7811eefae95487143f0db3beb5343c3c3b11b2e7472b805b9eb0a5b6394c84b933219bf2648e6706a463bfc2cd30f1f1e623f48e665d9dec452b0d
+  data.tar.gz: ca99dbc220c9e757549bfd5659ac0673db96f1eadb394b2a396eb7581df482156c83bb107eee98e91744f0f7d93663d393d25f1b7996aac2df84f5e09d69baa3

data/.gitignore

@@ -4,6 +4,7 @@
 .config
 .yardoc
 Gemfile.lock
+gemfiles/*.lock
 InstalledFiles
 _yardoc
 coverage

data/.travis.yml

@@ -1,7 +1,18 @@
 language: ruby
 rvm:
   - 2.2
+  - 2.3.1
+  - 2.4
+  - 2.5
+
 cache: bundler
 
 services:
   - redis-server
+
+gemfile:
+  - gemfiles/sidekiq_4.0.gemfile
+  - gemfiles/sidekiq_4.1.gemfile
+  - gemfiles/sidekiq_4.2.gemfile
+  - gemfiles/sidekiq_5.0.gemfile
+  - gemfiles/sidekiq_master.gemfile

data/Appraisals

@@ -0,0 +1,19 @@
+appraise 'sidekiq-4.0' do
+  gem 'sidekiq', '~> 4.0.0'
+end
+
+appraise 'sidekiq-4.1' do
+  gem 'sidekiq', '~> 4.1.0'
+end
+
+appraise 'sidekiq-4.2' do
+  gem 'sidekiq', '~> 4.2.0'
+end
+
+appraise 'sidekiq-5.0' do
+  gem 'sidekiq', '~> 5.0.0'
+end
+
+appraise 'sidekiq-master' do
+  gem 'sidekiq', github: 'mperham/sidekiq'
+end

data/README.md

@@ -111,6 +111,8 @@ This jobs will be grouped into the single job with the single argument:
   # => [[5]]
   ```
 
+- `tests_env` is used to silence some logging in test environments (see below). Default: true if `Rails.env.test?`, false otherwise.
+
 ## Web UI
 
 ![Web UI](web.png)
@@ -142,9 +144,56 @@ Sidekiq::Grouping::Config.lock_ttl = 1
 
 Note that you should set poll_interval option inside of sidekiq.yml to take effect. Setting this param in your ruby code won't change actual polling frequency.
 
-## TODO
+## Testing with Sidekiq::Testing.fake!
+
+Sidekiq::Grouping uses internal queues for grouping tasks. If you need to force flush internal queues into normal Sidekiq queues, use `Sidekiq::Grouping.force_flush_for_test!`.
+
+See example:
+
+```ruby
+# worker
+class GroupedWorker
+
+  include Sidekiq::Worker
+  sidekiq_options(
+    queue: :custom_queue,
+    retry: 5,
+    batch_flush_size: 9,
+    batch_flush_interval: 10,
+    batch_size: 3,
+    batch_unique: true
+  )
+
+  def perform(grouped_arguments)
+    # ... important payload
+  end
+
+end
+
+# test itself
+RSpec.describe GroupedWorker, type: :worker do
 
-1. Add support redis_pool option.
+  describe '#perform' do
+    it 'calls perform with array of arguments' do
+      Sidekiq::Testing.fake! do
+        described_class.perform_async(1)
+        described_class.perform_async(1)
+        described_class.perform_async(2)
+        described_class.perform_async(2)
+
+        # All 4 above asks will be put to :custom_queue despite of :batch_flush_size is set to 9.
+        Sidekiq::Grouping.force_flush_for_test!
+
+        last_job = described_class.jobs.last
+        expect(last_job['args']).to eq([[[1], [2]]])
+        expect(last_job['queue']).to eq('custom_queue')
+      end
+    end
+  end
+
+end
+
+```
 
 ## Installation
 

data/gemfiles/sidekiq_4.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sidekiq", "~> 4.0.0"
+
+gemspec path: "../"

data/gemfiles/sidekiq_4.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sidekiq", "~> 4.1.0"
+
+gemspec path: "../"

data/gemfiles/sidekiq_4.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sidekiq", "~> 4.2.0"
+
+gemspec path: "../"

data/gemfiles/sidekiq_5.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sidekiq", "~> 5.0.0"
+
+gemspec path: "../"

data/gemfiles/sidekiq_master.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sidekiq", github: "mperham/sidekiq"
+
+gemspec path: "../"

data/lib/sidekiq/grouping.rb

@@ -19,6 +19,10 @@ module Sidekiq::Grouping
       @logger ||= Sidekiq.logger
     end
 
+    def force_flush_for_test!
+      Sidekiq::Grouping::Flusher.new.force_flush_for_test!
+    end
+
     def start!
       interval = Sidekiq::Grouping::Config.poll_interval
       @observer = Sidekiq::Grouping::FlusherObserver.new

data/lib/sidekiq/grouping/config.rb

@@ -2,7 +2,7 @@ module Sidekiq::Grouping::Config
   include ActiveSupport::Configurable
 
   def self.options
-    Sidekiq.options["grouping"] || {}
+    Sidekiq.options[:grouping] || Sidekiq.options["grouping"] || {} # sidekiq 5.x use symbol in keys
   end
 
   # Queue size overflow check polling interval
@@ -19,4 +19,11 @@ module Sidekiq::Grouping::Config
   config_accessor :lock_ttl do
     options[:lock_ttl] || 1
   end
+
+  # Option to override how Sidekiq::Grouping know about tests env
+  config_accessor :tests_env do
+    options[:tests_env] || (
+      defined?(::Rails) && Rails.respond_to?(:env) && Rails.env.test?
+    )
+  end
 end

data/lib/sidekiq/grouping/flusher.rb

@@ -3,18 +3,40 @@ class Sidekiq::Grouping::Flusher
     batches = Sidekiq::Grouping::Batch.all.map do |batch|
       batch if batch.could_flush?
     end
-    batches.compact!
-    flush_concrete(batches)
+    flush_batches(batches)
+  end
+
+  def force_flush_for_test!
+    unless Sidekiq::Grouping::Config.tests_env
+      Sidekiq::Grouping.logger.warn(
+        "**************************************************"
+      )
+      Sidekiq::Grouping.logger.warn([
+        "⛔️ force_flush_for_test! for testing API, ",
+        "but this is not the test environment. ",
+        "Please check your environment or ",
+        "change 'tests_env' to cover this one"
+      ].join)
+      Sidekiq::Grouping.logger.warn(
+        "**************************************************"
+      )
+    end
+    flush_batches(Sidekiq::Grouping::Batch.all)
   end
 
   private
 
+  def flush_batches(batches)
+    batches.compact!
+    flush_concrete(batches)
+  end
+
   def flush_concrete(batches)
     return if batches.empty?
     names = batches.map { |batch| "#{batch.worker_class} in #{batch.queue}" }
     Sidekiq::Grouping.logger.info(
       "[Sidekiq::Grouping] Trying to flush batched queues: #{names.join(',')}"
-    )
+    ) unless Sidekiq::Grouping::Config.tests_env
     batches.each(&:flush)
   end
 end

data/lib/sidekiq/grouping/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Grouping
-    VERSION = "1.0.9  "
+    VERSION = "1.0.10"
   end
 end

data/sidekiq-grouping.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "rspec-sidekiq"
   spec.add_development_dependency "timecop"
+  spec.add_development_dependency "appraisal"
 
   spec.add_dependency "activesupport"
   spec.add_dependency "sidekiq", ">= 3.4.2"

data/spec/modules/batch_spec.rb

@@ -6,7 +6,7 @@ describe Sidekiq::Grouping::Batch do
   context 'adding' do
     it 'must enqueue unbatched worker' do
        RegularWorker.perform_async('bar')
-       expect(RegularWorker).to have_enqueued_job('bar')
+       expect(RegularWorker).to have_enqueued_sidekiq_job("bar")
     end
 
     it 'must not enqueue batched worker' do
@@ -67,7 +67,9 @@ describe Sidekiq::Grouping::Batch do
       expect(batch.could_flush?).to be_falsy
       10.times { |n| BatchedSizeWorker.perform_async("bar#{n}") }
       batch.flush
-      expect(BatchedSizeWorker).to have_enqueued_job([["bar0"], ["bar1"]])
+      expect(BatchedSizeWorker).to(
+        have_enqueued_sidekiq_job([["bar0"], ["bar1"]])
+      )
       expect(batch.size).to eq(7)
     end
   end
@@ -124,7 +126,7 @@ describe Sidekiq::Grouping::Batch do
 
   private
   def expect_batch(klass, queue)
-    expect(klass).to_not have_enqueued_job('bar')
+    expect(klass).to_not have_enqueued_sidekiq_job("bar")
     batch = subject.new(klass.name, queue)
     stats = subject.all
     expect(batch.size).to eq(1)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-grouping
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.0.10
 platform: ruby
 authors:
 - Victor Sokolov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-30 00:00:00.000000000 Z
+date: 2018-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -146,10 +160,16 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- Appraisals
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- gemfiles/sidekiq_4.0.gemfile
+- gemfiles/sidekiq_4.1.gemfile
+- gemfiles/sidekiq_4.2.gemfile
+- gemfiles/sidekiq_5.0.gemfile
+- gemfiles/sidekiq_master.gemfile
 - lib/sidekiq/grouping.rb
 - lib/sidekiq/grouping/batch.rb
 - lib/sidekiq/grouping/config.rb
@@ -186,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Allows identical sidekiq jobs to be processed with a single background call