sidekiq-unique-jobs 2.6.6 → 2.6.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2296d65fb90ede4439f99784f379eb23c75d5a1b
-  data.tar.gz: 688b666f69e6dbd293e5662047dbe10b0429656a
+  metadata.gz: 83bac10875a23de22118d256945b92fff679923a
+  data.tar.gz: 71d378cca32301eebeb8c56bbfa1f76bdff3cd04
 SHA512:
-  metadata.gz: bea86a75d736637326b092067172db4186dce2689d6811e48227a9e5599c391396df58e17b59f8e34c9de066cae9fafb844195dbe05a4cb23d1f177fbc780458
-  data.tar.gz: 29b4d90da37697c917d644f062a6ac05585f6a8952da775eda22ab9bd939aae6e9f4e26196c7cf7011a0c3d848a594f3935ce25e30c54988e4a07f0ebb5cdb63
+  metadata.gz: 43f2b221b8a1eaa2a42a334cc263fab1e66472316eedddfa8aab18a49f9d8524691ee7f7a0dbd3168cce0a31a0877c2cf08bbad6da24228591409b3712751aab
+  data.tar.gz: c1fc0e67ab61a2c1def67563a0b3af418a76ff7645aa062183f2db093ddda532e852ad973cb21e5e54ad4ee54167e8862a848bae5910a89f90c02b13f6a6c33a

data/README.md

@@ -72,6 +72,21 @@ middleware, the JSON is passed directly to the worker `#perform` method. So, you
 arguments are different when enqueuing than they are when performing. Your `unique_args` method may need to
 account for this.
 
+### Unlock Ordering
+
+By default the server middleware will release the worker lock after yielding to the next middleware or worker. Alternatively, this can be changed by passing the `unique_unlock_order` option:
+
+```ruby
+class UniqueJobWithFilterMethod
+  include Sidekiq::Worker
+  sidekiq_options unique: true,
+                  unique_unlock_order: :before_yield
+
+  ...
+
+end
+```
+
 ## Contributing
 
 1. Fork it

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

@@ -23,5 +23,13 @@ module SidekiqUniqueJobs
     def self.default_expiration
       @expiration || 30 * 60
     end
+
+    def self.default_unlock_order=(order)
+      @default_unlock_order = order
+    end
+
+    def self.default_unlock_order
+      @default_unlock_order || :after_yield
+    end
   end
 end

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

@@ -48,27 +48,12 @@ module SidekiqUniqueJobs
 
         # Attempt to constantize a string worker_class argument, always 
         # failing back to the original argument.
-        # Duplicates Rails' String.constantize logic for non-Rails cases.
         def worker_class_constantize(worker_class)
           if worker_class.is_a?(String)
-            if worker_class.respond_to?(:constantize)
-              worker_class.constantize
-            else
-              # duplicated logic from Rails 3.2.13 ActiveSupport::Inflector
-              # https://github.com/rails/rails/blob/9e0b3fc7cfba43af55377488f991348e2de24515/activesupport/lib/active_support/inflector/methods.rb#L213
-              names = worker_class.split('::')
-              names.shift if names.empty? || names.first.empty?
-              constant = Object
-              names.each do |name|
-                constant = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
-              end
-              constant
-            end
+            worker_class.constantize rescue worker_class
           else
             worker_class
           end
-        rescue
-          worker_class
         end
 
       end

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

@@ -4,17 +4,31 @@ module SidekiqUniqueJobs
   module Middleware
     module Server
       class UniqueJobs
-        def call(*args)
+        def call(worker, item, queue)
+          unlock_order = worker.class.get_sidekiq_options['unique_unlock_order'] ||
+            SidekiqUniqueJobs::Config.default_unlock_order
+
+          lock_key = payload_hash(item)
+
+          unlocked = unlock_order == :before_yield ? unlock(lock_key).inspect : 0
+
           yield
         ensure
