redis_queued_locks 0.0.9 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 463b0613174c7a3806aef19ce962bbe5ed91d342796bec84ea47b2aa79cf61fb
-  data.tar.gz: 4d483db40896d77049e3e6d324a206606225c9c8e8b592072b1f501563fb7ec8
+  metadata.gz: 98c4154b27f6f87e29870ca00e4372d70243dcb528311030a7715de138cb2039
+  data.tar.gz: 0b7fe57e396bb7f13932417e963a5a53f530255db525dcf3d261d41e08a8396a
 SHA512:
-  metadata.gz: f829f8afc264f8a44d0edd1469c5ada76c7257f15ef6945c3f154fe2908b29d5ace4ce0c11365a30af1cdbb6d3b4aeec30227b84500da65b720f22247ed96053
-  data.tar.gz: 1eee0e4c2a665b57ee6d2c2c2d6488c065bbcdd586cfe06f2890a6b412a3a009675dd26e39383f2fad54434288d4c3c7660fba2faaa3013da98ab27c484b08b0
+  metadata.gz: 7a441b4848cb2471f694dc8f7f17e6471bf5f7957a5e37eadcdd0da23a4b0d50e3183575530fc764d5e262eea0898699b584393674a994411c7bd6ec18e02a81
+  data.tar.gz: 362ffaf848de14c6e42f79822a2e41a39f02b88aad8d5abb1ed79df235ffbb2dc7c42063bb6bee2aab5b9b7fc2d836498446734ee64b8d31001445ca3430e6f9

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.0.11] - 2024-02-27
+### Changed
+- Minor documentation updates;
+
+## [0.0.10] - 2024-02-27
+### Changed
+- Minor documentation updates;
+
 ## [0.0.9] - 2024-02-27
 ### Changed
 - The lock acquier identifier (`acq_id`) now includes the fiber id, the ractor id and an unique per-process

data/README.md

@@ -60,7 +60,7 @@ require 'redis_queued_locks'
 require 'redis_queued_locks'
 
 # Step 1: initialize RedisClient instance
-redis_clinet = RedisClient.config.new_pool # NOTE: provide your own RedisClient instance
+redis_client = RedisClient.config.new_pool # NOTE: provide your own RedisClient instance
 
 # Step 2: initialize RedisQueuedLock::Client instance
 rq_lock_client = RedisQueuedLocks::Client.new(redis_client) do |config|
@@ -125,6 +125,7 @@ clinet = RedisQueuedLocks::Client.new(redis_client) do |config|
   # - prevents potential lock-acquirement collisions bettween different process/pods
   #   that have identical process_id/thread_id/fiber_id/ractor_id (identivcal acquier ids);
   # - it is calculated once per `RedisQueudLocks::Client` instance;
+  # - expects the proc object;
   config.uniq_identifier = -> { RedisQueuedLocks::Resource.calc_uniq_identity }
 end
 ```
@@ -146,6 +147,10 @@ end
 
 #### #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 block is not passed the obtained lock will be released after lock's ttl;
+
+
 ```ruby
 def lock(
   lock_name,
@@ -198,7 +203,7 @@ Return value:
     ok: true,
     result: {
       lock_key: String, # acquierd lock key ("rql:lock:your_lock_name")
-      acq_id: String, # acquier identifier ("your_process_id/your_thread_id")
+      acq_id: String, # acquier identifier ("process_id/thread_id/fiber_id/ractor_id/identity")
       ts: Integer, # time (epoch) when lock was obtained (integer)
       ttl: Integer # lock's time to live in milliseconds (integer)
     }
@@ -243,7 +248,7 @@ See `#lock` method [documentation](#lock---obtain-a-lock).
 - returns `nil` if lock does not exist;
 - lock data (`Hash<Symbol,String|Integer>`):
   - `lock_key` - `string` - lock key in redis;
-  - `acq_id` - `string` - acquier identifier (process_id/thread_id/fiber_id/ractor_id/identity by default);
+  - `acq_id` - `string` - acquier identifier (process_id/thread_id/fiber_id/ractor_id/identity);
   - `ts` - `integer`/`epoch` - the time lock was obtained;
   - `init_ttl` - `integer` - (milliseconds) initial lock key ttl;
   - `rem_ttl` - `integer` - (milliseconds) remaining lock key ttl;
@@ -254,7 +259,7 @@ rql.lock_info("your_lock_name")
 # =>
 {
   lock_key: "rql:lock:your_lock_name",
-  acq_id: "rql:acq:123/456",
+  acq_id: "rql:acq:123/456/567/678/374dd74324",
   ts: 123456789,
   ini_ttl: 123456789,
   rem_ttl: 123456789
@@ -429,7 +434,7 @@ Detalized event semantics and payload structure:
   - payload:
     - `rel_time` - `float`/`milliseconds` - time spent on "realese all locks" operation;
     - `at` - `integer`/`epoch` - the time when the operation has ended;
-    - `rel_keys` - `integer` - released redis keys count (`released queu keys` + `released lock keys`);
+    - `rel_keys` - `integer` - released redis keys count (`released queue keys` + `released lock keys`);
 
 ---
 
@@ -438,6 +443,7 @@ Detalized event semantics and payload structure:
 - **Major**
   - Semantic Error objects for unexpected Redis errors;
   - `100%` test coverage;
+  - sidecar `Ractor` object and `in progress queue` in RedisDB that will extend an acquired lock for long-running blocks of code (that invoked "under" the lock);
 - **Minor**
   - `RedisQueuedLocks::Acquier::Try.try_to_lock` - detailed successful result analization;
   - better code stylization and interesting refactorings;

data/lib/redis_queued_locks/acquier.rb

@@ -403,6 +403,17 @@ module RedisQueuedLocks::Acquier
       end
     end
 
+    # @param redis_client [RedisClient]
+    # @param lock_name [String]
+    # @param milliseconds [Integer]
+    # @return [?]
+    #
+    # @api private
+    # @since 0.1.0
+    def extend_lock_ttl(redis_client, lock_name, milliseconds)
+
+    end
+
     private
 
     # @param timeout [NilClass,Integer]

data/lib/redis_queued_locks/client.rb

@@ -196,6 +196,16 @@ class RedisQueuedLocks::Client
     RedisQueuedLocks::Acquier.queue_info(redis_client, lock_name)
   end
 
+  # @param lock_name [String]
+  # @param milliseconds [Integer] How many milliseconds should be added.
+  # @return [?]
+  #
+  # @api public
+  # @since 0.1.0
+  def extend_lock_ttl(lock_name, milliseconds)
+    RedisQueuedLocks::Acquier.extend_lock_ttl(redis_client, lock_name)
+  end
+
   # @option batch_size [Integer]
   # @return [Hash<Symbol,Any>] Format: { ok: true/false, result: Symbol/Hash }.
   #

data/lib/redis_queued_locks/version.rb

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

metadata

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