sidekiq-unique-jobs 8.0.9 → 8.0.11

data/lib/sidekiq_unique_jobs/lock_ttl.rb

@@ -66,12 +66,34 @@ module SidekiqUniqueJobs
     # @return [Integer] the number of seconds to live
     #
     def calculate
-      ttl = item[LOCK_TTL]
-      ttl ||= job_options[LOCK_TTL]
-      ttl ||= item[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 = fetch_ttl
+      return unless ttl
+
+      timing = calculate_timing(ttl)
+      return unless timing
+
+      timing.to_i + time_until_scheduled
+    end
+
+    private
+
+    def fetch_ttl
+      item[LOCK_TTL] ||
+        job_options[LOCK_TTL] ||
+        item[LOCK_EXPIRATION] || # TODO: Deprecate at some point
+        job_options[LOCK_EXPIRATION] || # TODO: Deprecate at some point
+        SidekiqUniqueJobs.config.lock_ttl
+    end
+
+    def calculate_timing(ttl)
+      case ttl
+      when String, Numeric
+        ttl
+      when Proc
+        ttl.call(item[ARGS])
+      when Symbol
+        job_class.send(ttl, item[ARGS])
+      end
     end
   end
 end

data/lib/sidekiq_unique_jobs/locksmith.rb

@@ -4,7 +4,7 @@ module SidekiqUniqueJobs
   # Lock manager class that handles all the various locks
   #
   # @author Mikael Henriksson <mikael@mhenrixon.com>
-  class Locksmith # rubocop:disable Metrics/ClassLength
+  class Locksmith
     # includes "SidekiqUniqueJobs::Connection"
     # @!parse include SidekiqUniqueJobs::Connection
     include SidekiqUniqueJobs::Connection
@@ -82,7 +82,7 @@ module SidekiqUniqueJobs
     # Deletes the lock regardless of if it has a pttl set
     #
     def delete!
-      call_script(:delete, key.to_a, [job_id, config.pttl, config.type, config.limit]).to_i.positive?
+      call_script(:delete, key.to_a, argv).to_i.positive?
     end
 
     #
@@ -243,7 +243,7 @@ module SidekiqUniqueJobs
     # @return [nil] when lock was not possible
     # @return [Object] whatever the block returns when lock was acquired
     #
-    def primed_async(conn, wait = nil, &block) # rubocop:disable Metrics/MethodLength
+    def primed_async(conn, wait = nil, &block)
       timeout = (wait || config.timeout).to_i
       timeout = 1 if timeout.zero?
 
@@ -251,10 +251,10 @@ module SidekiqUniqueJobs
       concurrent_timeout = add_drift(timeout)
 
       reflect(:debug, :timeouts, item,
-              timeouts: {
-                brpoplpush_timeout: brpoplpush_timeout,
-                concurrent_timeout: concurrent_timeout,
-              })
+        timeouts: {
+          brpoplpush_timeout: brpoplpush_timeout,
+          concurrent_timeout: concurrent_timeout,
+        })
 
       # NOTE: When debugging, change .value to .value!
       primed_jid = Concurrent::Promises
@@ -362,7 +362,11 @@ module SidekiqUniqueJobs
     end
 
     def argv
-      [job_id, config.pttl, config.type, config.limit]
+      [job_id, config.pttl, config.type, config.limit, lock_score]
+    end
+
+    def lock_score
+      item[AT].to_s
     end
 
     def lock_info
@@ -375,6 +379,7 @@ module SidekiqUniqueJobs
         TYPE => config.type,
         LOCK_ARGS => item[LOCK_ARGS],
         TIME => now_f,
+        AT => item[AT],
       )
     end
 

data/lib/sidekiq_unique_jobs/logging.rb

@@ -223,8 +223,8 @@ module SidekiqUniqueJobs
     end
 
     def fake_logger_context(_context)
-      logger.warn "Don't know how to setup the logging context. Please open a feature request:" \
-                  " https://github.com/mhenrixon/sidekiq-unique-jobs/issues/new?template=feature_request.md"
+      logger.warn "Don't know how to setup the logging context. Please open a feature request: " \
+                  "https://github.com/mhenrixon/sidekiq-unique-jobs/issues/new?template=feature_request.md"
 
       yield
     end

data/lib/sidekiq_unique_jobs/lua/delete.lua

@@ -13,14 +13,15 @@ local job_id       = ARGV[1]
 local pttl         = tonumber(ARGV[2])
 local lock_type    = ARGV[3]
 local limit        = tonumber(ARGV[4])
