sidekiq-unique-jobs 7.0.9 → 7.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 935557852bee165ab73356ac080c4ac1cddcb218db752703f40d016dc9aadf01
-  data.tar.gz: 47e95549bc6c9b7784619c971c727a536abc0db2b5aac69aeb6a1f9de7cce4e9
+  metadata.gz: 31de42f9427b913ae2c311fe70bd63c1ebed4dba96de6837d5e1f489644f7222
+  data.tar.gz: 46a500dc20edc1cbaa562a27ad66522819359deead834a97cf7bd08d1c50cc08
 SHA512:
-  metadata.gz: e42873abe4b4e8b6628f381c8c2047827e9564a98cbdbacb3117486236d72e8348d1b7fe6a53d6afe99da4d084fed2b04437cad6d1f6e559100de4d624ba5482
-  data.tar.gz: 3a6577108d8f90f6bea64d825b54c253ffc150969930fa723acad63db98dfe7c3cf425d42f6902e82b71a8dc483ba588afc0fa3549d8066c8bc73ddf9522a108
+  metadata.gz: b8fd43403d772a57add9fa5a6d1fef4e728b53e14a72df440e68eb345d6e3a867132de697ad483fd197ebfe3bc77bc2d80ab17af5727eac96c69ef31e29d4447
+  data.tar.gz: fa2ecad50220f6cf6cb2b72666094f1761cb1c2671a505d4d804374b50b08a4b78b80ba82561f4a45f3108eb6098b8d2dd2ebfef4683aac226849412cb0eb1f9

data/CHANGELOG.md

@@ -1,5 +1,39 @@
 # Changelog
 
