sidekiq-unique-jobs 6.0.8 → 6.0.9

data/examples/my_unique_job_with_filter_proc.rb

@@ -10,7 +10,7 @@ class MyUniqueJobWithFilterProc
                   retry: true,
                   unique_args: (lambda do |args|
                     options = args.extract_options!
-                    [args.first, options['type']]
+                    [args.first, options["type"]]
                   end)
 
   def perform(*)

data/examples/unique_job_with_filter_method.rb

@@ -16,6 +16,6 @@ class UniqueJobWithFilterMethod
 
   def self.filtered_args(args)
     options = args.extract_options!
-    [args.first, options['type']]
+    [args.first, options["type"]]
   end
 end

data/lib/sidekiq-unique-jobs.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-require 'sidekiq_unique_jobs'
+require "sidekiq_unique_jobs"

data/lib/sidekiq_unique_jobs.rb

@@ -1,109 +1,34 @@
 # frozen_string_literal: true
 
-require 'yaml' if RUBY_VERSION.include?('2.0.0')
-require 'forwardable'
-require 'concurrent/mutable_struct'
-require 'ostruct'
-
-require 'sidekiq_unique_jobs/version'
-require 'sidekiq_unique_jobs/constants'
-require 'sidekiq_unique_jobs/logging'
-require 'sidekiq_unique_jobs/sidekiq_worker_methods'
-require 'sidekiq_unique_jobs/connection'
-require 'sidekiq_unique_jobs/exceptions'
-require 'sidekiq_unique_jobs/job'
-require 'sidekiq_unique_jobs/util'
-require 'sidekiq_unique_jobs/digests'
-require 'sidekiq_unique_jobs/cli'
-require 'sidekiq_unique_jobs/core_ext'
-require 'sidekiq_unique_jobs/timeout'
-require 'sidekiq_unique_jobs/scripts'
-require 'sidekiq_unique_jobs/unique_args'
-require 'sidekiq_unique_jobs/unlockable'
-require 'sidekiq_unique_jobs/locksmith'
-require 'sidekiq_unique_jobs/lock/base_lock'
-require 'sidekiq_unique_jobs/lock/until_executed'
-require 'sidekiq_unique_jobs/lock/until_executing'
-require 'sidekiq_unique_jobs/lock/until_expired'
-require 'sidekiq_unique_jobs/lock/while_executing'
-require 'sidekiq_unique_jobs/lock/while_executing_reject'
-require 'sidekiq_unique_jobs/lock/until_and_while_executing'
-require 'sidekiq_unique_jobs/options_with_fallback'
-require 'sidekiq_unique_jobs/middleware'
-require 'sidekiq_unique_jobs/sidekiq_unique_ext'
-require 'sidekiq_unique_jobs/on_conflict'
-
-# Namespace for this gem
-#
-# Contains configuration and utility methods that belongs top level
-#
-# @author Mikael Henriksson <mikael@zoolutions.se>
-module SidekiqUniqueJobs
-  include SidekiqUniqueJobs::Connection
-
-  module_function
-
-  Config = Concurrent::MutableStruct.new(
-    :default_lock_timeout,
-    :enabled,
-    :unique_prefix,
-    :logger,
-  )
-
-  # The current configuration (See: {.configure} on how to configure)
-  def config
-    # Arguments here need to match the definition of the new class (see above)
-    @config ||= Config.new(
-      0,
-      true,
-      'uniquejobs',
-      Sidekiq.logger,
-    )
-  end
-
-  # The current logger
-  # @return [Logger] the configured logger
-  def logger
-    config.logger
-  end
-
-  # Set a new logger
-  # @param [Logger] other a new logger
-  def logger=(other)
-    config.logger = other
-  end
-
-  # Change global configuration while yielding
-  # @yield control to the caller
-  def use_config(tmp_config)
-    fail ::ArgumentError, "#{name}.#{__method__} needs a block" unless block_given?
-
-    old_config = config.to_h
-    configure(tmp_config)
-    yield
-    configure(old_config)
-  end
-
-  # Configure the gem
-  #
-  # This is usually called once at startup of an application
-  # @param [Hash] options global gem options
-  # @option options [Integer] :default_lock_timeout (default is 0)
-  # @option options [true,false] :enabled (default is true)
-  # @option options [String] :unique_prefix (default is 'uniquejobs')
-  # @option options [Logger] :logger (default is Sidekiq.logger)
-  # @yield control to the caller when given block
-  def configure(options = {})
-    if block_given?
-      yield config
-    else
-      options.each do |key, val|
-        config.send("#{key}=", val)
-      end
-    end
-  end
-
-  def redis_version
-    @redis_version ||= redis { |conn| conn.info('server')['redis_version'] }
-  end
-end
+require "forwardable"
+require "concurrent/mutable_struct"
+
+require "sidekiq_unique_jobs/version"
+require "sidekiq_unique_jobs/constants"
+require "sidekiq_unique_jobs/logging"
+require "sidekiq_unique_jobs/sidekiq_worker_methods"
+require "sidekiq_unique_jobs/connection"
+require "sidekiq_unique_jobs/exceptions"
+require "sidekiq_unique_jobs/job"
+require "sidekiq_unique_jobs/util"
+require "sidekiq_unique_jobs/digests"
+require "sidekiq_unique_jobs/cli"
+require "sidekiq_unique_jobs/core_ext"
+require "sidekiq_unique_jobs/timeout"
+require "sidekiq_unique_jobs/scripts"
+require "sidekiq_unique_jobs/unique_args"
+require "sidekiq_unique_jobs/unlockable"
+require "sidekiq_unique_jobs/locksmith"
+require "sidekiq_unique_jobs/lock/base_lock"
+require "sidekiq_unique_jobs/lock/until_executed"
+require "sidekiq_unique_jobs/lock/until_executing"
+require "sidekiq_unique_jobs/lock/until_expired"
+require "sidekiq_unique_jobs/lock/while_executing"
+require "sidekiq_unique_jobs/lock/while_executing_reject"
+require "sidekiq_unique_jobs/lock/until_and_while_executing"
+require "sidekiq_unique_jobs/options_with_fallback"
+require "sidekiq_unique_jobs/middleware"
+require "sidekiq_unique_jobs/sidekiq_unique_ext"
+require "sidekiq_unique_jobs/on_conflict"
+
+require "sidekiq_unique_jobs/sidekiq_unique_jobs"