+local lock_score   = ARGV[5]
 -------- END lock arguments -----------
 
 --------  BEGIN injected arguments --------
-local current_time = tonumber(ARGV[5])
-local debug_lua    = tostring(ARGV[6]) == "1"
-local max_history  = tonumber(ARGV[7])
-local script_name  = tostring(ARGV[8]) .. ".lua"
-local redisversion = tostring(ARGV[9])
+local current_time = tonumber(ARGV[6])
+local debug_lua    = tostring(ARGV[7]) == "1"
+local max_history  = tonumber(ARGV[8])
+local script_name  = tostring(ARGV[9]) .. ".lua"
+local redisversion = tostring(ARGV[10])
 ---------  END injected arguments ---------
 
 --------  BEGIN local functions --------

data/lib/sidekiq_unique_jobs/lua/lock.lua

@@ -15,15 +15,16 @@ local job_id       = ARGV[1]
 local pttl         = tonumber(ARGV[2])
 local lock_type    = ARGV[3]
 local limit        = tonumber(ARGV[4])
+local lock_score   = ARGV[5]
 -------- END lock arguments -----------
 
 
 --------  BEGIN injected arguments --------
-local current_time = tonumber(ARGV[5])
-local debug_lua    = tostring(ARGV[6]) == "1"
-local max_history  = tonumber(ARGV[7])
-local script_name  = tostring(ARGV[8]) .. ".lua"
-local redisversion = ARGV[9]
+local current_time = tonumber(ARGV[6])
+local debug_lua    = tostring(ARGV[7]) == "1"
+local max_history  = tonumber(ARGV[8])
+local script_name  = tostring(ARGV[9]) .. ".lua"
+local redisversion = ARGV[10]
 ---------  END injected arguments ---------
 
 
@@ -62,8 +63,16 @@ if lock_type == "until_expired" and pttl and pttl > 0 then
   log_debug("ZADD", expiring_digests, current_time + pttl, digest)
   redis.call("ZADD", expiring_digests, current_time + pttl, digest)
 else
-  log_debug("ZADD", digests, current_time, digest)
-  redis.call("ZADD", digests, current_time, digest)
+  local score
+
+  if #lock_score == 0 then
+    score = current_time
+  else
+    score = lock_score
+  end
+
+  log_debug("ZADD", digests, score, digest)
+  redis.call("ZADD", digests, score, digest)
 end
 
 log_debug("HSET", locked, job_id, current_time)

data/lib/sidekiq_unique_jobs/lua/queue.lua

@@ -10,18 +10,19 @@ local digests   = KEYS[7]
 
 
 -------- BEGIN lock arguments ---------
-local job_id    = ARGV[1]      -- The job_id that was previously primed
-local pttl      = tonumber(ARGV[2])
-local lock_type = ARGV[3]
-local limit     = tonumber(ARGV[4])
+local job_id     = ARGV[1]      -- The job_id that was previously primed
+local pttl       = tonumber(ARGV[2])
+local lock_type  = ARGV[3]
+local limit      = tonumber(ARGV[4])
+local lock_score = ARGV[5]
 -------- END lock arguments -----------
 
 
 --------  BEGIN injected arguments --------
-local current_time = tonumber(ARGV[5])
-local debug_lua    = tostring(ARGV[6]) == "1"
-local max_history  = tonumber(ARGV[7])
-local script_name  = tostring(ARGV[8]) .. ".lua"
+local current_time = tonumber(ARGV[6])
+local debug_lua    = tostring(ARGV[7]) == "1"
+local max_history  = tonumber(ARGV[8])
+local script_name  = tostring(ARGV[9]) .. ".lua"
 ---------  END injected arguments ---------
 
 

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

@@ -1,22 +1,22 @@
 local function delete_from_queue(queue, digest)
-  local per    = 50
-  local total  = redis.call("LLEN", queue)
-  local index  = 0
-  local result = nil
+  local total = redis.call("LLEN", queue)
+  local per   = 50
+
+  for index = 0, total, per do
+    local items = redis.call("LRANGE", queue, index, index + per - 1)
 
-  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)
-        result = item
-        break
+
+        return item
       end
     end
-    index = index + per
   end
-  return result
+
+  return nil
 end

data/lib/sidekiq_unique_jobs/lua/shared/_delete_from_sorted_set.lua

@@ -1,19 +1,29 @@
 local function delete_from_sorted_set(name, digest)
