redis_queued_locks 0.0.28 → 0.0.29

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5de2915b0828a1c82327dd301b41388cc649b2b922ca18f98cde7e8607753b28
-  data.tar.gz: da86f22a9ed5a834467ae80d9596c9efb0be1e645546c5b32a8f5d5b1dcec294
+  metadata.gz: 3137184f5a89b895fe347d8080957e08a57974e91d5a68189d0eb157afd7c3eb
+  data.tar.gz: 7b059f5de5cde2af1634eed3aeae540afd7edfc5ba564781789649098e53e0a1
 SHA512:
-  metadata.gz: 1f3a60c00b200f9e474ad0471e8e59541786f6e035df4c4d93d553eb93456fc99f0743970d3154fa8d3878a4e67b03d8d2ae2c16b71336b8d277f886dd4821e4
-  data.tar.gz: 1b52f00d36d568dce68b14caa0cbfb0e1ec793a7eec9adeb5bbca3c042b8bd224cec5f74488c4f0b34de0b302ec98392584a07e21bd02f106a370f3341ef3a35
+  metadata.gz: 4821b6c0fc142d90fae314aa11c92069be9223cc4a61be077ff6e19278fae97f920d31b590c5688f3614159a2f5c9d9d1792d8a6aee50f51d7b24f83ea1a9298
+  data.tar.gz: 80a0de485f263459c52d230cc0e604d0c742db235a6a9b57053cc84001e9e146cfc35b9c31aff5e1ef5a2796692559f95fe94db39350720277fb219ef95a2685

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.0.29] - 2024-03-23
+### Added
+- Logging: more detailed logs to `RedisQueuedLocks::Acquier::AcquireLock::TryToLock`;
+
 ## [0.0.28] - 2024-03-21
 ### Added
 - Logging: added `acq_id` to every log message;

data/README.md

@@ -600,23 +600,21 @@ Detalized event semantics and payload structure:
 
 ## Roadmap
 
-- **Major**
-  - Semantic Error objects for unexpected Redis errors;
-  - `100%` test coverage;
-  - per-block-holding-the-lock sidecar `Ractor` and `in progress queue` in RedisDB that will extend
-    the acquired lock for long-running blocks of code (that invoked "under" the lock
-    whose ttl may expire before the block execution completes);
-  - an ability to add custom metadata to the lock and an ability to read this data;
-  - lock prioritization;
-  - support for LIFO strategy;
-  - structured logging;
-- **Minor**
-  - GitHub Actions CI;
-  - `RedisQueuedLocks::Acquier::Try.try_to_lock` - detailed successful result analization;
-  - better code stylization and interesting refactorings;
-  - lock queue expiration (dead queue cleanup);
-  - support for `Dragonfly` DB backend;
-  - support for `Garnet` DB backend;
+- Semantic Error objects for unexpected Redis errors;
+- `100%` test coverage;
+- per-block-holding-the-lock sidecar `Ractor` and `in progress queue` in RedisDB that will extend
+  the acquired lock for long-running blocks of code (that invoked "under" the lock
+  whose ttl may expire before the block execution completes);
+- an ability to add custom metadata to the lock and an ability to read this data;
+- lock prioritization;
+- support for LIFO strategy;
+- structured logging;
+- GitHub Actions CI;
+- `RedisQueuedLocks::Acquier::Try.try_to_lock` - detailed successful result analization;
+- better code stylization and interesting refactorings;
+- dead queue cleanup;
+- support for `Dragonfly` DB backend;
+- support for `Garnet` DB backend;
 
 ---
 

data/lib/redis_queued_locks/acquier/acquire_lock/try_to_lock.rb

@@ -2,7 +2,7 @@
 
 # @api private
 # @since 0.1.0
-# rubocop:disable Metrics/ModuleLength
+# rubocop:disable Metrics/ModuleLength, Metrics/BlockNesting
 module RedisQueuedLocks::Acquier::AcquireLock::TryToLock
   # @since 0.1.0
   extend RedisQueuedLocks::Utilities
@@ -41,7 +41,7 @@ module RedisQueuedLocks::Acquier::AcquireLock::TryToLock
     if log_lock_try
       run_non_critical do
         logger.debug(
-          "[redis_queued_locks.try_lock_start] " \
+          "[redis_queued_locks.try_lock.start] " \
           "lock_key => '#{lock_key}' " \
           "acq_id => '#{acquier_id}'"
         )
@@ -53,7 +53,7 @@ module RedisQueuedLocks::Acquier::AcquireLock::TryToLock
       if log_lock_try
         run_non_critical do
           logger.debug(
-            "[redis_queued_locks.try_lock_rconn_fetched] " \
+            "[redis_queued_locks.try_lock.rconn_fetched] " \
             "lock_key => '#{lock_key}' " \
             "acq_id => '#{acquier_id}'"
           )
@@ -69,6 +69,16 @@ module RedisQueuedLocks::Acquier::AcquireLock::TryToLock
           # Step 1: add an acquier to the lock acquirement queue
           res = rconn.call('ZADD', lock_key_queue, 'NX', acquier_position, acquier_id)
 
