sidekiq-unique-jobs 6.0.5 → 6.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d4687b0a098ec2c297ad6d46a8b9c3fa50d024d79fe0f241a9bd635bb0c99fd
-  data.tar.gz: 2539c5773a5da7bfd1f3ce09bc7b217a9f16b90bc2775e9f64406e68ba3ae509
+  metadata.gz: f82a371b5f835c77c75c753533472d6b7654cb5f403ebeb686502046a0884681
+  data.tar.gz: 982ad72a4c7f7a164c9dadc7e5979b26562b53d7a934a6a04c2baf0bd35f7732
 SHA512:
-  metadata.gz: ebf3ce0a04fe2d9c9ced23bfdd5c3b0cb58efb559bc81c4c2db96b8406ab83c6d86b7c14f46d2954ac1ea25d92a496334f338c559173b5125cfe3ccb01d209a9
-  data.tar.gz: ed0913b11a73d2036159a36d087044d53c9b95fe1b4c239f1181e1dffc681e1bafa9b5eed0449f92967909846afce3af6355c86195027993bf35b60cff8385d9
+  metadata.gz: 6e6e9740d60600bdf0ab87b1c24dca5c680f866bbdee55449dcfe2dd143956b85ecf8db33c5bbdbc1c4ec59dcd9ab8ee481af06c93b234419612005ce1628f62
+  data.tar.gz: 58e048744c22ebf4b288863919dad091a122f9511b7d578b06327060e88e4c377542ebae00311381ec2cbda4276d8c6e08cf51033c6369532499aa2c2e49815b

data/lib/sidekiq_unique_jobs/locksmith.rb

@@ -4,10 +4,7 @@ module SidekiqUniqueJobs
   # Lock manager class that handles all the various locks
   #
   # @author Mikael Henriksson <mikael@zoolutions.se>
-  class Locksmith # rubocop:disable ClassLength
-    API_VERSION = '1'
-    EXPIRES_IN = 10
-
+  class Locksmith
     include SidekiqUniqueJobs::Connection
 
     # @param [Hash] item a Sidekiq job hash
@@ -23,26 +20,6 @@ module SidekiqUniqueJobs
       @redis_pool    = redis_pool
     end
 
-    # Creates the necessary keys in redis to attempt a lock
-    # @return [String] the Sidekiq job_id
-    def create
-      Scripts.call(
-        :create,
-        redis_pool,
-        keys: [exists_key, grabbed_key, available_key, version_key, UNIQUE_SET, unique_digest],
-        argv: [jid, expiration, API_VERSION, concurrency],
-      )
-    end
-
-    def expire
-      Scripts.call(
-        :expire,
-        redis_pool,
-        keys: [exists_key, available_key, version_key],
-        argv: [expiration, jid],
-      )
-    end
-
     # Checks if the exists key is created in redis
     # @return [true, false]
     def exists?
@@ -78,48 +55,49 @@ module SidekiqUniqueJobs
     # @yield the block to execute if a lock is successful
     # @return the Sidekiq job_id (jid)
     def lock(timeout = nil, &block)
-      create
+      Scripts.call(:lock, redis_pool,
+                   keys: [exists_key, grabbed_key, available_key, UNIQUE_SET, unique_digest],
+                   argv: [jid, expiration])
 
       grab_token(timeout) do |token|
-        expire
         touch_grabbed_token(token)
         return_token_or_block_value(token, &block)
       end
     end
     alias wait lock
 
-    # Removes the lock keys from Redis
+    # Removes the lock keys from Redis if locked by the provided jid/token
     # @return [false] unless locked?
     # @return [String] Sidekiq job_id (jid) if successful
     def unlock(token = nil)
-      return false unless locked?(token)
-      signal(token)
-    end
-
-    # Checks if this instance is considered locked
-    # @param [String] token the unique token to check for a lock.
-    #   nil will default to the jid provided in the initializer
-    # @return [true, false]
-    def locked?(token = nil)
       token ||= jid
