# frozen_string_literal: true module SidekiqUniqueJobs # # Gathers all configuration for a lock # which helps reduce the amount of instance variables # # @author Mikael Henriksson # 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] the strategies to use as conflict resolution attr_reader :on_conflict # # @!attribute [r] errors # @return [Array] a collection of configuration errors attr_reader :errors def self.from_worker(options) new(options.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 def wait_for_lock? timeout.nil? || timeout.positive? end def valid? errors.empty? end def errors_as_string @errors_as_string ||= begin error_msg = +"\t" error_msg << lock_config.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_client_conflict ||= on_conflict&.(:[], :server) if on_conflict.is_a?(Hash) @on_server_conflict ||= on_conflict end end end