redis_queued_locks 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06ddeeb8f9ef0bd0c24742e68e83d10b237f8233ca5183c7f9612e7aebadd874
-  data.tar.gz: df9a7ba009357fc3fa80efc9b5837cec56f10cb9004f54df19e5d08fd06f7f26
+  metadata.gz: 5cac51b8b6c2a4986c188d7b419e11a282c4a18d6a32689000a2c9127f77eec3
+  data.tar.gz: d159e30574e503a714081dfda22d9085553818573ad968f745e302efe93edfde
 SHA512:
-  metadata.gz: 722aff2cb859419913d8f47c6118acaab378db70e49034290043cb1f9c3b4df115d15020d37effe815399d389fb360b68f2692a50537165043eb8a659428b6ba
-  data.tar.gz: ef370212d73abc96b1fed6962e274b616bb9b1ed232576ebee0b1e2e2b98d62cbdbe7dbb113ac32b28e489d4142a3a2f91b7f96be1be6c11d285cb948711bfee
+  metadata.gz: 6ee000a0470297832a593a8719a192feb5fdf583003d49f8dfb3335dad4c63aff45730cc8d4481a02eb41f629e60d929349fcc1842025117bd5b35304a09c8cd
+  data.tar.gz: c7e52ef09012e29a2ac1495fedc287c7a51c5fee8ceac466f78d5de548e8231b7a5c8fc29626db28ca82629ac0294b4ded991cbf5902f97a76619279bed4e353

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [1.3.1] - 2024-05-10
+### Fixed
+- `:meta` attribute type validation of `#lock`/`#lock!` was incorrect;
+### Added
+- documentation updates and clarifications;
+
 ## [1.3.0] - 2024-05-08
 ### Added
 - **Major Feature**: support for **Reentrant Locks**;

data/README.md

@@ -151,7 +151,9 @@ clinet = RedisQueuedLocks::Client.new(redis_client) do |config|
   config.is_timed_by_default = false
 
   # (symbol) (default: :wait_for_lock)
-  # - The conflict strategy mode for cases when the process that obtained the lock want to acquire this lock again;
+  # - Global default conflict strategy mode;
+  # - Can be customized in methods `#lock` and `#lock` via `:conflict_strategy` attribute (see method signatures of #lock and #lock! methods);
+  # - Conflict strategy is a logical behavior for cases when the process that obtained the lock want to acquire this lock again;
   # - Realizes "reentrant locks" abstraction (same process conflict / same process deadlock);
   # - By default uses `:wait_for_lock` strategy (classic way);
   # - Strategies:
@@ -159,7 +161,6 @@ clinet = RedisQueuedLocks::Client.new(redis_client) do |config|
   #   - `:extendable_work_through` - continue working under the lock <with> lock's TTL extension;
   #   - `:wait_for_lock` - (default) - work in classic way (with timeouts, retry delays, retry limits, etc - in classic way :));
   #   - `:dead_locking` - fail with deadlock exception;
-  # - Can be customized in methods via `:conflict_strategy` attribute (see method signatures of #lock and #lock! methods);
   # - See "Dead locks and Reentrant Locks" documentation section in REDME.md for details;
   config.default_conflict_strategy = :wait_for_lock
 
