redis_queued_locks 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 612f9339ffba6231bcfe2277af85e2225346f6166eb5bb77da0f507beaeae888
-  data.tar.gz: 35229b1d26a17a9c46e39e565d11ec416ca0e173f57360765c064327ffa6390a
+  metadata.gz: 7f78a90d3830a3797bfd973b8ce48a879ba8400c3daec8827c0c14c25c650bb3
+  data.tar.gz: a8e09fae141ff16d142234a4200c86f05abea787fb627e23b4187dd11fa06086
 SHA512:
-  metadata.gz: 1fdb43047ee4b3ac72d28a244ddc9cb4d6b363ff3aa3852b3cc27cbb77ab0a159ef1a45e7eb13f4e4407449fc7b7383e1aac1775f5f739e6ae2e2fcacc5ced46
-  data.tar.gz: 2fbf7fb572005090140ccc9a972e4d84d5be0b1a9a2154fc37c1b04f2dcf44abb06ec6e530c1fa36be0f7ddb3795615f6d7626a224a9d3f3fe913cbf3362734f
+  metadata.gz: fe28a66ec0d028453a0e43f2e140b907a100a70b8a547af8067f45f60392339dd9d0540ef9b8638d0bc9588dd0152f4e21ac488d031170cb872679c7ed4bc34a
+  data.tar.gz: 6608fc1f6a9b2b2000254ba0b4a39d5d16c50f9265bcf58c7b138066e08c29c32d31047e3419db09aa0bfda88c09af10111254c3bf2ba35df775248f2d732d63

data/.rubocop.yml

@@ -5,7 +5,7 @@ inherit_gem:
     - lib/rubocop.rspec.yml
 
 AllCops:
-  TargetRubyVersion: 3.2
+  TargetRubyVersion: 3.1
   NewCops: enable
   Include:
     - lib/**/*.rb
@@ -33,3 +33,6 @@ Metrics/AbcSize:
 
 Metrics/CyclomaticComplexity:
   Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-3.2.2
+3.1.2

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.0.1] - 2024-02-26
+
+- Still the initial release version;
+- Downgrade the minimal Ruby version requirement from 3.2 to 3.1;
+
 ## [0.0.0] - 2024-02-25
 
 - Initial release

data/README.md

@@ -1,3 +1,18 @@
 # RedisQueuedLocks
 
 Distributed lock implementation with "lock acquisition queue" capabilities based on the Redis Database.
+
+## Instrumentation events
+
+- `"redis_queued_locks.lock_obtained"`
+  - the moment when the lock was obtained;
+  - payload:
+    - `ttl` - `integer`/`milliseconds` - lock ttl;
+    - `acq_id` - `string` - lock acquier identifier;
+    - `lock_key` - `string` - lock name ;
+    - `ts` - `integer`/`epoch` - the time when the lock was obtaiend;
+    - `acq_time` - `float`/`milliseconds` - time spent on lock acquiring;
+
+## Todo
+
+- CI (github actions);

data/lib/redis_queued_locks/acquier/release.rb

@@ -29,7 +29,11 @@ module RedisQueuedLocks::Acquier::Release
   # @since 0.1.0
   def fully_release_all_locks(redis, batch_size)
     # Step A: release all queus and their related locks
-    redis.scan('MATCH', RedisQueuedLocks::Resource::LOCK_QUEUE_PATTERN) do |lock_queue|
+    redis.scan(
+      'MATCH',
+      RedisQueuedLocks::Resource::LOCK_QUEUE_PATTERN,
+      count: batch_size
+    ) do |lock_queue|
       redis.pipelined do |pipeline|
         pipeline.call('ZREMRANGEBYSCORE', lock_queue, '-inf', '+inf')
         pipeline.call('EXPIRE', RedisQueuedLocks::Resource.lock_key_from_queue(lock_queue))
@@ -38,7 +42,11 @@ module RedisQueuedLocks::Acquier::Release
 
     # Step B: release all locks
     redis.pipelined do |pipeline|
-      redis.scan('MATCH', RedisQueuedLocks::Resource::LOCK_PATTERN) do |lock_key|
+      redis.scan(
+        'MATCH',
+        RedisQueuedLocks::Resource::LOCK_PATTERN,
+        count: batch_size
+      ) do |lock_key|
         pipeline.call('EXPIRE', lock_key, '0')
       end
     end

