sidekiq-unique-jobs 6.0.24 → 7.0.4

data/lib/sidekiq_unique_jobs/lock/while_executing.rb

@@ -9,10 +9,13 @@ 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"
 
+      include SidekiqUniqueJobs::OptionsWithFallback
+      include SidekiqUniqueJobs::Logging::Middleware
+
       # @param [Hash] item the Sidekiq job hash
       # @param [Proc] callback callback to call after unlock
       # @param [Sidekiq::RedisConnection, ConnectionPool] redis_pool the redis connection
@@ -33,13 +36,14 @@ module SidekiqUniqueJobs
       #   These jobs are locked in the server process not from the client
       # @yield to the worker class perform method
       def execute
-        return strategy&.call unless locksmith.lock(item[LOCK_TIMEOUT_KEY])
-
-        yield
-        unlock_with_callback
-      rescue Exception # rubocop:disable Lint/RescueException
-        delete!
-        raise
+        with_logging_context do
+          server_strategy&.call unless locksmith.lock do
+            yield
+            callback_safely
+          end
+        end
+      ensure
+        locksmith.unlock!
       end
 
       private
@@ -47,7 +51,7 @@ module SidekiqUniqueJobs
       # This is safe as the base_lock always creates a new digest
       #   The append there for needs to be done every time
       def append_unique_key_suffix
-        item[UNIQUE_DIGEST_KEY] = item[UNIQUE_DIGEST_KEY] + RUN_SUFFIX
+        item[LOCK_DIGEST] = item[LOCK_DIGEST] + RUN_SUFFIX
       end
     end
   end

data/lib/sidekiq_unique_jobs/lock/while_executing_reject.rb

@@ -9,12 +9,12 @@ 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
-      def strategy
-        @strategy ||= OnConflict.find_strategy(:reject).new(item)
+      def server_strategy
+        @server_strategy ||= OnConflict.find_strategy(:reject).new(item, redis_pool)
       end
     end
   end

data/lib/sidekiq_unique_jobs/lock_args.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module SidekiqUniqueJobs
+  # Handles uniqueness of sidekiq arguments
+  #
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
+  class LockArgs
+    include SidekiqUniqueJobs::Logging
+    include SidekiqUniqueJobs::SidekiqWorkerMethods
+    include SidekiqUniqueJobs::JSON
+
+    # Convenience method for returning a digest
+    # @param [Hash] item a Sidekiq job hash
+    # @return [String] a unique digest
+    def self.call(item)
+      new(item).lock_args
+    end
+
+    # The sidekiq job hash
+    # @return [Hash] the Sidekiq job hash
+    attr_reader :item
+    #
+    # @!attribute [r] args
+    #   @return [Array<Objet>] the arguments passed to `perform_async`
+    attr_reader :args
+
+    # @param [Hash] item a Sidekiq job hash
+    def initialize(item)
+      @item         = item
+      @worker_class = item[CLASS]
+      @args         = item[ARGS]
+    end
+
+    # The unique arguments to use for creating a lock
+    # @return [Array] the arguments filters by the {#filtered_args} method if {#lock_args_enabled?}
+    def lock_args
+      @lock_args ||= filtered_args
+    end
+
+    # Checks if the worker class has enabled lock_args
+    # @return [true, false]
+    def lock_args_enabled?
+      # return false unless lock_args_method_valid?
+
+      lock_args_method
+    end
+
+    # Validate that the lock_args_method is acceptable
+    # @return [true, false]
+    def lock_args_method_valid?
+      [NilClass, TrueClass, FalseClass].none? { |klass| lock_args_method.is_a?(klass) }
+    end
+
+    # Checks if the worker class has disabled lock_args
+    # @return [true, false]
+    def lock_args_disabled?
+      !lock_args_method
+    end
+
+    # Filters unique arguments by proc or symbol
+    # @return [Array] {#filter_by_proc} when {#lock_args_method} is a Proc
+    # @return [Array] {#filter_by_symbol} when {#lock_args_method} is a Symbol
+    # @return [Array] args unfiltered when neither of the above
+    def filtered_args
+      return args if lock_args_disabled?
+
+      json_args = Normalizer.jsonify(args)
+
+      case lock_args_method
+      when Proc
+        filter_by_proc(json_args)
+      when Symbol
+        filter_by_symbol(json_args)
+      end
+    end
+
+    # Filters unique arguments by proc configured in the sidekiq worker
+    # @param [Array] args the arguments passed to the sidekiq worker
+    # @return [Array] with the filtered arguments
+    def filter_by_proc(args)
+      lock_args_method.call(args)
+    end
+
+    # Filters unique arguments by method configured in the sidekiq worker
+    # @param [Array] args the arguments passed to the sidekiq worker
+    # @return [Array] unfiltered unless {#worker_method_defined?}
+    # @return [Array] with the filtered arguments
+    def filter_by_symbol(args)
+      return args unless worker_method_defined?(lock_args_method)
+
+      worker_class.send(lock_args_method, args)
+    rescue ArgumentError
+      raise SidekiqUniqueJobs::InvalidUniqueArguments,
+            given: args,
+            worker_class: worker_class,
+            lock_args_method: lock_args_method
+    end
+
+    # The method to use for filtering unique arguments
+    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
+    end
+
+    # The global worker options defined in Sidekiq directly
+    def default_lock_args_method
+      default_worker_options[LOCK_ARGS_METHOD] ||
+        default_worker_options[UNIQUE_ARGS_METHOD]
+    end
+
+    #
+    # The globally default worker options configured from Sidekiq
+    #
+    #
+    # @return [Hash<String, Object>]
+    #
+    def default_worker_options
+      @default_worker_options ||= Sidekiq.default_worker_options.stringify_keys
+    end
+  end
+end