data/lib/sidekiq_unique_jobs/cli.rb

@@ -1,24 +1,29 @@
 # frozen_string_literal: true
 
-require 'thor'
+require "thor"
 
 module SidekiqUniqueJobs
+  #
+  # Command line interface for unique jobs
+  #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
+  #
   class Cli < Thor
     def self.banner(command, _namespace = nil, _subcommand = false)
       "jobs #{@package_name} #{command.usage}"
     end
 
-    desc 'keys PATTERN', 'list all unique keys and their expiry time'
-    option :count, aliases: :c, type: :numeric, default: 1000, desc: 'The max number of keys to return'
-    def keys(pattern = '*')
+    desc "keys PATTERN", "list all unique keys and their expiry time"
+    option :count, aliases: :c, type: :numeric, default: 1000, desc: "The max number of keys to return"
+    def keys(pattern = "*")
       keys = Util.keys(pattern, options[:count])
       say "Found #{keys.size} keys matching '#{pattern}':"
       print_in_columns(keys.sort) if keys.any?
     end
 
-    desc 'del PATTERN', 'deletes unique keys from redis by pattern'
-    option :dry_run, aliases: :d, type: :boolean, desc: 'set to false to perform deletion'
-    option :count, aliases: :c, type: :numeric, default: 1000, desc: 'The max number of keys to return'
+    desc "del PATTERN", "deletes unique keys from redis by pattern"
+    option :dry_run, aliases: :d, type: :boolean, desc: "set to false to perform deletion"
+    option :count, aliases: :c, type: :numeric, default: 1000, desc: "The max number of keys to return"
     def del(pattern)
       max_count = options[:count]
       if options[:dry_run]
@@ -30,7 +35,7 @@ module SidekiqUniqueJobs
       end
     end
 
-    desc 'console', 'drop into a console with easy access to helper methods'
+    desc "console", "drop into a console with easy access to helper methods"
     def console
       say "Use `keys '*', 1000 to display the first 1000 unique keys matching '*'"
       say "Use `del '*', 1000, true (default) to see how many keys would be deleted for the pattern '*'"
@@ -41,10 +46,10 @@ module SidekiqUniqueJobs
 
     no_commands do
       def console_class
-        require 'pry'
+        require "pry"
         Pry
       rescue LoadError
-        require 'irb'
+        require "irb"
         IRB
       end
     end

data/lib/sidekiq_unique_jobs/client/middleware.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'sidekiq_unique_jobs/server/middleware'
+require "sidekiq_unique_jobs/server/middleware"
 
 module SidekiqUniqueJobs
   module Client

data/lib/sidekiq_unique_jobs/constants.rb

@@ -1,24 +1,29 @@
 # frozen_string_literal: true
 
+#
+# Module with constants to avoid string duplication
+#
+# @author Mikael Henriksson <mikael@zoolutions.se>
+#
 module SidekiqUniqueJobs
