redis_queued_locks 0.0.20 → 0.0.22

data/lib/redis_queued_locks/client.rb

@@ -9,18 +9,16 @@ class RedisQueuedLocks::Client
 
   configuration do
     setting :retry_count, 3
-    setting :retry_delay, 200 # NOTE: milliseconds
-    setting :retry_jitter, 25 # NOTE: milliseconds
-    setting :try_to_lock_timeout, 10 # NOTE: seconds
-    setting :default_lock_ttl, 5_000 # NOTE: milliseconds
-    setting :default_queue_ttl, 15 # NOTE: seconds
+    setting :retry_delay, 200 # NOTE: in milliseconds
+    setting :retry_jitter, 25 # NOTE: in milliseconds
+    setting :try_to_lock_timeout, 10 # NOTE: in seconds
+    setting :default_lock_ttl, 5_000 # NOTE: in milliseconds
+    setting :default_queue_ttl, 15 # NOTE: in seconds
     setting :lock_release_batch_size, 100
     setting :key_extraction_batch_size, 500
     setting :instrumenter, RedisQueuedLocks::Instrument::VoidNotifier
     setting :uniq_identifier, -> { RedisQueuedLocks::Resource.calc_uniq_identity }
-
-    # TODO: setting :logger, Logger.new(IO::NULL)
-    # TODO: setting :debug, true/false
+    setting :logger, RedisQueuedLocks::Logging::VoidLogger
 
     validate('retry_count') { |val| val == nil || (val.is_a?(::Integer) && val >= 0) }
     validate('retry_delay') { |val| val.is_a?(::Integer) && val >= 0 }
@@ -30,6 +28,7 @@ class RedisQueuedLocks::Client
     validate('default_queue_ttl', :integer)
     validate('lock_release_batch_size', :integer)
     validate('instrumenter') { |val| RedisQueuedLocks::Instrument.valid_interface?(val) }
+    validate('logger') { |val| RedisQueuedLocks::Logging.valid_interface?(val) }
     validate('uniq_identifier', :proc)
   end
 
@@ -117,7 +116,7 @@ class RedisQueuedLocks::Client
     metadata: nil,
     &block
   )