data/lib/sidekiq_unique_jobs/lock_config.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module SidekiqUniqueJobs
+  #
+  # Gathers all configuration for a lock
+  #   which helps reduce the amount of instance variables
+  #
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
+  #
+  class LockConfig
+    #
+    # @!attribute [r] type
+    #   @return [Symbol] the type of lock
+    attr_reader :type
+    #
+    # @!attribute [r] worker
+    #   @return [Symbol] the worker class
+    attr_reader :worker
+    #
+    # @!attribute [r] limit
+    #   @return [Integer] the number of simultaneous locks
+    attr_reader :limit
+    #
+    # @!attribute [r] timeout
+    #   @return [Integer, nil] the time to wait for a lock
+    attr_reader :timeout
+    #
+    # @!attribute [r] ttl
+    #   @return [Integer, nil] the time (in seconds) to live after successful
+    attr_reader :ttl
+    #
+    # @!attribute [r] ttl
+    #   @return [Integer, nil] the time (in milliseconds) to live after successful
+    attr_reader :pttl
+    #
+    # @!attribute [r] lock_info
+    #   @return [Boolean] indicate wether to use lock_info or not
+    attr_reader :lock_info
+    #
+    # @!attribute [r] on_conflict
+    #   @return [Symbol, Hash<Symbol, Symbol>] the strategies to use as conflict resolution
+    attr_reader :on_conflict
+    #
+    # @!attribute [r] errors
+    #   @return [Array<Hash<Symbol, Array<String>] a collection of configuration errors
+    attr_reader :errors
+
+    #
+    # Instantiate a new lock_config based on sidekiq options in worker
+    #
+    # @param [Hash] options sidekiq_options for worker
+    #
+    # @return [LockConfig]
+    #
+    def self.from_worker(options)
+      new(options.deep_stringify_keys)
+    end
+
+    def initialize(job_hash = {})
+      @type        = job_hash[LOCK]&.to_sym
+      @worker      = 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
+      @pttl        = ttl * 1_000
+      @lock_info   = job_hash.fetch(LOCK_INFO) { SidekiqUniqueJobs.config.lock_info }
+      @on_conflict = job_hash.fetch(ON_CONFLICT, nil)
+      @errors      = job_hash.fetch(ERRORS) { {} }
+
+      @on_client_conflict = job_hash[ON_CLIENT_CONFLICT]
+      @on_server_conflict = job_hash[ON_SERVER_CONFLICT]
+    end
+
+    #
+    # Indicate if timeout was set
+    #
+    #
+    # @return [true,fakse]
+    #
+    def wait_for_lock?
+      timeout.nil? || timeout.positive?
+    end
+
+    #
+    # Is the configuration valid?
+    #
+    #
+    # @return [true,false]
+    #
+    def valid?
+      errors.empty?
+    end
+
+    #
+    # Return a nice descriptive message with all validation errors
+    #
+    #
+    # @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")
+        error_msg
+      end
+    end
+
+    # the strategy to use as conflict resolution from sidekiq client
+    def on_client_conflict
+      @on_client_conflict ||= on_conflict["client"] if on_conflict.is_a?(Hash)
+      @on_client_conflict ||= on_conflict
+    end
+
+    # the strategy to use as conflict resolution from sidekiq server
+    def on_server_conflict
+      @on_server_conflict ||= on_conflict["server"] if on_conflict.is_a?(Hash)
+      @on_server_conflict ||= on_conflict
+    end
+  end
+end