-  ARGS_KEY                  ||= 'args'
-  AT_KEY                    ||= 'at'
-  CLASS_KEY                 ||= 'class'
-  JID_KEY                   ||= 'jid'
-  LOCK_EXPIRATION_KEY       ||= 'lock_expiration'
-  LOCK_TIMEOUT_KEY          ||= 'lock_timeout'
-  LOG_DUPLICATE_KEY         ||= 'log_duplicate_payload'
-  QUEUE_KEY                 ||= 'queue'
-  UNIQUE_ACROSS_QUEUES_KEY  ||= 'unique_across_queues'
-  UNIQUE_ACROSS_WORKERS_KEY ||= 'unique_across_workers'
-  UNIQUE_ARGS_KEY           ||= 'unique_args'
-  UNIQUE_DIGEST_KEY         ||= 'unique_digest'
-  UNIQUE_KEY                ||= 'unique'
-  UNIQUE_SET                ||= 'unique:keys'
-  LOCK_KEY                  ||= 'lock'
-  ON_CONFLICT_KEY           ||= 'on_conflict'
-  UNIQUE_ON_ALL_QUEUES_KEY  ||= 'unique_on_all_queues' # TODO: Remove in v6.1
-  UNIQUE_PREFIX_KEY         ||= 'unique_prefix'
-  RETRY_SET                 ||= 'retry'
-  SCHEDULE_SET              ||= 'schedule'
+  ARGS_KEY                  ||= "args"
+  AT_KEY                    ||= "at"
+  CLASS_KEY                 ||= "class"
+  JID_KEY                   ||= "jid"
+  LOCK_EXPIRATION_KEY       ||= "lock_expiration"
+  LOCK_TIMEOUT_KEY          ||= "lock_timeout"
+  LOG_DUPLICATE_KEY         ||= "log_duplicate_payload"
+  QUEUE_KEY                 ||= "queue"
+  UNIQUE_ACROSS_QUEUES_KEY  ||= "unique_across_queues"
+  UNIQUE_ACROSS_WORKERS_KEY ||= "unique_across_workers"
+  UNIQUE_ARGS_KEY           ||= "unique_args"
+  UNIQUE_DIGEST_KEY         ||= "unique_digest"
+  UNIQUE_KEY                ||= "unique"
+  UNIQUE_SET                ||= "unique:keys"
+  LOCK_KEY                  ||= "lock"
+  ON_CONFLICT_KEY           ||= "on_conflict"
+  UNIQUE_ON_ALL_QUEUES_KEY  ||= "unique_on_all_queues" # TODO: Remove in v6.1
+  UNIQUE_PREFIX_KEY         ||= "unique_prefix"
+  RETRY_SET                 ||= "retry"
+  SCHEDULE_SET              ||= "schedule"
 end

data/lib/sidekiq_unique_jobs/digests.rb

@@ -6,7 +6,7 @@ module SidekiqUniqueJobs
   # @author Mikael Henriksson <mikael@zoolutions.se>
   module Digests
     DEFAULT_COUNT = 1_000
-    SCAN_PATTERN  = '*'
+    SCAN_PATTERN  = "*"
     CHUNK_SIZE    = 100
 
     include SidekiqUniqueJobs::Logging
@@ -25,8 +25,9 @@ module SidekiqUniqueJobs
     # Paginate unique digests
     #
     # @param [String] pattern a pattern to match with
-    # @param [Integer] page the current cursor position
-    # @param [Integer] count the maximum number to match
+    # @param [Integer] cursor the maximum number to match
+    # @param [Integer] page_size the current cursor position
+    #
     # @return [Array<String>] with unique digests
     def page(pattern: SCAN_PATTERN, cursor: 0, page_size: 100)
       redis do |conn|
@@ -57,7 +58,7 @@ module SidekiqUniqueJobs
       return delete_by_pattern(pattern, count: count) if pattern
       return delete_by_digest(digest) if digest
 
-      raise ArgumentError, 'either digest or pattern need to be provided'
+      raise ArgumentError, "either digest or pattern need to be provided"
     end
 
     private

data/lib/sidekiq_unique_jobs/lock/base_lock.rb

@@ -108,14 +108,14 @@ module SidekiqUniqueJobs
       def with_cleanup
         yield
       rescue Sidekiq::Shutdown
-        log_info('Sidekiq is shutting down, the job `should` be put back on the queue. Keeping the lock!')
+        log_info("Sidekiq is shutting down, the job `should` be put back on the queue. Keeping the lock!")
         raise
       else
         unlock_with_callback
       end
 
       def unlock_with_callback
