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

data/lib/sidekiq_unique_jobs/constants.rb

@@ -3,10 +3,11 @@
 #
 # Module with constants to avoid string duplication
 #
-# @author Mikael Henriksson <mikael@zoolutions.se>
+# @author Mikael Henriksson <mikael@mhenrixon.com>
 #
 module SidekiqUniqueJobs
   ARGS                  ||= "args"
+  APARTMENT             ||= "apartment"
   AT                    ||= "at"
   CHANGELOGS            ||= "uniquejobs:changelog"
   CLASS                 ||= "class"
@@ -18,6 +19,7 @@ module SidekiqUniqueJobs
   LIVE_VERSION          ||= "uniquejobs:live"
   LOCK                  ||= "lock"
   LOCK_ARGS             ||= "lock_args"
+  LOCK_ARGS_METHOD      ||= "lock_args_method"
   LOCK_DIGEST           ||= "lock_digest"
   LOCK_EXPIRATION       ||= "lock_expiration"
   LOCK_INFO             ||= "lock_info"
@@ -42,6 +44,7 @@ module SidekiqUniqueJobs
   UNIQUE_ACROSS_QUEUES  ||= "unique_across_queues"
   UNIQUE_ACROSS_WORKERS ||= "unique_across_workers"
   UNIQUE_ARGS           ||= "unique_args"
+  UNIQUE_ARGS_METHOD    ||= "unique_args_method"
   UNIQUE_DIGEST         ||= "unique_digest"
   UNIQUE_PREFIX         ||= "unique_prefix"
   UNIQUE_REAPER         ||= "uniquejobs:reaper"

data/lib/sidekiq_unique_jobs/digests.rb

@@ -4,7 +4,7 @@ module SidekiqUniqueJobs
   #
   # Class Changelogs provides access to the changelog entries
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   #
   class Digests < Redis::SortedSet
     #

data/lib/sidekiq_unique_jobs/exceptions.rb

@@ -4,14 +4,14 @@ module SidekiqUniqueJobs
   #
   # Base class for all exceptions raised from the gem
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   #
   class UniqueJobsError < ::RuntimeError
   end
 
   # Error raised when a Lua script fails to execute
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   class Conflict < UniqueJobsError
     def initialize(item)
       super("Item with the key: #{item[LOCK_DIGEST]} is already scheduled or processing")
@@ -21,7 +21,7 @@ module SidekiqUniqueJobs
   #
   # Error raised when trying to add a duplicate lock
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   #
   class DuplicateLock < UniqueJobsError
   end
@@ -29,7 +29,7 @@ module SidekiqUniqueJobs
   #
   # Error raised when trying to add a duplicate stragegy
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   #
   class DuplicateStrategy < UniqueJobsError
   end
@@ -37,7 +37,7 @@ module SidekiqUniqueJobs
   #
   # Error raised when an invalid argument is given
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   #
   class InvalidArgument < UniqueJobsError
   end
@@ -45,7 +45,7 @@ module SidekiqUniqueJobs
   #
   # Raised when a workers configuration is invalid
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   #
   class InvalidWorker < UniqueJobsError
     def initialize(lock_config)
@@ -58,7 +58,7 @@ module SidekiqUniqueJobs
 
   # Error raised when a Lua script fails to execute
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   class InvalidUniqueArguments < UniqueJobsError
     def initialize(options)
       given            = options[:given]
@@ -79,7 +79,7 @@ module SidekiqUniqueJobs
   #
   # Raised when a workers configuration is invalid
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   #
   class NotUniqueWorker < UniqueJobsError
     def initialize(options)
@@ -89,7 +89,7 @@ module SidekiqUniqueJobs
 
   # Error raised from {OptionsWithFallback#lock_class}
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   class UnknownLock < UniqueJobsError
   end
 end

data/lib/sidekiq_unique_jobs/job.rb

@@ -3,7 +3,7 @@
 module SidekiqUniqueJobs
   # Utility class to append uniqueness to the sidekiq job hash
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   module Job
     extend self
 
@@ -40,19 +40,19 @@ module SidekiqUniqueJobs
     end
 
     def add_lock_timeout(item)
