redis_queued_locks 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f78a90d3830a3797bfd973b8ce48a879ba8400c3daec8827c0c14c25c650bb3
-  data.tar.gz: a8e09fae141ff16d142234a4200c86f05abea787fb627e23b4187dd11fa06086
+  metadata.gz: 5dbd11cefb9d18a816eb4c63fe1178f87325c30d75efc2bc806d29f41994fc2c
+  data.tar.gz: 9697f4bf452aaaa7cade45320c50d16b510c657074ba97513c5f8de9c51f6c49
 SHA512:
-  metadata.gz: fe28a66ec0d028453a0e43f2e140b907a100a70b8a547af8067f45f60392339dd9d0540ef9b8638d0bc9588dd0152f4e21ac488d031170cb872679c7ed4bc34a
-  data.tar.gz: 6608fc1f6a9b2b2000254ba0b4a39d5d16c50f9265bcf58c7b138066e08c29c32d31047e3419db09aa0bfda88c09af10111254c3bf2ba35df775248f2d732d63
+  metadata.gz: b28ef92375c7eef4d6c43fccb5e44105d653fb00e052edcf67316f8da13578ad7b39086b3799782592b38bf046760f8faa1238b92de293b83eb1e4a7c441413e
+  data.tar.gz: dfd3891ae8d0303b88ac95268056addc3b4e03f862a5200166de9553b412eee78b77f42193f133f9dd340793b67928806e2e05451517585c2282fb7e4c871d1f

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 ## [Unreleased]
 
+## [0.0.3] - 2024-02-26
+### Changed
+- Instrumentation events:
+  - `"redis_queued_locks.explicit_all_locks_release"`
+    - re-factored with fully pipelined invocation;
+    - removed `rel_queue_cnt` and `rel_lock_cnt` because of the pipelined invocation
+      misses the concrete results and now we can receive only "released redis keys count";
+    - adde `rel_keys` payload data (released redis keys);
+
+## [0.0.2] - 2024-02-26
+### Added
+- Instrumentation events:
+  - `"redis_queued_locks.lock_obtained"`;
+  - `"redis_queued_locks.lock_hold_and_release"`;
+  - `"redis_queued_locks.explicit_lock_release"`;
+  - `"redis_queued_locks.explicit_all_locks_release"`;
+
 ## [0.0.1] - 2024-02-26
 
 - Still the initial release version;

data/README.md

@@ -5,14 +5,33 @@ Distributed lock implementation with "lock acquisition queue" capabilities based
 ## Instrumentation events
 
 - `"redis_queued_locks.lock_obtained"`
-  - the moment when the lock was obtained;
+  - a moment when the lock was obtained;
   - payload:
     - `ttl` - `integer`/`milliseconds` - lock ttl;
     - `acq_id` - `string` - lock acquier identifier;
-    - `lock_key` - `string` - lock name ;
+    - `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);
+- `"redis_queued_locks.lock_hold_and_release"`
+  - an event signalizes about the "hold+and+release" process
+    when the lock obtained and hold by the block of logic;
+  - payload:
+    - `hold_time` - `float`/`milliseconds` - lock hold time;
+    - `ttl` - `integer`/`milliseconds` - lock ttl;
+    - `acq_id` - `string` - lock acquier identifier;
+    - `lock_key` - `string` - lock name;
+    - `ts` - `integer`/`epoch` - the time when lock was obtained;
+    - `acq_time` - `float`/`milliseconds` - time spent on lock acquiring;
+- `"redis_queued_locks.explicit_lock_release"`
+  - an event signalizes about the explicit lock release (invoked via `RedisQueuedLock#unlock`);
+  - payload:
+    - `at` - `integer`/`epoch` - the time when the lock was released;
+    - `rel_time` - `float`/`milliseconds` - time spent on lock releasing;
+    - `lock_key` - `string` - released lock (lock name);
+    - `lock_key_queue` - `string` - released lock queue (lock queue name);
+- `"redis_queued_locks.explicit_all_locks_release"`
+  - an event signalizes about the explicit all locks release (invoked via `RedisQueuedLock#clear_locks`);
+  - payload:
+    - `rel_time` - `float`/`milliseconds` - time spent on the lock release;
+    - `at` - `integer`/`epoch` - the time when the operation has ended;
+    - `rel_keys` - `integer` - released redis keys count (`released queu keys` + `released lock keys`);

