sidekiq-unique-jobs 5.0.5 → 5.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f35cb3be6bdca4175e0c98f2a2ea068d2d35b26
-  data.tar.gz: b1e359ad759c2db79f8bda05daaf8f04ea392124
+  metadata.gz: 36eb8099e1e3a20e4a3e710c7bd8fab715454205
+  data.tar.gz: f46d3ddbbc3a1a436ecb4399b59c8f0565d882b9
 SHA512:
-  metadata.gz: 9f82651ba910aa23ff9dc5d291a44640290860fd9ef43281fcd4cb41eabad5e997dc495b54547b5341271acd7d3e36c06dc8eaca68015bdb5706468ff234919c
-  data.tar.gz: a338ce8b7b65dbca292b0665aadf7fb3df43e00eaf341c2ebb96b13e36c525d033c074648e125c55566ab99c0b4d38cbf0674519b6b9573ec7d38cd3d436e365
+  metadata.gz: 3251e6623db4af9da2dd4b35eba9f6f6a5b2343faa41d23688b2cc0499dd01a1c29bdccc3a2fa2d3974c026f8d8cb4a99b9b900f12475593c745704611451a63
+  data.tar.gz: c9f974e698449faf6e10c33f1c5d0ed01dcafe5c26c9c60da23037daf26d1267d42b2e753dc306413ea22dfb3b58e1633bc52331e410532cafd1b704dfb9ed95

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## v5.0.6
+- Allow across worker uniquenes: See https://github.com/mhenrixon/sidekiq-unique-jobs/blob/master/spec/jobs/unique_acrosss_workers_job.rb for information
+
 ## v5.0.5
 - Use a class level mutex for `while_executing`
 

data/README.md

