redis_queued_locks 0.0.32 → 0.0.34

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d33fd5af73686a34765eb95c54fe9dc28b107a01768e41b2a28150dffdc72a60
-  data.tar.gz: 0ac04f452fbd00b01df535a48dd724e360ed66f42459e33fbf989427531c6b6a
+  metadata.gz: 62b1870f7a71fb878167216b1f05a90f82c60b8a0da513dfad1edae8a87618a5
+  data.tar.gz: 705c1e47d0f4823e38f749f24e82700ce33d749e187c0ae98ff9bd5ff21aa142
 SHA512:
-  metadata.gz: 419d36772547c3a7010353d6589b62c442cd7e2575a1c96fcf8ebcee9be83c002a44de7a5dc6de8faa6e32c76f044bf5eaf659ddaf156e8eb3093587dab54e90
-  data.tar.gz: 28ba2de724d7d7540d967e9ade24ca6d65126af526224ae90f418c04e58618ff1aa856911d9eef363b004272fda73a0ce5ddf83a52460e4d78f09dabdd9fba3f
+  metadata.gz: cba6bd786d8db210d907bd5af41497aa3f34e026f2ecfb87f53e857f91d2278109c116a91bd767bffa4685c48f6a6d76be6054b93ffaea0e858f0d6a2ed29db1
+  data.tar.gz: 05fa884031b73de440c10442a46d2c328fb118d0e8c7447d241b6d5e2391408affddf964b7ae210038bc40f620009a38537cccbe418c9dc6ea562f7f50b76537

data/CHANGELOG.md

@@ -1,20 +1,30 @@
 ## [Unreleased]
 
+## [0.0.34] - 2024-03-26
+### Changed
+- Removing the acquirer from the request queue during a lock obtaining logic now using more proper and accurate `ZREM` instead of `ZPOPMIN` for this;
+
+## [0.0.33] - 2024-03-26
+### Added
+- Logging: added current lock data info to the detailed `#try_to_lock` log to the cases when lock is still obtained. It is suitable
+  when you pass a custom metadata with lock obtainer (for example: the current string of code) and want to see this information
+  in logs when you can not acquire the concrete lock long time;
+
 ## [0.0.32] - 2024-03-26
 ### Added
 - Support for custom metadata that merged to the lock data. This data also returned from `RedisQueudLocks::Client#lock_info` method;
-  - Custom metadata shou;d be represented as a `key => value` `Hash` data (or `NilClass` instead);
+  - Custom metadata should be represented as a `key => value` `Hash` (`nil` by default);
   - Custom metadata values is returned as raw data from Redis (commonly as strings);
   - Custom metadata can not contain reserved lock data keys;
 - Reduced some memory consuption;
 ### Changed
-- `RedisQueuedLocks::Client#lock_info` - has keys is changed from `Symbol` type to `String` type;
-- `RedisQueuedLocks::Client#queue_info` - hash keys is changed from `Symbol` type to `String` type;
+- `RedisQueuedLocks::Client#lock_info`: hash key types of method result is changed from `Symbol` type to `String` type;
+- `RedisQueuedLocks::Client#queue_info`: hash key types of method result is changed from `Symbol` type to `String` type;
 
 ## [0.0.31] - 2024-03-25
 ### Changed
 - `:metadata` renamed to `:instrument` in order to reflect it's domain area;
-- `:metadata` is renamed to `:meta` and reserved for the future updates;
+- `:metadata` is renamed to `:meta` and reserved for future updates;
 
 ## [0.0.30] - 2024-03-23
 ### Fixed

data/README.md

@@ -108,7 +108,7 @@ clinet = RedisQueuedLocks::Client.new(redis_client) do |config|
   config.default_lock_ttl = 5_000
 
   # (seconds) (default: 15)
-  # - lock request timeout. after this timeout your lock request in queue will be requeued;
+  # - lock request timeout. after this timeout your lock request in queue will be requeued with new position (at the end of the queue);
   config.default_queue_ttl = 15
 
   # (default: 100)
