sidekiq-unique-jobs 7.1.5 → 7.1.25

data/lib/sidekiq_unique_jobs/deprecation.rb

@@ -7,6 +7,13 @@ module SidekiqUniqueJobs
   # @author Mikael Henriksson <mikael@mhenrixon.com>
   #
   class Deprecation
+    #
+    # Mute warnings from this gem in a threaded context
+    #
+    #
+    # @return [void] <description>
+    #
+    # @yieldreturn [void]
     def self.muted
       orig_val = Thread.current[:uniquejobs_mute_deprecations]
       Thread.current[:uniquejobs_mute_deprecations] = true
@@ -15,21 +22,44 @@ module SidekiqUniqueJobs
       Thread.current[:uniquejobs_mute_deprecations] = orig_val
     end
 
+    #
+    # Check if deprecation warnings have been muted
+    #
+    #
+    # @return [true,false]
+    #
     def self.muted?
       Thread.current[:uniquejobs_mute_deprecations] == true
     end
 
+    #
+    # Warn about deprecation
+    #
+    # @param [String] msg a descriptive reason for why the deprecation
+    #
+    # @return [void]
+    #
     def self.warn(msg)
       return if SidekiqUniqueJobs::Deprecation.muted?
 
       warn "DEPRECATION WARNING: #{msg}"
+      nil
     end
 
+    #
+    # Warn about deprecation and provide a context
+    #
+    # @param [String] msg a descriptive reason for why the deprecation
+    #
+    # @return [void]
+    #
     def self.warn_with_backtrace(msg)
       return if SidekiqUniqueJobs::Deprecation.muted?
 
       trace = "\n\nCALLED FROM:\n#{caller.join("\n")}"
       warn(msg + trace)
+
+      nil
     end
   end
 end

data/lib/sidekiq_unique_jobs/digests.rb

@@ -31,7 +31,8 @@ module SidekiqUniqueJobs
     #
     # @param [String] pattern a key pattern to match with
     # @param [Integer] count the maximum number
-    # @return [Array<String>] with unique digests
+    # @return [Hash<String,Float>] Hash mapping of digest matching the given pattern and score
+
     def delete_by_pattern(pattern, count: DEFAULT_COUNT)
       result, elapsed = timed do
         digests = entries(pattern: pattern, count: count).keys
@@ -80,11 +81,7 @@ module SidekiqUniqueJobs
       options[:match] = pattern
       options[:count] = count
 
-      result = redis { |conn| conn.zscan_each(key, **options).to_a }
-
-      result.each_with_object({}) do |entry, hash|
-        hash[entry[0]] = entry[1]
-      end
+      redis { |conn| conn.zscan_each(key, **options).to_a }.to_h
     end
 
     #
@@ -98,9 +95,9 @@ module SidekiqUniqueJobs
     #
     def page(cursor: 0, pattern: SCAN_PATTERN, page_size: 100)
       redis do |conn|
