sidekiq-merger 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2333d3953e27f0ba0d3f0efc23a8bc48747b2a6d
-  data.tar.gz: ed6230c813938f38f4092ee9a27589a774c55029
+  metadata.gz: fe6c788a720ff09719c0c646767a82102ee0c858
+  data.tar.gz: f7e3afc43bd8a75e0dfebbbf31425b97949328aa
 SHA512:
-  metadata.gz: 271adc650104013b83c9fa5b99672c995c10b7e2d3518485daa9b5f2d62a9fc14333cd29014d8024f0e17a7b6bcfea393010d544f1ca899bab876a9a14647f7d
-  data.tar.gz: 1e647aa5449188f1649bd57a84fb34629f348996991e28085aa19a83139cd31eaa2ec089aebb82f6e6cfcd4ec57ffc0738eb52118a07498d72c851d8aeefb9a0
+  metadata.gz: b45ec5e708f89daf1dbebbfd1c9b32648e2478d89cc38c68f4ffa53fd8d46c050b3aa9c84451488af955615dd213aefb5542a677de752f535e32d2c2482627e7
+  data.tar.gz: a13ed626974a75bfbb12d1763b3cf944f0fd353f3de17b63e0a2e2416ec76b1912fd687259a9d8da77bc688143b45738f44221238d18fb7a9edc860f4971aa61

data/README.md

@@ -18,11 +18,11 @@ gem 'sidekiq-merger'
 
 And then execute:
 
-  $ bundle
+    $ bundle
 
 Or install it yourself as:
 
-  $ gem install sidekiq-merger
+    $ gem install sidekiq-merger
 
 ## Usage
 
@@ -65,6 +65,14 @@ SomeWorker.perform_async 5
 
 In this case, `SomeWorker` will be executed 3 times with args of `[4]`, `[3]` and `[5]`.
 
+### Quick Check
+
+Run docker containers to check the behavior of this gem.
+
+    $ docker-compose up
+
+Then, open `http://localhost:3000/`. You can push jobs from the UI and see what happens in the sidekiq console.
+
 ## Options
 
 ### `key` (optional, default: `nil`)
@@ -72,6 +80,7 @@ In this case, `SomeWorker` will be executed 3 times with args of `[4]`, `[3]` an
 Defines merge key so different arguments can be merged.
 
 Format: `String` or `Proc`
+
 e.g. `sidekiq_options merger: { key: -> (args) { args[0..1] } }`
 
 ### `unique` (optional, default: `false`)
@@ -79,6 +88,7 @@ e.g. `sidekiq_options merger: { key: -> (args) { args[0..1] } }`
 Prevents enqueue of jobs with identical arguments.
 
 Format: `Boolean`
+
 e.g. `true`
 
 ## Web UI
@@ -93,19 +103,13 @@ require "sidekiq/merger/web"
 
 ## Test
 
-  $ bundle exec rspec
+    $ bundle exec rspec
 
 The test coverage is available at `./coverage/index.html`.
 
-To check the behavior of this plugin, you can run docker containers.
-
-  $ docker-compose up
-
-Then, open `http://localhost:3000/`.
-
 ## Lint
 
-  $ bundle exec rubocop
+    $ bundle exec rubocop
 
 ## Contributing
 

data/lib/sidekiq/merger.rb

@@ -7,6 +7,8 @@ require_relative "merger/flusher"
 require_relative "merger/logging_observer"
 
 module Sidekiq::Merger
+  LOGGER_TAG = self.name.freeze
+
   class << self
     attr_accessor :logger
 
@@ -19,7 +21,7 @@ module Sidekiq::Merger
       ) { flusher.flush }
       task.add_observer(observer)
       logger.info(
-        "[Sidekiq::Merger] Started polling merges every #{interval} seconds"
+        "[#{Sidekiq::Merger::LOGGER_TAG}] Started polling merges every #{interval} seconds"
       )
       task.execute
     end

data/lib/sidekiq/merger/logging_observer.rb

@@ -6,11 +6,11 @@ class Sidekiq::Merger::LoggingObserver
   def update(time, _result, ex)
     if ex.is_a?(Concurrent::TimeoutError)
       @logger.error(
-        "[Sidekiq::Grouping] (#{time}) Execution timed out\n"
+        "[#{Sidekiq::Merger::LOGGER_TAG}] Execution timed out\n"
       )
     elsif ex.present?
       @logger.error(
-        "[Sidekiq::Grouping] Execution failed with error #{ex}\n"
+        "[#{Sidekiq::Merger::LOGGER_TAG}] Execution failed with error #{ex}\n"
       )
     end
   end

data/lib/sidekiq/merger/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Merger
-    VERSION = "0.0.5".freeze
+    VERSION = "0.0.6".freeze
   end
 end

data/spec/sidekiq/merger/logging_observer_spec.rb

@@ -0,0 +1,19 @@
+require "spec_helper"
+
+describe Sidekiq::Merger::LoggingObserver do
+  subject { described_class.new(logger) }
+  let(:logger) { Logger.new("/dev/null") }
+  let(:now) { Time.now }
+  before { Timecop.freeze(now) }
+
+  describe "#update" do
+    it "logs a timeout" do
+      expect(logger).to receive(:error).with("[Sidekiq::Merger] Execution timed out\n")
+      subject.update(now, nil, Concurrent::TimeoutError.new)
+    end
+    it "logs an error" do
+      expect(logger).to receive(:error).with("[Sidekiq::Merger] Execution failed with error foo\n")
+      subject.update(now, nil, "foo")
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-merger
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - dtaniwaki
@@ -201,6 +201,7 @@ files:
 - misc/web_ui.png
 - sidekiq-merger.gemspec
 - spec/sidekiq/merger/flusher_spec.rb
+- spec/sidekiq/merger/logging_observer_spec.rb
 - spec/sidekiq/merger/merge_spec.rb
 - spec/sidekiq/merger/middleware_spec.rb
 - spec/sidekiq/merger/redis_spec.rb
@@ -236,6 +237,7 @@ specification_version: 4
 summary: Sidekiq merger plugin
 test_files:
 - spec/sidekiq/merger/flusher_spec.rb
+- spec/sidekiq/merger/logging_observer_spec.rb
 - spec/sidekiq/merger/merge_spec.rb
 - spec/sidekiq/merger/middleware_spec.rb
 - spec/sidekiq/merger/redis_spec.rb