-  local per   = 50
-  local total = redis.call("zcard", name)
-  local index = 0
-  local result
+  local score  = redis.call("ZSCORE", "uniquejobs:digests", digest)
+  local total  = redis.call("ZCARD", name)
+  local per    = 50
+
+  for offset = 0, total, per do
+    local items
+
+    if score then
+      items = redis.call("ZRANGE", name, score, "+inf", "BYSCORE", "LIMIT", offset, per)
+    else
+      items = redis.call("ZRANGE", name, offset, offset + per -1)
+    end
+
+    if #items == 0 then
+      break
+    end
 
-  while (index < total) do
-    local items = redis.call("ZRANGE", name, index, index + per -1)
     for _, item in pairs(items) do
       if string.find(item, digest) then
         redis.call("ZREM", name, item)
-        result = item
-        break
+
+        return item
       end
     end
-    index = index + per
   end
-  return result
+
+  return nil
 end

data/lib/sidekiq_unique_jobs/lua/unlock.lua

@@ -10,19 +10,20 @@ local digests   = KEYS[7]
 
 
 -------- BEGIN lock arguments ---------
-local job_id    = ARGV[1]
-local pttl      = tonumber(ARGV[2])
-local lock_type = ARGV[3]
-local limit     = tonumber(ARGV[4])
+local job_id     = ARGV[1]
+local pttl       = tonumber(ARGV[2])
+local lock_type  = ARGV[3]
+local limit      = tonumber(ARGV[4])
+local lock_score = ARGV[5]
 -------- END lock arguments -----------
 
 
 --------  BEGIN injected arguments --------
-local current_time = tonumber(ARGV[5])
-local debug_lua    = tostring(ARGV[6]) == "1"
-local max_history  = tonumber(ARGV[7])
-local script_name  = tostring(ARGV[8]) .. ".lua"
-local redisversion = ARGV[9]
+local current_time = tonumber(ARGV[6])
+local debug_lua    = tostring(ARGV[7]) == "1"
+local max_history  = tonumber(ARGV[8])
+local script_name  = tostring(ARGV[9]) .. ".lua"
+local redisversion = ARGV[10]
 ---------  END injected arguments ---------
 
 

data/lib/sidekiq_unique_jobs/on_conflict/reject.rb

@@ -28,7 +28,16 @@ module SidekiqUniqueJobs
       # @return [false] when Sidekiq::Deadset#kill does not take multiple arguments
       #
       def kill_with_options?
-        Sidekiq::DeadSet.instance_method(:kill).arity > 1
+        kill_arity = Sidekiq::DeadSet.instance_method(:kill).arity
+        # Method#arity returns:
+        #   1. a nonnegative number for methods that take a fixed number of arguments.
+        #   2. A negative number if it takes a variable number of arguments.
+        # Keyword arguments are considered a single argument, and are considered optional unless one of the kwargs is
+        # required.
+        # Therefore, to determine if `Sidekiq::DeadSet#kill` accepts options beyond the single positional payload
+        # argument, we need to check whether the absolute value of the arity is greater than 1.
+        # See: https://apidock.com/ruby/Method/arity
+        kill_arity > 1 || kill_arity < -1
       end
 
       #

data/lib/sidekiq_unique_jobs/on_conflict/replace.rb

@@ -21,7 +21,7 @@ module SidekiqUniqueJobs
       # @param [Hash] item sidekiq job hash
       #
       def initialize(item, redis_pool = nil)
-        super(item, redis_pool)
+        super
         @queue       = item[QUEUE]
         @lock_digest = item[LOCK_DIGEST]
       end
@@ -54,8 +54,8 @@ module SidekiqUniqueJobs
       #
       def delete_job_by_digest
         call_script(:delete_job_by_digest,
-                    keys: ["#{QUEUE}:#{queue}", SCHEDULE, RETRY],
-                    argv: [lock_digest])
+          keys: ["#{QUEUE}:#{queue}", SCHEDULE, RETRY],
+          argv: [lock_digest])
       end
 
       #

data/lib/sidekiq_unique_jobs/on_conflict/reschedule.rb

@@ -13,7 +13,7 @@ module SidekiqUniqueJobs
 
       # @param [Hash] item sidekiq job hash
       def initialize(item, redis_pool = nil)
-        super(item, redis_pool)
+        super
         self.job_class = item[CLASS]
       end
 

data/lib/sidekiq_unique_jobs/on_conflict.rb

@@ -33,8 +33,8 @@ module SidekiqUniqueJobs
 
       strategies.fetch(strategy.to_sym) do
         SidekiqUniqueJobs.logger.warn(
-          "No matching implementation for strategy: #{strategy}, returning OnConflict::NullStrategy." \
-          " Available strategies are (#{strategies.inspect})",
+          "No matching implementation for strategy: #{strategy}, returning OnConflict::NullStrategy. " \
+          "Available strategies are (#{strategies.inspect})",
         )
 
         OnConflict::NullStrategy

