sidekiq-unique-jobs 2.2.1 → 2.3.2

data/Gemfile

@@ -1,20 +1,14 @@
 source 'http://rubygems.org'
 gemspec
 
-gem 'celluloid'
-gem 'slim'
-gem 'sprockets'
-gem 'sass'
-gem 'rails', '3.2.8'
-gem 'sqlite3'
-
 group :test do
   gem 'simplecov', :require => false
 end
 
 group :development do
+  gem 'activesupport'
   gem 'pry'
   gem 'pry-doc'
   gem 'pry-stack_explorer'
   gem 'pry-debugger'
-end
+end

data/README.md

@@ -24,6 +24,12 @@ All that is required is that you specifically set the sidekiq option for *unique
 sidekiq_options unique: true
 ```
 
+You can also control the expiration length of the uniqueness check. If you want to enforce uniqueness over a longer period than the default of 30 minutes then you can pass the number of seconds you want to use to the sidekiq options:
+
+```ruby
+sidekiq_options unique: true, unique_job_expiration: 120 * 60 # 2 hours
+```
+
 Requiring the gem in your gemfile should be sufficient to enable unique jobs.
 
 

data/lib/sidekiq-unique-jobs/middleware.rb

@@ -1,5 +1,4 @@
-require 'sidekiq/middleware/chain'
-require 'sidekiq/processor'
+require 'sidekiq'
 
 Sidekiq.configure_server do |config|
   config.server_middleware do |chain|
@@ -13,4 +12,4 @@ Sidekiq.configure_client do |config|
     require 'sidekiq-unique-jobs/middleware/client/unique_jobs'
     chain.add SidekiqUniqueJobs::Middleware::Client::UniqueJobs
   end
-end
+end

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

@@ -9,10 +9,12 @@ module SidekiqUniqueJobs
         def call(worker_class, item, queue)
 
           enabled = worker_class.get_sidekiq_options['unique']
+          unique_job_expiration = worker_class.get_sidekiq_options['unique_job_expiration']
 
           if enabled
 
-            payload_hash = Digest::MD5.hexdigest(Sidekiq.dump_json(item['args']))
+            md5_arguments = {:class => item['class'], :queue => item['queue'], :args => item['args']}
+            payload_hash = Digest::MD5.hexdigest(Sidekiq.dump_json(md5_arguments))
 
             unique = false
 
@@ -23,8 +25,8 @@ module SidekiqUniqueJobs
               if conn.get(payload_hash)
                 conn.unwatch
               else
-                expires_at = HASH_KEY_EXPIRATION
-                expires_at = ((Time.at(item['at']) - Time.now.utc) * 24 * 60 * 60).to_i if item['at']
+                expires_at = unique_job_expiration || HASH_KEY_EXPIRATION
+                expires_at = ((Time.at(item['at']) - Time.now.utc) + expires_at).to_i if item['at']
 
                 unique = conn.multi do
                   conn.setex(payload_hash, expires_at, 1)
@@ -40,4 +42,4 @@ module SidekiqUniqueJobs
       end
     end
   end
-end
+end

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

@@ -5,13 +5,22 @@ module SidekiqUniqueJobs
     module Server
       class UniqueJobs
         def call(*args)
+          logger.info("About to process a job with args #{args.inspect}")
           yield
+          logger.info("Done processing a job with args #{args.inspect}")
         ensure
-          json = Sidekiq.dump_json(args[1])
-          hash = Digest::MD5.hexdigest(json)
+          item = args[1]
+          md5_arguments = {:class => item['class'], :queue => item['queue'], :args => item['args']}
+          hash = Digest::MD5.hexdigest(Sidekiq.dump_json(md5_arguments))
           Sidekiq.redis {|conn| conn.del(hash) }
         end
+
+        protected
+
+        def logger
+          Sidekiq.logger
+        end
       end
     end
   end
-end
+end

data/lib/sidekiq-unique-jobs/version.rb

@@ -1,3 +1,3 @@
 module SidekiqUniqueJobs
-  VERSION = "2.2.1"
+  VERSION = "2.3.2"
 end

data/sidekiq-unique-jobs.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |gem|
   gem.name          = "sidekiq-unique-jobs"
   gem.require_paths = ["lib"]
   gem.version       = SidekiqUniqueJobs::VERSION
-  gem.add_dependency                  'sidekiq', '~> 2.2.0'
+  gem.add_dependency                  'sidekiq', '>= 2.2.0'
   gem.add_development_dependency      'minitest', '~> 3'
   gem.add_development_dependency      'sinatra'
   gem.add_development_dependency      'slim'

data/test/lib/sidekiq/test_client.rb

@@ -2,12 +2,14 @@ require 'helper'
 require 'sidekiq/worker'
 require "sidekiq-unique-jobs"
 require 'sidekiq/scheduled'
+require 'sidekiq-unique-jobs/middleware/server/unique_jobs'
 
 class TestClient < MiniTest::Unit::TestCase
   describe 'with real redis' do
     before do
       Sidekiq.redis = REDIS
       Sidekiq.redis {|c| c.flushdb }
+      QueueWorker.sidekiq_options :unique => nil, :unique_job_expiration => nil
     end
 
     class QueueWorker
@@ -17,15 +19,47 @@ class TestClient < MiniTest::Unit::TestCase
       end
     end
 
+    # This spec sometimes fails (unless it's the only spec that runs)
+    # Not sure why, we tried a wide variety of ways to make sure that
+    # there aren't side effects between tests and it still happens
+    it 'is able to enqueue after the server middleware completes' do
+      QueueWorker.sidekiq_options :unique => true
+      request_item = {'class' => TestClient::QueueWorker, 'queue' => 'customqueue', 'args' => ["some arg"]}
+
+      Sidekiq::Client.push(request_item.dup)
+      assert_equal 1, Sidekiq.redis {|c| c.llen("queue:customqueue") }
+
+      # Simulate sidekiq processing the job
+      Sidekiq.redis {|c| c.lpop("queue:customqueue")}
+      assert_equal 0, Sidekiq.redis {|c| c.llen("queue:customqueue") }
+
+      SidekiqUniqueJobs::Middleware::Server::UniqueJobs.new.call("dummy arg", request_item.dup) {}
+
+      Sidekiq::Client.push(request_item.dup) 
+      assert_equal 1, Sidekiq.redis {|c| c.llen("queue:customqueue") }
+    end
+
     it 'does not push duplicate messages when configured for unique only' do
       QueueWorker.sidekiq_options :unique => true
-      10.times { Sidekiq::Client.push('class' => QueueWorker, 'args' => [1, 2]) }
+      10.times { Sidekiq::Client.push('class' => TestClient::QueueWorker, 'queue' => 'customqueue',  'args' => [1, 2]) }
       assert_equal 1, Sidekiq.redis {|c| c.llen("queue:customqueue") }
     end
 
+    it 'sets an expiration when provided by sidekiq options' do
+      one_hour_expiration = 60 * 60
+      QueueWorker.sidekiq_options :unique => true, :unique_job_expiration => one_hour_expiration
+      Sidekiq::Client.push('class' => TestClient::QueueWorker, 'queue' => 'customqueue',  'args' => [1, 2])
+
+      md5_arguments = {:class => "TestClient::QueueWorker", :queue => "customqueue", :args => [1, 2]}
+      payload_hash = Digest::MD5.hexdigest(Sidekiq.dump_json(md5_arguments))
+      actual_expires_at = Sidekiq.redis {|c| c.ttl(payload_hash) }
+
+      assert_in_delta one_hour_expiration, actual_expires_at, 2
+    end
+
     it 'does push duplicate messages when not configured for unique only' do
       QueueWorker.sidekiq_options :unique => false
-      10.times { Sidekiq::Client.push('class' => QueueWorker, 'args' => [1, 2]) }
+      10.times { Sidekiq::Client.push('class' => TestClient::QueueWorker, 'queue' => 'customqueue',  'args' => [1, 2]) }
       assert_equal 10, Sidekiq.redis {|c| c.llen("queue:customqueue") }
     end
 
@@ -36,16 +70,16 @@ class TestClient < MiniTest::Unit::TestCase
       QueueWorker.sidekiq_options :unique => true
 
       at = 15.minutes.from_now
-      expected_expires_at = (Time.at(at) - Time.now.utc).to_f
+      expected_expires_at = (Time.at(at) - Time.now.utc) + SidekiqUniqueJobs::Middleware::Client::UniqueJobs::HASH_KEY_EXPIRATION
 
       QueueWorker.perform_in(at, 'mike')
-      payload_hash = Digest::MD5.hexdigest(Sidekiq.dump_json(['mike']))
+      md5_arguments = {:class => "TestClient::QueueWorker", :queue => "customqueue", :args => ['mike']}
+      payload_hash = Digest::MD5.hexdigest(Sidekiq.dump_json(md5_arguments))
 
       # deconstruct this into a time format we can use to get a decent delta for
-      actual_expires_at = Sidekiq.redis {|c| c.ttl(payload_hash).to_f  / 24 / 60 / 60 }
-
-      assert_in_delta expected_expires_at, actual_expires_at, 0.05
+      actual_expires_at = Sidekiq.redis {|c| c.ttl(payload_hash) }
 
+      assert_in_delta expected_expires_at, actual_expires_at, 2
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-unique-jobs
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,14 +9,14 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-19 00:00:00.000000000 Z
+date: 2012-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.2.0
   type: :runtime
@@ -24,7 +24,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.2.0
 - !ruby/object:Gem::Dependency
@@ -158,21 +158,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -556960269690268684
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -556960269690268684
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: The unique jobs that were removed from sidekiq