data/lib/redis_queued_locks/acquier/try.rb

@@ -14,7 +14,7 @@ module RedisQueuedLocks::Acquier::Try
   #
   # @api private
   # @since 0.1.0
-  # rubocop:disable Metrics/MethodLength, Metrics/PerceivedComplexity
+  # rubocop:disable Metrics/MethodLength
   def try_to_lock(redis, lock_key, lock_key_queue, acquier_id, acquier_position, ttl, queue_ttl)
     # Step X: intermediate invocation results
     inter_result = nil
@@ -111,13 +111,13 @@ module RedisQueuedLocks::Acquier::Try
     when result == nil || (result.is_a?(::Array) && result.empty?)
       # Step 7.b: lock is already acquired durign the acquire race => failed to acquire
       { ok: false, result: :lock_is_acquired_during_acquire_race }
-    when result.is_a?(::Array) && result.size == 3 # NOTE: 3 is a count of lock commands
+    when result.is_a?(::Array) && result.size == 3 # NOTE: 3 is a count of redis lock commands
       # TODO:
       #   => (!) analyze the command result and do actions with the depending on it;
       #   => (*) at this moment we accept that all comamnds are completed successfully;
       #   => (!) need to analyze:
       #   1. zpopmin should return our process (array with <acq_id> and <score>)
-      #   2. hset should return 2 (lock key is added to the redis db with 2 fields)
+      #   2. hset should return 2 (lock key is added to the redis as a hashmap with 2 fields)
       #   3. pexpire should return 1 (expiration time is successfully applied)
 
       # Step 7.c: locked! :) let's go! => successfully acquired

data/lib/redis_queued_locks/acquier.rb

@@ -2,6 +2,7 @@
 
 # @api private
 # @since 0.1.0
+# rubocop:disable Metrics/ModuleLength
 module RedisQueuedLocks::Acquier
   require_relative 'acquier/try'
   require_relative 'acquier/delay'
@@ -26,6 +27,7 @@ module RedisQueuedLocks::Acquier
   # @since 0.1.0
   REDIS_EXPIRATION_DEVIATION = 2 # NOTE: milliseconds
 
+  # rubocop:disable Metrics/ClassLength
   class << self
     # @param redis [RedisClient]
     #   Redis connection client.
@@ -47,6 +49,10 @@ module RedisQueuedLocks::Acquier
     #   A time-interval between the each retry (in milliseconds).
     # @option retry_jitter [Integer]
     #   Time-shift range for retry-delay (in milliseconds).
+    # @option raise_errors [Boolean]
+    #   Raise errors on exceptional cases.
+    # @option instrumenter [#notify]
+    #   See RedisQueuedLocks::Instrument::ActiveSupport for example.
     # @param [Block]
     #   A block of code that should be executed after the successfully acquired lock.
     # @return [Hash<Symbol,Any>]
@@ -66,6 +72,8 @@ module RedisQueuedLocks::Acquier
       retry_count:,
       retry_delay:,
       retry_jitter:,
+      raise_errors:,
+      instrumenter:,
       &block
     )
       # Step 1: prepare lock requirements (generate lock name, calc lock ttl, etc).
@@ -76,11 +84,20 @@ module RedisQueuedLocks::Acquier
       acquier_position = RedisQueuedLocks::Resource.calc_initial_acquier_position
 
       # Step X: intermediate result observer
-      acq_process = { lock_info: {}, should_try: true, tries: 0, acquired: false, result: nil }
+      acq_process = {
+        lock_info: {},
+        should_try: true,
+        tries: 0,
+        acquired: false,
+        result: nil,
+        acq_time: nil # NOTE: in milliseconds
+      }
       acq_dequeue = -> { dequeue_from_lock_queue(redis, lock_key_queue, acquier_id) }
 
       # Step 2: try to lock with timeout
-      with_timeout(timeout, lock_key, on_timeout: acq_dequeue) do
+      with_timeout(timeout, lock_key, raise_errors, on_timeout: acq_dequeue) do
+        acq_start_time = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
+
         # Step 2.1: caclically try to obtain the lock
         while acq_process[:should_try]
           try_to_lock(
@@ -93,15 +110,33 @@ module RedisQueuedLocks::Acquier
             queue_ttl
           ) => { ok:, result: }
 