-        total_size, digests = conn.multi do
-          conn.zcard(key)
-          conn.zscan(key, cursor, match: pattern, count: page_size)
+        total_size, digests = conn.multi do |pipeline|
+          pipeline.zcard(key)
+          pipeline.zscan(key, cursor, match: pattern, count: page_size)
         end
 
         [

data/lib/sidekiq_unique_jobs/exceptions.rb

@@ -22,6 +22,7 @@ module SidekiqUniqueJobs
   # Raised when no block was given
   #
   class NoBlockGiven < SidekiqUniqueJobs::UniqueJobsError; end
+
   #
   # Raised when a notification has been mistyped
   #
@@ -71,14 +72,14 @@ module SidekiqUniqueJobs
   class InvalidUniqueArguments < UniqueJobsError
     def initialize(options)
       given            = options[:given]
-      worker_class     = options[:worker_class]
+      job_class        = options[:job_class]
       lock_args_method = options[:lock_args_method]
-      lock_args_meth   = worker_class.method(lock_args_method)
+      lock_args_meth   = job_class.method(lock_args_method)
       num_args         = lock_args_meth.arity
       source_location  = lock_args_meth.source_location
 
       super(
-        "#{worker_class}##{lock_args_method} takes #{num_args} arguments, received #{given.inspect}" \
+        "#{job_class}##{lock_args_method} takes #{num_args} arguments, received #{given.inspect}" \
         "\n\n" \
         "   #{source_location.join(':')}"
       )

data/lib/sidekiq_unique_jobs/json.rb

@@ -20,6 +20,13 @@ module SidekiqUniqueJobs
       ::JSON.parse(string)
     end
 
+    #
+    # Prevents trying JSON.load from raising errors given argument is a hash
+    #
+    # @param [String, Hash] string the JSON string to parse
+    #
+    # @return [Hash,Array]
+    #
     def safe_load_json(string)
       return string if string.is_a?(Hash)
 

data/lib/sidekiq_unique_jobs/lock/base_lock.rb

@@ -91,6 +91,13 @@ module SidekiqUniqueJobs
       #   @return [Integer] the current locking attempt
       attr_reader :attempt
 
+      #
+      # Eases testing by allowing the lock implementation to add the missing
+      # keys to the job hash.
+      #
+      #
+      # @return [void] the return value should be irrelevant
+      #
       def prepare_item
         return if item.key?(LOCK_DIGEST)
 
@@ -100,33 +107,22 @@ module SidekiqUniqueJobs
       end
 
       #
-      # Handle when lock failed
+      # Call whatever strategry that has been configured
       #
-      # @param [Symbol] location: :client or :server
+      # @param [Symbol] origin: the origin `:client` or `:server`
       #
-      # @return [void]
+      # @return [void] the return value is irrelevant
       #
-      def lock_failed(origin: :client)
-        reflect(:lock_failed, item)
-        call_strategy(origin: origin)
-      end
-
+      # @yieldparam [void] if a new job id was set and a block is given
+      # @yieldreturn [void] the yield is irrelevant, it only provides a mechanism in
+      #   one specific situation to yield back to the middleware.
       def call_strategy(origin:)
-        @attempt += 1
+        new_job_id = nil
+        strategy   = strategy_for(origin)
+        @attempt  += 1
 
-        case origin
-        when :client
-          client_strategy.call { lock if replace? }
-        when :server
-          server_strategy.call { lock if replace? }
-        else
-          raise SidekiqUniqueJobs::InvalidArgument,
-                "either `for: :server` or `for: :client` needs to be specified"
-        end
-      end
-
-      def replace?
-        client_strategy.replace? && attempt < 2
+        strategy.call { new_job_id = lock if strategy.replace? && @attempt < 2 }
+        yield if new_job_id && block_given?
       end
 
       def unlock_and_callback
@@ -143,6 +139,18 @@ module SidekiqUniqueJobs
         raise
       end
 
+      def strategy_for(origin)
+        case origin
+        when :client
+          client_strategy
+        when :server
+          server_strategy
+        else
+          raise SidekiqUniqueJobs::InvalidArgument,
+                "#origin needs to be either `:server` or `:client`"
+        end
+      end
+
       def client_strategy
         @client_strategy ||=
           OnConflict.find_strategy(lock_config.on_client_conflict).new(item, redis_pool)

data/lib/sidekiq_unique_jobs/lock/until_and_while_executing.rb

@@ -22,9 +22,15 @@ module SidekiqUniqueJobs
       #
       # @yield to the caller when given a block
       #
-      def lock(origin: :client)
-        return lock_failed(origin: origin) unless (token = locksmith.lock)
-        return yield token if block_given?
+      def lock(origin: :client, &block)
+        unless (token = locksmith.lock)
+          reflect(:lock_failed, item)
+          call_strategy(origin: origin, &block)
+
+          return
+        end
+
+        yield if block
 
         token
       end

data/lib/sidekiq_unique_jobs/lock/until_executed.rb

@@ -17,9 +17,15 @@ module SidekiqUniqueJobs
       #
       # @yield to the caller when given a block
       #
-      def lock
-        return lock_failed(origin: :client) unless (token = locksmith.lock)
-        return yield token if block_given?
+      def lock(&block)
+        unless (token = locksmith.lock)
+          reflect(:lock_failed, item)
+          call_strategy(origin: :client, &block)
+
+          return
+        end
+
+        yield if block
 
         token
       end
@@ -27,10 +33,14 @@ module SidekiqUniqueJobs
       # Executes in the Sidekiq server process
       # @yield to the worker class perform method
       def execute
-        locksmith.execute do
+        executed = locksmith.execute do
           yield
           unlock_and_callback
         end
+
+        reflect(:execution_failed, item) unless executed
+
+        nil
       end
     end
   end

data/lib/sidekiq_unique_jobs/lock/until_executing.rb

@@ -15,11 +15,17 @@ module SidekiqUniqueJobs
       #
       # @return [String, nil] the locked jid when properly locked, else nil.
       #
-      def lock
-        return lock_failed unless (job_id = locksmith.lock)
-        return yield job_id if block_given?
+      def lock(&block)
+        unless (token = locksmith.lock)
+          reflect(:lock_failed, item)
+          call_strategy(origin: :client, &block)
 
-        job_id
+          return
+        end
+
+        yield if block
+
+        token
       end
 
       # Executes in the Sidekiq server process
@@ -27,6 +33,10 @@ module SidekiqUniqueJobs
       def execute
         callback_safely if locksmith.unlock
         yield
+      rescue StandardError => ex
+        reflect(:execution_failed, item, ex)
+        locksmith.lock(wait: 1)
+        raise
       end
     end
   end

data/lib/sidekiq_unique_jobs/lock/until_expired.rb

@@ -17,17 +17,25 @@ module SidekiqUniqueJobs
       #
       # @yield to the caller when given a block
       #
-      def lock
-        return lock_failed unless (job_id = locksmith.lock)
-        return yield job_id if block_given?
+      def lock(&block)
+        unless (token = locksmith.lock)
+          reflect(:lock_failed, item)
+          call_strategy(origin: :client, &block)
 
-        job_id
+          return
+        end
+
+        yield if block
+
+        token
       end
 
       # Executes in the Sidekiq server process
       # @yield to the worker class perform method
       def execute(&block)
-        locksmith.execute(&block)
+        executed = locksmith.execute(&block)
+
+        reflect(:execution_failed, item) unless executed
       end
     end
   end

data/lib/sidekiq_unique_jobs/lock/while_executing.rb

@@ -11,7 +11,7 @@ module SidekiqUniqueJobs
     #
     # @author Mikael Henriksson <mikael@mhenrixon.com>
     class WhileExecuting < BaseLock
-      RUN_SUFFIX ||= ":RUN"
+      RUN_SUFFIX = ":RUN"
 
       include SidekiqUniqueJobs::OptionsWithFallback
       include SidekiqUniqueJobs::Logging::Middleware
@@ -30,7 +30,7 @@ module SidekiqUniqueJobs
       # @return [true] always returns true
       def lock
         job_id = item[JID]
-        yield job_id if block_given?
+        yield if block_given?
 
         job_id
       end
@@ -38,14 +38,19 @@ module SidekiqUniqueJobs
       # Executes in the Sidekiq server process.
       #   These jobs are locked in the server process not from the client
       # @yield to the worker class perform method
-      def execute
+      def execute(&block)
         with_logging_context do
-          call_strategy(origin: :server) unless locksmith.execute do
+          executed = locksmith.execute do
             yield
             callback_safely if locksmith.unlock
           ensure
             locksmith.unlock
           end
+
+          unless executed
+            reflect(:execution_failed, item)
+            call_strategy(origin: :server, &block)
+          end
         end
       end
 

data/lib/sidekiq_unique_jobs/lock.rb

@@ -62,13 +62,13 @@ module SidekiqUniqueJobs
     #
     def lock(job_id, lock_info = {})
       redis do |conn|
-        conn.multi do
-          conn.set(key.digest, job_id)
-          conn.hset(key.locked, job_id, now_f)
-          info.set(lock_info)
-          conn.zadd(key.digests, now_f, key.digest)
-          conn.zadd(key.changelog, now_f, changelog_json(job_id, "queue.lua", "Queued"))
-          conn.zadd(key.changelog, now_f, changelog_json(job_id, "lock.lua", "Locked"))
+        conn.multi do |pipeline|
+          pipeline.set(key.digest, job_id)
+          pipeline.hset(key.locked, job_id, now_f)
+          info.set(lock_info, pipeline)
+          pipeline.zadd(key.digests, now_f, key.digest)
+          pipeline.zadd(key.changelog, now_f, changelog_json(job_id, "queue.lua", "Queued"))
+          pipeline.zadd(key.changelog, now_f, changelog_json(job_id, "lock.lua", "Locked"))
         end
       end
     end
@@ -123,9 +123,9 @@ module SidekiqUniqueJobs
     #
     def del
       redis do |conn|
-        conn.multi do
-          conn.zrem(DIGESTS, key.digest)
-          conn.del(key.digest, key.queued, key.primed, key.locked, key.info)
+        conn.multi do |pipeline|
+          pipeline.zrem(DIGESTS, key.digest)
+          pipeline.del(key.digest, key.queued, key.primed, key.locked, key.info)
         end
       end
     end

data/lib/sidekiq_unique_jobs/lock_args.rb

@@ -26,15 +26,15 @@ module SidekiqUniqueJobs
 
     # @param [Hash] item a Sidekiq job hash
     def initialize(item)
-      @item         = item
-      @worker_class = item[CLASS]
-      @args         = item[ARGS]
+      @item = item
+      @args = item[ARGS]
+      self.job_class = item[CLASS]
     end
 
     # The unique arguments to use for creating a lock
     # @return [Array] the arguments filters by the {#filtered_args} method if {#lock_args_enabled?}
     def lock_args
-      @lock_args ||= filtered_args
+      @lock_args ||= filtered_args || []
     end
 
     # Checks if the worker class has enabled lock_args
@@ -83,31 +83,31 @@ module SidekiqUniqueJobs
 
     # Filters unique arguments by method configured in the sidekiq worker
     # @param [Array] args the arguments passed to the sidekiq worker
-    # @return [Array] unfiltered unless {#worker_method_defined?}
+    # @return [Array] unfiltered unless {#job_method_defined?}
     # @return [Array] with the filtered arguments
     def filter_by_symbol(args)
-      return args unless worker_method_defined?(lock_args_method)
+      return args unless job_method_defined?(lock_args_method)
 
-      worker_class.send(lock_args_method, args)
+      job_class.send(lock_args_method, args)
     rescue ArgumentError
       raise SidekiqUniqueJobs::InvalidUniqueArguments,
             given: args,
-            worker_class: worker_class,
+            job_class: job_class,
             lock_args_method: lock_args_method
     end
 
     # The method to use for filtering unique arguments
     def lock_args_method
-      @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 ||= job_options.slice(LOCK_ARGS_METHOD, UNIQUE_ARGS_METHOD).values.first
+      @lock_args_method ||= :lock_args if job_method_defined?(:lock_args)
+      @lock_args_method ||= :unique_args if job_method_defined?(:unique_args)
       @lock_args_method ||= default_lock_args_method
     end
 
     # The global worker options defined in Sidekiq directly
     def default_lock_args_method
-      default_worker_options[LOCK_ARGS_METHOD] ||
-        default_worker_options[UNIQUE_ARGS_METHOD]
+      default_job_options[LOCK_ARGS_METHOD] ||
+        default_job_options[UNIQUE_ARGS_METHOD]
     end
 
     #
@@ -116,8 +116,12 @@ module SidekiqUniqueJobs
     #
     # @return [Hash<String, Object>]
     #
-    def default_worker_options
-      @default_worker_options ||= Sidekiq.default_worker_options.stringify_keys
+    def default_job_options
+      @default_job_options ||= if Sidekiq.respond_to?(:default_job_options)
+        Sidekiq.default_job_options.stringify_keys
+      else
+        Sidekiq.default_worker_options.stringify_keys
+      end
     end
   end
 end

data/lib/sidekiq_unique_jobs/lock_config.rb

@@ -13,9 +13,9 @@ module SidekiqUniqueJobs
     #   @return [Symbol] the type of lock
     attr_reader :type
     #
-    # @!attribute [r] worker
-    #   @return [Symbol] the worker class
-    attr_reader :worker
+    # @!attribute [r] job
+    #   @return [Symbol] the job class
+    attr_reader :job
     #
     # @!attribute [r] limit
     #   @return [Integer] the number of simultaneous locks
@@ -58,7 +58,7 @@ module SidekiqUniqueJobs
 
     def initialize(job_hash = {})
       @type        = job_hash[LOCK]&.to_sym
-      @worker      = SidekiqUniqueJobs.safe_constantize(job_hash[CLASS])
+      @job         = SidekiqUniqueJobs.safe_constantize(job_hash[CLASS])
       @limit       = job_hash.fetch(LOCK_LIMIT, 1)&.to_i
       @timeout     = job_hash.fetch(LOCK_TIMEOUT, 0)&.to_i
       @ttl         = job_hash.fetch(LOCK_TTL) { job_hash.fetch(LOCK_EXPIRATION, nil) }.to_i
@@ -113,13 +113,13 @@ module SidekiqUniqueJobs
 
     # the strategy to use as conflict resolution from sidekiq client
     def on_client_conflict
-      @on_client_conflict ||= on_conflict["client"] if on_conflict.is_a?(Hash)
+      @on_client_conflict ||= on_conflict["client"] || on_conflict[:client] if on_conflict.is_a?(Hash)
       @on_client_conflict ||= on_conflict
     end
 
     # the strategy to use as conflict resolution from sidekiq server
     def on_server_conflict
-      @on_server_conflict ||= on_conflict["server"] if on_conflict.is_a?(Hash)
+      @on_server_conflict ||= on_conflict["server"] || on_conflict[:server] if on_conflict.is_a?(Hash)
       @on_server_conflict ||= on_conflict
     end
   end

data/lib/sidekiq_unique_jobs/lock_digest.rb

@@ -36,10 +36,10 @@ module SidekiqUniqueJobs
 
     # @param [Hash] item a Sidekiq job hash
     def initialize(item)
-      @item         = item
-      @worker_class = item[CLASS]
-      @lock_args    = item.slice(LOCK_ARGS, UNIQUE_ARGS).values.first # TODO: Deprecate UNIQUE_ARGS
-      @lock_prefix  = item.slice(LOCK_PREFIX, UNIQUE_PREFIX).values.first # TODO: Deprecate UNIQUE_PREFIX
+      @item        = item
+      @lock_args   = item[LOCK_ARGS] || item[UNIQUE_ARGS] # TODO: Deprecate UNIQUE_ARGS
+      @lock_prefix = item[LOCK_PREFIX] || item[UNIQUE_PREFIX] # TODO: Deprecate UNIQUE_PREFIX
+      self.job_class = item[CLASS]
     end
 
     # Memoized lock_digest
@@ -67,13 +67,13 @@ module SidekiqUniqueJobs
     # Checks if we should disregard the queue when creating the unique digest
     # @return [true, false]
     def unique_across_queues?
-      item[UNIQUE_ACROSS_QUEUES] || worker_options[UNIQUE_ACROSS_QUEUES]
+      item[UNIQUE_ACROSS_QUEUES] || job_options[UNIQUE_ACROSS_QUEUES]
     end
 
     # Checks if we should disregard the worker when creating the unique digest
     # @return [true, false]
     def unique_across_workers?
-      item[UNIQUE_ACROSS_WORKERS] || worker_options[UNIQUE_ACROSS_WORKERS]
+      item[UNIQUE_ACROSS_WORKERS] || job_options[UNIQUE_ACROSS_WORKERS]
     end
   end
 end

data/lib/sidekiq_unique_jobs/lock_info.rb

@@ -55,13 +55,13 @@ module SidekiqUniqueJobs
     #
     # @return [Hash]
     #
-    def set(obj)
+    def set(obj, pipeline = nil)
       return unless SidekiqUniqueJobs.config.lock_info
       raise InvalidArgument, "argument `obj` (#{obj}) needs to be a hash" unless obj.is_a?(Hash)
 
       json = dump_json(obj)
       @value = load_json(json)
-      super(json)
+      super(json, pipeline)
       value
     end
   end

data/lib/sidekiq_unique_jobs/lock_timeout.rb

@@ -30,8 +30,8 @@ module SidekiqUniqueJobs
     # @option item [String] :class the class of the sidekiq worker
     # @option item [Float] :at the unix time the job is scheduled at
     def initialize(item)
-      @item         = item
-      @worker_class = item[CLASS]
+      @item = item
+      self.job_class = item[CLASS]
     end
 
     #
@@ -42,9 +42,9 @@ module SidekiqUniqueJobs
     # @return [Integer, nil]
     #
     def calculate
-      timeout = default_worker_options[LOCK_TIMEOUT]
+      timeout = default_job_options[LOCK_TIMEOUT]
       timeout = default_lock_timeout if default_lock_timeout
-      timeout = worker_options[LOCK_TIMEOUT] if worker_options.key?(LOCK_TIMEOUT)
+      timeout = job_options[LOCK_TIMEOUT] if job_options.key?(LOCK_TIMEOUT)
       timeout
     end
 

data/lib/sidekiq_unique_jobs/lock_ttl.rb

@@ -33,8 +33,8 @@ module SidekiqUniqueJobs
     # @option item [String] :class the class of the sidekiq worker
     # @option item [Float] :at the unix time the job is scheduled at
     def initialize(item)
-      @item         = item
-      @worker_class = item[CLASS]
+      @item = item
+      self.job_class = item[CLASS]
     end
 
     #
@@ -67,11 +67,11 @@ module SidekiqUniqueJobs
     #
     def calculate
       ttl = item[LOCK_TTL]
-      ttl ||= worker_options[LOCK_TTL]
+      ttl ||= job_options[LOCK_TTL]
       ttl ||= item[LOCK_EXPIRATION] # TODO: Deprecate at some point
-      ttl ||= worker_options[LOCK_EXPIRATION] # TODO: Deprecate at some point
+      ttl ||= job_options[LOCK_EXPIRATION] # TODO: Deprecate at some point
       ttl ||= SidekiqUniqueJobs.config.lock_ttl
-      ttl && ttl.to_i + time_until_scheduled
+      ttl && (ttl.to_i + time_until_scheduled)
     end
   end
 end

data/lib/sidekiq_unique_jobs/locksmith.rb

@@ -188,18 +188,18 @@ module SidekiqUniqueJobs
     # @yieldparam [string] job_id the sidekiq JID
     # @yieldreturn [void] whatever the calling block returns
     def lock!(conn, primed_method, wait = nil)
-      return yield job_id if locked?(conn)
+      return yield if locked?(conn)
 
       enqueue(conn) do |queued_jid|
-        reflect(:debug, item, queued_jid)
+        reflect(:debug, :queued, item, queued_jid)
 
         primed_method.call(conn, wait) do |primed_jid|
           reflect(:debug, :primed, item, primed_jid)
-
           locked_jid = call_script(:lock, key.to_a, argv, conn)
+
           if locked_jid
             reflect(:debug, :locked, item, locked_jid)
-            return yield job_id
+            return yield
           end
         end
       end
@@ -328,6 +328,7 @@ module SidekiqUniqueJobs
     end
 
     def add_drift(val)
+      val = val.to_f
       val + drift(val)
     end
 

data/lib/sidekiq_unique_jobs/logging.rb

@@ -92,9 +92,18 @@ module SidekiqUniqueJobs
     def log_fatal(message_or_exception = nil, item = nil, &block)
       message = build_message(message_or_exception, item)
       logger.fatal(message, &block)
+
       nil
     end
 
+    #
+    # Build a log message
+    #
+    # @param [String, Exception] message_or_exception an entry to log
+    # @param [Hash] item the sidekiq job hash
+    #
+    # @return [String] a complete log entry
+    #
     def build_message(message_or_exception, item = nil)
       return nil if message_or_exception.nil?
       return message_or_exception if item.nil?