-      redis(redis_pool) { |conn| conn.hexists(grabbed_key, token) }
+      return false unless locked?(token)
+      unlock!(token)
     end
 
-    # Signal that the token should be released
-    # @param [String] token the unique token to check for a lock.
-    #   nil will default to the jid provided in the initializer.
-    # @return [Integer] the number of available lock resources
-    def signal(token = nil)
+    # Removes the lock keys from Redis
+    # @return [false] unless locked?
+    # @return [String] Sidekiq job_id (jid) if successful
+    def unlock!(token = nil)
       token ||= jid
 
       Scripts.call(
-        :signal,
+        :unlock,
         redis_pool,
         keys: [exists_key, grabbed_key, available_key, version_key, UNIQUE_SET, unique_digest],
         argv: [token, expiration],
       )
     end
 
+    # Checks if this instance is considered locked
+    # @param [String] token the unique token to check for a lock.
+    #   nil will default to the jid provided in the initializer
+    # @return [true, false]
+    def locked?(token = nil)
+      token ||= jid
+      redis(redis_pool) { |conn| conn.hexists(grabbed_key, token) }
+    end
+
     private
 
     attr_reader :concurrency, :unique_digest, :expiration, :jid, :redis_pool
@@ -148,7 +126,7 @@ module SidekiqUniqueJobs
       begin
         yield token
       ensure
-        signal(token)
+        unlock(token)
       end
     end
 

data/lib/sidekiq_unique_jobs/util.rb

@@ -44,7 +44,7 @@ module SidekiqUniqueJobs
     # @return [Integer] the number of keys deleted
     def del(pattern = SCAN_PATTERN, count = 0)
       raise ArgumentError, 'Please provide a number of keys to delete greater than zero' if count.zero?
-      pattern = "#{pattern}:*" unless pattern.end_with?(':*')
+      pattern = suffix(pattern)
 
       log_debug { "Deleting keys by: #{pattern}" }
       keys, time = timed { keys(pattern, count) }
@@ -87,6 +87,11 @@ module SidekiqUniqueJobs
       "#{unique_prefix}:#{key}"
     end
 
+    def suffix(key)
+      return "#{key}*" unless key.end_with?(':*')
+      key
+    end
+
     def unique_prefix
       SidekiqUniqueJobs.config.unique_prefix
     end

data/lib/sidekiq_unique_jobs/version.rb

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

data/redis/{create.lua → lock.lua}

@@ -3,14 +3,20 @@
 local exists_key    = KEYS[1]
 local grabbed_key   = KEYS[2]
 local available_key = KEYS[3]
-local version_key   = KEYS[4]
-local unique_keys   = KEYS[5]
-local unique_digest = KEYS[6]
+local unique_keys   = KEYS[4]
+local unique_digest = KEYS[5]
 
 local job_id        = ARGV[1]
 local expiration    = tonumber(ARGV[2])
-local api_version   = ARGV[3]
-local concurrency   = tonumber(ARGV[4])
+
+local function current_time()
+  local time = redis.call('time')
+  local s = time[1]
+  local ms = time[2]
+  local number = tonumber((s .. '.' .. ms))
+
+  return number
+end
 
 -- redis.log(redis.LOG_DEBUG, "create.lua - investigate possibility of locking jid: " .. job_id)
 
@@ -35,24 +41,18 @@ if old_token then
 end
 ----------------------------------------------------------------
 
--- redis.log(redis.LOG_DEBUG, "create.lua - creating locks for jid: " .. job_id)
 redis.call('SADD', unique_keys, unique_digest)
-redis.call('EXPIRE', exists_key, 5)
 redis.call('DEL', grabbed_key)
+-- TODO: Move this to LUA when redis 3.2 is the least supported
+-- redis.call('HSET', grabbed_key, job_id, current_time())
+---------------------------------------------------------------
 redis.call('DEL', available_key)
+redis.call('RPUSH', available_key, job_id)
 
