sidekiq-merger 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7acc8bcc7c43fe634d4be54f9a4ce5c09135da27
-  data.tar.gz: ae19824415ac8fe3a38cd876977334f7e41ffaa2
+SHA256:
+  metadata.gz: 53e070ac5acbed069e9ac6b49e9f43651bdf0e061a8a29d461e5b40111c8c5f7
+  data.tar.gz: 9d08abf9726549e6dacb30a6382591bcb7d86b3bf219c30b4c151b471346872e
 SHA512:
-  metadata.gz: 8fe75f849916a6c70177f68bc9f4326b873d7715e43efdc42db5f26206f7561dd2db4a986c229e32fbe43e40b915ac769db94c6d03b10aaab0a78d27a777e9e5
-  data.tar.gz: 6a0ef14b3ebac1b36ff959da8d35a28454757b5cbe4ea89efb0799fec10d2c34f4d7e324e67b482c432f24812758f79d640401ad1bec877419abcb2e0dc1cf78
+  metadata.gz: 8baeb68048097d0e32c31ebb099f658fdb7201bccd8fed439956a60d82fd309d67dec63d4bfd95c4276c72d115c669d8fc49bf0405de789d28f3852725f5950c
+  data.tar.gz: 874696413e3d3d8b37cfa196b7adb72bb01526080017a9a34142cbd051f153568b03372d23ab36ca8944e05883452d440e88d65d20339ca3c5a35031b0402085

data/.codeclimate.yml

@@ -0,0 +1,21 @@
+engines:
+  brakeman:
+    enabled: true
+  duplication:
+    enabled: true
+    config:
+      languages:
+        - ruby
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - Gemfile.lock
+  - "**.erb"
+  - "**.rb"
+exclude_paths:
+  - "app/"
+  - "spec/"
+  - "misc/"

data/.gitignore

@@ -9,6 +9,8 @@ tmp/
 rdoc/
 
 /Gemfile.lock
+#Appraisal
+*.gemfile.lock 
 
 *.gem
 *.rbc

data/.rubocop.yml

@@ -1,5 +1,7 @@
 AllCops:
   DisabledByDefault: true
+  Exclude:
+    - 'gemfiles/**/*'
 
 Style/StringLiterals:
   Enabled: true
@@ -9,39 +11,42 @@ Style/StringLiteralsInInterpolation:
   Enabled: true
   EnforcedStyle: double_quotes
 
-Style/SpaceBeforeBlockBraces:
+Layout/SpaceBeforeBlockBraces:
   Enabled: true
   EnforcedStyle: 'space'
 
-Style/SpaceInsideBrackets:
+Layout/SpaceInsideArrayLiteralBrackets:
+  Enabled: true
+
+Layout/SpaceInsideReferenceBrackets:
   Enabled: true
 
-Style/SpaceInsideHashLiteralBraces:
+Layout/SpaceInsideHashLiteralBraces:
   Enabled: true
 
-Style/SpaceInsideBlockBraces:
+Layout/SpaceInsideBlockBraces:
   Enabled: true
 
-Style/SpaceAroundEqualsInParameterDefault:
+Layout/SpaceAroundEqualsInParameterDefault:
   Enabled: true
 
-Style/SpaceBeforeComma:
+Layout/SpaceBeforeComma:
   Enabled: false
 
-Style/SpaceAroundOperators:
+Layout/SpaceAroundOperators:
   Enabled: true
 
-Style/SpaceAfterComma:
+Layout/SpaceAfterComma:
   Enabled: true
 
-Style/ExtraSpacing:
+Layout/ExtraSpacing:
   Enabled: true
   AllowForAlignment: true
 
 Lint/DuplicateMethods:
   Enabled: true
 
-Metrics/LineLength:
+Layout/LineLength:
   Enabled: true
   Max: 200
   AllowHeredoc: true
@@ -65,16 +70,13 @@ Style/ClassAndModuleChildren:
   Exclude:
     - lib/sidekiq/merger/version.rb
 
-Rails/PluralizationGrammar:
-  Enabled: true
-
-Style/AlignArray:
+Layout/ArrayAlignment:
   Enabled: true
 
-Style/AlignHash:
+Layout/HashAlignment:
   Enabled: true
 
-Style/BlockEndNewline:
+Layout/BlockEndNewline:
   Enabled: false
 
 Style/DoubleNegation:

data/.travis.yml

@@ -1,14 +1,20 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.2.6
-  - 2.3.3
-  - 2.4.0
+  - 2.5.9
+  - 2.6.7
+  - 2.7.3
+gemfile:
+  - gemfiles/sidekiq_4_0.gemfile
+  - gemfiles/sidekiq_4_1.gemfile
+  - gemfiles/sidekiq_4_2.gemfile
+  - gemfiles/sidekiq_5_0.gemfile
+  - gemfiles/sidekiq_5_1.gemfile
 services:
   - redis-server