data/lib/sidekiq_unique_jobs/orphans/manager.rb

@@ -32,7 +32,7 @@ module SidekiqUniqueJobs
       #
       # @return [SidekiqUniqueJobs::TimerTask] the task that was started
       #
-      def start(test_task = nil) # rubocop:disable
+      def start(test_task = nil)
         return if disabled?
         return if registered?
 
@@ -73,7 +73,7 @@ module SidekiqUniqueJobs
       # @return [<type>] <description>
       #
       def task
-        @task ||= default_task # rubocop:disable ThreadSafety/InstanceVariableInClassMethod
+        @task ||= default_task # rubocop:disable ThreadSafety/ClassInstanceVariable
       end
 
       #
@@ -101,7 +101,7 @@ module SidekiqUniqueJobs
       # @return [void]
       #
       def task=(task)
-        @task = task # rubocop:disable ThreadSafety/InstanceVariableInClassMethod
+        @task = task # rubocop:disable ThreadSafety/ClassInstanceVariable
       end
 
       #

data/lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb

@@ -9,7 +9,6 @@ module SidekiqUniqueJobs
     #
     # @author Mikael Henriksson <mikael@mhenrixon.com>
     #
-    # rubocop:disable Metrics/ClassLength
     class RubyReaper < Reaper
       include SidekiqUniqueJobs::Timing
 
@@ -57,7 +56,7 @@ module SidekiqUniqueJobs
       # @param [Redis] conn a connection to redis
       #
       def initialize(conn)
-        super(conn)
+        super
         @digests      = SidekiqUniqueJobs::Digests.new
         @scheduled    = Redis::SortedSet.new(SCHEDULE)
         @retried      = Redis::SortedSet.new(RETRY)
@@ -107,7 +106,7 @@ module SidekiqUniqueJobs
       #
       # @return [Array<String>] an array of orphaned digests
       #
-      def orphans # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity
+      def orphans
         orphans = []
         page    = 0
         per     = reaper_count * 2
@@ -197,7 +196,7 @@ module SidekiqUniqueJobs
         end
       end
 
-      def active?(digest) # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      def active?(digest)
         Sidekiq.redis do |conn|
           procs = conn.sscan("processes").to_a
           return false if procs.empty?
@@ -253,7 +252,7 @@ module SidekiqUniqueJobs
         conn.sscan("queues").each(&block)
       end
 
-      def entries(conn, queue, &block) # rubocop:disable Metrics/MethodLength
+      def entries(conn, queue, &block)
         queue_key    = "queue:#{queue}"
         initial_size = conn.llen(queue_key)
         deleted_size = 0

data/lib/sidekiq_unique_jobs/reflections.rb

@@ -50,15 +50,15 @@ module SidekiqUniqueJobs
     #
     # @return [void] <description>
     #
-    def dispatch(reflection, *args) # rubocop:disable Metrics/MethodLength
+    def dispatch(reflection, *args)
       if (block = @reflections[reflection])
         block.call(*args)
 
         if DEPRECATIONS.key?(reflection)
           replacement, removal_version = DEPRECATIONS[reflection]
           SidekiqUniqueJobs::Deprecation.warn(
-            "#{reflection} is deprecated and will be removed in version #{removal_version}." \
-            " Use #{replacement} instead.",
+            "#{reflection} is deprecated and will be removed in version #{removal_version}. " \
+            "Use #{replacement} instead.",
           )
         end
       elsif misconfigured?(reflection)

data/lib/sidekiq_unique_jobs/sidekiq_unique_ext.rb

@@ -60,7 +60,7 @@ module Sidekiq
       #
       def delete(score, job_id)
         entry = find_job(job_id)
-        SidekiqUniqueJobs::Unlockable.delete!(entry.item) if super(score, job_id)
+        SidekiqUniqueJobs::Unlockable.delete!(entry.item) if super
         entry
       end
     end
@@ -132,7 +132,7 @@ module Sidekiq
       # @param [String] value a sidekiq job hash
       #
       def delete_by_value(name, value)
-        SidekiqUniqueJobs::Unlockable.delete!(Sidekiq.load_json(value)) if super(name, value)
+        SidekiqUniqueJobs::Unlockable.delete!(Sidekiq.load_json(value)) if super
       end
     end
 

data/lib/sidekiq_unique_jobs/sidekiq_unique_jobs.rb