data/lib/redis_queued_locks/acquier/delay.rb

@@ -3,6 +3,8 @@
 # @api private
 # @since 0.1.0
 module RedisQueuedLocks::Acquier::Delay
+  # Sleep with random time-shifting (it is necessary for empty-time-slot lock acquirement).
+  #
   # @param retry_delay [Integer] In milliseconds
   # @param retry_jitter [Integer] In milliseconds
   # @return [void]

data/lib/redis_queued_locks/acquier/expire.rb

@@ -3,10 +3,10 @@
 # @api private
 # @since 0.1.0
 module RedisQueuedLocks::Acquier::Expire
-  # @param redis [RedisClient]
-  # @param lock_key [String]
-  # @param block [Block]
-  # @return [void]
+  # @param redis [RedisClient] Redis connection manager.
+  # @param lock_key [String] Lock key to be expired.
+  # @param block [Block] Custom logic that should be invoked unter the obtained lock.
+  # @return [Any,NilClass] nil is returned no block parametr is provided.
   #
   # @api private
   # @since 0.1.0

data/lib/redis_queued_locks/acquier/release.rb

@@ -8,47 +8,53 @@ module RedisQueuedLocks::Acquier::Release
   # @param redis [RedisClient]
   # @param lock_key [String]
   # @param lock_key_queue [String]
-  # @return [void]
+  # @return [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)
-    redis.multi do |transact|
+    result = redis.multi do |transact|
       transact.call('ZREMRANGEBYSCORE', lock_key_queue, '-inf', '+inf')
       transact.call('EXPIRE', lock_key, '0')
     end
+
+    { ok: true, result: }
   end
 
   # Release all locks: clear all lock queus and expire all locks.
   #
   # @param redis [RedisClient]
   # @param batch_size [Integer]
-  # @return [void]
+  # @return [Hash<Symbol,Any>] Format: { ok: true/false, result: Any }
   #
   # @api private
   # @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,
-      count: batch_size
-    ) do |lock_queue|
-      redis.pipelined do |pipeline|
+    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|
+        puts "RELEASE (lock_queue): #{lock_queue}"
         pipeline.call('ZREMRANGEBYSCORE', lock_queue, '-inf', '+inf')
-        pipeline.call('EXPIRE', RedisQueuedLocks::Resource.lock_key_from_queue(lock_queue))
+        pipeline.call('EXPIRE', RedisQueuedLocks::Resource.lock_key_from_queue(lock_queue), "0")
       end
-    end
 
-    # Step B: release all locks
-    redis.pipelined do |pipeline|
+      # Step B: release all locks
       redis.scan(
         'MATCH',
         RedisQueuedLocks::Resource::LOCK_PATTERN,
         count: batch_size
       ) do |lock_key|
+        puts "RELEASE (lock_key): #{lock_key}"
         pipeline.call('EXPIRE', lock_key, '0')
       end
     end
+
+    rel_keys = result.count { |red_res| red_res == 0 }
+
+    { ok: true, result: { rel_keys: rel_keys } }
   end
 end

data/lib/redis_queued_locks/acquier.rb

@@ -37,14 +37,14 @@ module RedisQueuedLocks::Acquier
     #   The process that want to acquire the lock.
     # @option thread_id [Integer,String]
     #   The process's thread that want to acquire the lock.
-    # @option ttl [Integer]
-    #   Lock's time to live (in milliseconds).
+    # @option ttl [Integer,NilClass]
+    #   Lock's time to live (in milliseconds). Nil means "without timeout".
     # @option queue_ttl [Integer]
-    #   ?
+    #   Lifetime of the acuier's lock request. In seconds.
     # @option timeout [Integer]
     #   Time period whe should try to acquire the lock (in seconds).
-    # @option retry_count [Integer]
-    #   How many times we should try to acquire a lock.
+    # @option retry_count [Integer,NilClass]
+    #   How many times we should try to acquire a lock. Nil means "infinite retries".
     # @option retry_delay [Integer]
     #   A time-interval between the each retry (in milliseconds).
     # @option retry_jitter [Integer]
