sidekiq-unique-jobs 7.0.0.beta25 → 7.0.0

data/lib/sidekiq-unique-jobs.rb

@@ -1,5 +1,3 @@
 # frozen_string_literal: true
 
 require "sidekiq_unique_jobs"
-
-SidekiqUniqueJobs::Middleware.configure

data/lib/sidekiq_unique_jobs/batch_delete.rb

@@ -4,7 +4,7 @@ module SidekiqUniqueJobs
   #
   # Class BatchDelete provides batch deletion of digests
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   #
   class BatchDelete
     #

data/lib/sidekiq_unique_jobs/changelog.rb

@@ -4,7 +4,7 @@ module SidekiqUniqueJobs
   #
   # Class Changelogs provides access to the changelog entries
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   #
   class Changelog < Redis::SortedSet
     def initialize
@@ -36,7 +36,7 @@ module SidekiqUniqueJobs
     #
     def entries(pattern: "*", count: nil)
       options = {}
-      options[:match] = pattern if pattern
+      options[:match] = pattern
       options[:count] = count if count
 
       redis do |conn|

data/lib/sidekiq_unique_jobs/cli.rb

@@ -6,7 +6,7 @@ module SidekiqUniqueJobs
   #
   # Command line interface for unique jobs
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   #
   class Cli < Thor
     # :nodoc:

data/lib/sidekiq_unique_jobs/config.rb

@@ -6,7 +6,7 @@ module SidekiqUniqueJobs
                                                    :lock_timeout,
                                                    :lock_ttl,
                                                    :enabled,
-                                                   :unique_prefix,
+                                                   :lock_prefix,
                                                    :logger,
                                                    :locks,
                                                    :strategies,
@@ -127,7 +127,7 @@ module SidekiqUniqueJobs
     #   default_lock_timeout: 0,
     #   default_lock_ttl: nil,
     #   enabled: true,
-    #   unique_prefix: "uniquejobs",
+    #   lock_prefix: "uniquejobs",
     #   logger: #<Sidekiq::Logger:0x00007f81e096b0e0 @level=1 ...>,
     #   locks: {
     #     around_perform: SidekiqUniqueJobs::Lock::WhileExecuting,

data/lib/sidekiq_unique_jobs/connection.rb

@@ -3,7 +3,7 @@
 module SidekiqUniqueJobs
   # Shared module for dealing with redis connections
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   module Connection
     def self.included(base)
       base.send(:extend, self)

data/lib/sidekiq_unique_jobs/constants.rb

@@ -3,7 +3,7 @@
 #
 # Module with constants to avoid string duplication
 #
-# @author Mikael Henriksson <mikael@zoolutions.se>
+# @author Mikael Henriksson <mikael@mhenrixon.com>
 #
 module SidekiqUniqueJobs
   ARGS                  ||= "args"
@@ -11,6 +11,7 @@ module SidekiqUniqueJobs
   AT                    ||= "at"
   CHANGELOGS            ||= "uniquejobs:changelog"
   CLASS                 ||= "class"
+  CREATED_AT            ||= "created_at"
   DEAD_VERSION          ||= "uniquejobs:dead"
   DIGESTS               ||= "uniquejobs:digests"
   ERRORS                ||= "errors"
@@ -19,6 +20,7 @@ module SidekiqUniqueJobs
   LIVE_VERSION          ||= "uniquejobs:live"
   LOCK                  ||= "lock"
   LOCK_ARGS             ||= "lock_args"
+  LOCK_ARGS_METHOD      ||= "lock_args_method"
   LOCK_DIGEST           ||= "lock_digest"
   LOCK_EXPIRATION       ||= "lock_expiration"
   LOCK_INFO             ||= "lock_info"
@@ -31,6 +33,7 @@ module SidekiqUniqueJobs
   ON_CLIENT_CONFLICT    ||= "on_client_conflict"
   ON_CONFLICT           ||= "on_conflict"
   ON_SERVER_CONFLICT    ||= "on_server_conflict"
+  PAYLOAD               ||= "payload"
   PROCESSES             ||= "processes"
   QUEUE                 ||= "queue"
   RETRY                 ||= "retry"
@@ -43,6 +46,7 @@ module SidekiqUniqueJobs
   UNIQUE_ACROSS_QUEUES  ||= "unique_across_queues"
   UNIQUE_ACROSS_WORKERS ||= "unique_across_workers"
   UNIQUE_ARGS           ||= "unique_args"