-    RedisQueuedLocks::Acquier.acquire_lock!(
+    RedisQueuedLocks::Acquier::AcquireLock.acquire_lock(
       redis_client,
       lock_name,
       process_id: RedisQueuedLocks::Resource.get_process_id,
@@ -136,6 +135,7 @@ class RedisQueuedLocks::Client
       identity:,
       fail_fast:,
       metadata:,
+      logger: config[:logger],
       &block
     )
   end
@@ -183,7 +183,12 @@ class RedisQueuedLocks::Client
   # @api public
   # @since 0.1.0
   def unlock(lock_name)
-    RedisQueuedLocks::Acquier.release_lock!(redis_client, lock_name, config[:instrumenter])
+    RedisQueuedLocks::Acquier::ReleaseLock.release_lock(
+      redis_client,
+      lock_name,
+      config[:instrumenter],
+      config[:logger]
+    )
   end
 
   # @param lock_name [String]
@@ -192,7 +197,7 @@ class RedisQueuedLocks::Client
   # @api public
   # @since 0.1.0
   def locked?(lock_name)
-    RedisQueuedLocks::Acquier.locked?(redis_client, lock_name)
+    RedisQueuedLocks::Acquier::IsLocked.locked?(redis_client, lock_name)
   end
 
   # @param lock_name [String]
@@ -201,7 +206,7 @@ class RedisQueuedLocks::Client
   # @api public
   # @since 0.1.0
   def queued?(lock_name)
-    RedisQueuedLocks::Acquier.queued?(redis_client, lock_name)
+    RedisQueuedLocks::Acquier::IsQueued.queued?(redis_client, lock_name)
   end
 
   # @param lock_name [String]
@@ -210,7 +215,7 @@ class RedisQueuedLocks::Client
   # @api public
   # @since 0.1.0
   def lock_info(lock_name)
-    RedisQueuedLocks::Acquier.lock_info(redis_client, lock_name)
+    RedisQueuedLocks::Acquier::LockInfo.lock_info(redis_client, lock_name)
   end
 
   # @param lock_name [String]
@@ -219,7 +224,7 @@ class RedisQueuedLocks::Client
   # @api public
   # @since 0.1.0
   def queue_info(lock_name)
-    RedisQueuedLocks::Acquier.queue_info(redis_client, lock_name)
+    RedisQueuedLocks::Acquier::QueueInfo.queue_info(redis_client, lock_name)
   end
 
   # @param lock_name [String]
@@ -229,7 +234,12 @@ class RedisQueuedLocks::Client
   # @api public
   # @since 0.1.0
   def extend_lock_ttl(lock_name, milliseconds)
-    RedisQueuedLocks::Acquier.extend_lock_ttl(redis_client, lock_name)
+    RedisQueuedLocks::Acquier::ExtendLockTTL.extend_lock_ttl(
+      redis_client,
+      lock_name,
+      milliseconds,
+      config[:logger]
+    )
   end
 
   # @option batch_size [Integer]
@@ -239,7 +249,12 @@ class RedisQueuedLocks::Client
   # @api public
   # @since 0.1.0
   def clear_locks(batch_size: config[:lock_release_batch_size])
-    RedisQueuedLocks::Acquier.release_all_locks!(redis_client, batch_size, config[:instrumenter])
+    RedisQueuedLocks::Acquier::ReleaseAllLocks.release_all_locks(
+      redis_client,
+      batch_size,
+      config[:instrumenter],
+      config[:logger]
+    )
   end
 
   # @option scan_size [Integer]
@@ -248,7 +263,7 @@ class RedisQueuedLocks::Client
   # @api public
   # @since 0.1.0
   def locks(scan_size: config[:key_extraction_batch_size])
-    RedisQueuedLocks::Acquier.locks(redis_client, scan_size:)
+    RedisQueuedLocks::Acquier::Locks.locks(redis_client, scan_size:)
   end
 
   # @option scan_size [Integer]
@@ -257,7 +272,7 @@ class RedisQueuedLocks::Client
   # @api public
   # @since 0.1.0
   def queues(scan_size: config[:key_extraction_batch_size])
-    RedisQueuedLocks::Acquier.queues(redis_client, scan_size:)
+    RedisQueuedLocks::Acquier::Queues.queues(redis_client, scan_size:)
   end
 
   # @option scan_size [Integer]
@@ -266,7 +281,7 @@ class RedisQueuedLocks::Client
   # @api public
   # @since 0.1.0
   def keys(scan_size: config[:key_extraction_batch_size])
-    RedisQueuedLocks::Acquier.keys(redis_client, scan_size:)
+    RedisQueuedLocks::Acquier::Keys.keys(redis_client, scan_size:)
   end
 end
 # rubocop:enable Metrics/ClassLength

data/lib/redis_queued_locks/instrument/active_support.rb

@@ -8,7 +8,7 @@ module RedisQueuedLocks::Instrument::ActiveSupport
     # @param payload [Hash<String|Symbol,Any>]
     # @return [void]
     #
-    # @api private
+    # @api public
     # @since 0.1.0
     def notify(event, payload = {})
       ::ActiveSupport::Notifications.instrument(event, payload)

data/lib/redis_queued_locks/instrument/void_notifier.rb

@@ -8,7 +8,7 @@ module RedisQueuedLocks::Instrument::VoidNotifier
     # @param payload [Hash<String|Symbol,Any>]
     # @return [void]
     #
-    # @api private
+    # @api public
     # @since 0.1.0
     def notify(event, payload = {}); end
   end

data/lib/redis_queued_locks/instrument.rb

@@ -25,10 +25,10 @@ module RedisQueuedLocks::Instrument
         m_obj = instrumenter.method(:notify)
         m_sig = m_obj.parameters
 
-        f_prm = m_sig[0][0]
-        s_prm = m_sig[1][0]
-
         if m_sig.size == 2
+          f_prm = m_sig[0][0]
+          s_prm = m_sig[1][0]
+
           # rubocop:disable Layout/MultilineOperationIndentation
           # NOTE: check the signature vairants
           f_prm == :req && s_prm == :req ||

data/lib/redis_queued_locks/logging/void_logger.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# @api public
+# @since 0.1.0
+module RedisQueuedLocks::Logging::VoidLogger
+  class << self
+    # @api public
+    # @since 0.1.0
+    def warn(progname = nil, &block); end
+
+    # @api public
+    # @since 0.1.0
+    def unknown(progname = nil, &block); end
+
+    # @api public
+    # @since 0.1.0
+    def log(progname = nil, &block); end
+
+    # @api public
+    # @since 0.1.0
+    def info(progname = nil, &block); end
+
+    # @api public
+    # @since 0.1.0
+    def error(progname = nil, &block); end
+
+    # @api public
+    # @since 0.1.0
+    def fatal(progname = nil, &block); end
+
+    # @api public
+    # @since 0.1.0
+    def debug(progname = nil, &block); end
+
+    # @api public
+    # @since 0.1.0
+    def add(*, &block); end
+
+    # @api public
+    # @since 0.1.0
+    def <<(message); end
+  end
+end

data/lib/redis_queued_locks/logging.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# @api public
+# @since 0.1.0
+module RedisQueuedLocks::Logging
+  require_relative 'logging/void_logger'
+
+  class << self
+    # @param logger [#debug]
+    # @return [Boolean]
+    #
+    # @api public
+    # @since 0.1.0
+    def valid_interface?(logger)
+      return true if logger.is_a?(::Logger)
+
+      # NOTE: should provide `#debug` method.
+      return false unless logger.respond_to?(:debug)
+
+      # NOTE:
+      #   `#debug` method should have appropriated signature `(progname, &block)`
+      #   Required method signature (progname, &block):
+      #     => [[:opt, :progname], [:block, :block]]
+      #     => [[:req, :progname], [:block, :block]]
+      #     => [[:opt, :progname]]
+      #     => [[:req, :progname]]
+      #     => [[:rest], [:block, :block]]
+      #     => [[:rest]]
+
+      m_obj = logger.method(:debug)
+      m_sig = m_obj.parameters
+
+      if m_sig.size == 2
+        # => [[:opt, :progname], [:block, :block]]
+        # => [[:req, :progname], [:block, :block]]
+        # => [[:rest], [:block, :block]]
+        f_prm = m_sig[0][0]
+        s_prm = m_sig[1][0]
+
+        # rubocop:disable Layout/MultilineOperationIndentation
+        f_prm == :opt && s_prm == :block ||
+        f_prm == :req && s_prm == :block ||
+        f_prm == :rest && s_prm == :block
+        # rubocop:enable Layout/MultilineOperationIndentation
+      elsif m_sig.size == 1
+        # => [[:opt, :progname]]
+        # => [[:req, :progname]]
+        # => [[:rest]]
+        prm = m_sig[0][0]
+
+        prm == :opt || prm == :req || prm == :rest
+      else
+        false
+      end
+    end
+  end
+end

data/lib/redis_queued_locks/utilities.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+module RedisQueuedLocks::Utilities
+  module_function
+
+  # @param block [Block]
+  # @return [Any]
+  #
+  # @api private
+  # @since 0.1.0
+  def run_non_critical(&block)
+    yield rescue nil
+  end
+end

data/lib/redis_queued_locks/version.rb

@@ -5,6 +5,6 @@ module RedisQueuedLocks
   #
   # @api public
   # @since 0.0.1
-  # @version 0.0.20
-  VERSION = '0.0.20'
+  # @version 0.0.22
+  VERSION = '0.0.22'
 end

data/lib/redis_queued_locks.rb

@@ -4,12 +4,15 @@ require 'redis-client'
 require 'qonfig'
 require 'timeout'
 require 'securerandom'
+require 'logger'
 
 # @api public
 # @since 0.1.0
 module RedisQueuedLocks
   require_relative 'redis_queued_locks/version'
   require_relative 'redis_queued_locks/errors'
+  require_relative 'redis_queued_locks/utilities'
+  require_relative 'redis_queued_locks/logging'
   require_relative 'redis_queued_locks/data'
   require_relative 'redis_queued_locks/debugger'
   require_relative 'redis_queued_locks/resource'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis_queued_locks
 version: !ruby/object:Gem::Version
-  version: 0.0.20
+  version: 0.0.22
 platform: ruby
 authors:
 - Rustam Ibragimov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-14 00:00:00.000000000 Z
+date: 2024-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis-client
@@ -56,10 +56,21 @@ files:
 - Rakefile
 - lib/redis_queued_locks.rb
 - lib/redis_queued_locks/acquier.rb
-- lib/redis_queued_locks/acquier/delay.rb
-- lib/redis_queued_locks/acquier/release.rb
-- lib/redis_queued_locks/acquier/try.rb
-- lib/redis_queued_locks/acquier/yield_expire.rb
+- lib/redis_queued_locks/acquier/acquire_lock.rb
+- lib/redis_queued_locks/acquier/acquire_lock/delay_execution.rb
+- lib/redis_queued_locks/acquier/acquire_lock/try_to_lock.rb
+- lib/redis_queued_locks/acquier/acquire_lock/with_acq_timeout.rb
+- lib/redis_queued_locks/acquier/acquire_lock/yield_with_expire.rb
+- lib/redis_queued_locks/acquier/extend_lock_ttl.rb
+- lib/redis_queued_locks/acquier/is_locked.rb
+- lib/redis_queued_locks/acquier/is_queued.rb
+- lib/redis_queued_locks/acquier/keys.rb
+- lib/redis_queued_locks/acquier/lock_info.rb
+- lib/redis_queued_locks/acquier/locks.rb
+- lib/redis_queued_locks/acquier/queue_info.rb
+- lib/redis_queued_locks/acquier/queues.rb
+- lib/redis_queued_locks/acquier/release_all_locks.rb
+- lib/redis_queued_locks/acquier/release_lock.rb
 - lib/redis_queued_locks/client.rb
 - lib/redis_queued_locks/data.rb
 - lib/redis_queued_locks/debugger.rb
@@ -68,7 +79,10 @@ files:
 - lib/redis_queued_locks/instrument.rb
 - lib/redis_queued_locks/instrument/active_support.rb
 - lib/redis_queued_locks/instrument/void_notifier.rb
+- lib/redis_queued_locks/logging.rb
+- lib/redis_queued_locks/logging/void_logger.rb
 - lib/redis_queued_locks/resource.rb
+- lib/redis_queued_locks/utilities.rb
 - lib/redis_queued_locks/version.rb
 - redis_queued_locks.gemspec
 homepage: https://github.com/0exp/redis_queued_locks

data/lib/redis_queued_locks/acquier/release.rb

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-# @api private
-# @since 0.1.0
-module RedisQueuedLocks::Acquier::Release
-  # Realease the lock: clear the lock queue and expire the lock.
-  #
-  # @param redis [RedisClient]
-  # @param lock_key [String]
-  # @param lock_key_queue [String]
-  # @return [RedisQueuedLocks::Data,Hash<Symbol,Any>] Format: { ok: true/false, result: Any }
-  #
-  # @api private
-  # @since 0.1.0
-  def fully_release_lock(redis, lock_key, lock_key_queue)
-    result = redis.multi do |transact|
-      transact.call('ZREMRANGEBYSCORE', lock_key_queue, '-inf', '+inf')
-      transact.call('EXPIRE', lock_key, '0')
-    end
-
-    RedisQueuedLocks::Data[ok: true, result:]
-  end
-
-  # Release all locks: clear all lock queus and expire all locks.
-  #
-  # @param redis [RedisClient]
-  # @param batch_size [Integer]
-  # @return [RedisQueuedLocks::Data,Hash<Symbol,Any>] Format: { ok: true/false, result: Any }
-  #
-  # @api private
-  # @since 0.1.0
-  def fully_release_all_locks(redis, batch_size)
-    result = redis.pipelined do |pipeline|
-      # Step A: release all queus and their related locks
-      redis.scan(
-        'MATCH',
-        RedisQueuedLocks::Resource::LOCK_QUEUE_PATTERN,
-        count: batch_size
-      ) do |lock_queue|
-        # TODO: reduce unnecessary iterations
-        pipeline.call('ZREMRANGEBYSCORE', lock_queue, '-inf', '+inf')
-        pipeline.call('EXPIRE', RedisQueuedLocks::Resource.lock_key_from_queue(lock_queue), '0')
-      end
-
-      # Step B: release all locks
-      redis.scan(
-        'MATCH',
-        RedisQueuedLocks::Resource::LOCK_PATTERN,
-        count: batch_size
-      ) do |lock_key|
-        # TODO: reduce unnecessary iterations
-        pipeline.call('EXPIRE', lock_key, '0')
-      end
-    end
-
-    rel_keys = result.count { |red_res| red_res == 0 }
-
-    RedisQueuedLocks::Data[ok: true, result: { rel_keys: rel_keys }]
-  end
-end