@@ -90,7 +90,9 @@ module RedisQueuedLocks::Acquier
         tries: 0,
         acquired: false,
         result: nil,
-        acq_time: nil # NOTE: in milliseconds
+        acq_time: nil, # NOTE: in milliseconds
+        hold_time: nil, # NOTE: in milliseconds
+        rel_time: nil # NOTE: in milliseconds
       }
       acq_dequeue = -> { dequeue_from_lock_queue(redis, lock_key_queue, acquier_id) }
 
@@ -111,14 +113,14 @@ module RedisQueuedLocks::Acquier
           ) => { ok:, result: }
 
           acq_end_time = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
-          acq_time = ((acq_end_time - acq_start_time) * 1_000).ceil
+          acq_time = ((acq_end_time - acq_start_time) * 1_000).ceil(2)
 
           # 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
+            # Step X (instrumentation): lock obtained
             instrumenter.notify('redis_queued_locks.lock_obtained', {
               lock_key: result[:lock_key],
               ttl: result[:ttl],
@@ -137,20 +139,20 @@ module RedisQueuedLocks::Acquier
             acq_process[:acquired] = true
             acq_process[:should_try] = false
             acq_process[:acq_time] = acq_time
+            acq_process[:acq_end_time] = acq_end_time
           else
             # Step 2.1.b: failed acquirement => retry
             acq_process[:tries] += 1
 
-            if acq_process[:tries] >= retry_count
+            if retry_count != nil && acq_process[:tries] >= retry_count
               # NOTE: reached the retry limit => quit from the loop
               acq_process[:should_try] = false
               # NOTE: reached the retry limit => dequeue from the lock queue
               acq_dequeue.call
-            else
+            elsif delay_execution(retry_delay, retry_jitter)
               # NOTE:
               #   delay the exceution in order to prevent chaotic attempts
               #   and to allow other processes and threads to obtain the lock too.
-              delay_execution(retry_delay, retry_jitter)
             end
           end
         end
@@ -160,7 +162,26 @@ 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) # INSTRUMENT: lock release
+          begin
+            yield_with_expire(redis, lock_key, &block)
+          ensure
+            acq_process[:rel_time] = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
+            acq_process[:hold_time] = (
+              (acq_process[:rel_time] - acq_process[:acq_end_time]) * 1000
+            ).ceil(2)
+
+            # Step X (instrumentation): lock_hold_and_release
+            run_non_critical do
+              instrumenter.notify('redis_queued_locks.lock_hold_and_release', {
+                hold_time: acq_process[:hold_time],
+                ttl: acq_process[:lock_info][:ttl],
+                acq_id: acq_process[:lock_info][:acq_id],
+                ts: acq_process[:lock_info][:ts],
+                lock_key: acq_process[:lock_info][:lock_key],
+                acq_time: acq_process[:acq_time]
+              })
+            end
+          end
         else
           { ok: true, result: acq_process[:lock_info] }
         end
@@ -181,16 +202,30 @@ module RedisQueuedLocks::Acquier
     #
     # @param redis [RedisClient] Redis connection client.
     # @param lock_name [String] The lock name that should be released.
+    # @param isntrumenter [#notify] See RedisQueuedLocks::Instrument::ActiveSupport for example.
     # @return [Hash<Symbol,Any>] Format: { ok: true/false, result: Any }
     #
     # @api private
     # @since 0.1.0
-    def release_lock!(redis, lock_name)
+    def release_lock!(redis, lock_name, instrumenter)
       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)
+      rel_start_time = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
+      fully_release_lock(redis, lock_key, lock_key_queue) => { ok:, result: }
+      time_at = Time.now.to_i
+      rel_end_time = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
+      rel_time = ((rel_end_time - rel_start_time) * 1_000).ceil(2)
+
+      run_non_critical do
+        instrumenter.notify('redis_queued_locks.explicit_lock_release', {
+          lock_key: lock_key,
+          lock_key_queue: lock_key_queue,
+          rel_time: rel_time,
+          at: time_at
+        })
+      end
+
       { ok: true, result: result }
     end
 