+          acq_end_time = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
+          acq_time = ((acq_end_time - acq_start_time) * 1_000).ceil
+
           # Step X: save the intermediate results to the result observer
           acq_process[:result] = result
 
           # Step 2.1: analyze an acquirement attempt
           if ok
+            # INSTRUMENT: lock obtained
+            instrumenter.notify('redis_queued_locks.lock_obtained', {
+              lock_key: result[:lock_key],
+              ttl: result[:ttl],
+              acq_id: result[:acq_id],
+              ts: result[:ts],
+              acq_time: acq_time
+            })
+
             # Step 2.1.a: successfully acquired => build the result
-            acq_process[:lock_info] = result
+            acq_process[:lock_info] = {
+              lock_key: result[:lock_key],
+              acq_id: result[:acq_id],
+              ts: result[:ts],
+              ttl: result[:ttl]
+            }
             acq_process[:acquired] = true
             acq_process[:should_try] = false
+            acq_process[:acq_time] = acq_time
           else
             # Step 2.1.b: failed acquirement => retry
             acq_process[:tries] += 1
@@ -125,7 +160,7 @@ module RedisQueuedLocks::Acquier
       if acq_process[:acquired]
         # Step 3.a: acquired successfully => run logic or return the result of acquirement
         if block_given?
-          yield_with_expire(redis, lock_key, &block)
+          yield_with_expire(redis, lock_key, &block) # INSTRUMENT: lock release
         else
           { ok: true, result: acq_process[:lock_info] }
         end
@@ -154,6 +189,7 @@ module RedisQueuedLocks::Acquier
       lock_key = RedisQueuedLocks::Resource.prepare_lock_key(lock_name)
       lock_key_queue = RedisQueuedLocks::Resource.prepare_lock_queue(lock_name)
 
+      # INSTRUMENT: lock release
       result = fully_release_lock(redis, lock_key, lock_key_queue)
       { ok: true, result: result }
     end
@@ -169,26 +205,37 @@ module RedisQueuedLocks::Acquier
     # @api private
     # @since 0.1.0
     def release_all_locks!(redis, batch_size)
+      # INSTRUMENT: all locks released
       result = fully_release_all_locks(redis, batch_size)
       { ok: true, result: result }
     end
 
     private
 
-    # @param timeout [Integer] Time period after which the logic will fail with timeout error.
-    # @param lock_key [String] Lock name.
-    # @option on_timeout [Proc,NilClass] Callback invoked on Timeout::Error.
+    # @param timeout [NilClass,Integer]
+    #   Time period after which the logic will fail with timeout error.
+    # @param lock_key [String]
+    #   Lock name.
+    # @param raise_errors [Boolean]
+    #   Raise erros on exceptional cases.
+    # @option on_timeout [Proc,NilClass]
+    #   Callback invoked on Timeout::Error.
     # @return [Any]
     #
     # @api private
     # @since 0.1.0
-    def with_timeout(timeout, lock_key, on_timeout: nil, &block)
+    def with_timeout(timeout, lock_key, raise_errors, on_timeout: nil, &block)
       ::Timeout.timeout(timeout, &block)
     rescue ::Timeout::Error
       on_timeout.call unless on_timeout == nil