-      item[LOCK_TIMEOUT] = SidekiqUniqueJobs::LockTimeout.calculate(item)
+      item[LOCK_TIMEOUT] ||= SidekiqUniqueJobs::LockTimeout.calculate(item)
     end
 
     def add_lock_args(item)
-      item[LOCK_ARGS] = SidekiqUniqueJobs::LockArgs.call(item)
+      item[LOCK_ARGS] ||= SidekiqUniqueJobs::LockArgs.call(item)
     end
 
     def add_lock_digest(item)
-      item[LOCK_DIGEST] = SidekiqUniqueJobs::LockDigest.call(item)
+      item[LOCK_DIGEST] ||= SidekiqUniqueJobs::LockDigest.call(item)
     end
 
     def add_lock_prefix(item)
-      item[LOCK_PREFIX] = SidekiqUniqueJobs.config.unique_prefix
+      item[LOCK_PREFIX] ||= SidekiqUniqueJobs.config.unique_prefix
     end
   end
 end

data/lib/sidekiq_unique_jobs/json.rb

@@ -3,7 +3,7 @@
 module SidekiqUniqueJobs
   # Handles loading and dumping of json
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   module JSON
     module_function
 

data/lib/sidekiq_unique_jobs/key.rb

@@ -3,7 +3,7 @@
 module SidekiqUniqueJobs
   # Key class wraps logic dealing with various lock keys
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   class Key
     #
     # @!attribute [r] digest

data/lib/sidekiq_unique_jobs/lock.rb

@@ -4,7 +4,7 @@ module SidekiqUniqueJobs
   #
   # Class Lock provides access to information about a lock
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   #
   class Lock # rubocop:disable Metrics/ClassLength
     # includes "SidekiqUniqueJobs::Connection"

data/lib/sidekiq_unique_jobs/lock/base_lock.rb

@@ -5,7 +5,7 @@ module SidekiqUniqueJobs
     # Abstract base class for locks
     #
     # @abstract
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     class BaseLock
       include SidekiqUniqueJobs::Logging
 

data/lib/sidekiq_unique_jobs/lock/client_validator.rb

@@ -5,7 +5,7 @@ module SidekiqUniqueJobs
     #
     # Validates the sidekiq options for the Sidekiq client process
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     #
     class ClientValidator
       #

data/lib/sidekiq_unique_jobs/lock/server_validator.rb

@@ -5,7 +5,7 @@ module SidekiqUniqueJobs
     #
     # Validates the sidekiq options for the Sidekiq server process
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     #
     class ServerValidator
       #

data/lib/sidekiq_unique_jobs/lock/until_and_while_executing.rb

@@ -11,7 +11,7 @@ module SidekiqUniqueJobs
     # See {#lock} for more information about the client.
     # See {#execute} for more information about the server
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     class UntilAndWhileExecuting < BaseLock
       # Executes in the Sidekiq server process
       # @yield to the worker class perform method

data/lib/sidekiq_unique_jobs/lock/until_executed.rb

@@ -6,7 +6,7 @@ module SidekiqUniqueJobs
     # - Locks on perform_in or perform_async
     # - Unlocks after yielding to the worker's perform method
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     class UntilExecuted < BaseLock
       OK ||= "OK"
 

data/lib/sidekiq_unique_jobs/lock/until_executing.rb

@@ -6,7 +6,7 @@ module SidekiqUniqueJobs
     # - Locks on perform_in or perform_async
     # - Unlocks before yielding to the worker's perform method
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     class UntilExecuting < BaseLock
       # Executes in the Sidekiq server process
       # @yield to the worker class perform method

data/lib/sidekiq_unique_jobs/lock/until_expired.rb

@@ -5,7 +5,7 @@ module SidekiqUniqueJobs
     #
     # UntilExpired locks until the job expires
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     #
     class UntilExpired < UntilExecuted
     end

data/lib/sidekiq_unique_jobs/lock/validator.rb

