redis_queued_locks 0.0.33 → 0.0.35

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43854a2842911dcf40e95329b2631bc6c76cdaff0cd204fb57eff55c0ee461aa
-  data.tar.gz: c361d55a71ac4c71d307fca4a7182069d055e302ec7b65274bcbc1a4ede6f768
+  metadata.gz: 8e16184437150045fd98daf2ab2aaa328e0e7b0bae2a3bb513db25ea7eb535d6
+  data.tar.gz: 1965028261e953591dc707baea43801ed0ec506a85bd4de67c0a4e17cda52820
 SHA512:
-  metadata.gz: 6887f12891fce49f878427b501980695872e304c1429331d23b251d2f66f2db1f07a0994952f0b4ad6d9ec9b81ea769eaefe09ab1bef0c1abcadc9770ef38344
-  data.tar.gz: aa2f6d2cfbe72dd6bf5c637f5538ce1df7c8415579505f765b3016a4c243abc52cd1db246f51abba7efa51abef123d577e26bfee992a5484208cb1416ca00f50
+  metadata.gz: e0cff23e13e47de8bd207597c65e0e036bbf971caad6dbd062628ca8e1975467d52834cc83787a5b4f41b3b88310eb88fe17aba93b2776687d0e5af9913d44b4
+  data.tar.gz: a963e804304ff4884669244f07a41061c7cc7ed56ad72f702bc41a42e7e4f8985d4f8b27d330a62afdce652123343cddae390a75d8bd8cdbab354ac54f4dd118

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.0.35] - 2024-03-26
+### Changed
+- The random unique client instance identifier now uses 16-byte strings instead of 10-btes in order to prevent potential collisions;
+
+## [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
@@ -9,18 +17,18 @@
 ## [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)
@@ -161,7 +161,6 @@ clinet = RedisQueuedLocks::Client.new(redis_client) do |config|
   #   - "[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");
-  # - if logger is not configured this option does not lead to any effect;
   config.log_lock_try = false
 end
 ```
@@ -330,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
@@ -640,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

@@ -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')
@@ -216,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/resource.rb

@@ -22,7 +22,7 @@ module RedisQueuedLocks::Resource
   LOCK_QUEUE_PATTERN = 'rql:lock_queue:*'
 
   class << self
-    # Returns 10-byte unique identifier. It is used for uniquely
+    # Returns 16-byte unique identifier. It is used for uniquely
     # identify current process between different nodes/pods of your application
     # during the lock obtaining and self-identifying in the lock queue.
     #
@@ -31,7 +31,7 @@ module RedisQueuedLocks::Resource
     # @api private
     # @since 0.1.0
     def calc_uniq_identity
-      SecureRandom.hex(5)
+      SecureRandom.hex(8)
     end
 
     # @param process_id [Integer,String]

data/lib/redis_queued_locks/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis_queued_locks
 version: !ruby/object:Gem::Version
-  version: 0.0.33
+  version: 0.0.35
 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