sidekiq-unique-jobs 7.1.3 → 7.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57accefc169e11923a88ad34751e2e7c5f2a2c25a8f672084d946d1c536a7a46
-  data.tar.gz: e019c6288d6b87fb0b306b18e0435095a81a56ab04046ca25485b531c418f692
+  metadata.gz: f0525a9235a69f86ef177c23a54afea5977a4a99fe4c09867d88c88d29eeb280
+  data.tar.gz: f105453b5082cb2a37ff2484e8c92213ec578a488b5f97f894b7f06e901aca23
 SHA512:
-  metadata.gz: 1989a4f0d6a335be4f7b35e97028a32fabd39212dd3f914471fa78c6654cefacc9e2725654299a10b7df5c55f0778566283f7e5e0ba01542de7900995dcfb734
-  data.tar.gz: d9be5add9dbaac2c523dbb6ed8dfe2879026087132c4812a2a03e4e58945cf481047aff00ed49e78942d8450749fc2864b09b44e6646dd4125452568cbc902ec
+  metadata.gz: 24eeed23d326f74ebf0c06d34913c8429d1ce7848bdb384606176bf8362ae74f8e1a3dbd0cffad10fbdac1344fe7a1170804e332f5974713c890f6fb330fae91
+  data.tar.gz: 61ce06ebeb3b49f25dbb3ffb12cfe90f164e9c668756e47b81d527181f66e27a07dc836f5230bb1949ca94429c59bdfe2fa7bc13c3dbac3a53ebe1feb2257080

data/CHANGELOG.md

@@ -1,13 +1,64 @@
 # Changelog
 
-## [Unreleased](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/HEAD)
+## [v7.0.13](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v7.0.13) (2021-09-27)
 
