sidekiq-unique-jobs 7.0.0.beta27 → 7.0.0.beta28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f8ac719de8bb615ca9727bc1fcce616e7b4c074c3ea9dee035cbaa0a6883948
-  data.tar.gz: 98062177539795c85bf3934cfa7c79396a3b9185c927a2506da61bd5cbcd6795
+  metadata.gz: 13bc0a51e575fe6e019fa0e47b16875733eaf3c674913caff86c8e9e25b03212
+  data.tar.gz: 4798530068d809e896baf5a5091eb81f31f72adec762232e606c3b9c59946889
 SHA512:
-  metadata.gz: 0def4f823803bb1c4cce5b93a99ad78b20fa31c563094ad833ce75bcdbafbb415ca27dd8427c6b449063f09e4318e131d97e7111b3925c552791e23d6dabdb01
-  data.tar.gz: 745df60df4ac33e232703ba12cebeebf8ffe80147d4efcf70879701f399d5b8e714649704356321a3cdac9f181150eae0b5403a80ae9cf4be5d68cc83932989a
+  metadata.gz: aad36721efc247b274437dbc327d21bf4c014d482962ce361cad6a7b2fbf63874d32121ac4f2f44d14197169c7c8ac9bb268b7ad8851d2cf407e9c47503524ce
+  data.tar.gz: b1308b72466f8a7ec8150e0997eab097c17fcabd7d554811e0ddd3ff547105ff9fa36442318bd9db182a3b6b130e755f6ac4fce93d863cb6c60ae3fe4cadf5c2

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 
+## [Unreleased](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/HEAD)
+
+[Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v7.0.0.beta27...HEAD)
+
+**Fixed bugs:**
+
+- lock\_args does not work when you define the lock\_args argument and default lock\_args function at the same time. [\#548](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/548)
+
+## [v7.0.0.beta27](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v7.0.0.beta27) (2020-11-03)
+
+[Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v7.0.0.beta26...v7.0.0.beta27)
+
+**Implemented enhancements:**
+
+- Adds coverage for regression purposes [\#550](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/550) ([mhenrixon](https://github.com/mhenrixon))
+
+**Fixed bugs:**
+
+- Rename lock\_args to lock\_args\_method [\#551](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/551) ([mhenrixon](https://github.com/mhenrixon))
+
+**Closed issues:**
+
+- Documentation incorrect for `delete\_by\_digest` [\#547](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/547)
+- Locked jobs after kill -9 with while\_executing lock [\#546](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/546)
+
 ## [v7.0.0.beta26](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v7.0.0.beta26) (2020-10-28)
 
 [Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v6.0.25...v7.0.0.beta26)
@@ -193,12 +218,15 @@
 **Fixed bugs:**
 
 - Use thread-safe digest creation mechanism [\#484](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/484) ([mhenrixon](https://github.com/mhenrixon))
-- Remove digest deletion for concurrent locks [\#482](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/482) ([mhenrixon](https://github.com/mhenrixon))
 
 ## [v7.0.0.beta13](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v7.0.0.beta13) (2020-03-26)
 
 [Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v7.0.0.beta12...v7.0.0.beta13)
 
+**Fixed bugs:**
+
+- Remove digest deletion for concurrent locks [\#482](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/482) ([mhenrixon](https://github.com/mhenrixon))
+
 ## [v7.0.0.beta12](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v7.0.0.beta12) (2020-03-25)
 
 [Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v6.0.20...v7.0.0.beta12)

data/README.md

@@ -18,7 +18,7 @@
   - [reaper_count](#reaper_count)
   - [reaper_interval](#reaper_interval)
   - [reaper_timeout](#reaper_timeout)
-  - [unique_prefix](#unique_prefix)
+  - [lock_prefix](#lock_prefix)
   - [lock_info](#lock_info)
 - [Worker Configuration](#worker-configuration)
   - [lock_ttl](#lock_ttl-1)
@@ -61,13 +61,13 @@
 
 ## Introduction
 
-The goal of this gem is to ensure your Sidekiq jobs are unique. We do this by creating unique keys in Redis based on how you configure uniqueness.
+This gem adds unique constraints to the sidekiq queues. The uniqueness is achieved by acquiring locks for a hash of a queue name, a worker class, and job's arguments. Only one lock for a given hash can be acquired. What happens when a lock can't be acquired is governed by a chosen strategy.
 
 This is the documentation for the master branch. You can find the documentation for each release by navigating to its tag.
 
 Here are links to some of the old versions
 
-- [v6.0.13](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v6.0.13)
+- [v6.0.25](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v6.0.25)
 - [v5.0.10](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v5.0.10)
 - [v4.0.18](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v4.0.18)
 
@@ -235,10 +235,10 @@ SidekiqUniqueJobs.config.reaper_timeout #=> 10
 
 The number of seconds to wait for the reaper to finish before raising a TimeoutError. This is done to ensure that the next time we reap isn't getting stuck due to the previous process already running.
 
-### unique_prefix
+### lock_prefix
 
 ```ruby
-SidekiqUniqueJobs.config.unique_prefix #=> "uniquejobs"
+SidekiqUniqueJobs.config.lock_prefix #=> "uniquejobs"
 ```
 
 Use if you want a different key prefix for the keys in redis.

data/lib/sidekiq_unique_jobs/config.rb

@@ -6,7 +6,7 @@ module SidekiqUniqueJobs
                                                    :lock_timeout,
                                                    :lock_ttl,
                                                    :enabled,
-                                                   :unique_prefix,
+                                                   :lock_prefix,
                                                    :logger,
                                                    :locks,
                                                    :strategies,
@@ -127,7 +127,7 @@ module SidekiqUniqueJobs
     #   default_lock_timeout: 0,
     #   default_lock_ttl: nil,
     #   enabled: true,
-    #   unique_prefix: "uniquejobs",
+    #   lock_prefix: "uniquejobs",
     #   logger: #<Sidekiq::Logger:0x00007f81e096b0e0 @level=1 ...>,
     #   locks: {
     #     around_perform: SidekiqUniqueJobs::Lock::WhileExecuting,

data/lib/sidekiq_unique_jobs/constants.rb

@@ -32,6 +32,7 @@ module SidekiqUniqueJobs
   ON_CLIENT_CONFLICT    ||= "on_client_conflict"
   ON_CONFLICT           ||= "on_conflict"
   ON_SERVER_CONFLICT    ||= "on_server_conflict"
+  PAYLOAD               ||= "payload"
   PROCESSES             ||= "processes"
   QUEUE                 ||= "queue"
   RETRY                 ||= "retry"

data/lib/sidekiq_unique_jobs/job.rb

@@ -52,7 +52,7 @@ module SidekiqUniqueJobs
     end
 
     def add_lock_prefix(item)
-      item[LOCK_PREFIX] ||= SidekiqUniqueJobs.config.unique_prefix
+      item[LOCK_PREFIX] ||= SidekiqUniqueJobs.config.lock_prefix
     end
   end
 end

data/lib/sidekiq_unique_jobs/lock/while_executing.rb

@@ -43,7 +43,7 @@ module SidekiqUniqueJobs
           end
         end
       ensure
-        locksmith.unlock
+        locksmith.unlock!
       end
 
       private

data/lib/sidekiq_unique_jobs/locksmith.rb

@@ -87,7 +87,7 @@ module SidekiqUniqueJobs
     #
     def lock(&block)
       redis(redis_pool) do |conn|
-        return lock_async(conn, &block) if block_given?
+        return lock_async(conn, &block) if block
 
         lock_sync(conn) do
           return job_id

data/lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb

@@ -132,7 +132,7 @@ module SidekiqUniqueJobs
             next unless workers.any?
 
             workers.each_pair do |_tid, job|
-              return true if load_json(job)[LOCK_DIGEST] == digest
+              return true if load_json(job).dig(PAYLOAD, LOCK_DIGEST) == digest
             end
           end
 

data/lib/sidekiq_unique_jobs/sidekiq_unique_jobs.rb

@@ -168,7 +168,7 @@ module SidekiqUniqueJobs
   # @option options [Integer] :lock_timeout (default is 0)
   # @option options [Integer] :lock_ttl (default is 0)
   # @option options [true,false] :enabled (default is true)
-  # @option options [String] :unique_prefix (default is 'uniquejobs')
+  # @option options [String] :lock_prefix (default is 'uniquejobs')
   # @option options [Logger] :logger (default is Sidekiq.logger)
   # @yield control to the caller when given block
   def configure(options = {})

data/lib/sidekiq_unique_jobs/version.rb

@@ -3,5 +3,5 @@
 module SidekiqUniqueJobs
   #
   # @return [String] the current SidekiqUniqueJobs version
-  VERSION = "7.0.0.beta27"
+  VERSION = "7.0.0.beta28"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-unique-jobs
 version: !ruby/object:Gem::Version
-  version: 7.0.0.beta27
+  version: 7.0.0.beta28
 platform: ruby
 authors:
 - Mikael Henriksson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-03 00:00:00.000000000 Z
+date: 2021-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: brpoplpush-redis_script
@@ -252,7 +252,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.4
 signing_key:
 specification_version: 4
 summary: Sidekiq middleware that prevents duplicates jobs