-        return log_warn('might need to be unlocked manually') unless unlock
+        return log_warn("might need to be unlocked manually") unless unlock
 
         callback_safely
         item[JID_KEY]
@@ -124,7 +124,7 @@ module SidekiqUniqueJobs
       def callback_safely
         callback&.call
       rescue StandardError
-        log_warn('unlocked successfully but the #after_unlock callback failed!')
+        log_warn("unlocked successfully but the #after_unlock callback failed!")
         raise
       end
 

data/lib/sidekiq_unique_jobs/lock/until_executed.rb

@@ -8,7 +8,7 @@ module SidekiqUniqueJobs
     #
     # @author Mikael Henriksson <mikael@zoolutions.se>
     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@zoolutions.se>
     class WhileExecuting < BaseLock
-      RUN_SUFFIX ||= ':RUN'
+      RUN_SUFFIX ||= ":RUN"
 
       # @param [Hash] item the Sidekiq job hash
       # @param [Proc] callback callback to call after unlock

data/lib/sidekiq_unique_jobs/locksmith.rb

@@ -133,19 +133,19 @@ module SidekiqUniqueJobs
     end
 
     def available_key
-      @available_key ||= namespaced_key('AVAILABLE')
+      @available_key ||= namespaced_key("AVAILABLE")
     end
 
     def exists_key
-      @exists_key ||= namespaced_key('EXISTS')
+      @exists_key ||= namespaced_key("EXISTS")
     end
 
     def grabbed_key
-      @grabbed_key ||= namespaced_key('GRABBED')
+      @grabbed_key ||= namespaced_key("GRABBED")
     end
 
     def version_key
-      @version_key ||= namespaced_key('VERSION')
+      @version_key ||= namespaced_key("VERSION")
     end
 
     def namespaced_key(variable)

data/lib/sidekiq_unique_jobs/logging.rb

@@ -51,7 +51,7 @@ module SidekiqUniqueJobs
     end
 
     def logging_context(middleware_class, job_hash)
-      digest = job_hash['unique_digest']
+      digest = job_hash["unique_digest"]
       "#{middleware_class} #{"DIG-#{digest}" if digest}"
     end
   end

data/lib/sidekiq_unique_jobs/middleware.rb

@@ -1,8 +1,13 @@
 # frozen_string_literal: true
 
-require 'sidekiq'
+require "sidekiq"
 
 module SidekiqUniqueJobs
+  #
+  # Provides the sidekiq middleware that makes the gem work
+  #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
+  #
   module Middleware
     def self.extended(base)
       base.class_eval do
@@ -18,12 +23,12 @@ module SidekiqUniqueJobs
     def configure_server_middleware
       Sidekiq.configure_server do |config|
         config.client_middleware do |chain|
-          require 'sidekiq_unique_jobs/client/middleware'
+          require "sidekiq_unique_jobs/client/middleware"
           chain.add SidekiqUniqueJobs::Client::Middleware
         end
 
         config.server_middleware do |chain|
-          require 'sidekiq_unique_jobs/server/middleware'
+          require "sidekiq_unique_jobs/server/middleware"
           chain.add SidekiqUniqueJobs::Server::Middleware
         end
       end
@@ -32,7 +37,7 @@ module SidekiqUniqueJobs
     def configure_client_middleware
       Sidekiq.configure_client do |config|
         config.client_middleware do |chain|
-          require 'sidekiq_unique_jobs/client/middleware'
+          require "sidekiq_unique_jobs/client/middleware"
           chain.add SidekiqUniqueJobs::Client::Middleware
         end
       end

data/lib/sidekiq_unique_jobs/normalizer.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'json'
+require "json"
 
 module SidekiqUniqueJobs
   # Normalizes hashes by dumping them to json and loading them from json

data/lib/sidekiq_unique_jobs/on_conflict.rb

@@ -1,14 +1,19 @@
 # frozen_string_literal: true
 
-require_relative 'on_conflict/strategy'
-require_relative 'on_conflict/null_strategy'
-require_relative 'on_conflict/log'
-require_relative 'on_conflict/raise'
-require_relative 'on_conflict/reject'
-require_relative 'on_conflict/replace'
-require_relative 'on_conflict/reschedule'
+require_relative "on_conflict/strategy"
+require_relative "on_conflict/null_strategy"
+require_relative "on_conflict/log"
+require_relative "on_conflict/raise"
+require_relative "on_conflict/reject"
+require_relative "on_conflict/replace"
+require_relative "on_conflict/reschedule"
 
 module SidekiqUniqueJobs
+  #
+  # Provides lock conflict resolutions
+  #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
+  #
   module OnConflict
     STRATEGIES = {
       log: OnConflict::Log,