@@ -140,19 +140,27 @@ clinet = RedisQueuedLocks::Client.new(redis_client) do |config|
   # (default: RedisQueuedLocks::Logging::VoidLogger)
   # - the logger object;
   # - should implement `debug(progname = nil, &block)` (minimal requirement) or be an instance of Ruby's `::Logger` class/subclass;
-  # - at this moment the only debug logs are realised in 3 cases:
-  #   - start of lock obtaining: "[redis_queud_locks.start_lock_obtaining] lock_key => 'rql:lock:your_lock' acq_id => 'rql:acq:54307/3620/3640/3540/c1799ede93'"
-  #   - finish of the lock obtaining: "[redis_queued_locks.lock_obtained] lock_key => 'rql:lock:your_lock' acq_id => 'rql:acq:54307/3620/3640/3540/c1799ede93' acq_time => 123.456 (ms)"
-  #   - start of the lock expiration after `yield`: "[redis_queud_locks.expire_lock] lock_key => 'rql:lock:your_lock' acq_id => 'rql:acq:54307/3620/3640/3540/c1799ede93'"
+  # - at this moment the only debug logs are realised in following cases:
+  #   - "[redis_queued_locks.start_lock_obtaining]" (logs "lock_key", "queue_ttl", "acq_id");
+  #   - "[redis_queued_locks.start_try_to_lock_cycle]" (logs "lock_key", "queue_ttl", "acq_id");
+  #   - "[redis_queued_locks.dead_score_reached__reset_acquier_position]" (logs "lock_key", "queue_ttl", "acq_id");
+  #   - "[redis_queued_locks.lock_obtained]" (logs "lockkey", "queue_ttl", "acq_id", "acq_time");
   # - by default uses VoidLogger that does nothing;
   config.logger = RedisQueuedLocks::Logging::VoidLogger
 
   # (default: false)
-  # - should be logged the each internal try-retry lock acquire (a lot of logs can be generated depending on your retry configurations);
-  # - it adds 2 cases to the log in addition to the existing 3:
-  #   - start of a try: "[redis_queud_locks.try_lock_start] lock_key => 'rql:lock:your_lock' acq_id => 'rql:acq:54307/3620/3640/3540/c1799ede93'"
-  #   - redis connection is feteched from the pool after "start of a try": "[redis_queued_locks.try_lock_rconn_fetched] lock_key => 'rql:lock:your_lock' acq_id => 'rql:acq:54307/3620/3640/3540/c1799ede93'"
-  # - if logger is not configured this option does not lead to any effect;
+  # - adds additional debug logs;
+  # - enables additional logs for each internal try-retry lock acquiring (a lot of logs can be generated depending on your retry configurations);
+  # - it adds following logs in addition to the existing:
+  #   - "[redis_queued_locks.try_lock.start]" (logs "lock_key", "queue_ttl", "acq_id");
+  #   - "[redis_queued_locks.try_lock.rconn_fetched]" (logs "lock_key", "queue_ttl", "acq_id");
+  #   - "[redis_queued_locks.try_lock.acq_added_to_queue]" (logs "lock_key", "queue_ttl", "acq_id)";
+  #   - "[redis_queued_locks.try_lock.remove_expired_acqs]" (logs "lock_key", "queue_ttl", "acq_id");
+  #   - "[redis_queued_locks.try_lock.get_first_from_queue]" (logs "lock_key", "queue_ttl", "acq_id", "first_acq_id_in_queue");
+  #   - "[redis_queued_locks.try_lock.exit__queue_ttl_reached]" (logs "lock_key", "queue_ttl", "acq_id");
+  #   - "[redis_queued_locks.try_lock.exit__no_first]" (logs "lock_key", "queue_ttl", "acq_id", "first_acq_id_in_queue", "<current_lock_data>");
+  #   - "[redis_queued_locks.try_lock.exit__still_obtained]" (logs "lock_key", "queue_ttl", "acq_id", "first_acq_id_in_queue", "locked_by_acq_id", "<current_lock_data>");
+  #   - "[redis_queued_locks.try_lock.run__free_to_acquire]" (logs "lock_key", "queue_ttl", "acq_id");
   config.log_lock_try = false
 end
 ```
@@ -321,8 +329,7 @@ See `#lock` method [documentation](#lock---obtain-a-lock).
   - `"ts"` - `integer`/`epoch` - the time lock was obtained;
   - `"init_ttl"` - `integer` - (milliseconds) initial lock key ttl;
   - `"rem_ttl"` - `integer` - (milliseconds) remaining lock key ttl;