-[Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v7.1.2...HEAD)
+[Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v7.1.7...v7.0.13)
+
+## [v7.1.7](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v7.1.7) (2021-09-27)
+
+[Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v7.1.6...v7.1.7)
+
+**Implemented enhancements:**
+
+- Styles [\#642](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/642) ([mhenrixon](https://github.com/mhenrixon))
 
 **Fixed bugs:**
 
+- OnConflict::Replace: yield when lock was achieved [\#640](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/640) ([mhenrixon](https://github.com/mhenrixon))
+
+## [v7.1.6](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v7.1.6) (2021-09-21)
+
+[Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v7.1.5...v7.1.6)
+
+**Closed issues:**
+
+- until\_and\_while\_executing is not running the job at all in sidekiq-unique-jobs 7.1.4 [\#626](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/626)
+
+**Merged pull requests:**
+
+- Necessary upgrades for Sidekiq v6.2.2 [\#639](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/639) ([mhenrixon](https://github.com/mhenrixon))
+- Tese to these in README.md [\#633](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/633) ([carrickr](https://github.com/carrickr))
+
+## [v7.1.5](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v7.1.5) (2021-07-28)
+
+[Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v7.1.4...v7.1.5)
+
+**Fixed bugs:**
+
+- Fix: UntilAndWhileExecuting [\#627](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/627) ([mhenrixon](https://github.com/mhenrixon))
+
+## [v7.1.4](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v7.1.4) (2021-07-21)
+
+[Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v7.1.3...v7.1.4)
+
+**Fixed bugs:**
+
+- Pass lock timeout to primed\_async [\#624](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/624) ([millerjs](https://github.com/millerjs))
+
+## [v7.1.3](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v7.1.3) (2021-07-20)
+
+[Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v7.1.2...v7.1.3)
+
+**Fixed bugs:**
+
+- Locks are not released: seeing 'Might need to be unlocked manually" warnings [\#594](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/594)
+- Disable resurrector by default [\#623](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/623) ([mhenrixon](https://github.com/mhenrixon))
 - Documentation fixes [\#622](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/622) ([ursm](https://github.com/ursm))
 
+**Closed issues:**
+
+- Lock until\_and\_while\_executing not working as expected [\#613](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/613)
+
 **Merged pull requests:**
 
 - Improve readme [\#621](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/621) ([mhenrixon](https://github.com/mhenrixon))
@@ -90,7 +141,6 @@
 
 **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)

data/README.md

@@ -92,10 +92,11 @@ This gem adds unique constraints to sidekiq jobs. The uniqueness is achieved by
 
 By default, only one lock for a given hash can be acquired. What happens when a lock can't be acquired is governed by a chosen [Conflict Strategy](#conflict-strategy) strategy. Unless a conflict strategy is chosen
 
-This is the documentation for the master branch. You can find the documentation for each release by navigating to its tag.
+This is the documentation for the `main` branch. You can find the documentation for each release by navigating to its tag.
 
 Here are links to some of the old versions
 
+- [v7.0.12](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v7.0.12)
 - [v6.0.25](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v6.0.25)
 - [v5.0.10](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v5.0.10)
 - [v4.0.18](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v4.0.18)
@@ -268,7 +269,7 @@ end
 
 ### While Executing
 
-Tese locks are put on a queue without any type of locking mechanism, the locking doesn't happen until Sidekiq pops the job from the queue and starts processing it.
+These locks are put on a queue without any type of locking mechanism, the locking doesn't happen until Sidekiq pops the job from the queue and starts processing it.
 
 #### Example worker
 

data/lib/sidekiq_unique_jobs/config.rb

@@ -196,26 +196,65 @@ module SidekiqUniqueJobs
       )
     end
 
+    #
+    # Set the default_lock_ttl
+    # @deprecated
+    #
+    # @param [Integer] obj value to set (seconds)
+    #
+    # @return [<type>] <description>
+    #
     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
 
+    #
+    # Set new value for default_lock_timeout
+    # @deprecated
+    #
+    # @param [Integer] obj value to set (seconds)
+    #
+    # @return [Integer]
+    #
     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
 
+    #
+    # Default lock TTL (Time To Live)
+    # @deprecated
+    #
+    # @return [nil, Integer] configured value or nil
+    #
     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
 
+    #
+    # Default Lock Timeout
+    # @deprecated
+    #
+    #
+    # @return [nil, Integer] configured value or nil
+    #
     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
 
+    #
+    # Memoized variable to get the class name
+    #
+    #
+    # @return [String] name of the class
+    #
     def class_name
       @class_name ||= self.class.name
     end

data/lib/sidekiq_unique_jobs/constants.rb

@@ -6,48 +6,48 @@
 # @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"
-  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"
+  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/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
 
     #

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
   #

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

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

data/lib/sidekiq_unique_jobs/lock/until_expired.rb

@@ -17,11 +17,17 @@ 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

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,16 @@ 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
+
+          call_strategy(origin: :server, &block) unless executed
         end
       end
 

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

@@ -179,6 +179,9 @@ module SidekiqUniqueJobs
     #
     # Used to reduce some duplication from the two methods
     #
+    # @see lock
+    # @see execute
+    #
     # @param [Sidekiq::RedisConnection, ConnectionPool] conn the redis connection
     # @param [Method] primed_method reference to the method to use for getting a primed token
     #
@@ -238,7 +241,7 @@ module SidekiqUniqueJobs
     def primed_async(conn, wait = nil, &block)
       primed_jid = Concurrent::Promises
                    .future(conn) { |red_con| pop_queued(red_con, wait) }
-                   .value(add_drift(wait || config.ttl))
+                   .value(add_drift(wait || config.timeout))
 
       handle_primed(primed_jid, &block)
     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?

data/lib/sidekiq_unique_jobs/lua/lock.lua

@@ -76,6 +76,9 @@ if pttl and pttl > 0 then
 
   log_debug("PEXPIRE", locked, pttl)
   redis.call("PEXPIRE", locked, pttl)
+
+  log_debug("PEXPIRE", info, pttl)
+  redis.call("PEXPIRE", info, pttl)
 end
 
 log_debug("PEXPIRE", queued, 1000)
@@ -84,9 +87,6 @@ redis.call("PEXPIRE", queued, 1000)
 log_debug("PEXPIRE", primed, 1000)
 redis.call("PEXPIRE", primed, 1000)
 
-log_debug("PEXPIRE", info, 1000)
-redis.call("PEXPIRE", info, 1000)
-
 log("Locked")
 log_debug("END lock digest:", digest, "job_id:", job_id)
 return job_id

data/lib/sidekiq_unique_jobs/lua/unlock.lua

@@ -76,6 +76,7 @@ local del_cmd       = "DEL"
 if tonumber(redis_version["major"]) >= 4 then del_cmd =  "UNLINK"; end
 
 if lock_type ~= "until_expired" then
+
   log_debug(del_cmd, digest, info)
   redis.call(del_cmd, digest, info)
 
@@ -83,6 +84,13 @@ if lock_type ~= "until_expired" then
   redis.call("HDEL", locked, job_id)
 end
 
+local locked_count = redis.call("HLEN", locked)
+
+if tonumber(locked_count) < 1 then
+  log_debug(del_cmd, locked)
+  redis.call(del_cmd, locked)
+end
+
 log_debug("LPUSH", queued, "1")
 redis.call("LPUSH", queued, "1")
 

data/lib/sidekiq_unique_jobs/middleware/client.rb

@@ -30,7 +30,7 @@ module SidekiqUniqueJobs
       private
 
       def lock
-        lock_instance.lock do |_locked_jid|
+        lock_instance.lock do
           reflect(:locked, item)
           return yield
         end

data/lib/sidekiq_unique_jobs/options_with_fallback.rb

@@ -46,10 +46,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/manager.rb

@@ -10,10 +10,18 @@ module SidekiqUniqueJobs
     module Manager
       module_function
 
+      #
+      # @return [Float] the amount to add to the reaper interval
       DRIFT_FACTOR = 0.02
+      #
+      # @return [Symbol] allowed reapers (:ruby or :lua)
       REAPERS      = [:ruby, :lua].freeze
 
+      # includes "SidekiqUniqueJobs::Connection"
+      # @!parse include SidekiqUniqueJobs::Connection
       include SidekiqUniqueJobs::Connection
+      # includes "SidekiqUniqueJobs::Logging"
+      # @!parse include SidekiqUniqueJobs::Logging
       include SidekiqUniqueJobs::Logging
 
       #
@@ -65,6 +73,12 @@ module SidekiqUniqueJobs
         @task ||= default_task
       end
 
+      #
+      # A properly configured timer task
+      #
+      #
+      # @return [SidekiqUniqueJobs::TimerTask]
+      #
       def default_task
         SidekiqUniqueJobs::TimerTask.new(timer_task_options) do
           with_logging_context do
@@ -76,6 +90,13 @@ module SidekiqUniqueJobs
         end
       end
 
+      #
+      # Store a task to use for scheduled execution
+      #
+      # @param [SidekiqUniqueJobs::TimerTask] task the task to use
+      #
+      # @return [void]
+      #
       def task=(task)
         @task = task
       end
@@ -201,10 +222,24 @@ module SidekiqUniqueJobs
         redis { |conn| conn.del(UNIQUE_REAPER) }
       end
 
+      #
+      # Reaper interval with a little drift
+      #   Redis isn't exact enough so to give a little bufffer,
+      #   we add a tiny value to the reaper interval.
+      #
+      #
+      # @return [Integer] <description>
+      #
       def drift_reaper_interval
         reaper_interval + (reaper_interval * DRIFT_FACTOR).to_i
       end
 
+      #
+      # Current time (as integer value)
+      #
+      #
+      # @return [Integer]
+      #
       def current_timestamp
         Time.now.to_i
       end

data/lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb

@@ -10,6 +10,8 @@ module SidekiqUniqueJobs
     # @author Mikael Henriksson <mikael@mhenrixon.com>
     #
     class RubyReaper < Reaper
+      #
+      # @return [String] the suffix for :RUN locks
       RUN_SUFFIX = ":RUN"
       #
       # @!attribute [r] digests
@@ -182,7 +184,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/reflectable.rb

@@ -7,11 +7,20 @@ module SidekiqUniqueJobs
   # @author Mikael Henriksson <mikael@mhenrixon.com>
   #
   module Reflectable
-    def reflect(name, *args)
-      SidekiqUniqueJobs.reflections.dispatch(name, *args)
+    #
+    # Reflects on specific event
+    #
+    # @param [Symbol] reflection the reflected event
+    # @param [Array] args arguments to provide to reflector
+    #
+    # @return [void]
+    #
+    def reflect(reflection, *args)
+      SidekiqUniqueJobs.reflections.dispatch(reflection, *args)
       nil
     rescue UniqueJobsError => ex
       SidekiqUniqueJobs.logger.error(ex)
+      nil
     end
   end
 end

data/lib/sidekiq_unique_jobs/reflections.rb

@@ -42,6 +42,14 @@ module SidekiqUniqueJobs
       @reflections = {}
     end
 
+    #
+    # Dispatch a reflected event
+    #
+    # @param [reflection] reflection the reflected event
+    # @param [Array] args the arguments to provide to the block
+    #
+    # @return [void] <description>
+    #
     def dispatch(reflection, *args)
       if (block = @reflections[reflection])
         block.call(*args)
@@ -49,12 +57,15 @@ module SidekiqUniqueJobs
         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)
         raise NoSuchNotificationError, reflection
       end
+
+      nil
     end
 
     def configured?(reflection)

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)
@@ -25,6 +25,12 @@ module SidekiqUniqueJobs
       config.death_handlers << death_handler
     end
 
+    #
+    # Start the sidekiq unique jobs server process
+    #
+    #
+    # @return [void]
+    #
     def self.start
       SidekiqUniqueJobs::UpdateVersion.call
       SidekiqUniqueJobs::UpgradeLocks.call
@@ -32,6 +38,12 @@ module SidekiqUniqueJobs
       SidekiqUniqueJobs::Orphans::ReaperResurrector.start
     end
 
+    #
+    # Stop the sidekiq unique jobs server process
+    #
+    #
+    # @return [void]
+    #
     def self.stop
       SidekiqUniqueJobs::Orphans::Manager.stop
     end

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/timing.rb

@@ -51,7 +51,7 @@ module SidekiqUniqueJobs
       if Process.const_defined?("CLOCK_MONOTONIC")
         Process.clock_gettime(Process::CLOCK_MONOTONIC)
       else
-        Time.now.to_f
+        now_f
       end
     end
   end

data/lib/sidekiq_unique_jobs/version.rb

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

data/lib/tasks/changelog.rake

@@ -1,22 +1,22 @@
 # 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("git checkout main")
   sh(*CHANGELOG_CMD.push(ENV["CHANGELOG_GITHUB_TOKEN"]))
   sh(ADD_CHANGELOG_CMD)
   sh(COMMIT_CHANGELOG_CMD)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-unique-jobs
 version: !ruby/object:Gem::Version
-  version: 7.1.3
+  version: 7.1.8
 platform: ruby
 authors:
 - Mikael Henriksson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-20 00:00:00.000000000 Z
+date: 2021-10-08 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.
@@ -223,7 +223,7 @@ metadata:
 post_install_message: |
   IMPORTANT!
 
-  Automatic configuration of the sidekiq middelware is no longer done.
+  Automatic configuration of the sidekiq middleware is no longer done.
   Please see: https://github.com/mhenrixon/sidekiq-unique-jobs/blob/master/README.md#add-the-middleware
 
   This version deprecated the following sidekiq_options
@@ -254,14 +254,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.0.3.1
+rubygems_version: 3.2.28
 signing_key:
 specification_version: 4
 summary: Sidekiq middleware that prevents duplicates jobs