@@ -5,14 +5,15 @@ module SidekiqUniqueJobs
     #
     # Validator base class to avoid some duplication
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     #
     class Validator
       #
       # @return [Hash] a hash mapping of deprecated keys and their new value
       DEPRECATED_KEYS = {
         UNIQUE.to_sym => LOCK.to_sym,
-        UNIQUE_ARGS.to_sym => LOCK_ARGS.to_sym,
+        UNIQUE_ARGS.to_sym => LOCK_ARGS_METHOD.to_sym,
+        LOCK_ARGS.to_sym => LOCK_ARGS_METHOD.to_sym,
         UNIQUE_PREFIX.to_sym => LOCK_PREFIX.to_sym,
       }.freeze
 

data/lib/sidekiq_unique_jobs/lock/while_executing.rb

@@ -9,7 +9,7 @@ module SidekiqUniqueJobs
     # See {#lock} for more information about the client.
     # See {#execute} for more information about the server
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     class WhileExecuting < BaseLock
       RUN_SUFFIX ||= ":RUN"
 

data/lib/sidekiq_unique_jobs/lock/while_executing_reject.rb

@@ -9,7 +9,7 @@ module SidekiqUniqueJobs
     # See {#lock} for more information about the client.
     # See {#execute} for more information about the server
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     class WhileExecutingReject < WhileExecuting
       # Overridden with a forced {OnConflict::Reject} strategy
       # @return [OnConflict::Reject] a reject strategy

data/lib/sidekiq_unique_jobs/lock_args.rb

@@ -3,7 +3,7 @@
 module SidekiqUniqueJobs
   # Handles uniqueness of sidekiq arguments
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   class LockArgs
     include SidekiqUniqueJobs::Logging
     include SidekiqUniqueJobs::SidekiqWorkerMethods
@@ -98,7 +98,7 @@ module SidekiqUniqueJobs
 
     # The method to use for filtering unique arguments
     def lock_args_method
-      @lock_args_method ||= worker_options[LOCK_ARGS] || worker_options[UNIQUE_ARGS]
+      @lock_args_method ||= worker_options.slice(LOCK_ARGS_METHOD, UNIQUE_ARGS_METHOD).values.first
       @lock_args_method ||= :lock_args if worker_method_defined?(:lock_args)
       @lock_args_method ||= :unique_args if worker_method_defined?(:unique_args)
       @lock_args_method ||= default_lock_args_method
@@ -106,8 +106,8 @@ module SidekiqUniqueJobs
 
     # The global worker options defined in Sidekiq directly
     def default_lock_args_method
-      default_worker_options[LOCK_ARGS] ||
-        default_worker_options[UNIQUE_ARGS]
+      default_worker_options[LOCK_ARGS_METHOD] ||
+        default_worker_options[UNIQUE_ARGS_METHOD]
     end
 
     #

data/lib/sidekiq_unique_jobs/lock_config.rb

@@ -5,7 +5,7 @@ module SidekiqUniqueJobs
   # Gathers all configuration for a lock
   #   which helps reduce the amount of instance variables
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   #
   class LockConfig
     #
@@ -59,12 +59,12 @@ module SidekiqUniqueJobs
     def initialize(job_hash = {})
       @type        = job_hash[LOCK]&.to_sym
       @worker      = job_hash[CLASS]
-      @limit       = job_hash.fetch(LOCK_LIMIT) { 1 }
-      @timeout     = job_hash.fetch(LOCK_TIMEOUT) { 0 }
-      @ttl         = job_hash.fetch(LOCK_TTL) { job_hash.fetch(LOCK_EXPIRATION) { nil } }.to_i
+      @limit       = job_hash.fetch(LOCK_LIMIT, 1)
+      @timeout     = job_hash.fetch(LOCK_TIMEOUT, 0)
+      @ttl         = job_hash.fetch(LOCK_TTL) { job_hash.fetch(LOCK_EXPIRATION, nil) }.to_i
       @pttl        = ttl * 1_000
       @lock_info   = job_hash.fetch(LOCK_INFO) { SidekiqUniqueJobs.config.lock_info }
-      @on_conflict = job_hash.fetch(ON_CONFLICT) { nil }
+      @on_conflict = job_hash.fetch(ON_CONFLICT, nil)
       @errors      = job_hash.fetch(ERRORS) { {} }
 
       @on_client_conflict = job_hash[ON_CLIENT_CONFLICT]