data/lib/sidekiq_unique_jobs/lock_digest.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "openssl"
+
+module SidekiqUniqueJobs
+  # Handles uniqueness of sidekiq arguments
+  #
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
+  class LockDigest
+    include SidekiqUniqueJobs::Logging
+    include SidekiqUniqueJobs::JSON
+    include SidekiqUniqueJobs::SidekiqWorkerMethods
+
+    #
+    # Generates a new digest
+    #
+    # @param [Hash] item a sidekiq job hash
+    #
+    # @return [String] a unique digest for the given arguments
+    #
+    def self.call(item)
+      new(item).lock_digest
+    end
+
+    # The sidekiq job hash
+    # @return [Hash] the Sidekiq job hash
+    attr_reader :item
+    #
+    # @!attribute [r] args
+    #   @return [Array<Objet>] the arguments passed to `perform_async`
+    attr_reader :lock_args
+    #
+    # @!attribute [r] args
+    #   @return [String] the prefix for the unique key
+    attr_reader :lock_prefix
+
+    # @param [Hash] item a Sidekiq job hash
+    def initialize(item)
+      @item         = item
+      @worker_class = item[CLASS]
+      @lock_args    = item.slice(LOCK_ARGS, UNIQUE_ARGS).values.first # TODO: Deprecate UNIQUE_ARGS
+      @lock_prefix  = item.slice(LOCK_PREFIX, UNIQUE_PREFIX).values.first # TODO: Deprecate UNIQUE_PREFIX
+    end
+
+    # Memoized lock_digest
+    # @return [String] a unique digest
+    def lock_digest
+      @lock_digest ||= create_digest
+    end
+
+    # Creates a namespaced unique digest based on the {#digestable_hash} and the {#lock_prefix}
+    # @return [String] a unique digest
+    def create_digest
+      digest = OpenSSL::Digest::MD5.hexdigest(dump_json(digestable_hash))
+      "#{lock_prefix}:#{digest}"
+    end
+
+    # Filter a hash to use for digest
+    # @return [Hash] to use for digest
+    def digestable_hash
+      @item.slice(CLASS, QUEUE, LOCK_ARGS, APARTMENT).tap do |hash|
+        hash.delete(QUEUE) if unique_across_queues?
+        hash.delete(CLASS) if unique_across_workers?
+      end
+    end
+
+    # Checks if we should disregard the queue when creating the unique digest
+    # @return [true, false]
+    def unique_across_queues?
+      item[UNIQUE_ACROSS_QUEUES] || worker_options[UNIQUE_ACROSS_QUEUES]
+    end
+
+    # Checks if we should disregard the worker when creating the unique digest
+    # @return [true, false]
+    def unique_across_workers?
+      item[UNIQUE_ACROSS_WORKERS] || worker_options[UNIQUE_ACROSS_WORKERS]
+    end
+  end
+end

data/lib/sidekiq_unique_jobs/lock_info.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module SidekiqUniqueJobs
+  #
+  # Class Info provides information about a lock
+  #
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
+  #
+  class LockInfo < Redis::String
+    #
+    # Returns the value for this key as a hash
+    #
+    #
+    # @return [Hash]
+    #
+    def value
+      @value ||= load_json(super)
+    end
+
+    #
+    # Check if this redis string is blank
+    #
+    #
+    # @return [Boolean]
+    #
+    def none?
+      value.nil? || value.empty?
+    end
+
+    #
+    # Check if this redis string has a value
+    #
+    #
+    # @return [Boolean]
+    #
+    def present?
+      !none?
+    end
+
+    #
+    # Quick access to the hash members for the value
+    #
+    # @param [String, Symbol] key the key who's value to retrieve
+    #
+    # @return [Object]
+    #
+    def [](key)
+      value[key.to_s] if value.is_a?(Hash)
+    end
+
+    #
+    # Writes the lock info to redis
+    #
+    # @param [Hash] obj the information to store at key
+    #
+    # @return [Hash]
+    #
+    def set(obj)
+      return unless SidekiqUniqueJobs.config.lock_info
+      raise InvalidArgument, "argument `obj` (#{obj}) needs to be a hash" unless obj.is_a?(Hash)
+
+      json = dump_json(obj)
+      @value = load_json(json)
+      super(json)
+      value
+    end
+  end
+end