-if concurrency and concurrency > 1 then
-  for index = 1, concurrency do
-    redis.call('RPUSH', available_key, index)
-  end
-else
-  redis.call('RPUSH', available_key, job_id)
+if expiration then
+  redis.call('EXPIRE', available_key, expiration)
+  redis.call('EXPIRE', exists_key, expiration)
+  redis.call('EXPIRE', grabbed_key, expiration)
 end
 
--- redis.log(redis.LOG_DEBUG, "create.lua - persisting locks for jid: " .. job_id)
-redis.call('PERSIST', exists_key)
-
-redis.call('GETSET', version_key, api_version)
-
-
 return job_id

data/redis/{signal.lua → unlock.lua}

@@ -17,15 +17,15 @@ if expiration then
   redis.call('SREM', unique_keys, unique_digest)
   redis.call('EXPIRE', exists_key, expiration)
   redis.call('EXPIRE', available_key, expiration)
-  redis.call('EXPIRE', version_key, expiration)
+  redis.call('EXPIRE', version_key, expiration)   -- TODO: Legacy support (Remove in v6.1)
   redis.call('EXPIRE', unique_digest, expiration) -- TODO: Legacy support (Remove in v6.1)
 else
   redis.call('DEL', exists_key)
   redis.call('SREM', unique_keys, unique_digest)
   redis.call('DEL', grabbed_key)
   redis.call('DEL', available_key)
-  redis.call('DEL', version_key)
-  redis.call('DEL', 'uniquejobs')   -- TODO: Old job hash, just drop the darn thing
+  redis.call('DEL', version_key)    -- TODO: Legacy support (Remove in v6.1)
+  redis.call('DEL', 'uniquejobs')   -- TODO: Old job hash, just drop the darn thing  (Remove in v6.1)
   redis.call('DEL', unique_digest)  -- TODO: Legacy support (Remove in v6.1)
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-unique-jobs
 version: !ruby/object:Gem::Version
-  version: 6.0.5
+  version: 6.0.6
 platform: ruby
 authors:
 - Mikael Henriksson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-07 00:00:00.000000000 Z
+date: 2018-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -310,14 +310,12 @@ files:
 - lib/sidekiq_unique_jobs/web/views/unique_digest.erb
 - lib/sidekiq_unique_jobs/web/views/unique_digests.erb
 - redis/acquire_lock.lua
-- redis/create.lua
 - redis/delete.lua
 - redis/delete_by_digest.lua
 - redis/delete_job_by_digest.lua
-- redis/expire.lua
-- redis/release_lock.lua
+- redis/lock.lua
 - redis/release_stale_locks.lua
-- redis/signal.lua
+- redis/unlock.lua
 - sidekiq-unique-jobs.gemspec
 homepage: https://github.com/mhenrixon/sidekiq-unique-jobs
 licenses:
@@ -339,7 +337,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Uniqueness for Sidekiq Jobs

data/redis/expire.lua

@@ -1,15 +0,0 @@
--- redis.replicate_commands();
-
-local exists_key    = KEYS[1]
-local available_key = KEYS[2]
-local version_key   = KEYS[3]
-
-local expiration    = tonumber(ARGV[1])
-local job_id        = ARGV[2]
-
-if expiration then
-  -- redis.log(redis.LOG_DEBUG, "expire.lua - expiring locks for job_id: " .. job_id)
-  redis.call('EXPIRE', available_key, expiration)
-  redis.call('EXPIRE', exists_key, expiration)
-  redis.call('EXPIRE', version_key, expiration)
-end

data/redis/release_lock.lua

@@ -1,16 +0,0 @@
-local unique_key = KEYS[1]
-local job_id     = ARGV[1]
-local stored_jid = redis.pcall('get', unique_key)
-
-if stored_jid then
-  if stored_jid == job_id or stored_jid == '2' then
-    redis.pcall('del', unique_key)
-    redis.pcall('HDEL', 'uniquejobs', job_id)
-    return 1
-  else
-    return 0
-  end
-else
-  return -1
-end
-