-  - custom metadata keys - `String` - custom metadata passed to the `lock`/`lock!`
-    methods via `meta:` keyword argument (see [lock]((#lock---obtain-a-lock)) method documentation);
+  - `custom metadata`- `string`/`integer` - custom metadata passed to the `lock`/`lock!` methods via `meta:` keyword argument (see [lock]((#lock---obtain-a-lock)) method documentation);
 
 ```ruby
 # without custom metadata
@@ -631,16 +638,14 @@ Detalized event semantics and payload structure:
 - `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). It only makes sens for non-`timed` locks
-  (for those locks where otaned with `timed: false` option);
-- an ability to add custom metadata to the lock and an ability to read this data;
+  whose ttl may expire before the block execution completes). It only makes sense for non-`timed` locks;
 - lock prioritization;
 - support for LIFO strategy;
-- structured logging;
+- structured logging (separated docs);
 - GitHub Actions CI;
 - `RedisQueuedLocks::Acquier::Try.try_to_lock` - detailed successful result analization;
 - better code stylization and interesting refactorings;
-- dead queue cleanup;
+- dead queue keys cleanup (empty queues);
 - statistics with UI;
 - support for `Dragonfly` DB backend;
 - support for `Garnet` DB backend;

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

@@ -46,7 +46,7 @@ module RedisQueuedLocks::Acquier::AcquireLock::TryToLock
           "[redis_queued_locks.try_lock.start] " \
           "lock_key => '#{lock_key}' " \
           "queue_ttl => #{queue_ttl} " \
-          "acq_id => '#{acquier_id}' "
+          "acq_id => '#{acquier_id}'"
         )
       end
     end
@@ -64,7 +64,9 @@ module RedisQueuedLocks::Acquier::AcquireLock::TryToLock
         end
       end
 
-      # Step 0: watch the lock key changes (and discard acquirement if lock is already acquired)
+      # Step 0:
+      #   watch the lock key changes (and discard acquirement if lock is already
+      #   obtained by another acquier during the current lock acquiremntt)
       rconn.multi(watch: [lock_key]) do |transact|
         # Fast-Step X0: fail-fast check
         if fail_fast && rconn.call('HGET', lock_key, 'acq_id')
@@ -163,7 +165,8 @@ module RedisQueuedLocks::Acquier::AcquireLock::TryToLock
                   "lock_key => '#{lock_key}' " \
                   "queue_ttl => #{queue_ttl} " \
                   "acq_id => '#{acquier_id}' " \
-                  "first_acq_id_in_queue => '#{waiting_acquier}'"
+                  "first_acq_id_in_queue => '#{waiting_acquier}' " \
+                  "<current_lock_data> => <<#{rconn.call('HGETALL', lock_key).to_h}>>"
                 )
               end
             end
@@ -199,7 +202,8 @@ module RedisQueuedLocks::Acquier::AcquireLock::TryToLock
                     "queue_ttl => #{queue_ttl} " \
                     "acq_id => '#{acquier_id}' " \
                     "first_acq_id_in_queue => '#{waiting_acquier}' " \
-                    "locked_by_acq_id => '#{locked_by_acquier}'"
+                    "locked_by_acq_id => '#{locked_by_acquier}' " \
+                    "<current_lock_data> => <<#{rconn.call('HGETALL', lock_key).to_h}>>"
                   )
                 end
               end
@@ -214,7 +218,7 @@ module RedisQueuedLocks::Acquier::AcquireLock::TryToLock
               # NOTE: required lock is free and ready to be acquired! acquire!
 
               # Step 6.1: remove our acquier from waiting queue
-              transact.call('ZPOPMIN', lock_key_queue, '1')
+              transact.call('ZREM', lock_key_queue, acquier_id)
 
               RedisQueuedLocks.debug(
                 'Step №4: Забираем наш текущий процесс из очереди. [ZPOPMIN]'

data/lib/redis_queued_locks/version.rb

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

metadata

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