redis_queued_locks 0.0.36 → 0.0.38

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32c3b5078ec27e7203f41fc7537a75b336d5ff25c5f6a62b27c767daf16c912f
-  data.tar.gz: a2ebddba52834ff1bbbbd04570f8573185f3529b3afa9c88bb7b349a3fcaf1d2
+  metadata.gz: 863e2fffb431d3db21fa7aa88b6238d072475c863f4927e7277d2fb052cb7af1
+  data.tar.gz: c5a67c1f2f44cbc1269d5f01600738ab193fefcdab1f5d072ead8fd2d7260b13
 SHA512:
-  metadata.gz: fa8f84f8059e55209c5ec354705d6ecf3dbf4a461b3971dd300ae67301e5e4063ba5382548074279a5603226fed90e72c84b8be014b15277bbd154668236e146
-  data.tar.gz: e2b05110dfeedbdc9d58495eaa9133156615dabe314c5f1f5226036b379f457d74998791ff60b7e91fdca7095c6f22c09f8b585f3aa0f0a71123b428b836a754
+  metadata.gz: 88cea7bce9a2522eea4a8af5a3c749874508595ec1d7f6df3af20fc8b15b2e7238a1dbaa8ccbee2414c42ac1a2eccc8daf5fb5a73aabd21c0517b97f3472f43b
+  data.tar.gz: 86a4a86b8928b0cccc0b4db94a38ee86e52a0cc5929a55db96e38fcfa9c8ac596e05df0ea7709465d561b2322165d333a996f7bd3f5ebff3bb32b43bfd5c7f4f

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.0.38] - 2024-03-28
+### Changed
+- Minor update (dropped useless constant);
+
+## [0.0.37] - 2024-03-28
+### Changed
+- `#queues_info`: `:contains` is renamed to `:reqeusts` in order to reflect it's domain area;
+
 ## [0.0.36] - 2024-03-28
 ### Added
 - Requirements:

data/README.md