data/lib/sidekiq_unique_jobs/lock_digest.rb

@@ -5,7 +5,7 @@ require "openssl"
 module SidekiqUniqueJobs
   # Handles uniqueness of sidekiq arguments
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   class LockDigest
     include SidekiqUniqueJobs::Logging
     include SidekiqUniqueJobs::JSON
@@ -58,7 +58,7 @@ module SidekiqUniqueJobs
     # Filter a hash to use for digest
     # @return [Hash] to use for digest
     def digestable_hash
-      @item.slice(CLASS, QUEUE, LOCK_ARGS).tap do |hash|
+      @item.slice(CLASS, QUEUE, LOCK_ARGS, APARTMENT).tap do |hash|
         hash.delete(QUEUE) if unique_across_queues?
         hash.delete(CLASS) if unique_across_workers?
       end

data/lib/sidekiq_unique_jobs/lock_info.rb

@@ -4,7 +4,7 @@ module SidekiqUniqueJobs
   #
   # Class Info provides information about a lock
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   #
   class LockInfo < Redis::String
     #

data/lib/sidekiq_unique_jobs/lock_timeout.rb

@@ -3,7 +3,7 @@
 module SidekiqUniqueJobs
   # Calculates timeout and expiration
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   class LockTimeout
     # includes "SidekiqUniqueJobs::SidekiqWorkerMethods"
     # @!parse include SidekiqUniqueJobs::SidekiqWorkerMethods

data/lib/sidekiq_unique_jobs/lock_ttl.rb

@@ -3,7 +3,7 @@
 module SidekiqUniqueJobs
   # Calculates timeout and expiration
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   class LockTTL
     # includes "SidekiqUniqueJobs::SidekiqWorkerMethods"
     # @!parse include SidekiqUniqueJobs::SidekiqWorkerMethods

data/lib/sidekiq_unique_jobs/locksmith.rb

@@ -3,7 +3,7 @@
 module SidekiqUniqueJobs
   # Lock manager class that handles all the various locks
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   class Locksmith # rubocop:disable Metrics/ClassLength
     # includes "SidekiqUniqueJobs::Connection"
     # @!parse include SidekiqUniqueJobs::Connection

data/lib/sidekiq_unique_jobs/logging.rb

@@ -3,7 +3,7 @@
 module SidekiqUniqueJobs
   # Utility module for reducing the number of uses of logger.
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   module Logging
     def self.included(base)
       base.send(:extend, self)
@@ -114,8 +114,8 @@ module SidekiqUniqueJobs
     #
     # @yield
     #
-    def with_configured_loggers_context
-      logger_method.call(logging_context) { yield }
+    def with_configured_loggers_context(&block)
+      logger_method.call(logging_context, &block)
     end
 
     #

data/lib/sidekiq_unique_jobs/logging/middleware_context.rb

@@ -4,13 +4,13 @@ module SidekiqUniqueJobs
   #
   # Provides the sidekiq middleware that makes the gem work
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   #
   module Logging
     #
     # Context aware logging for Sidekiq Middlewares
     #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
     #
     module Middleware
       include Logging

data/lib/sidekiq_unique_jobs/lua/delete_by_digest.lua

@@ -25,7 +25,7 @@ local redisversion = tostring(ARGV[5])
 --------  BEGIN delete_by_digest.lua --------
 local counter       = 0
 local redis_version = toversion(redisversion)
-local del_cmd   = "DEL"
+local del_cmd       = "DEL"
 
 log_debug("BEGIN delete_by_digest:", digest)
 

data/lib/sidekiq_unique_jobs/lua/shared/_delete_from_queue.lua

@@ -6,6 +6,9 @@ local function delete_from_queue(queue, digest)
 
   while (index < total) do
     local items = redis.call("LRANGE", queue, index, index + per -1)
+    if #items == 0 then
+      break
+    end
     for _, item in pairs(items) do
       if string.find(item, digest) then
         redis.call("LREM", queue, 1, item)