+  UNIQUE_ARGS_METHOD    ||= "unique_args_method"
   UNIQUE_DIGEST         ||= "unique_digest"
   UNIQUE_PREFIX         ||= "unique_prefix"
   UNIQUE_REAPER         ||= "uniquejobs:reaper"

data/lib/sidekiq_unique_jobs/digests.rb

@@ -4,7 +4,7 @@ module SidekiqUniqueJobs
   #
   # Class Changelogs provides access to the changelog entries
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   #
   class Digests < Redis::SortedSet
     #
@@ -78,7 +78,7 @@ module SidekiqUniqueJobs
     def entries(pattern: SCAN_PATTERN, count: DEFAULT_COUNT)
       options = {}
       options[:match] = pattern
-      options[:count] = count if count
+      options[:count] = count
 
       result = redis { |conn| conn.zscan_each(key, **options).to_a }
 

data/lib/sidekiq_unique_jobs/exceptions.rb

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

data/lib/sidekiq_unique_jobs/job.rb

@@ -3,7 +3,7 @@
 module SidekiqUniqueJobs
   # Utility class to append uniqueness to the sidekiq job hash
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   module Job
     extend self
 
@@ -52,7 +52,7 @@ module SidekiqUniqueJobs
     end
 
     def add_lock_prefix(item)
-      item[LOCK_PREFIX] ||= SidekiqUniqueJobs.config.unique_prefix
+      item[LOCK_PREFIX] ||= SidekiqUniqueJobs.config.lock_prefix
     end
   end
 end

data/lib/sidekiq_unique_jobs/json.rb

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

data/lib/sidekiq_unique_jobs/key.rb

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

data/lib/sidekiq_unique_jobs/lock.rb

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

data/lib/sidekiq_unique_jobs/lock/base_lock.rb

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

data/lib/sidekiq_unique_jobs/lock/client_validator.rb

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

data/lib/sidekiq_unique_jobs/lock/server_validator.rb

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

data/lib/sidekiq_unique_jobs/lock/until_and_while_executing.rb

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

data/lib/sidekiq_unique_jobs/lock/until_executed.rb

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

data/lib/sidekiq_unique_jobs/lock/until_executing.rb

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

data/lib/sidekiq_unique_jobs/lock/until_expired.rb

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

data/lib/sidekiq_unique_jobs/lock/validator.rb

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

data/lib/sidekiq_unique_jobs/lock/while_executing.rb

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

data/lib/sidekiq_unique_jobs/lock/while_executing_reject.rb

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

data/lib/sidekiq_unique_jobs/lock_args.rb

@@ -3,7 +3,7 @@
 module SidekiqUniqueJobs
   # Handles uniqueness of sidekiq arguments
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   class LockArgs
     include SidekiqUniqueJobs::Logging
     include SidekiqUniqueJobs::SidekiqWorkerMethods
@@ -97,8 +97,8 @@ module SidekiqUniqueJobs
     end
 
     # The method to use for filtering unique arguments
-    def lock_args_method # rubocop:disable Metrics/CyclomaticComplexity
-      @lock_args_method ||= worker_options[LOCK_ARGS] || worker_options[UNIQUE_ARGS]
+    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 ||= default_lock_args_method
@@ -106,8 +106,8 @@ module SidekiqUniqueJobs
 
     # The global worker options defined in Sidekiq directly
     def default_lock_args_method
-      default_worker_options[LOCK_ARGS] ||
-        default_worker_options[UNIQUE_ARGS]
+      default_worker_options[LOCK_ARGS_METHOD] ||
+        default_worker_options[UNIQUE_ARGS_METHOD]
     end
 
     #

data/lib/sidekiq_unique_jobs/lock_config.rb

@@ -5,7 +5,7 @@ module SidekiqUniqueJobs
   # Gathers all configuration for a lock
   #   which helps reduce the amount of instance variables
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   #
   class LockConfig
     #
@@ -98,6 +98,8 @@ module SidekiqUniqueJobs
     # @return [String]
     #
     def errors_as_string
+      return if valid?
+
       @errors_as_string ||= begin
         error_msg = +"\t"
         error_msg << errors.map { |key, val| "#{key}: :#{val}" }.join("\n\t")

data/lib/sidekiq_unique_jobs/lock_digest.rb

@@ -5,7 +5,7 @@ require "openssl"
 module SidekiqUniqueJobs
   # Handles uniqueness of sidekiq arguments
   #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
   class LockDigest
     include SidekiqUniqueJobs::Logging
     include SidekiqUniqueJobs::JSON

data/lib/sidekiq_unique_jobs/lock_info.rb

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

data/lib/sidekiq_unique_jobs/lock_timeout.rb

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