@@ -262,10 +263,14 @@ end
 
 <sup>\[[back to top](#usage)\]</sup>
 
-- If block is passed the obtained lock will be released after the block execution or the lock's ttl (what will happen first);
-- If block is not passed the obtained lock will be released after lock's ttl;
-- If block is passed the block's yield result will be returned;
-- If block is not passed the lock information will be returned;
+- `#lock` - obtain a lock;
+- If block is passed:
+  - the obtained lock will be released after the block execution or the lock's ttl (what will happen first);
+    - if you want to timeout (fail with timeout) the block execution with lock's TTL use `timed: true` option;
+  - the block's result will be returned;
+- If block is not passed:
+  - the obtained lock will be released after lock's ttl;
+  - the lock information will be returned (hash with technical info that contains: lock key, acquier identifier, acquirement timestamp, lock's ttl, type of obtaining process, etc);
 
 ```ruby
 def lock(
@@ -543,10 +548,12 @@ rql.lock("my_lock", queue_ttl: 5, timeout: 10_000, retry_count: nil)
 
 <sup>\[[back to top](#usage)\]</sup>
 
+- `#lock!` - exceptional lock obtaining;
 - fails when (and with):
   - (`RedisQueuedLocks::LockAlreadyObtainedError`) when `fail_fast` is `true` and lock is already obtained;
   - (`RedisQueuedLocks::LockAcquiermentTimeoutError`) `timeout` limit reached before lock is obtained;
   - (`RedisQueuedLocks::LockAcquiermentRetryLimitError`) `retry_count` limit reached before lock is obtained;
+  - (`RedisQueuedLocks::ConflictLockObtainError`) when `conflict_strategy: :dead_locking` is used and the "same-process-dead-lock" is happened (see [Dead locks and Reentrant locks](#dead-locks-and-reentrant-locks) for details);
 
 ```ruby
 def lock!(
@@ -648,7 +655,7 @@ rql.lock_info("your_lock_name")
   # ==> keys for extendable reentarnt locks with `:extendable_work_through` strategy:
   "spc_ext_ttl" => 5_000, # sum of TTL of the each <extendable> reentrant lock (3_000 + 2_000)
   "l_spc_ext_ini_ttl" => 2_000, # TTL of the last <extendable> reentrant lock
-  "l_spc_ext_ts" =>  123456792.12345 # timestamp of the last <extendable> reentrant lock obtaining
+  "l_spc_ext_ts" =>  123456792.12345, # timestamp of the last <extendable> reentrant lock obtaining
   # ==> keys for non-extendable locks with `:work_through` strategy:
   "l_spc_ts" => 123456.789 # timestamp of the last <non-extendable> reentrant lock obtaining
 }
@@ -1073,13 +1080,17 @@ rql.clear_dead_requests(dead_ttl: 60 * 60 * 1000) # 1 hour in milliseconds
 
 <sup>\[[back to top](#table-of-contents)\]</sup>
 
-- **documentation is in progress**
-- (little details for a context of current implementation and feautres):
-  - at this moment we support only **reentrant locks**: they works via customizable conflict strategy behavior;
-  - in non-reentrant conflict cases your lock obtaining process will work in a classic way (some dead lock conflict => work in "wait for lock" style);
+- **this documentation section is in progress**;
+- (little details for a context of the current implementation and feautres):
+  - at this moment we support only **reentrant locks**: they works via customizable conflict strategy behavior
+    (`:wait_for_lock` (default), `:work_through`, `:extendable_work_through`, `:dead_locking`);
+  - by default behavior (`:wait_for_lock`) your lock obtaining process will work in a classic way (limits, retries, etc);
+  - `:work_through`, `:extendable_work_through` works with limits too (timeouts, delays, etc), but the decision of
+    "is your lock are obtained or not" is made as you work with **reentrant locks** (your process continues to use the lock without/without
+    lock's TTL accordingly);
   - for current implementation details check:
-    - (Configuration)[#configuration] documentation: see `config.default_conflict_strategy` config docs;
-    - (#lock)[#lock] method documentation: see `conflict_strategy` attribute docs;
+    - [Configuration](#configuration) documentation: see `config.default_conflict_strategy` config docs;
+    - [#lock](#lock---obtain-a-lock) method documentation: see `conflict_strategy` attribute docs and the method result data;
 
 ---
 

data/lib/redis_queued_locks/acquier/acquire_lock.rb

@@ -94,7 +94,7 @@ module RedisQueuedLocks::Acquier::AcquireLock
     #
     # @api private
     # @since 1.0.0
-    # @version 1.3.0
+    # @version 1.3.1
     def acquire_lock(
       redis,
       lock_name,
@@ -132,7 +132,7 @@ module RedisQueuedLocks::Acquier::AcquireLock
       end
 
       # Step 0.2: prevent :meta incompatabiltiies (structure)
-      if meta == ::Hash && (meta.keys.any? do |key|
+      if meta.is_a?(::Hash) && (meta.keys.any? do |key|
         key == 'acq_id' ||
         key == 'ts' ||
         key == 'ini_ttl' ||

data/lib/redis_queued_locks/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis_queued_locks
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Rustam Ibragimov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-08 00:00:00.000000000 Z
+date: 2024-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis-client
@@ -108,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.1
 signing_key:
 specification_version: 4
 summary: Queued distributed locks based on Redis.