-before_install:
-  - gem update --system
-  - gem --version
+cache: bundler
 script:
   - "bundle exec rake spec"
   - "bundle exec rubocop -D"
+notifications:
+  email: false

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-5-1" do
+  gem "sidekiq", "~> 5.1.0"
+end

data/Dockerfile

@@ -1,10 +1,13 @@
 FROM ruby:2.3.3
 MAINTAINER dtaniwaki
 
-ENV PORT ${PORT:-3000}
+ENV PORT 3000
+ENV REDIS_HOST 127.0.0.1
+ENV REDIS_PORT 6379
+
 RUN gem install bundler
 ADD . /gem
 WORKDIR /gem/app
 RUN bundle install -j4
 
-EXPOSE 3000
+EXPOSE $PORT

data/Gemfile

@@ -4,3 +4,5 @@ gemspec
 
 gem "gem-release"
 gem "pry"
+
+gem "sidekiq", "~> #{ENV["SIDEKIQ_VERSION"]}" unless ENV["SIDEKIQ_VERSION"].nil?

data/README.md

@@ -6,8 +6,22 @@
 [![Coverage Status][cov-image]][cov-link]
 [![Code Climate][gpa-image]][gpa-link]
 
+[![Docker][docker-hub-image]][docker-hub-link]
+
 Merge [sidekiq](http://sidekiq.org/) jobs occurring before the execution times. Inspired by [sidekiq-grouping](https://github.com/gzigzigzeo/sidekiq-grouping).
 
+[Demo](http://sidekiq-merger.dtaniwaki.com/)
+
+## Use Case
+
+### Cancel Task
+
+![Cancel Task](misc/cancel_task_flow.png)
+
+### Bulk Notification
+
+![Bulk Notification](misc/bulk_notification_flow.png)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -91,6 +105,14 @@ Format: `Boolean`
 
 e.g. `true`
 
+### `batch_size` (optional, default: `nil`)
+
+Allow to specify how many jobs max to provide as arguments per aggregation
+
+Format: `Int`
+
+e.g. `50`
+
 ## Web UI
 
 ![Web UI](misc/web_ui.png)
@@ -103,13 +125,13 @@ require "sidekiq/merger/web"
 
 ## Test
 
-    $ bundle exec rspec
+    $ bundle exec appraisal rspec
 
 The test coverage is available at `./coverage/index.html`.
 
 ## Lint
 
-    $ bundle exec rubocop
+    $ bundle exec appraisal rubocop
 
 ## Contributing
 
@@ -133,4 +155,5 @@ Copyright (c) 2017 dtaniwaki. See [LICENSE](LICENSE) for details.
 [cov-link]:    https://coveralls.io/r/dtaniwaki/sidekiq-merger
 [gpa-image]:   https://codeclimate.com/github/dtaniwaki/sidekiq-merger.svg
 [gpa-link]:    https://codeclimate.com/github/dtaniwaki/sidekiq-merger
-
+[docker-hub-image]: http://dockeri.co/image/dtaniwaki/sidekiq-merger
+[docker-hub-link]: https://hub.docker.com/r/dtaniwaki/sidekiq-merger/

data/app/Gemfile

@@ -2,6 +2,7 @@ source "https://rubygems.org"
 
 gem "rack-flash3"
 gem "sinatra"
+gem "sinatra-contrib"
 gem "sidekiq"
 gem "sidekiq-status"
 

data/app/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    sidekiq-merger (0.0.6)
+    sidekiq-merger (0.0.10)
       activesupport (>= 3.2, < 6)
       concurrent-ruby (~> 1.0)
       sidekiq (>= 3.4, < 5)
@@ -14,15 +14,19 @@ GEM
       i18n (~> 0.7)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
+    backports (3.6.8)
     concurrent-ruby (1.0.4)
     connection_pool (2.2.1)
-    i18n (0.7.0)
+    i18n (0.8.0)
     minitest (5.10.1)
+    multi_json (1.12.1)
     rack (1.6.5)
     rack-flash3 (1.0.5)
       rack
     rack-protection (1.5.3)
       rack
+    rack-test (0.6.3)
+      rack (>= 1.0)
     redis (3.3.3)
     sidekiq (4.2.9)
       concurrent-ruby (~> 1.0)
@@ -35,6 +39,13 @@ GEM
       rack (~> 1.5)
       rack-protection (~> 1.4)
       tilt (>= 1.3, < 3)
+    sinatra-contrib (1.4.7)
+      backports (>= 2.0)
+      multi_json
+      rack-protection
+      rack-test
+      sinatra (~> 1.4.0)
+      tilt (>= 1.3, < 3)
     thread_safe (0.3.5)
     tilt (2.0.6)
     tzinfo (1.2.2)
@@ -49,6 +60,7 @@ DEPENDENCIES
   sidekiq-merger!
   sidekiq-status
   sinatra
+  sinatra-contrib
 
 BUNDLED WITH
    1.13.6

data/app/app.rb

@@ -1,5 +1,7 @@
 require_relative "./sidekiq"
 require "sinatra/base"
+require "sinatra/cookies"
+require "securerandom"
 require "rack/flash"
 require "sidekiq/web"
 require "sidekiq-status/web"
@@ -9,35 +11,57 @@ class App < Sinatra::Application
   enable :sessions
   use Rack::Flash
 
+  before do
+    @queue = cookies[:queue] ||= SecureRandom.urlsafe_base64(8)
+  end
+
   get "/" do
     erb :index
   end
 
   post "/some_worker/perform_in" do
     n = rand(10)
-    SomeWorker.perform_in((params[:in] || 60).to_i, n)
-    flash[:notice] = "Added #{n} to SomeWorker"
+    Sidekiq::Client.push(
+      "queue" => @queue,
+      "class" => SomeWorker,
+      "args" => [n],
+      "at" => Time.now + (params[:in] || 60)
+    )
+    flash[:notice] = "Added #{n} to SomeWorker to Queue #{@queue}"
     redirect "/"
   end
 
   post "/some_worker/perform_async" do
     n = rand(10)
-    SomeWorker.perform_async(n)
-    flash[:notice] = "Added #{n} to SomeWorker"
+    Sidekiq::Client.push(
+      "queue" => @queue,
+      "class" => SomeWorker,
+      "args" => [n]
+    )
+    flash[:notice] = "Added #{n} to SomeWorker to Queue #{@queue}"
     redirect "/"
   end
 
   post "/unique_worker/perform_in" do
     n = rand(10)
-    UniqueWorker.perform_in((params[:in] || 60).to_i, n)
-    flash[:notice] = "Added #{n} to UniqueWorker"
+    Sidekiq::Client.push(
+      "queue" => @queue,
+      "class" => UniqueWorker,
+      "args" => [n],
+      "at" => Time.now + (params[:in] || 60)
+    )
+    flash[:notice] = "Added #{n} to UniqueWorker to Queue #{@queue}"
     redirect "/"
   end
 
   post "/unique_worker/perform_async" do
     n = rand(10)
-    UniqueWorker.perform_async(n)
-    flash[:notice] = "Added #{n} to UniqueWorker"
+    Sidekiq::Client.push(
+      "queue" => @queue,
+      "class" => UniqueWorker,
+      "args" => [n]
+    )
+    flash[:notice] = "Added #{n} to UniqueWorker to Queue #{@queue}"
     redirect "/"
   end
 end

data/app/views/index.erb

@@ -1,35 +1,64 @@
-<html>
+<!DOCTYPE html>
+<html lang="en">
 <head>
-<meta charset="UTF-8">
+  <meta charset="UTF-8">
+  <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css">
+  <title>Sidekiq Merger</title>
+  <meta name="description" content="Merge sidekiq jobs occurring before the execution times. Inspired by sidekiq-grouping.">
 </head>
 <body>
-  <h1>Sidekiq Merger</h1>
-  <% if flash[:notice] %>
-    <p style="color: green; font-weight: bold;"><%= flash[:notice] %></p>
-  <% end %>
-  <p>
-    <a href="/sidekiq" target="_blank">Open sidekiq console</a>
-  </p>
-  <h2>Workers</h2>
-  <div style="margin-left: 20px;">
-    <h3>SomeWorker</h3>
-    <div>
-      <form action="/some_worker/perform_in" method="post" style="display: inline-block;">
-        <input type="submit" name="perform_in" value="perform_in">
-      </form>
-      <form action="/some_worker/perform_in" method="post" style="display: inline-block;">
-        <input type="submit" name="perform_async" value="perform_async">
-      </form>
+  <header class="navbar">
+    <div class="container">
+      <h1>Sidekiq Merger</h1>
+      <a href="https://github.com/dtaniwaki/sidekiq-merger">View Source on GitHub →</a>
     </div>
-    <h3>UniqueWorker</h3>
+  </header>
+  <div class="container">
+    <% if flash[:notice] %>
+      <div class="alert alert-info">
+        <a href="#" class="close" data-dismiss="alert">&times;</a>
+        <p><%= flash[:notice] %></p>
+      </div>
+    <% end %>
+    <p class="lead">
+      Click the `perform_in` buttons to create or merge tasks until the execution time (in 60s).<br>
+      Click the `perform_async` buttons to execute a single task.<br><br>
+      Open <a href="<%= "/sidekiq/merges?queue=#{@queue}" %>" target="_blank">sidekiq console</a> to check what happens.
+    </p>
     <div>
-      <form action="/unique_worker/perform_in" method="post" style="display: inline-block;">
-        <input type="submit" name="perform_in" value="perform_in">
-      </form>
-      <form action="/unique_worker/perform_in" method="post" style="display: inline-block;">
-        <input type="submit" name="perform_async" value="perform_async">
-      </form>
+      <h2>SomeWorker</h2>
+      <p>
+        <code>sidekiq_options merger: { unique: false }</code>
+      </p>
+      <p class="lead">
+        <small>Tasks will be merged regardless of uniqueness.</small>
+      </p>
+      <div>
+        <form action="/some_worker/perform_in" method="post" style="display: inline-block;">
+          <input type="submit" name="perform_in" value="perform_in" class="btn btn-primary">
+        </form>
+        <form action="/some_worker/perform_in" method="post" style="display: inline-block;">
+          <input type="submit" name="perform_async" value="perform_async" class="btn btn-default">
+        </form>
+      </div>
+      <h2>UniqueWorker</h2>
+      <p>
+        <code>sidekiq_options merger: { unique: true }</code>
+      </p>
+      <p class="lead">
+        <small>Tasks will be merged if they haven't added already.</small>
+      </p>
+      <div>
+        <form action="/unique_worker/perform_in" method="post" style="display: inline-block;">
+          <input type="submit" name="perform_in" value="perform_in" class="btn btn-primary">
+        </form>
+        <form action="/unique_worker/perform_in" method="post" style="display: inline-block;">
+          <input type="submit" name="perform_async" value="perform_async" class="btn btn-default">
+        </form>
+      </div>
     </div>
   </div>
+  <script type="text/javascript" src="https://code.jquery.com/jquery-3.1.1.min.js"></script>
+  <script type="text/javascript" src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js"></script>
 </body>
 </html>

data/docker-compose.yml

@@ -20,7 +20,8 @@ services:
     links:
       - redis
     environment:
+      - PORT=3000
       - REDIS_HOST=redis
       - REDIS_PORT=6379
   redis:
-    image: redis:latest
+    image: redis:3.2.7

data/gemfiles/sidekiq_4_0.gemfile

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

data/gemfiles/sidekiq_4_1.gemfile

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

data/gemfiles/sidekiq_4_2.gemfile

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

data/gemfiles/sidekiq_5_0.gemfile

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

data/gemfiles/sidekiq_5_1.gemfile

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

data/lib/sidekiq/merger/config.rb

@@ -1,6 +1,6 @@
 require "active_support/configurable"
 
-module Sidekiq::Merger::Config
+class Sidekiq::Merger::Config
   include ActiveSupport::Configurable
 
   def self.options

data/lib/sidekiq/merger/merge.rb

@@ -73,12 +73,16 @@ class Sidekiq::Merger::Merge
     end
 
     unless msgs.empty?
-      Sidekiq::Client.push(
-        "class" => worker_class,
-        "queue" => queue,
-        "args" => msgs,
-        "merged" => true
-      )
+      batches = options[:batch_size].nil? ? [msgs] : msgs.each_slice(options[:batch_size].to_i).to_a
+      batches.each do |batch_msgs|
+        # preserve FIFO when enqueuing batches
+        Sidekiq::Client.push(
+          "class" => worker_class,
+          "queue" => queue,
+          "args" => batch_msgs,
+          "merged" => true
+        )
+      end
     end
   end
 

data/lib/sidekiq/merger/middleware.rb

@@ -1,7 +1,7 @@
 require_relative "merge"
 
 class Sidekiq::Merger::Middleware
-  def call(worker_class, msg, queue, redis_pool = nil)
+  def call(worker_class, msg, queue, _ = nil)
     return yield if defined?(Sidekiq::Testing) && Sidekiq::Testing.inline?
 
     worker_class = worker_class.camelize.constantize if worker_class.is_a?(String)
@@ -9,14 +9,16 @@ class Sidekiq::Merger::Middleware
 
     merger_enabled = options.key?("merger")
 
-    if merger_enabled && !msg["at"].nil? && msg["at"].to_f > Time.now.to_f
+    return yield unless merger_enabled
+
+    if !msg["at"].nil? && msg["at"].to_f > Time.now.to_f
       Sidekiq::Merger::Merge
         .initialize_with_args(worker_class, queue, msg["args"])
         .add(msg["args"], msg["at"])
       false
     else
-      msg["args"] = [msg["args"]] unless msg.delete("merged")
-      yield(worker_class, msg, queue, redis_pool)
+      msg["args"] = [msg["args"].flatten] unless msg.delete("merged")
+      yield
     end
   end
 end

data/lib/sidekiq/merger/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Merger
-    VERSION = "0.0.9".freeze
+    VERSION = "0.1.0".freeze
   end
 end

data/lib/sidekiq/merger/views/index.erb

@@ -25,7 +25,7 @@
           <td><%= merge.all_args %></td>
           <td><%= merge.execution_time || "&ndash;"%></td>
           <td>
-            <form action="<%= "#{root_path}merger/#{URI.encode_www_form_component merge.full_merge_key}/delete" %>" method="post">
+            <form action="<%= "#{root_path}merges/#{URI.encode_www_form_component merge.full_merge_key}/delete" %>" method="post">
               <%= csrf_tag %>
               <input class="btn btn-danger btn-xs" type="submit" name="delete" value="Delete" data-confirm="Are you sure you want to delete this merge?" />
             </form>

data/lib/sidekiq/merger/web.rb

@@ -6,6 +6,7 @@ module Sidekiq::Merger::Web
   def self.registered(app)
     app.get "/merges" do
       @merges = Sidekiq::Merger::Merge.all
+      @merges.select! { |m| m.queue == params[:queue] } unless params[:queue].nil?
       erb File.read(File.join(VIEWS, "index.erb")), locals: { view_path: VIEWS }
     end
 

data/lib/sidekiq/merger.rb

@@ -22,6 +22,14 @@ module Sidekiq::Merger
       task.add_observer(observer)
       task
     end
+
+    def configure(&block)
+      yield config
+    end
+
+    def config
+      @config ||= Config.new
+    end
   end
 
   self.logger = Sidekiq.logger

data/sidekiq-merger.gemspec

@@ -22,16 +22,17 @@ Gem::Specification.new do |spec|
   spec.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = [">= 2.2.2", "< 2.5"]
+  spec.required_ruby_version = [">= 2.5.0"]
 
   spec.add_development_dependency "rake", ">= 10.0", "< 13"
   spec.add_development_dependency "rspec", ">= 3.0", "< 4"
   spec.add_development_dependency "simplecov", "~> 0.12"
   spec.add_development_dependency "timecop", "~> 0.8"
-  spec.add_development_dependency "rubocop", "~> 0.47"
+  spec.add_development_dependency "rubocop", "~> 0.93.1"
   spec.add_development_dependency "coveralls", "~> 0.8"
+  spec.add_development_dependency "appraisal"
 
-  spec.add_runtime_dependency "sidekiq", ">= 3.4", "< 5"
+  spec.add_runtime_dependency "sidekiq", ">= 4.0", "< 6"
   spec.add_runtime_dependency "concurrent-ruby", "~> 1.0"
   spec.add_runtime_dependency "activesupport", ">= 3.2", "< 6"
 end

data/spec/sidekiq/merger/merge_spec.rb

@@ -1,28 +1,13 @@
 require "spec_helper"
 
-describe Sidekiq::Merger::Merge do
+describe Sidekiq::Merger::Merge, worker_class: true do
   subject { described_class.new(worker_class, queue, args, redis: redis) }
   let(:args) { "foo" }
   let(:redis) { Sidekiq::Merger::Redis.new }
   let(:queue) { "queue" }
   let(:now) { Time.now }
   let(:execution_time) { now + 10.seconds }
-  let(:options) { { key: -> (args) { args.to_json } } }
-  let(:worker_class) do
-    local_options = options
-    Class.new do
-      include Sidekiq::Worker
-
-      sidekiq_options merger: local_options
-
-      def self.name
-        "name"
-      end
-
-      def perform(args)
-      end
-    end
-  end
+  let(:worker_options) { { key: -> (args) { args.to_json } } }
   before { Timecop.freeze(now) }
 
   describe ".all" do
@@ -64,30 +49,30 @@ describe Sidekiq::Merger::Merge do
 
   describe ".merge_key" do
     let(:args) { "foo" }
-    let(:options) { {} }
+    let(:worker_options) { {} }
     it "returns an empty string" do
       expect(described_class.merge_key(worker_class, args)).to eq ""
     end
     context "string key" do
-      let(:options) { { key: "bar" } }
+      let(:worker_options) { { key: "bar" } }
       it "returns the string" do
         expect(described_class.merge_key(worker_class, args)).to eq "bar"
       end
     end
     context "other type key" do
-      let(:options) { { key: [1, 2, 3] } }
+      let(:worker_options) { { key: [1, 2, 3] } }
       it "returns nil" do
         expect(described_class.merge_key(worker_class, args)).to eq "[1,2,3]"
       end
     end
     context "proc key" do
       let(:args) { [1, 2, 3] }
-      let(:options) { { key: -> (args) { args[0].to_s } } }
+      let(:worker_options) { { key: -> (args) { args[0].to_s } } }
       it "returns the result of the proc" do
         expect(described_class.merge_key(worker_class, args)).to eq "1"
       end
       context "non-string result" do
-        let(:options) { { key: -> (args) { args[0] } } }
+        let(:worker_options) { { key: -> (args) { args[0] } } }
         it "returns nil" do
           expect(described_class.merge_key(worker_class, args)).to eq "1"
         end
@@ -97,13 +82,13 @@ describe Sidekiq::Merger::Merge do
 
   describe "#add" do
     it "adds the args in lazy merge" do
-      expect(redis).to receive(:push_message).with("name:queue:foo", [1, 2, 3], execution_time)
+      expect(redis).to receive(:push_message).with("some_worker:queue:foo", [1, 2, 3], execution_time)
       subject.add([1, 2, 3], execution_time)
     end
     context "with unique option" do
-      let(:options) { { key: -> (args) { args.to_json }, unique: true } }
+      let(:worker_options) { { key: -> (args) { args.to_json }, unique: true } }
       it "adds the args in lazy merge" do
-        expect(redis).to receive(:push_message).with("name:queue:foo", [1, 2, 3], execution_time)
+        expect(redis).to receive(:push_message).with("some_worker:queue:foo", [1, 2, 3], execution_time)
         subject.add([1, 2, 3], execution_time)
       end
       context "the args has alredy been added" do
@@ -118,7 +103,7 @@ describe Sidekiq::Merger::Merge do
 
   describe "#delete" do
     it "adds the args in lazy merge" do
-      expect(redis).to receive(:delete_message).with("name:queue:foo", [1, 2, 3])
+      expect(redis).to receive(:delete_message).with("some_worker:queue:foo", [1, 2, 3])
       subject.delete([1, 2, 3])
     end
   end
@@ -156,19 +141,48 @@ describe Sidekiq::Merger::Merge do
   end
 
   describe "#flush" do
-    before do
-      subject.add([1, 2, 3], execution_time)
-      subject.add([2, 3, 4], execution_time)
+    context "when no batch_size is configured" do
+      before do
+        subject.add([1, 2, 3], execution_time)
+        subject.add([2, 3, 4], execution_time)
+      end
+      it "flushes all the args" do
+        expect(Sidekiq::Client).to receive(:push).with(
+          "class" => worker_class,
+          "queue" => queue,
+          "args" => a_collection_containing_exactly([1, 2, 3], [2, 3, 4]),
+          "merged" => true
+        )
+  
+        subject.flush
+      end
     end
-    it "flushes all the args" do
-      expect(Sidekiq::Client).to receive(:push).with(
-        "class" => worker_class,
-        "queue" => queue,
-        "args" => a_collection_containing_exactly([1, 2, 3], [2, 3, 4]),
-        "merged" => true
-      )
 
-      subject.flush
+    context "when batch_size is configured to 2" do
+      let(:worker_options) { { key: -> (args) { args.to_json }, batch_size: 2 } }
+      before do
+        subject.add([1, 2, 3], execution_time)
+        subject.add([2, 3, 4], execution_time)
+        subject.add([3, 4, 5], execution_time)
+        subject.add([4, 5, 6], execution_time)
+      end
+      it "flushes all the args" do
+        expect(Sidekiq::Client).to receive(:push).with(
+          "class" => worker_class,
+          "queue" => queue,
+          "args" => a_collection_containing_exactly([1, 2, 3], [2, 3, 4]),
+          "merged" => true
+        )
+
+        expect(Sidekiq::Client).to receive(:push).with(
+          "class" => worker_class,
+          "queue" => queue,
+          "args" => a_collection_containing_exactly([3, 4, 5], [4, 5, 6]),
+          "merged" => true
+        )
+
+        subject.flush
+      end
     end
   end
 
@@ -195,7 +209,7 @@ describe Sidekiq::Merger::Merge do
 
   describe "#full_merge_key" do
     it "returns full merge key" do
-      expect(subject.full_merge_key).to eq "name:queue:foo"
+      expect(subject.full_merge_key).to eq "some_worker:queue:foo"
     end
   end
 end

data/spec/sidekiq/merger/middleware_spec.rb

@@ -1,32 +1,24 @@
 require "spec_helper"
 
-describe Sidekiq::Merger::Middleware do
+describe Sidekiq::Merger::Middleware, worker_class: true do
   subject { described_class.new }
   let(:flusher) { Sidekiq::Merger::Flusher.new(Sidekiq.logger) }
   let(:queue) { "queue" }
   let(:now) { Time.now }
-  let(:options) { { key: -> (args) { "key" } } }
-  let(:worker_class) do
-    local_options = options
-    Class.new do
-      include Sidekiq::Worker
-
-      sidekiq_options merger: local_options
-
-      def self.name
-        "name"
-      end
-
-      def perform(*args)
-      end
-    end
-  end
   before :example do
-    allow(Object).to receive(:const_get).with("Name").and_return worker_class
     Timecop.freeze(now)
   end
 
   describe "#call" do
+    context "non-merger worker" do
+      it "leaves args alone" do
+        msg = { "args" => [1, 2, 3] }
+        expect { |b| subject.call(non_merge_worker_class, msg, queue, &b) }.to yield_with_no_args
+        expect(msg).to eq({ "args" => [1, 2, 3] }) #unmodified
+        flusher.flush
+        expect(worker_class.jobs.size).to eq 0
+      end
+    end
     it "adds the args to the merge" do
       subject.call(worker_class, { "args" => [1, 2, 3], "at" => (now + 10.seconds).to_f }, queue) {}
       subject.call(worker_class, { "args" => [2, 3, 4], "at" => (now + 15.seconds).to_f }, queue) {}
@@ -41,13 +33,17 @@ describe Sidekiq::Merger::Middleware do
     end
     context "without at msg" do
       it "peforms now with brackets" do
-        expect { |b| subject.call(worker_class, { "args" => [1, 2, 3] }, queue, &b) }.to yield_with_args(worker_class, { "args" => [[1, 2, 3]] }, queue, anything)
+        msg = { "args" => [1, 2, 3] }
+        expect { |b| subject.call(worker_class, msg, queue, &b) }.to yield_with_no_args
+        expect(msg).to eq({ "args" => [[1, 2, 3]] })
         flusher.flush
         expect(worker_class.jobs.size).to eq 0
       end
       context "merged msgs" do
         it "performs now" do
-          expect { |b| subject.call(worker_class, { "args" => [[1, 2, 3]], "merged" => true }, queue, &b) }.to yield_with_args(worker_class, { "args" => [[1, 2, 3]] }, queue, anything)
+          msg = { "args" => [[1, 2, 3]], "merged" => true }
+          expect { |b| subject.call(worker_class, msg, queue, &b) }.to yield_with_no_args
+          expect(msg).to eq({ "args" => [[1, 2, 3]] })
           flusher.flush
           expect(worker_class.jobs.size).to eq 0
         end
@@ -55,7 +51,9 @@ describe Sidekiq::Merger::Middleware do
     end
     context "at is before current time" do
       it "peforms now" do
-        expect { |b| subject.call(worker_class, { "args" => [1, 2, 3], "at" => now.to_f }, queue, &b) }.to yield_with_args(worker_class, { "args" => [[1, 2, 3]], "at" => now.to_f }, queue, anything)
+        msg = { "args" => [1, 2, 3], "at" => now.to_f }
+        expect { |b| subject.call(worker_class, msg, queue, &b) }.to yield_with_no_args
+        expect(msg).to eq({ "args" => [[1, 2, 3]], "at" => now.to_f })
         flusher.flush
         expect(worker_class.jobs.size).to eq 0
       end

data/spec/sidekiq/merger_spec.rb

@@ -4,11 +4,26 @@ describe Sidekiq::Merger do
   it "has a version number" do
     expect(described_class::VERSION).not_to be nil
   end
-  describe "#create_task" do
+  describe ".create_task" do
     it "starts a monitoring task" do
       task = described_class.create_task
       expect(task).to be_a Concurrent::TimerTask
       task.shutdown
     end
   end
+  describe ".configure" do
+    it "yields to the config" do
+      expect { |b| described_class.configure(&b) }.to yield_with_args(described_class.config)
+    end
+  end
+  describe ".config" do
+    it "returns a config" do
+      expect(described_class.config).to be_a Sidekiq::Merger::Config
+    end
+    context "called twice" do
+      it "returns the same config instance" do
+        expect(described_class.config).to be described_class.config
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -21,31 +21,15 @@ require "sidekiq/merger"
 Dir[File.join(__dir__, "support", "**", "*.rb")].each { |f| require f }
 
 RSpec.configure do |config|
-  # rspec-expectations config goes here. You can use an alternate
-  # assertion/expectation library such as wrong or the stdlib/minitest
-  # assertions if you prefer.
   config.expect_with :rspec do |expectations|
-    # This option will default to `true` in RSpec 4. It makes the `description`
-    # and `failure_message` of custom matchers include text for helper methods
-    # defined using `chain`, e.g.:
-    # be_bigger_than(2).and_smaller_than(4).description
-    #   # => "be bigger than 2 and smaller than 4"
-    # ...rather than:
-    #   # => "be bigger than 2"
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true
   end
 
   config.mock_with :rspec do |mocks|
-    # Prevents you from mocking or stubbing a method that does not exist on
-    # a real object. This is generally recommended, and will default to
-    # `true` in RSpec 4.
     mocks.verify_partial_doubles = true
   end
 
   if config.files_to_run.one?
-    # Use the documentation formatter for detailed output,
-    # unless a formatter has already been configured
-    # (e.g. via a command-line flag).
     config.default_formatter = "doc"
   end
 
@@ -57,11 +41,17 @@ RSpec.configure do |config|
     Sidekiq::Testing.fake!
     Sidekiq::Merger.logger = nil
     Sidekiq.logger = nil
+    if Redis.respond_to?(:exists_returns_integer)
+      Redis.exists_returns_integer = false
+    end
   end
 
-  config.before :example do
-    Sidekiq::Merger::Redis.redis do |conn|
-      conn.flushall
+  config.around :example do |example|
+    Sidekiq::Merger::Redis.redis { |conn| conn.flushall }
+    begin
+      example.run
+    ensure
+      Sidekiq::Merger::Redis.redis { |conn| conn.flushall }
     end
   end
 

data/spec/support/worker_class.rb

@@ -0,0 +1,49 @@
+RSpec.shared_context "worker class", worker_class: true do
+  let(:worker_options) { { key: -> (args) { "key" } } }
+  let(:worker_class) do
+    local_options = worker_options
+    Class.new do
+      include Sidekiq::Worker
+
+      sidekiq_options merger: local_options
+
+      def self.name
+        "SomeWorker"
+      end
+
+      def self.to_s
+        "SomeWorker"
+      end
+
+      def perform(*args)
+      end
+    end
+  end
+  let(:non_merge_worker_class) do
+    Class.new do
+      include Sidekiq::Worker
+
+      def self.to_s
+        "NonMergeWorker"
+      end
+
+      def perform(*args)
+      end
+    end
+  end
+  before :example do
+    allow(Object).to receive(:const_get).with(anything).and_call_original
+    allow(Object).to receive(:const_get).with("SomeWorker").and_return worker_class
+    allow(Object).to receive(:const_get).with("NonMergeWorker").and_return non_merge_worker_class
+  end
+  around :example do |example|
+    worker_class.jobs.clear
+    non_merge_worker_class.jobs.clear
+    begin
+      example.run
+    ensure
+      worker_class.jobs.clear
+      non_merge_worker_class.jobs.clear
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-merger
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - dtaniwaki
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-02-01 00:00:00.000000000 Z
+date: 2021-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -84,14 +84,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.47'
+        version: 0.93.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.47'
+        version: 0.93.1
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -106,26 +106,40 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+- !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: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -167,12 +181,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".dockerignore"
 - ".gemrelease"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- Appraisals
 - Dockerfile
 - Gemfile
 - LICENSE
@@ -188,6 +204,11 @@ files:
 - app/workers/unique_worker.rb
 - docker-compose-common.yml
 - docker-compose.yml
+- gemfiles/sidekiq_4_0.gemfile
+- gemfiles/sidekiq_4_1.gemfile
+- gemfiles/sidekiq_4_2.gemfile
+- gemfiles/sidekiq_5_0.gemfile
+- gemfiles/sidekiq_5_1.gemfile
 - lib/sidekiq-merger.rb
 - lib/sidekiq/merger.rb
 - lib/sidekiq/merger/config.rb
@@ -199,6 +220,8 @@ files:
 - lib/sidekiq/merger/version.rb
 - lib/sidekiq/merger/views/index.erb
 - lib/sidekiq/merger/web.rb
+- misc/bulk_notification_flow.png
+- misc/cancel_task_flow.png
 - misc/web_ui.png
 - sidekiq-merger.gemspec
 - spec/sidekiq/merger/flusher_spec.rb
@@ -209,11 +232,12 @@ files:
 - spec/sidekiq/merger_spec.rb
 - spec/spec_helper.rb
 - spec/support/matchers.rb
+- spec/support/worker_class.rb
 homepage: https://github.com/dtaniwaki/sidekiq-merger
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -221,19 +245,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.2
-  - - "<"
-    - !ruby/object:Gem::Version
-      version: '2.5'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Sidekiq merger plugin
 test_files:
@@ -245,3 +265,4 @@ test_files:
 - spec/sidekiq/merger_spec.rb
 - spec/spec_helper.rb
 - spec/support/matchers.rb
+- spec/support/worker_class.rb