+## [v7.0.11](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v7.0.11) (2021-05-16)
+
+[Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v7.0.10...v7.0.11)
+
+**Fixed bugs:**
+
+- Constants are not necessary when deleting locks [\#606](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/606) ([mhenrixon](https://github.com/mhenrixon))
+
+**Closed issues:**
+
+- Sidekiq Pro Sharded Web UI Error \> 7.0.8 [\#605](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/605)
+- Timed out after 0s while waiting for primed token [\#601](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/601)
+
+## [v7.0.10](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v7.0.10) (2021-05-10)
+
+[Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v7.0.9...v7.0.10)
+
+**Fixed bugs:**
+
+- Add drift to original value [\#603](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/603) ([mhenrixon](https://github.com/mhenrixon))
+
+**Closed issues:**
+
+- Nested Sidekiq jobs are not kicked off with until\_and\_while\_executing [\#600](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/600)
+
+## [v7.0.9](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v7.0.9) (2021-04-26)
+
+[Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v7.0.8...v7.0.9)
+
+**Fixed bugs:**
+
+- lock\_info set to true but no lock info showing up in web ui [\#589](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/589)
+- Fix recording lock\_info [\#599](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/599) ([mhenrixon](https://github.com/mhenrixon))
+
 ## [v7.0.8](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v7.0.8) (2021-04-14)
 
 [Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v7.0.7...v7.0.8)

data/README.md

@@ -226,7 +226,7 @@ SidekiqUniqueJobs.config.lock_ttl #=> nil
 
 Set a global lock_ttl to use for all jobs that don't otherwise specify a lock_ttl.
 
-Lock TTL decides how long to wait after the job has been successfully processed before making it possible to reuse that lock.
+Lock TTL decides how long to wait at most before considering a lock to be expired and making it possible to reuse that lock.
 
 ### enabled
 
@@ -336,7 +336,7 @@ sidekiq_options lock_prefix: "uniquejobs" # this is the default value
 
 ### lock_ttl
 
-Lock TTL decides how long to wait after the job has been successfully processed before making it possible to reuse that lock.
+Lock TTL decides how long to wait at most before considering a lock to be expired and making it possible to reuse that lock.
 
 Starting from `v7` the expiration will take place when the job is pushed to the queue.
 
@@ -567,7 +567,7 @@ You may need to define some custom strategy. You can define it in one project fo
 ```ruby
 # lib/strategies/my_custom_strategy.rb
 module Strategies
-  class MyCustomStrategy < OnConflict::Strategy
+  class MyCustomStrategy < SidekiqUniqueJobs::OnConflict::Strategy
     def call
       # Do something ...
     end

data/lib/sidekiq_unique_jobs/config.rb

@@ -185,22 +185,26 @@ module SidekiqUniqueJobs
     end
 
     def default_lock_ttl=(obj)
-      warn "[DEPRECATION] `#{class_name}##{__method__}` is deprecated. Please use `#{class_name}#lock_ttl=` instead."
+      warn "[DEPRECATION] `#{class_name}##{__method__}` is deprecated." \
+           " Please use `#{class_name}#lock_ttl=` instead."
       self.lock_ttl = obj
     end
 
     def default_lock_timeout=(obj)
-      warn "[DEPRECATION] `#{class_name}##{__method__}` is deprecated. Please use `#{class_name}#lock_timeout=` instead."
+      warn "[DEPRECATION] `#{class_name}##{__method__}` is deprecated." \
+           " Please use `#{class_name}#lock_timeout=` instead."
       self.lock_timeout = obj
     end
 
     def default_lock_ttl
-      warn "[DEPRECATION] `#{class_name}##{__method__}` is deprecated. Please use `#{class_name}#lock_ttl` instead."
+      warn "[DEPRECATION] `#{class_name}##{__method__}` is deprecated." \
+           " Please use `#{class_name}#lock_ttl` instead."
       lock_ttl
     end
 
     def default_lock_timeout
-      warn "[DEPRECATION] `#{class_name}##{__method__}` is deprecated. Please use `#{class_name}#lock_timeout` instead."
+      warn "[DEPRECATION] `#{class_name}##{__method__}` is deprecated." \
+           " Please use `#{class_name}#lock_timeout` instead."
       lock_timeout
     end
 

data/lib/sidekiq_unique_jobs/constants.rb

@@ -6,49 +6,49 @@
 # @author Mikael Henriksson <mikael@mhenrixon.com>
 #
 module SidekiqUniqueJobs
-  ARGS                  ||= "args"
-  APARTMENT             ||= "apartment"
-  AT                    ||= "at"
-  CHANGELOGS            ||= "uniquejobs:changelog"
-  CLASS                 ||= "class"
-  CREATED_AT            ||= "created_at"
-  DEAD_VERSION          ||= "uniquejobs:dead"
-  DIGESTS               ||= "uniquejobs:digests"
-  ERRORS                ||= "errors"
-  JID                   ||= "jid"
-  LIMIT                 ||= "limit"
-  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"
-  LOCK_LIMIT            ||= "lock_limit"
-  LOCK_PREFIX           ||= "lock_prefix"
-  LOCK_TIMEOUT          ||= "lock_timeout"
-  LOCK_TTL              ||= "lock_ttl"
-  LOCK_TYPE             ||= "lock_type"
-  LOG_DUPLICATE         ||= "log_duplicate"
-  ON_CLIENT_CONFLICT    ||= "on_client_conflict"
-  ON_CONFLICT           ||= "on_conflict"
-  ON_SERVER_CONFLICT    ||= "on_server_conflict"
-  PAYLOAD               ||= "payload"
-  PROCESSES             ||= "processes"
-  QUEUE                 ||= "queue"
-  RETRY                 ||= "retry"
-  SCHEDULE              ||= "schedule"
-  TIME                  ||= "time"
-  TIMEOUT               ||= "timeout"
-  TTL                   ||= "ttl"
-  TYPE                  ||= "type"
-  UNIQUE                ||= "unique"
-  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"
-  WORKER                ||= "worker"
+  ARGS                  = "args"
+  APARTMENT             = "apartment"
+  AT                    = "at"
+  CHANGELOGS            = "uniquejobs:changelog"
+  CLASS                 = "class"
+  CREATED_AT            = "created_at"
+  DEAD_VERSION          = "uniquejobs:dead"
+  DIGESTS               = "uniquejobs:digests"
+  ERRORS                = "errors"
+  JID                   = "jid"
+  LIMIT                 = "limit"
+  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"
+  LOCK_LIMIT            = "lock_limit"
+  LOCK_PREFIX           = "lock_prefix"
+  LOCK_TIMEOUT          = "lock_timeout"
+  LOCK_TTL              = "lock_ttl"
+  LOCK_TYPE             = "lock_type"
+  LOG_DUPLICATE         = "log_duplicate"
+  ON_CLIENT_CONFLICT    = "on_client_conflict"
+  ON_CONFLICT           = "on_conflict"
+  ON_SERVER_CONFLICT    = "on_server_conflict"
+  PAYLOAD               = "payload"
+  PROCESSES             = "processes"
+  QUEUE                 = "queue"
+  RETRY                 = "retry"
+  SCHEDULE              = "schedule"
+  TIME                  = "time"
+  TIMEOUT               = "timeout"
+  TTL                   = "ttl"
+  TYPE                  = "type"
+  UNIQUE                = "unique"
+  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"
+  WORKER                = "worker"
 end

data/lib/sidekiq_unique_jobs/lock/until_executed.rb

@@ -8,7 +8,7 @@ module SidekiqUniqueJobs
     #
     # @author Mikael Henriksson <mikael@mhenrixon.com>
     class UntilExecuted < BaseLock
-      OK ||= "OK"
+      OK = "OK"
 
       # Executes in the Sidekiq server process
       # @yield to the worker class perform method

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

data/lib/sidekiq_unique_jobs/lock_config.rb

@@ -58,7 +58,7 @@ module SidekiqUniqueJobs
 
     def initialize(job_hash = {})
       @type        = job_hash[LOCK]&.to_sym
-      @worker      = SidekiqUniqueJobs.constantize(job_hash[CLASS])
+      @worker      = SidekiqUniqueJobs.safe_constantize(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

data/lib/sidekiq_unique_jobs/lock_ttl.rb

@@ -71,7 +71,7 @@ module SidekiqUniqueJobs
       ttl ||= item[LOCK_EXPIRATION] # TODO: Deprecate at some point
       ttl ||= worker_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

@@ -199,7 +199,7 @@ module SidekiqUniqueJobs
     def primed_async(conn)
       return yield if Concurrent::Promises
                       .future(conn) { |red_con| pop_queued(red_con) }
-                      .value(drift(config.pttl) / 1000) # Important to reduce time spent waiting
+                      .value(add_drift(config.ttl))
 
       warn_about_timeout
     end
@@ -317,7 +317,11 @@ module SidekiqUniqueJobs
       # Add 2 milliseconds to the drift to account for Redis expires
       # precision, which is 1 millisecond, plus 1 millisecond min drift
       # for small TTLs.
-      (val.to_f * CLOCK_DRIFT_FACTOR).to_f + 2
+      (val + 2).to_f * CLOCK_DRIFT_FACTOR
+    end
+
+    def add_drift(val)
+      val + drift(val)
     end
 
     #
@@ -332,7 +336,9 @@ module SidekiqUniqueJobs
     end
 
     def warn_about_timeout
-      log_warn("Timed out after #{config.timeout}s while waiting for primed token (digest: #{key}, job_id: #{job_id})")
+      return unless config.wait_for_lock?
+
+      log_debug("Timed out after #{config.timeout}s while waiting for primed token (digest: #{key}, job_id: #{job_id})")
     end
 
     def lock_info

data/lib/sidekiq_unique_jobs/options_with_fallback.rb

@@ -55,10 +55,8 @@ module SidekiqUniqueJobs
     # @return [Class]
     #
     def lock_class
-      @lock_class ||= begin
-        locks.fetch(lock_type.to_sym) do
-          raise UnknownLock, "No implementation for `lock: :#{lock_type}`"
-        end
+      @lock_class ||= locks.fetch(lock_type.to_sym) do
+        raise UnknownLock, "No implementation for `lock: :#{lock_type}`"
       end
     end
 

data/lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb

@@ -182,7 +182,7 @@ module SidekiqUniqueJobs
         page_size    = 50
 
         loop do
-          range_start = page * page_size - deleted_size
+          range_start = (page * page_size) - deleted_size
           range_end   = range_start + page_size - 1
           entries     = conn.lrange(queue_key, range_start, range_end)
           page       += 1

data/lib/sidekiq_unique_jobs/server.rb

@@ -5,7 +5,7 @@ module SidekiqUniqueJobs
   #
   # @author Mikael Henriksson <mikael@mhenrixon.com>
   class Server
-    DEATH_HANDLER ||= (lambda do |job, _ex|
+    DEATH_HANDLER = (lambda do |job, _ex|
       return unless (digest = job["lock_digest"])
 
       SidekiqUniqueJobs::Digests.new.delete_by_digest(digest)

data/lib/sidekiq_unique_jobs/sidekiq_unique_ext.rb

@@ -68,24 +68,46 @@ module Sidekiq
     prepend UniqueExtension
   end
 
-  # See Sidekiq::Api
-  class Job
-    #
-    # Provides extensions for unlocking jobs that are removed and deleted
-    #
-    # @author Mikael Henriksson <mikael@mhenrixon.com>
-    #
-    module UniqueExtension
+  if Sidekiq.const_defined?("JobRecord")
+    # See Sidekiq::Api
+    class JobRecord
       #
-      # Wraps the original method to ensure locks for the job are deleted
+      # Provides extensions for unlocking jobs that are removed and deleted
       #
-      def delete
-        SidekiqUniqueJobs::Unlockable.delete!(item)
-        super
+      # @author Mikael Henriksson <mikael@mhenrixon.com>
+      #
+      module UniqueExtension
+        #
+        # Wraps the original method to ensure locks for the job are deleted
+        #
+        def delete
+          SidekiqUniqueJobs::Unlockable.delete!(item)
+          super
+        end
       end
+
+      prepend UniqueExtension
     end
+  else
+    # See Sidekiq::Api
+    class Job
+      #
+      # Provides extensions for unlocking jobs that are removed and deleted
+      #
+      # @author Mikael Henriksson <mikael@mhenrixon.com>
+      #
+      module UniqueExtension
+        #
+        # Wraps the original method to ensure locks for the job are deleted
+        #
+        def delete
+          SidekiqUniqueJobs::Unlockable.delete!(item)
+          super
+        end
+      end
 
-    prepend UniqueExtension
+      prepend UniqueExtension
+    end
   end
 
   # See Sidekiq::Api

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
+module SidekiqUniqueJobs # rubocop:disable Metrics/ModuleLength
   include SidekiqUniqueJobs::Connection
   extend SidekiqUniqueJobs::JSON
 
@@ -255,4 +255,19 @@ module SidekiqUniqueJobs
       constant.const_get(name, false)
     end
   end
+
+  # Attempt to constantize a string worker_class argument, always
+  # failing back to the original argument when the constant can't be found
+  #
+  # @return [Sidekiq::Worker, String]
+  def safe_constantize(str)
+    constantize(str)
+  rescue NameError => ex
+    case ex.message
+    when /uninitialized constant/
+      str
+    else
+      raise
+    end
+  end
 end

data/lib/sidekiq_unique_jobs/sidekiq_worker_methods.rb

@@ -49,14 +49,7 @@ module SidekiqUniqueJobs
     #
     # @return [Sidekiq::Worker]
     def worker_class_constantize(klazz = @worker_class)
-      SidekiqUniqueJobs.constantize(klazz)
-    rescue NameError => ex
-      case ex.message
-      when /uninitialized constant/
-        klazz
-      else
-        raise
-      end
+      SidekiqUniqueJobs.safe_constantize(klazz)
     end
 
     #

data/lib/sidekiq_unique_jobs/version.rb

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

data/lib/tasks/changelog.rake

@@ -1,21 +1,21 @@
 # frozen_string_literal: true
 
+# rubocop:disable Style/MutableConstant
+CHANGELOG_CMD = %w[
+  github_changelog_generator
+  --no-verbose
+  --user
+  mhenrixon
+  --project
+  sidekiq-unique-jobs
+  --token
+]
+ADD_CHANGELOG_CMD = "git add --all"
+COMMIT_CHANGELOG_CMD = "git commit -a -m 'Update changelog'"
+# rubocop:enable Style/MutableConstant
+
 desc "Generate a Changelog"
 task :changelog do
-  # rubocop:disable Style/MutableConstant
-  CHANGELOG_CMD ||= %w[
-    github_changelog_generator
-    --no-verbose
-    --user
-    mhenrixon
-    --project
-    sidekiq-unique-jobs
-    --token
-  ]
-  ADD_CHANGELOG_CMD ||= "git add --all"
-  COMMIT_CHANGELOG_CMD ||= "git commit -a -m 'Update changelog'"
-  # rubocop:enable Style/MutableConstant
-
   sh("git checkout master")
   sh(*CHANGELOG_CMD.push(ENV["CHANGELOG_GITHUB_TOKEN"]))
   sh(ADD_CHANGELOG_CMD)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-unique-jobs
 version: !ruby/object:Gem::Version
-  version: 7.0.9
+  version: 7.0.13
 platform: ruby
 authors:
 - Mikael Henriksson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-26 00:00:00.000000000 Z
+date: 2021-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: brpoplpush-redis_script
@@ -59,7 +59,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -69,7 +69,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -79,7 +79,7 @@ dependencies:
         version: '0.20'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -89,7 +89,7 @@ dependencies:
         version: '0.20'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 description: |
   Prevents simultaneous Sidekiq jobs with the same unique arguments to run.
   Highly configurable to suite your specific needs.
@@ -250,14 +250,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.16
+rubygems_version: 3.2.28
 signing_key:
 specification_version: 4
 summary: Sidekiq middleware that prevents duplicates jobs