@@ -200,13 +235,26 @@ module RedisQueuedLocks::Acquier
     #
     # @param redis [RedisClient] Redis connection client.
     # @param batch_size [Integer] The number of lock keys that should be released in a time.
+    # @param isntrumenter [#notify] See RedisQueuedLocks::Instrument::ActiveSupport for example.
     # @return [Hash<Symbol,Any>] Format: { ok: true/false, result: Any }
     #
     # @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)
+    def release_all_locks!(redis, batch_size, instrumenter)
+      rel_start_time = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
+      fully_release_all_locks(redis, batch_size) => { ok:, result: }
+      time_at = Time.now.to_i
+      rel_end_time = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
+      rel_time = ((rel_end_time - rel_start_time) * 1_000).ceil(2)
+
+      run_non_critical do
+        instrumenter.notify('redis_queued_locks.explicit_all_locks_release', {
+          at: time_at,
+          rel_time: rel_time,
+          rel_keys: result[:rel_keys]
+        })
+      end
+
       { ok: true, result: result }
     end
 
@@ -235,6 +283,15 @@ module RedisQueuedLocks::Acquier
         ERROR_MESSAGE
       end
     end
+
+    # @param block [Block]
+    # @return [Any]
+    #
+    # @api private
+    # @since 0.1.0
+    def run_non_critical(&block)
+      yield rescue nil
+    end
   end
   # rubocop:enable Metrics/ClassLength
 end

data/lib/redis_queued_locks/client.rb

@@ -12,15 +12,15 @@ class RedisQueuedLocks::Client
     setting :retry_jitter, 50 # NOTE: milliseconds
     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 :default_lock_ttl, 5_000 # NOTE: milliseconds
+    setting :default_queue_ttl, 30 # 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_count') { |val| val == nil || (val.is_a?(::Integer) && val >= 0) }
     validate('retry_delay', :integer)
     validate('retry_jitter', :integer)
     validate('default_timeout', :integer)
@@ -28,7 +28,7 @@ class RedisQueuedLocks::Client
     validate('default_lock_tt', :integer)
     validate('default_queue_ttl', :integer)
     validate('lock_release_batch_size', :integer)
-    validate('instrumenter') { |instr| RedisQueuedLocks::Instrument.valid_interface?(instr) }
+    validate('instrumenter') { |val| RedisQueuedLocks::Instrument.valid_interface?(val) }
   end
 
   # @return [RedisClient]
@@ -60,11 +60,11 @@ class RedisQueuedLocks::Client
   # @option ttl [Integer]
   #   Lock's time to live (in milliseconds).
   # @option queue_ttl [Integer]
-  #   ?
-  # @option timeout [Integer]
-  #   Time period whe should try to acquire the lock (in seconds).
-  # @option retry_count [Integer]
-  #   How many times we should try to acquire a lock.
+  #   Lifetime of the acuier's lock request. In seconds.
+  # @option timeout [Integer,NilClass]
+  #   Time period whe should try to acquire the lock (in seconds). Nil means "without timeout".
+  # @option retry_count [Integer,NilClass]
+  #   How many times we should try to acquire a lock. Nil means "infinite retries".
   # @option retry_delay [Integer]
   #   A time-interval between the each retry (in milliseconds).
   # @option retry_jitter [Integer]
@@ -147,14 +147,23 @@ class RedisQueuedLocks::Client
   # @api public
   # @since 0.1.0
   def unlock(lock_name)
-    RedisQueuedLocks::Acquier.release_lock!(redis_client, lock_name)
+    RedisQueuedLocks::Acquier.release_lock!(
+      redis_client,
+      lock_name,
+      config[:instrumenter]
+    )
   end
 
+  # @option batch_size [Integer]
   # @return [Hash<Symbol,Any>] Format: { ok: true/false, result: Symbol/Hash }.
   #
   # @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)
+    RedisQueuedLocks::Acquier.release_all_locks!(
+      redis_client,
+      batch_size,
+      config[:instrumenter]
+    )
   end
 end

data/lib/redis_queued_locks/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis_queued_locks
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Rustam Ibragimov