@@ -4,7 +4,7 @@
 # Contains configuration and utility methods that belongs top level
 #
 # @author Mikael Henriksson <mikael@mhenrixon.com>
-module SidekiqUniqueJobs # rubocop:disable Metrics/ModuleLength
+module SidekiqUniqueJobs
   include SidekiqUniqueJobs::Connection
   extend SidekiqUniqueJobs::JSON
 
@@ -17,7 +17,7 @@ module SidekiqUniqueJobs # rubocop:disable Metrics/ModuleLength
   # @return [SidekiqUniqueJobs::Config] the gem configuration
   #
   def config
-    @config ||= reset! # rubocop:disable ThreadSafety/InstanceVariableInClassMethod
+    @config ||= reset! # rubocop:disable ThreadSafety/ClassInstanceVariable
   end
 
   #
@@ -108,7 +108,7 @@ module SidekiqUniqueJobs # rubocop:disable Metrics/ModuleLength
   # @return [SidekiqUniqueJobs::Config] a default gem configuration
   #
   def reset!
-    @config = SidekiqUniqueJobs::Config.default # rubocop:disable ThreadSafety/InstanceVariableInClassMethod
+    @config = SidekiqUniqueJobs::Config.default # rubocop:disable ThreadSafety/ClassInstanceVariable
   end
 
   #
@@ -288,7 +288,7 @@ module SidekiqUniqueJobs # rubocop:disable Metrics/ModuleLength
   # @return [Reflections]
   #
   def reflections
-    @reflections ||= Reflections.new # rubocop:disable ThreadSafety/InstanceVariableInClassMethod
+    @reflections ||= Reflections.new # rubocop:disable ThreadSafety/ClassInstanceVariable
   end
 
   #

data/lib/sidekiq_unique_jobs/sidekiq_worker_methods.rb

@@ -39,7 +39,7 @@ module SidekiqUniqueJobs
 
     # The hook to call after a successful unlock
     # @return [Proc]
-    def after_unlock_hook # rubocop:disable Metrics/MethodLength
+    def after_unlock_hook
       lambda do
         if @original_job_class.respond_to?(:after_unlock)
           # instance method in sidekiq v6

data/lib/sidekiq_unique_jobs/testing.rb

@@ -21,7 +21,7 @@ module Sidekiq
   #
   # @param [Hash<Symbol, Object>] tmp_config the temporary config to use
   #
-  def self.use_options(tmp_config = {}) # rubocop:disable Metrics/MethodLength
+  def self.use_options(tmp_config = {})
     if respond_to?(:default_job_options)
       default_job_options.clear
       self.default_job_options = tmp_config
@@ -87,7 +87,7 @@ module Sidekiq
       def sidekiq_options(options = {})
         SidekiqUniqueJobs.validate_worker!(options) if SidekiqUniqueJobs.config.raise_on_config_error
 
-        super(options)
+        super
       end
 
       #

data/lib/sidekiq_unique_jobs/version.rb

@@ -3,5 +3,5 @@
 module SidekiqUniqueJobs
   #
   # @return [String] the current SidekiqUniqueJobs version
-  VERSION = "8.0.9"
+  VERSION = "8.0.11"
 end

data/lib/sidekiq_unique_jobs/web/helpers.rb

@@ -116,7 +116,7 @@ module SidekiqUniqueJobs
       #
       # @return a redirect to the new subpath
       #
-      def redirect_to(subpath)
+      def safe_redirect_to(subpath)
         if respond_to?(:to)
           # Sinatra-based web UI
           redirect to(subpath)
@@ -170,6 +170,34 @@ module SidekiqUniqueJobs
           Time.parse(time.to_s)
         end
       end
+
+      # Copied from sidekiq for compatibility with older versions
+
+      # stuff after ? or form input
+      # uses String keys, no Symbols!
+      def safe_url_params(key)
+        return url_params(key) if Sidekiq::MAJOR >= 8
+
+        if key.is_a?(Symbol)
+          warn do
+            "URL parameter `#{key}` should be accessed via String, not Symbol (at #{caller(3..3).first})"
+          end
+        end
+        request.params[key.to_s]
+      end
+
+      # variables embedded in path, `/metrics/:name`
+      # uses Symbol keys, no Strings!
+      def safe_route_params(key)
+        return route_params(key) if Sidekiq::MAJOR >= 8
+
+        if key.is_a?(String)
+          warn do
+            "Route parameter `#{key}` should be accessed via Symbol, not String (at #{caller(3..3).first})"
+          end
+        end
+        env["rack.route_params"][key.to_sym]
+      end
     end
   end
 end