+          if log_lock_try
+            run_non_critical do
+              logger.debug(
+                "[redis_queued_locks.try_lock.acq_added_to_queue] " \
+                "lock_key => '#{lock_key}' " \
+                "acq_id => '#{acquier_id}'"
+              )
+            end
+          end
+
           RedisQueuedLocks.debug(
             "Step №1: добавление в очередь (#{acquier_id}). [ZADD to the queue: #{res}]"
           )
@@ -81,6 +91,16 @@ module RedisQueuedLocks::Acquier::AcquireLock::TryToLock
             RedisQueuedLocks::Resource.acquier_dead_score(queue_ttl)
           )
 
+          if log_lock_try
+            run_non_critical do
+              logger.debug(
+                "[redis_queued_locks.try_lock.remove_expired_acqs] " \
+                "lock_key => '#{lock_key}' " \
+                "acq_id => '#{acquier_id}'"
+              )
+            end
+          end
+
           RedisQueuedLocks.debug(
             "Step №2: дропаем из очереди просроченных ожидающих. [ZREMRANGE: #{res}]"
           )
@@ -88,6 +108,17 @@ module RedisQueuedLocks::Acquier::AcquireLock::TryToLock
           # Step 3: get the actual acquier waiting in the queue
           waiting_acquier = Array(rconn.call('ZRANGE', lock_key_queue, '0', '0')).first
 
+          if log_lock_try
+            run_non_critical do
+              logger.debug(
+                "[redis_queued_locks.try_lock.get_first_from_queue] " \
+                "lock_key => '#{lock_key}' " \
+                "acq_id => '#{acquier_id}' " \
+                "first_acq_id_in_queue => '#{waiting_acquier}'"
+              )
+            end
+          end
+
           RedisQueuedLocks.debug(
             "Step №3: какой процесс в очереди сейчас ждет. " \
             "[ZRANGE <следующий процесс>: #{waiting_acquier} :: <текущий процесс>: #{acquier_id}]"
@@ -97,6 +128,17 @@ module RedisQueuedLocks::Acquier::AcquireLock::TryToLock
           unless waiting_acquier == acquier_id
             # Step ROLLBACK 1.1: our time hasn't come yet. retry!
 
+            if log_lock_try
+              run_non_critical do
+                logger.debug(
+                  "[redis_queued_locks.try_lock.exit__no_first] " \
+                  "lock_key => '#{lock_key}' " \
+                  "acq_id => '#{acquier_id}' " \
+                  "first_acq_id_in_queue => '#{waiting_acquier}'"
+                )
+              end
+            end
+
             RedisQueuedLocks.debug(
               "Step ROLLBACK №1: не одинаковые ключи. выходим. " \
               "[Ждет: #{waiting_acquier}. А нужен: #{acquier_id}]"
@@ -120,6 +162,18 @@ module RedisQueuedLocks::Acquier::AcquireLock::TryToLock
             if locked_by_acquier
               # Step ROLLBACK 2: required lock is stil acquired. retry!
 
+              if log_lock_try
+                run_non_critical do
+                  logger.debug(
+                    "[redis_queued_locks.try_lock.exit__still_obtained] " \
+                    "lock_key => '#{lock_key}' " \
+                    "acq_id => '#{acquier_id}' " \
+                    "first_acq_id_in_queue => '#{waiting_acquier}' " \
+                    "locked_by_acq_id => '#{locked_by_acquier}'"
+                  )
+                end
+              end
+
               RedisQueuedLocks.debug(
                 "Step ROLLBACK №2: Ключ уже занят. Ничего не делаем. " \
                 "[Занят процессом: #{locked_by_acquier}]"
@@ -153,6 +207,16 @@ module RedisQueuedLocks::Acquier::AcquireLock::TryToLock
 
               # Step 6.3: set the lock expiration time in order to prevent "infinite locks"
               transact.call('PEXPIRE', lock_key, ttl) # NOTE: in milliseconds
+
+              if log_lock_try
+                run_non_critical do
+                  logger.debug(
+                    "[redis_queued_locks.try_lock.run__free_to_acquire] " \
+                    "lock_key => '#{lock_key}' " \
+                    "acq_id => '#{acquier_id}'"
+                  )
+                end
+              end
             end
           end
         end
@@ -210,4 +274,4 @@ module RedisQueuedLocks::Acquier::AcquireLock::TryToLock
     RedisQueuedLocks::Data[ok: true, result: result]
   end
 end
-# rubocop:enable Metrics/ModuleLength
+# rubocop:enable Metrics/ModuleLength, Metrics/BlockNesting

data/lib/redis_queued_locks/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis_queued_locks
 version: !ruby/object:Gem::Version
-  version: 0.0.28
+  version: 0.0.29
 platform: ruby
 authors:
 - Rustam Ibragimov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-21 00:00:00.000000000 Z
+date: 2024-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis-client