sidekiq-merger 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 868770b1fc4d83d09ceec2f91f5d2b539ed645c3
-  data.tar.gz: 6e39e32f88984066ca1352e14cca9fba4d72501e
+  metadata.gz: 3468cfb6c6b95fa60dd5db64e5ce1a4ae04e5aac
+  data.tar.gz: 0b44b824a0b6ce4caf290fceae0f103c69493b9a
 SHA512:
-  metadata.gz: e3f727a6a1a1135f4b86032d0c488dd52319796f78dc3e681ebab4cd383de6623bbd5761c37c1cddef7a81fc2eb5a032da7fa61d9fe6a579d38e708c960d6e0e
-  data.tar.gz: 45b178f929064a161ddbb825101c64137cebca27a127c689ba4e72dbc300727a175f59f0487d5323cba3af4b41043a8cb9e361837514085f73fe15a16b6a33e0
+  metadata.gz: aa20b7462ba95c846352e51310eb467657a5808e5cb1d49f15801a516a34bc50e3efab585e4f940259819d1d756dedc6460811273014e8f0438ecebd6e081e64
+  data.tar.gz: d6d0e0b80540dbe54a1e2adc85fd4d21e4674f6370fae9db3c97b51c41da8fc02152aba089f0452599779834590f9d4087e20617d3ad5687d4e4bd84381a55e8

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

data/.travis.yml

@@ -1,21 +1,18 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.2.6
-  - 2.3.3
-  - 2.4.0
-env:
-  -
-  - SIDEKIQ_VERSION=3.4.0
-  - SIDEKIQ_VERSION=3.5.0
-  - SIDEKIQ_VERSION=4.0.0
-  - SIDEKIQ_VERSION=4.1.0
-  - SIDEKIQ_VERSION=4.2.0
+  - 2.3.7
+  - 2.4.4
+  - 2.5.1
+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"

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/README.md

@@ -10,6 +10,8 @@
 
 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
@@ -115,13 +117,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
 

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.9)
+    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.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

@@ -3,6 +3,8 @@
 <head>
   <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>
   <header class="navbar">
@@ -21,7 +23,7 @@
     <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?poll=true" target="_blank">sidekiq console</a> to check what happens.
+      Open <a href="<%= "/sidekiq/merges?queue=#{@queue}" %>" target="_blank">sidekiq console</a> to check what happens.
     </p>
     <div>
       <h2>SomeWorker</h2>

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/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.11".freeze
+    VERSION = "0.0.12".freeze
   end
 end

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/sidekiq-merger.gemspec

@@ -22,7 +22,7 @@ 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.2.2", "< 2.6"]
 
   spec.add_development_dependency "rake", ">= 10.0", "< 13"
   spec.add_development_dependency "rspec", ">= 3.0", "< 4"
@@ -30,8 +30,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "timecop", "~> 0.8"
   spec.add_development_dependency "rubocop", "~> 0.47"
   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/middleware_spec.rb

@@ -10,6 +10,15 @@ describe Sidekiq::Merger::Middleware, worker_class: true do
   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) {}
@@ -24,13 +33,17 @@ describe Sidekiq::Merger::Middleware, worker_class: true 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
@@ -38,7 +51,9 @@ describe Sidekiq::Merger::Middleware, worker_class: true 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/support/worker_class.rb

@@ -19,16 +19,31 @@ RSpec.shared_context "worker class", worker_class: true do
       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.11
+  version: 0.0.12
 platform: ruby
 authors:
 - dtaniwaki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-12 00:00:00.000000000 Z
+date: 2018-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -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
@@ -174,6 +188,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- Appraisals
 - Dockerfile
 - Gemfile
 - LICENSE
@@ -189,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
@@ -228,7 +248,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.2.2
   - - "<"
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -236,7 +256,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Sidekiq merger plugin