@@ -41,6 +41,27 @@ sidekiq_options unique: :while_executing
 
 Is to make sure that a job can be scheduled any number of times but only executed a single time per argument provided to the job we call this runtime uniqueness. This is probably most useful for background jobs that are fast to execute. (See mhenrixon/sidekiq-unique-jobs#111 for a great example of when this would be right.) While the job is executing/performing no other jobs can be executed at the same time.
 
+The way it currently works is that the jobs can be put on the queue but any succeedent job will wait until the first one finishes. 
+
+There is an example of this to try it out in the `rails_example` application. Run `foreman start` in the root of the directory and open the url: `localhost:5000/work/duplicate_while_executing`.
+
+In the console you should see something like:
+
+```
+0:32:24 worker.1 | 2017-04-23T08:32:24.955Z 84404 TID-ougq4thko WhileExecutingWorker JID-400ec51c9523f41cd4a35058 INFO: start
+10:32:24 worker.1 | 2017-04-23T08:32:24.956Z 84404 TID-ougq8csew WhileExecutingWorker JID-8d6d9168368eedaed7f75763 INFO: start
+10:32:24 worker.1 | 2017-04-23T08:32:24.957Z 84404 TID-ougq8crt8 WhileExecutingWorker JID-affcd079094c9b26e8b9ba60 INFO: start
+10:32:24 worker.1 | 2017-04-23T08:32:24.959Z 84404 TID-ougq8cs8s WhileExecutingWorker JID-9e197460c067b22eb1b5d07f INFO: start
+10:32:24 worker.1 | 2017-04-23T08:32:24.959Z 84404 TID-ougq4thko WhileExecutingWorker JID-400ec51c9523f41cd4a35058 WhileExecutingWorker INFO: perform(1, 2)
+10:32:34 worker.1 | 2017-04-23T08:32:34.964Z 84404 TID-ougq4thko WhileExecutingWorker JID-400ec51c9523f41cd4a35058 INFO: done: 10.009 sec
+10:32:34 worker.1 | 2017-04-23T08:32:34.965Z 84404 TID-ougq8csew WhileExecutingWorker JID-8d6d9168368eedaed7f75763 WhileExecutingWorker INFO: perform(1, 2)
+10:32:44 worker.1 | 2017-04-23T08:32:44.965Z 84404 TID-ougq8crt8 WhileExecutingWorker JID-affcd079094c9b26e8b9ba60 WhileExecutingWorker INFO: perform(1, 2)
+10:32:44 worker.1 | 2017-04-23T08:32:44.965Z 84404 TID-ougq8csew WhileExecutingWorker JID-8d6d9168368eedaed7f75763 INFO: done: 20.009 sec
+10:32:54 worker.1 | 2017-04-23T08:32:54.970Z 84404 TID-ougq8cs8s WhileExecutingWorker JID-9e197460c067b22eb1b5d07f WhileExecutingWorker INFO: perform(1, 2)
+10:32:54 worker.1 | 2017-04-23T08:32:54.969Z 84404 TID-ougq8crt8 WhileExecutingWorker JID-affcd079094c9b26e8b9ba60 INFO: done: 30.012 sec
+10:33:04 worker.1 | 2017-04-23T08:33:04.973Z 84404 TID-ougq8cs8s WhileExecutingWorker JID-9e197460c067b22eb1b5d07f INFO: done: 40.014 sec
+```
+
 ### Until Executing
 
 ```ruby
@@ -81,8 +102,10 @@ That means it locks for any job with the same arguments to be persisted into red
 
 ### Uniqueness Scope
 
+
 - Queue specific locks
-- Across all queues.
+- Across all queues - [spec/jobs/unique_on_all_queues_job.rb](https://github.com/mhenrixon/sidekiq-unique-jobs/blob/master/spec/jobs/unique_on_all_queues_job.rb)
+- Across all workers - [spec/jobs/unique_across_workers_job.rb](https://github.com/mhenrixon/sidekiq-unique-jobs/blob/master/spec/jobs/unique_across_workers_job.rb)
 - Timed / Scheduled jobs
 
 ## Usage
@@ -158,6 +181,27 @@ end
 
 The previous problems with unique args being string in server and symbol in client is no longer a problem because the `UniqueArgs` class accounts for this and converts everything to json now. If you find an edge case please provide and example so that we can add coverage and fix it.
 
+
+It is also quite possible to ensure different types of unique args based on context. I can't vouch for the below example but see [#203](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/203) for the discussion.
+
+```ruby
+class UniqueJobWithFilterMethod
+  include Sidekiq::Worker
+  sidekiq_options unique: :until_and_while_executing, unique_args: :unique_args
+
+  def self.unique_args(args)
+    if Sidekiq::ProcessSet.new.size > 1
+      # sidekiq runtime; uniqueness for the object (first arg)
+      args.first
+    else
+      # queuing from the app; uniqueness for all params
+      args
+    end
+  end
+end
+```
+
+
 ### After Unlock Callback
 
 If you are using :after_yield as your unlock ordering, Unique Job offers a callback to perform some work after the block is yielded.

data/lib/sidekiq-unique-jobs.rb

@@ -27,7 +27,7 @@ module SidekiqUniqueJobs
       unique_prefix: 'uniquejobs',
       default_queue_lock_expiration: 30 * 60,
       default_run_lock_expiration: 60,
-      default_lock: :while_executing,
+      default_lock: :until_executed,
       redis_test_mode: :redis, # :mock
     )
   end

data/lib/sidekiq_unique_jobs/constants.rb

@@ -17,5 +17,6 @@ module SidekiqUniqueJobs
   UNIQUE_PREFIX_KEY ||= 'unique_prefix'
   UNIQUE_DIGEST_KEY ||= 'unique_digest'
   UNIQUE_ON_ALL_QUEUES_KEY ||= 'unique_on_all_queues'
+  UNIQUE_ACROSS_WORKERS_KEY ||= 'unique_across_workers'
   UNIQUE_ARGS_ENABLED_KEY ||= 'unique_args_enabled'
 end

data/lib/sidekiq_unique_jobs/unique_args.rb

@@ -18,9 +18,9 @@ module SidekiqUniqueJobs
       new(item).unique_digest
     end
 
-    def initialize(job)
+    def initialize(item)
       Sidekiq::Logging.with_context(CLASS_NAME) do
-        @item = job
+        @item = item
         @worker_class            ||= worker_class_constantize(@item[CLASS_KEY])
         @item[UNIQUE_PREFIX_KEY] ||= unique_prefix
         @item[UNIQUE_ARGS_KEY]     = unique_args(@item[ARGS_KEY])
@@ -43,15 +43,16 @@ module SidekiqUniqueJobs
     end
 
     def digestable_hash
-      hash = @item.slice(CLASS_KEY, QUEUE_KEY, UNIQUE_ARGS_KEY)
-
-      if unique_on_all_queues?
-        logger.debug do
-          "#{__method__} uniqueness specified across all queues (deleting queue: #{@item[QUEUE_KEY]} from hash)"
+      @item.slice(CLASS_KEY, QUEUE_KEY, UNIQUE_ARGS_KEY).tap do |hash|
+        if unique_on_all_queues?
+          logger.debug { "#{__method__} deleting queue: #{@item[QUEUE_KEY]}" }
+          hash.delete(QUEUE_KEY)
+        end
+        if unique_across_workers?
+          logger.debug { "#{__method__} deleting class: #{@item[CLASS_KEY]}" }
+          hash.delete(CLASS_KEY)
         end
-        hash.delete(QUEUE_KEY)
       end
-      hash
     end
 
     def unique_args(args)
@@ -71,6 +72,11 @@ module SidekiqUniqueJobs
       @item[UNIQUE_ON_ALL_QUEUES_KEY] || @worker_class.get_sidekiq_options[UNIQUE_ON_ALL_QUEUES_KEY]
     end
 
+    def unique_across_workers?
+      return unless sidekiq_worker_class?
+      @item[UNIQUE_ACROSS_WORKERS_KEY] || @worker_class.get_sidekiq_options[UNIQUE_ACROSS_WORKERS_KEY]
+    end
+
     def unique_args_enabled?
       return unless sidekiq_worker_class?
       unique_args_method # && !unique_args_method.is_a?(Boolean)

data/lib/sidekiq_unique_jobs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SidekiqUniqueJobs
-  VERSION = '5.0.5'
+  VERSION = '5.0.6'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-unique-jobs
 version: !ruby/object:Gem::Version
-  version: 5.0.5
+  version: 5.0.6
 platform: ruby
 authors:
 - Mikael Henriksson