-      raise(RedisQueuedLocks::LockAcquiermentTimeoutError, <<~ERROR_MESSAGE.strip)
-        Failed to acquire the lock "#{lock_key}" for the given timeout (#{timeout} seconds).
-      ERROR_MESSAGE
+
+      if raise_errors
+        raise(RedisQueuedLocks::LockAcquiermentTimeoutError, <<~ERROR_MESSAGE.strip)
+          Failed to acquire the lock "#{lock_key}" for the given timeout (#{timeout} seconds).
+        ERROR_MESSAGE
+      end
     end
   end
+  # rubocop:enable Metrics/ClassLength
 end
+# rubocop:enable Metrics/ModuleLength

data/lib/redis_queued_locks/client.rb

@@ -10,23 +10,25 @@ class RedisQueuedLocks::Client
     setting :retry_count, 3
     setting :retry_delay, 200 # NOTE: milliseconds
     setting :retry_jitter, 50 # NOTE: milliseconds
-    setting :acquire_timeout, 10 # NOTE: seconds
+    setting :default_timeout, 10 # NOTE: seconds
     setting :exp_precision, 1 # NOTE: milliseconds
     setting :default_lock_ttl, 10_000 # NOTE: milliseconds
     setting :default_queue_ttl, 5 # NOTE: seconds
     setting :lock_release_batch_size, 100
+    setting :instrumenter, RedisQueuedLocks::Instrument::VoidNotifier
 
     # TODO: setting :logger, Logger.new(IO::NULL)
     # TODO: setting :debug, true/false
 
-    validate 'retry_count', :integer
-    validate 'retry_delay', :integer
-    validate 'retry_jitter', :integer
-    validate 'acquire_timeout', :integer
-    validate 'exp_precision', :integer
-    validate 'default_lock_tt', :integer
-    validate 'default_queue_ttl', :integer
-    validate 'lock_release_batch_size', :integer
+    validate('retry_count', :integer)
+    validate('retry_delay', :integer)
+    validate('retry_jitter', :integer)
+    validate('default_timeout', :integer)
+    validate('exp_precision', :integer)
+    validate('default_lock_tt', :integer)
+    validate('default_queue_ttl', :integer)
+    validate('lock_release_batch_size', :integer)
+    validate('instrumenter') { |instr| RedisQueuedLocks::Instrument.valid_interface?(instr) }
   end
 
   # @return [RedisClient]
@@ -67,6 +69,10 @@ class RedisQueuedLocks::Client
   #   A time-interval between the each retry (in milliseconds).
   # @option retry_jitter [Integer]
   #   Time-shift range for retry-delay (in milliseconds).
+  # @option instrumenter [#notify]
+  #   See RedisQueuedLocks::Instrument::ActiveSupport for example.
+  # @option raise_errors [Boolean]
+  #   Raise errors on library-related limits such as timeout or failed lock obtain.
   # @param [Block]
   #   A block of code that should be executed after the successfully acquired lock.
   # @return [Hash<Symbol,Any>]
@@ -80,10 +86,11 @@ class RedisQueuedLocks::Client
     thread_id: RedisQueuedLocks::Resource.get_thread_id,
     ttl: config[:default_lock_ttl],
     queue_ttl: config[:default_queue_ttl],
-    timeout: config[:acquire_timeout],
+    timeout: config[:default_timeout],
     retry_count: config[:retry_count],
     retry_delay: config[:retry_delay],
     retry_jitter: config[:retry_jitter],
+    raise_errors: false,
     &block
   )
     RedisQueuedLocks::Acquier.acquire_lock!(
@@ -97,12 +104,45 @@ class RedisQueuedLocks::Client
       retry_count:,
       retry_delay:,
       retry_jitter:,
+      raise_errors:,
+      instrumenter: config[:instrumenter],
+      &block
+    )
+  end
+
+  # @note See #lock method signature.
+  #
+  # @api public
+  # @since 0.1.0
+  def lock!(
+    lock_name,
+    process_id: RedisQueuedLocks::Resource.get_process_id,
+    thread_id: RedisQueuedLocks::Resource.get_thread_id,
+    ttl: config[:default_lock_ttl],
+    queue_ttl: config[:default_queue_ttl],
+    timeout: config[:default_timeout],
+    retry_count: config[:retry_count],
+    retry_delay: config[:retry_delay],
+    retry_jitter: config[:retry_jitter],
+    &block
+  )
+    lock(
+      lock_name,
+      process_id:,
+      thread_id:,
+      ttl:,
+      queue_ttl:,
+      timeout:,
+      retry_count:,
+      retry_delay:,
+      retry_jitter:,
+      raise_errors: true,
       &block
     )
   end
 
   # @param lock_name [String] The lock name that should be released.
-  # @return [?]
+  # @return [Hash<Symbol,Any>] Format: { ok: true/false, result: Symbol/Hash }.
   #
   # @api public
   # @since 0.1.0
@@ -110,7 +150,7 @@ class RedisQueuedLocks::Client
     RedisQueuedLocks::Acquier.release_lock!(redis_client, lock_name)
   end
 
-  # @return [?]
+  # @return [Hash<Symbol,Any>] Format: { ok: true/false, result: Symbol/Hash }.
   #
   # @api public
   # @since 0.1.0

data/lib/redis_queued_locks/debugger.rb

@@ -10,7 +10,7 @@ module RedisQueuedLocks::Debugger
   # @api private
   # @since 0.1.0
   DEBUG_ENABLED_METHOD = <<~METHOD_DECLARATION.strip.freeze
-    def debug(message) = STDOUT.write_nonblock("#\{message}\n")
+    def debug(message) = STDOUT.write("#\{message}\n")
   METHOD_DECLARATION
 
   # @return [String]

data/lib/redis_queued_locks/instrument/active_support.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# @api public
+# @since 0.1.0
+module RedisQueuedLocks::Instrument::ActiveSupport
+  class << self
+    # @param event [String]
+    # @param payload [Hash<String|Symbol,Any>]
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    def notify(event, payload = {})
+      ::ActiveSupport::Notifications.instrument(event, payload)
+    end
+  end
+end

data/lib/redis_queued_locks/instrument/void_notifier.rb

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

data/lib/redis_queued_locks/instrument.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# @api public
+# @since 0.1.0
+module RedisQueuedLocks::Instrument
+  require_relative 'instrument/void_notifier'
+  require_relative 'instrument/active_support'
+
+  class << self
+    # @param instrumenter [Class,Module,Object]
+    # @return [Boolean]
+    #
+    # @api public
+    # @since 0.1.0
+    def valid_interface?(instrumenter)
+      if instrumenter == RedisQueuedLocks::Instrument::ActiveSupport
+        # NOTE: active_support should be required in your app
+        defined?(::ActiveSupport::Notifications)
+      elsif instrumenter.respond_to?(:notify)
+        # NOTE: the method signature should be (event, payload). Supported variants:
+        #   => [[:req, :event], [:req, :payload]]
+        #   => [[:req, :event], [:opt, :payload]]
+        #   => [[:opt, :event], [:opt, :payload]]
+
+        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
+          # rubocop:disable Layout/MultilineOperationIndentation
+          # NOTE: check the signature vairants
+          f_prm == :req && s_prm == :req ||
+          f_prm == :req && s_prm == :opt ||
+          f_prm == :opt && s_prm == :opt
+          # rubocop:enable Layout/MultilineOperationIndentation
+        else
+          # NOTE: incompatible signature
+          false
+        end
+      else
+        # NOTE: no required method :notify
+        false
+      end
+    end
+  end
+end

data/lib/redis_queued_locks/version.rb

@@ -4,6 +4,6 @@ module RedisQueuedLocks
   # @return [String]
   #
   # @api public
-  # @since 0.0.0
-  VERSION = '0.0.0'
+  # @since 0.0.1
+  VERSION = '0.0.1'
 end

data/lib/redis_queued_locks.rb

@@ -12,7 +12,7 @@ module RedisQueuedLocks
   require_relative 'redis_queued_locks/debugger'
   require_relative 'redis_queued_locks/resource'
   require_relative 'redis_queued_locks/acquier'
-  require_relative 'redis_queued_locks/instrumentation'
+  require_relative 'redis_queued_locks/instrument'
   require_relative 'redis_queued_locks/client'
 
   # @since 0.1.0

data/redis_queued_locks.gemspec

@@ -3,7 +3,7 @@
 require_relative 'lib/redis_queued_locks/version'
 
 Gem::Specification.new do |spec|
-  spec.required_ruby_version = '>= 3.2.0'
+  spec.required_ruby_version = '>= 3.1'
 
   spec.name    = 'redis_queued_locks'
   spec.version = RedisQueuedLocks::VERSION

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis_queued_locks
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Rustam Ibragimov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-25 00:00:00.000000000 Z
+date: 2024-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis-client
@@ -64,7 +64,9 @@ files:
 - lib/redis_queued_locks/debugger.rb
 - lib/redis_queued_locks/debugger/interface.rb
 - lib/redis_queued_locks/errors.rb
-- lib/redis_queued_locks/instrumentation.rb
+- 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/resource.rb
 - lib/redis_queued_locks/version.rb
 - redis_queued_locks.gemspec
@@ -83,14 +85,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.1
 signing_key:
 specification_version: 4
 summary: Queued distributed locks based on Redis.

data/lib/redis_queued_locks/instrumentation.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-# @api private
-# @since 0.1.0
-module RedisQueuedLocks::Instrumentation
-end