@@ -595,7 +595,9 @@ rql.keys # or rql.keys(scan_size: 123)
 - returns `Set<Hash<Symbol,Any>>` (see [#lock_info](#lock_info) and examples below for details).
   - contained data: `{ lock: String, status: Symbol, info: Hash<String,Any> }`;
   - `:lock` - `String` - lock key in Redis;
-  - `:status` - `Symbol`- `:released` or `:alive`. The lock may become relased durign the lock info extractio process;
+  - `:status` - `Symbol`- `:released` or `:alive`
+    - the lock may become relased durign the lock info extraction process;
+    - `:info` for `:released` keys is empty (`{}`);
   - `:info` - `Hash<String,Any>` - lock data stored in the lock key in Redis. See [#lock_info](#lock_info) for details;
 
 ```ruby
@@ -612,11 +614,8 @@ rql.locks_info # or rql.locks_info(scan_size: 123)
     "rem_ttl"=>13998}},
   {:lock=>"rql:lock:some-lock-456",
    :status=>:released,
-   :info=>{
-    "acq_id"=>"rql:acq:41478/4500/4520/4360/848818f09d8c3420",
-    "ts"=>1711607112.67106,
-    "ini_ttl"=>15000,
-    "rem_ttl"=>13999}}}>
+   :info=>{},
+  ...}>
 ```
 
 ---
@@ -626,24 +625,25 @@ rql.locks_info # or rql.locks_info(scan_size: 123)
 - uses redis `SCAN` under the hod;
 - accepts `scan_size:`/`Integer` option (`config[:key_extraction_batch_size]` by default);
 - returns `Set<Hash<Symbol,Any>>` (see [#queue_info](#queue_info) and examples below for details).
-  - contained data: `{ queue: String, contains: Array<Hash<String,Any>> }`
+  - contained data: `{ queue: String, requests: Array<Hash<String,Any>> }`
   - `:queue` - `String` - lock key queue in Redis;
-  - `:contains` - `Array<Hash<String,Any>>` - lock requests in the que with their acquier id and score.
+  - `:requests` - `Array<Hash<String,Any>>` - lock requests in the que with their acquier id and score.
 
 ```ruby
 rql.queues_info # or rql.qeuues_info(scan_size: 123)
 
 => #<Set:
  {{:queue=>"rql:lock_queue:some-lock-123",
-   :contains=>
+   :requests=>
     [{"acq_id"=>"rql:acq:38529/4500/4520/4360/66093702f24a3129", "score"=>1711606640.540842},
      {"acq_id"=>"rql:acq:38529/4580/4600/4360/66093702f24a3129", "score"=>1711606640.540906},
      {"acq_id"=>"rql:acq:38529/4620/4640/4360/66093702f24a3129", "score"=>1711606640.5409632}]},
   {:queue=>"rql:lock_queue:some-lock-456",
-   :contains=>
+   :requests=>
     [{"acq_id"=>"rql:acq:38529/4380/4400/4360/66093702f24a3129", "score"=>1711606640.540722},
      {"acq_id"=>"rql:acq:38529/4420/4440/4360/66093702f24a3129", "score"=>1711606640.5407748},
-     {"acq_id"=>"rql:acq:38529/4460/4480/4360/66093702f24a3129", "score"=>1711606640.540808}]}}>
+     {"acq_id"=>"rql:acq:38529/4460/4480/4360/66093702f24a3129", "score"=>1711606640.540808}]},
+  ...}>
 ```
 
 ---
@@ -686,7 +686,7 @@ Detalized event semantics and payload structure:
     - `:lock_key` - `string` - lock name;
     - `:ts` - `integer`/`epoch` - the time when the lock was obtaiend;
     - `:acq_time` - `float`/`milliseconds` - time spent on lock acquiring;
-    - `:meta` - `nil`/`Any` - custom metadata passed to the `lock`/`lock!` method;
+    - `:instrument` - `nil`/`Any` - custom data passed to the `lock`/`lock!` method as `:instrument` attribute;
 - `"redis_queued_locks.lock_hold_and_release"`
   - an event signalizes about the "hold+and+release" process
     when the lock obtained and hold by the block of logic;
@@ -697,7 +697,7 @@ Detalized event semantics and payload structure:
     - `:lock_key` - `string` - lock name;
     - `:ts` - `integer`/`epoch` - the time when lock was obtained;
     - `:acq_time` - `float`/`milliseconds` - time spent on lock acquiring;
-    - `:meta` - `nil`/`Any` - custom metadata passed to the `lock`/`lock!` method;
+    - `:instrument` - `nil`/`Any` - custom data passed to the `lock`/`lock!` method as `:instrument` attribute;
 - `"redis_queued_locks.explicit_lock_release"`
   - an event signalizes about the explicit lock release (invoked via `RedisQueuedLock#unlock`);
   - payload:

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

@@ -279,7 +279,8 @@ module RedisQueuedLocks::Acquier::AcquireLock::TryToLock
       #   => (*) at this moment we accept that all comamnds are completed successfully;
       #   => (!) need to analyze:
       #   1. zrem shoud return ? (?)
-      #   2. hset should return 3 as minimum (lock key is added to the redis as a hashmap with 3 fields as minimum)
+      #   2. hset should return 3 as minimum
+      #      (lock key is added to the redis as a hashmap with 3 fields as minimum)
       #   3. pexpire should return 1 (expiration time is successfully applied)
 
       # Step 7.d: locked! :) let's go! => successfully acquired

data/lib/redis_queued_locks/acquier/locks.rb

@@ -3,12 +3,6 @@
 # @api private
 # @since 0.1.0
 module RedisQueuedLocks::Acquier::Locks
-  # @return [Hash]
-  #
-  # @api private
-  # @since 0.1.0
-  NO_LOCK_INFO = {}.freeze
-
   class << self
     # @param redis_client [RedisClient]
     # @option scan_size [Integer]

data/lib/redis_queued_locks/acquier/queues.rb

@@ -67,7 +67,7 @@ module RedisQueuedLocks::Acquier::Queues
           # Step 3: push the lock queue info to the result store
           seeded_queues << {
             queue: lock_queue,
-            contains: queue_info
+            requests: queue_info
           }
         end
       end

data/lib/redis_queued_locks/client.rb

@@ -322,7 +322,7 @@ class RedisQueuedLocks::Client
   #   Possible options:
   #   - `true` => returns a set of hashes that represents the queue state: <queue:, containing:>
   #     - :queue (String) - the lock queue key in Redis database;
-  #     - :contains (Array<Hash<String,Any>>) - queue state in redis. see #queue_info for details;
+  #     - :requests (Array<Hash<String,Any>>) - queue state in redis. see #queue_info for details;
   #   - `false` => returns a set of strings that represents an active queues
   #     at the moment of Redis'es SCAN;
   # @return [Set<String>,String<Hash<Symbol,Any>>]

data/lib/redis_queued_locks/version.rb

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

metadata

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