-          item = args[1]
-          payload_hash = SidekiqUniqueJobs::PayloadHelper.get_payload(item['class'], item['queue'], item['args'])
-
-          Sidekiq.redis {|conn| conn.del(payload_hash) }
+          if unlock_order == :after_yield || !defined? unlocked || unlocked != 1
+            unlock(lock_key)
+          end
         end
 
         protected
 
+        def payload_hash(item)
+          SidekiqUniqueJobs::PayloadHelper.get_payload(item['class'], item['queue'], item['args'])
+        end
+
+        def unlock(payload_hash)
+          Sidekiq.redis {|conn| conn.del(payload_hash) }
+        end
+
         def logger
           Sidekiq.logger
         end

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

@@ -1,3 +1,3 @@
 module SidekiqUniqueJobs
-  VERSION = "2.6.6"
+  VERSION = "2.6.7"
 end

data/test/lib/sidekiq/test_unlock_ordering.rb

@@ -0,0 +1,63 @@
+require 'helper'
+require 'sidekiq/worker'
+require 'sidekiq-unique-jobs/middleware/server/unique_jobs'
+
+class TestUnlockOrdering < MiniTest::Unit::TestCase
+  QUEUE = 'unlock_ordering'
+
+  class BeforeYieldOrderingWorker
+    include Sidekiq::Worker
+
+    sidekiq_options unique: true, unique_unlock_order: :before_yield, queue: QUEUE
+
+    def perform
+    end
+  end
+
+  class AfterYieldOrderingWorker
+    include Sidekiq::Worker
+
+    sidekiq_options unique: true, unique_unlock_order: :after_yield, queue: QUEUE
+
+    def perform
+    end
+  end
+
+  describe 'with real redis' do
+    before do
+      Sidekiq.redis = REDIS
+      Sidekiq.redis { |c| c.flushdb }
+      @middleware = SidekiqUniqueJobs::Middleware::Server::UniqueJobs.new
+    end
+
+    describe ':before_yield' do
+      it 'removes the lock before yielding to the worker' do
+        jid = BeforeYieldOrderingWorker.perform_async
+        item = Sidekiq::Queue.new(QUEUE).find_job(jid).item
+
+        result = @middleware.call(BeforeYieldOrderingWorker.new, item, QUEUE) do
+          Sidekiq.redis do |c|
+            c.get(SidekiqUniqueJobs::PayloadHelper.get_payload(item['class'], item['queue'], item['args']))
+          end
+        end
+
+        assert_nil result
+      end
+    end
+
+    describe ':after_yield' do
+      it 'removes the lock after yielding to the worker' do
+        jid = AfterYieldOrderingWorker.perform_async
+        item = Sidekiq::Queue.new(QUEUE).find_job(jid).item
+
+        result = @middleware.call(AfterYieldOrderingWorker.new, item, QUEUE) do
+          Sidekiq.redis do |c|
+            c.get(SidekiqUniqueJobs::PayloadHelper.get_payload(item['class'], item['queue'], item['args']))
+          end
+        end
+
+        assert_equal '1', result
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-unique-jobs
 version: !ruby/object:Gem::Version
-  version: 2.6.6
+  version: 2.6.7
 platform: ruby
 authors:
 - Mikael Henriksson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-23 00:00:00.000000000 Z
+date: 2013-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -133,6 +133,7 @@ files:
 - test/helper.rb
 - test/lib/sidekiq/another_test_client.rb
 - test/lib/sidekiq/test_client.rb
+- test/lib/sidekiq/test_unlock_ordering.rb
 homepage: http://mperham.github.com/sidekiq
 licenses:
 - LGPL-3.0
@@ -153,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.7
 signing_key: 
 specification_version: 4
 summary: The unique jobs that were removed from sidekiq
@@ -161,4 +162,5 @@ test_files:
 - test/helper.rb
 - test/lib/sidekiq/another_test_client.rb
 - test/lib/sidekiq/test_client.rb
+- test/lib/sidekiq/test_unlock_ordering.rb
 has_rdoc: