sidekiq-middleware 0.0.2 → 0.0.3

data/README.md

@@ -1,6 +1,6 @@
 # Additional sidekiq middleware [![Build Status](https://secure.travis-ci.org/krasnoukhov/sidekiq-middleware.png)](http://travis-ci.org/krasnoukhov/sidekiq-middleware)
 
-This gem provides additional middleware for [Sidekiq](github.com/mperham/sidekiq/).
+This gem provides additional middleware for [Sidekiq](https://github.com/mperham/sidekiq).
 
 See [Sidekiq Wiki](https://github.com/mperham/sidekiq/wiki/Middleware) for more details.
 
@@ -29,26 +29,26 @@ Provides uniqueness for jobs.
 Example worker:
 
 ```ruby
-  class UniqueWorker
-    include Sidekiq::Worker
-  
-    sidekiq_options({
-      # Should be set to true (enables uniqueness for async jobs)
-      # or :all (enables uniqueness for both async and scheduled jobs)
-      unique: :all,
-  
-      # Set this to true in case your job schedules itself
-      forever: true,
-  
-      # Unique expiration (optional, default is 30 minutes)
-      # For scheduled jobs calculates automatically if not provided
-      expiration: 24 * 60 * 60
-    })
-  
-    def perform
-      # Your code goes here
-    end
+class UniqueWorker
+  include Sidekiq::Worker
+
+  sidekiq_options({
+    # Should be set to true (enables uniqueness for async jobs)
+    # or :all (enables uniqueness for both async and scheduled jobs)
+    unique: :all,
+
+    # Set this to true in case your job schedules itself
+    forever: true,
+
+    # Unique expiration (optional, default is 30 minutes)
+    # For scheduled jobs calculates automatically if not provided
+    expiration: 24 * 60 * 60
+  })
+
+  def perform
+    # Your code goes here
   end
+end
 ```
 
 ## Contributing

data/lib/sidekiq-middleware.rb

@@ -1,5 +1,6 @@
 require "digest"
 require "sidekiq-middleware/version"
+require "sidekiq-middleware/core_ext"
 require "sidekiq-middleware/server/unique_jobs"
 require "sidekiq-middleware/client/unique_jobs"
 require "sidekiq-middleware/middleware"

data/lib/sidekiq-middleware/client/unique_jobs.rb

@@ -5,23 +5,19 @@ module Sidekiq
         HASH_KEY_EXPIRATION = 30 * 60
 
         def call(worker_class, item, queue)
-          enabled = worker_class.get_sidekiq_options['unique']
+          enabled, expiration = worker_class.get_sidekiq_options['unique'],
+            (worker_class.get_sidekiq_options['expiration'] || HASH_KEY_EXPIRATION)
 
           if enabled
-            unique = false
+            unique, payload = false, item.clone.slice(%w(class queue args at))
 
             # Enabled unique scheduled
-            if enabled == :all && item.has_key?('at')
-              expiration = worker_class.get_sidekiq_options['expiration'] || (item['at'].to_i - Time.new.to_i)
-              payload = item.clone
+            if enabled == :all && payload.has_key?('at')
+              expiration = (payload['at'].to_i - Time.now.to_i)
               payload.delete('at')
-              payload.delete('jid')
-            else
-              expiration = worker_class.get_sidekiq_options['expiration'] || HASH_KEY_EXPIRATION
-              payload = item.clone
-              payload.delete('jid')
             end
-            payload_hash = Digest::MD5.hexdigest(Sidekiq.dump_json(Hash[payload.sort]))
+
+            payload_hash = Digest::MD5.hexdigest(Sidekiq.dump_json(payload))
 
             Sidekiq.redis do |conn|
               conn.watch(payload_hash)
@@ -40,7 +36,6 @@ module Sidekiq
             yield
           end
         end
-
       end
     end
   end

data/lib/sidekiq-middleware/core_ext.rb

@@ -0,0 +1,11 @@
+class Hash
+  def slice(*items)
+    items = items.to_a.flatten
+
+    {}.tap do |hash|
+      items.each do |item|
+        hash[item] = self[item] if self[item]
+      end
+    end
+  end
+end

data/lib/sidekiq-middleware/server/unique_jobs.rb

@@ -18,22 +18,18 @@ module Sidekiq
         end
 
         def clear(worker_instance, item, queue)
-          enabled = worker_instance.class.get_sidekiq_options['unique']
+          # Only enforce uniqueness across class, queue, args, and at.
+          # Useful when middleware uses the payload to store metadata.
+          enabled, payload = worker_instance.class.get_sidekiq_options['unique'],
+            item.clone.slice(%w(class queue args at))
 
           # Enabled unique scheduled 
-          if enabled == :all && item.has_key?('at')
-            payload = item.clone
+          if enabled == :all && payload.has_key?('at')
             payload.delete('at')
-            payload.delete('jid')
-          else
-            payload = item.clone
-            payload.delete('jid')
           end
-          payload_hash = Digest::MD5.hexdigest(Sidekiq.dump_json(Hash[payload.sort]))
-          
-          Sidekiq.redis { |conn| conn.del(payload_hash) }
-        end
 
+          Sidekiq.redis { |conn| conn.del Digest::MD5.hexdigest(Sidekiq.dump_json(payload)) }
+        end
       end
     end
   end

data/lib/sidekiq-middleware/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Middleware
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/test/helper.rb

@@ -8,6 +8,9 @@ require 'minitest/unit'
 require 'minitest/pride'
 require 'minitest/autorun'
 
+require 'celluloid'
+Celluloid.logger = nil
+
 require 'sidekiq'
 require 'sidekiq/util'
 require 'sidekiq-middleware'

data/test/test_core_ext.rb

@@ -0,0 +1,28 @@
+require 'helper'
+require 'sidekiq-middleware'
+
+class TestCoreExt < MiniTest::Unit::TestCase
+  describe 'for an empty array' do
+    it 'should be an ampty hash' do
+      assert_equal({}, {:foo => "bar"}.slice([]))
+    end
+  end
+
+  describe 'for items not in the hash' do
+    it 'should be an empty hash' do
+      assert_equal({}, {:foo => "bar", :foobar => "baz"}.slice(:baz, :foobaz))
+    end
+  end
+
+  describe 'for items in the hash' do
+    it 'should be the attributes' do
+      assert_equal({:foo => "bar"}, {:foo => "bar", :foobar => "baz"}.slice(:foo))
+    end
+  end
+
+  describe 'when all items are in the hash' do
+    it 'should be the hash' do
+      assert_equal({:foo => "bar", :foobar => "baz"}, {:foo => "bar", :foobar => "baz"}.slice(:foo, :foobar))
+    end
+  end
+end

data/test/test_unique_jobs.rb

@@ -10,7 +10,6 @@ class TestUniqueJobs < MiniTest::Unit::TestCase
     before do
       @boss = MiniTest::Mock.new
       @processor = ::Sidekiq::Processor.new(@boss)
-      Celluloid.logger = nil
       
       Sidekiq.redis = REDIS
       Sidekiq.redis {|c| c.flushdb }
@@ -29,6 +28,11 @@ class TestUniqueJobs < MiniTest::Unit::TestCase
       assert_equal 1, Sidekiq.redis { |c| c.llen('queue:unique_queue') }
     end
 
+    it 'discards non critical information about the message' do
+      5.times { Sidekiq::Client.push('class' => UniqueWorker, 'args' => ['critical'], 'sent_at' => Time.now.to_f, 'non' => 'critical') }
+      assert_equal 1, Sidekiq.redis { |c| c.llen('queue:unique_queue') }
+    end
+
     class NotUniqueWorker
       include Sidekiq::Worker
       sidekiq_options queue: :not_unique_queue, unique: false
@@ -53,17 +57,27 @@ class TestUniqueJobs < MiniTest::Unit::TestCase
 
     it 'does not duplicate scheduled messages with enabled unique option' do
       5.times { |t| UniqueScheduledWorker.perform_in((t+1)*60, 'args') }
-      assert_equal 1, Sidekiq.redis { |c| c.zrangebyscore('schedule', '-inf', '+inf').length }
+      assert_equal 1, Sidekiq.redis { |c| c.zcard('schedule') }
     end
 
-    it 'once schedules job in future with enabled forever option' do
+    it 'allows the job to reschedule itself with enabled forever option' do
       5.times {
-        msg = Sidekiq.dump_json({ 'class' => UniqueScheduledWorker.to_s, 'args' => ['forever'] })
+        msg = Sidekiq.dump_json('class' => UniqueScheduledWorker.to_s, 'args' => ['something'])
+        @boss.expect(:processor_done!, nil, [@processor])
+        @processor.process(msg, 'default')
+        @boss.verify
+      }
+      assert_equal 1, Sidekiq.redis { |c| c.zcard('schedule') }
+    end
+
+    it 'discards non critical information about the message' do
+      5.times {|i|
+        msg = Sidekiq.dump_json('class' => UniqueScheduledWorker.to_s, 'args' => ['something'], 'sent_at' => (Time.now + i*60).to_f)
         @boss.expect(:processor_done!, nil, [@processor])
         @processor.process(msg, 'default')
         @boss.verify
       }
-      assert_equal 1, Sidekiq.redis { |c| c.zrangebyscore('schedule', '-inf', '+inf').length }
+      assert_equal 1, Sidekiq.redis { |c| c.zcard('schedule') }
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-middleware
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-05 00:00:00.000000000 Z
+date: 2012-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -74,11 +74,13 @@ files:
 - Rakefile
 - lib/sidekiq-middleware.rb
 - lib/sidekiq-middleware/client/unique_jobs.rb
+- lib/sidekiq-middleware/core_ext.rb
 - lib/sidekiq-middleware/middleware.rb
 - lib/sidekiq-middleware/server/unique_jobs.rb
 - lib/sidekiq-middleware/version.rb
 - sidekiq-middleware.gemspec
 - test/helper.rb
+- test/test_core_ext.rb
 - test/test_unique_jobs.rb
 homepage: http://github.com/krasnoukhov/sidekiq-middleware
 licenses: []
@@ -94,7 +96,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2849267342138572133
+      hash: 4144828327274564708
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -103,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2849267342138572133
+      hash: 4144828327274564708
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -112,4 +114,5 @@ specification_version: 3
 summary: Additional sidekiq middleware
 test_files:
 - test/helper.rb
+- test/test_core_ext.rb
 - test/test_unique_jobs.rb