redis_queued_locks 1.17.0 → 1.18.0

data/lib/redis_queued_locks/swarm/zombie_info.rb

@@ -83,6 +83,7 @@ module RedisQueuedLocks::Swarm::ZombieInfo
     #
     # @api private
     # @since 1.9.0
+    # @version 1.18.0
     def extract_zombie_locks(rconn, zombie_ttl, lock_scan_size)
       zombie_hosts = extract_zombie_hosts(rconn, zombie_ttl)
       zombie_locks = Set.new
@@ -92,6 +93,10 @@ module RedisQueuedLocks::Swarm::ZombieInfo
         _acquirer_id, host_id = rconn.call('HMGET', lock_key, 'acq_id', 'hst_id')
         zombie_locks << lock_key if zombie_hosts.include?(host_id)
       end
+      # NOTE: (RW) readers registries with zombie read locks
+      each_zombie_read_lock(rconn, zombie_hosts, lock_scan_size) do |lock_readers_key, _acquirer_id|
+        zombie_locks << lock_readers_key
+      end
       zombie_locks
     end
 
@@ -102,6 +107,7 @@ module RedisQueuedLocks::Swarm::ZombieInfo
     #
     # @api private
     # @since 1.9.0
+    # @version 1.18.0
     def extract_zombie_acquirers(rconn, zombie_ttl, lock_scan_size)
       zombie_hosts = extract_zombie_hosts(rconn, zombie_ttl)
       zombie_acquirers = Set.new
@@ -111,6 +117,10 @@ module RedisQueuedLocks::Swarm::ZombieInfo
         acquirer_id, host_id = rconn.call('HMGET', lock_key, 'acq_id', 'hst_id')
         zombie_acquirers << acquirer_id if zombie_hosts.include?(host_id)
       end
+      # NOTE: (RW) zombie read lock acquirers
+      each_zombie_read_lock(rconn, zombie_hosts, lock_scan_size) do |_lock_readers_key, acquirer_id|
+        zombie_acquirers << acquirer_id
+      end
       zombie_acquirers
     end
 
@@ -126,6 +136,7 @@ module RedisQueuedLocks::Swarm::ZombieInfo
     #
     # @api private
     # @since 1.9.0
+    # @version 1.18.0
     def extract_all(rconn, zombie_ttl, lock_scan_size)
       zombie_hosts = extract_zombie_hosts(rconn, zombie_ttl)
       zombie_locks = Set.new
@@ -139,7 +150,38 @@ module RedisQueuedLocks::Swarm::ZombieInfo
           zombie_locks << lock_key
         end
       end
+      # NOTE: (RW) zombie read locks
+      each_zombie_read_lock(rconn, zombie_hosts, lock_scan_size) do |lock_readers_key, acquirer_id|
+        zombie_acquirers << acquirer_id
+        zombie_locks << lock_readers_key
+      end
       { zombie_hosts:, zombie_acquirers:, zombie_locks: }
     end
+
+    # Iterates over read locks of zombie hosts
+    # (read locks store acquirer ids only: the host is a part of the acquirer id).
+    #
+    # @param rconn [RedisClient] redis connection obtained via `#with` from RedisClient instance;
+    # @param zombie_hosts [Set<String>]
+    # @param lock_scan_size [Integer]
+    # @yield [lock_readers_key, acquirer_id]
+    # @yieldparam lock_readers_key [String] Readers registry with a zombie read lock.
+    # @yieldparam acquirer_id [String] Zombie read lock acquirer.
+    # @return [void]
+    #
+    # @api private
+    # @since 1.18.0
+    def each_zombie_read_lock(rconn, zombie_hosts, lock_scan_size)
+      rconn.scan(
+        'MATCH', RedisQueuedLocks::Resource::LOCK_READERS_PATTERN, count: lock_scan_size
+      ) do |lock_readers_key|
+        # @type var read_lock_acquirers: Array[String]
+        read_lock_acquirers = rconn.call('ZRANGE', lock_readers_key, '0', '-1')
+        read_lock_acquirers.each do |acquirer_id|
+          host_id = RedisQueuedLocks::Resource.host_identifier_from_acquirer(acquirer_id)
+          yield(lock_readers_key, acquirer_id) if zombie_hosts.include?(host_id)
+        end
+      end
+    end
   end
 end

data/lib/redis_queued_locks/version.rb

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

data/rbs_collection.lock.yaml

@@ -6,14 +6,22 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: 52a7ef8a9328fb2413e3b42dd8ee37deb703a940
+    revision: c69c75ba79d7c19870f8d0e6fa7fe2c1d356e5ae
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: logger
+  version: '1.7'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: c69c75ba79d7c19870f8d0e6fa7fe2c1d356e5ae
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: monitor
   version: '0'
   source:
     type: stdlib
-- name: monitor
+- name: random-formatter
   version: '0'
   source:
     type: stdlib

data/rbs_collection.yaml

@@ -11,7 +11,5 @@ gems:
   - name: redis-client
   - name: securerandom
   - name: timeout
-  - name: redis-client
-  - name: securerandom
   - name: logger
   - name: monitor

data/sig/redis_queued_locks/acquirer/acquire_lock/dequeue_from_lock_queue/log_visitor.rbs

@@ -12,7 +12,8 @@ module RedisQueuedLocks
             Integer queue_ttl,
             String acquirer_id,
             String host_id,
-            Symbol access_strategy
+            Symbol access_strategy,
+            Symbol rw_mode
           ) -> void
         end
       end

data/sig/redis_queued_locks/acquirer/acquire_lock/dequeue_from_lock_queue.rbs

@@ -12,7 +12,6 @@ module RedisQueuedLocks
           Symbol read_write_mode,
           String lock_key_queue,
           String read_lock_key_queue,
-          String write_lock_key_queue,
           Integer queue_ttl,
           String acquirer_id,
           String host_id,

data/sig/redis_queued_locks/acquirer/acquire_lock/instr_visitor.rbs

@@ -8,6 +8,7 @@ module RedisQueuedLocks
           RQL::instrObj instrumenter,
           bool instr_sampled,
           String lock_key,
+          Symbol rw_mode,
           Integer? ttl,
           String acq_id,
           String hst_id,
@@ -20,6 +21,7 @@ module RedisQueuedLocks
           RQL::instrObj instrumenter,
           bool instr_sampled,
           String lock_key,
+          Symbol rw_mode,
           Integer? ttl,
           String acq_id,
           String hst_id,
@@ -32,6 +34,7 @@ module RedisQueuedLocks
           RQL::instrObj instrumenter,
           bool instr_sampled,
           String lock_key,
+          Symbol rw_mode,
           Integer? ttl,
           String acq_id,
           String hst_id,
@@ -44,6 +47,7 @@ module RedisQueuedLocks
           RQL::instrObj instrumenter,
           bool instr_sampled,
           String lock_key,
+          Symbol rw_mode,
           Integer? ttl,
           String acq_id,
           String hst_id,
@@ -57,6 +61,7 @@ module RedisQueuedLocks
           RQL::instrObj instrumenter,
           bool instr_sampled,
           String lock_key,
+          Symbol rw_mode,
           Integer? ttl,
           String acq_id,
           String hst_id,

data/sig/redis_queued_locks/acquirer/acquire_lock/log_visitor.rbs

@@ -11,7 +11,8 @@ module RedisQueuedLocks
           Integer queue_ttl,
           String acquirer_id,
           String host_id,
-          Symbol access_strategy
+          Symbol access_strategy,
+          Symbol rw_mode
         ) -> void
 
         def self.start_try_to_lock_cycle: (
@@ -21,7 +22,8 @@ module RedisQueuedLocks
           Integer queue_ttl,
           String acquirer_id,
           String host_id,
-          Symbol access_strategy
+          Symbol access_strategy,
+          Symbol rw_mode
         ) -> void
 
         def self.dead_score_reached__reset_acquirer_position: (
@@ -31,7 +33,8 @@ module RedisQueuedLocks
           Integer queue_ttl,
           String acquirer_id,
           String host_id,
-          Symbol access_strategy
+          Symbol access_strategy,
+          Symbol rw_mode
         ) -> void
 
         def self.extendable_reentrant_lock_obtained: (
@@ -42,7 +45,8 @@ module RedisQueuedLocks
           String acquirer_id,
           String host_id,
           Integer|Float acq_time,
-          Symbol access_strategy
+          Symbol access_strategy,
+          Symbol rw_mode
         ) -> void
 
         def self.reentrant_lock_obtained: (
@@ -53,7 +57,8 @@ module RedisQueuedLocks
           String acquirer_id,
           String host_id,
           Integer|Float acq_time,
-          Symbol access_strategy
+          Symbol access_strategy,
+          Symbol rw_mode
         ) -> void
 
         def self.lock_obtained: (
@@ -64,7 +69,8 @@ module RedisQueuedLocks
           String acquirer_id,
           String host_id,
           Integer|Float acq_time,
-          Symbol access_strategy
+          Symbol access_strategy,
+          Symbol rw_mode
         ) -> void
       end
     end

data/sig/redis_queued_locks/acquirer/acquire_lock/try_to_lock/log_visitor.rbs

@@ -13,7 +13,8 @@ module RedisQueuedLocks
             Integer queue_ttl,
             String acquirer_id,
             String host_id,
-            Symbol access_strategy
+            Symbol access_strategy,
+            Symbol rw_mode
           ) -> void
 
           def self.rconn_fetched: (
@@ -24,7 +25,8 @@ module RedisQueuedLocks
             Integer queue_ttl,
             String acquirer_id,
             String host_id,
-            Symbol access_strategy
+            Symbol access_strategy,
+            Symbol rw_mode
           ) -> void
 
           def self.same_process_conflict_detected: (
@@ -35,7 +37,8 @@ module RedisQueuedLocks
             Integer queue_ttl,
             String acquirer_id,
             String host_id,
-            Symbol access_strategy
+            Symbol access_strategy,
+            Symbol rw_mode
           ) -> void
 
           def self.same_process_conflict_analyzed: (
@@ -47,6 +50,7 @@ module RedisQueuedLocks
             String acquirer_id,
             String host_id,
             Symbol access_strategy,
+            Symbol rw_mode,
             Symbol sp_conflict_status
           ) -> void
 
@@ -59,6 +63,7 @@ module RedisQueuedLocks
             String acquirer_id,
             String host_id,
             Symbol access_strategy,
+            Symbol rw_mode,
             Symbol sp_conflict_status,
             Integer? ttl,
             ::Float spc_processed_timestamp
@@ -73,6 +78,7 @@ module RedisQueuedLocks
             String acquirer_id,
             String host_id,
             Symbol access_strategy,
+            Symbol rw_mode,
             Symbol sp_conflict_status,
             ::Float spc_processed_timestamp
           ) -> void
@@ -86,6 +92,21 @@ module RedisQueuedLocks
             String acquirer_id,
             String host_id,
             Symbol access_strategy,
+            Symbol rw_mode,
+            Symbol sp_conflict_status,
+            ::Float spc_processed_timestamp
+          ) -> void
+
+          def self.single_process_lock_conflict__lock_upgrade: (
+            RQL::loggerObj logger,
+            bool log_sampled,
+            bool log_lock_try,
+            String lock_key,
+            Integer queue_ttl,
+            String acquirer_id,
+            String host_id,
+            Symbol access_strategy,
+            Symbol rw_mode,
             Symbol sp_conflict_status,
             ::Float spc_processed_timestamp
           ) -> void
@@ -98,7 +119,8 @@ module RedisQueuedLocks
             Integer queue_ttl,
             String acquirer_id,
             String host_id,
-            Symbol access_strategy
+            Symbol access_strategy,
+            Symbol rw_mode
           ) -> void
 
           def self.remove_expired_acqs: (
@@ -109,7 +131,8 @@ module RedisQueuedLocks
             Integer queue_ttl,
             String acquirer_id,
             String host_id,
-            Symbol access_strategy
+            Symbol access_strategy,
+            Symbol rw_mode
           ) -> void
 
           def self.get_first_from_queue: (
@@ -121,6 +144,7 @@ module RedisQueuedLocks
             String acquirer_id,
             String host_id,
             Symbol access_strategy,
+            Symbol rw_mode,
             String? waiting_acquirer
           ) -> void
 
@@ -132,7 +156,8 @@ module RedisQueuedLocks
             Integer queue_ttl,
             String acquirer_id,
             String host_id,
-            Symbol access_strategy
+            Symbol access_strategy,
+            Symbol rw_mode
           ) -> void
 
           def self.exit__no_first: (
@@ -144,6 +169,7 @@ module RedisQueuedLocks
             String acquirer_id,
             String host_id,
             Symbol access_strategy,
+            Symbol rw_mode,
             String? waiting_acquirer,
             Hash[String,untyped] current_lock_data
           ) -> void
@@ -157,11 +183,51 @@ module RedisQueuedLocks
             String acquirer_id,
             String host_id,
             Symbol access_strategy,
+            Symbol rw_mode,
             String? waiting_acquirer,
             String locked_by_acquirer,
             Hash[String,untyped] current_lock_data
           ) -> void
 
+          def self.exit__write_request_ahead: (
+            RQL::loggerObj logger,
+            bool log_sampled,
+            bool log_lock_try,
+            String lock_key,
+            Integer queue_ttl,
+            String acquirer_id,
+            String host_id,
+            Symbol access_strategy,
+            Symbol rw_mode,
+            String ahead_acquirer
+          ) -> void
+
+          def self.exit__read_request_ahead: (
+            RQL::loggerObj logger,
+            bool log_sampled,
+            bool log_lock_try,
+            String lock_key,
+            Integer queue_ttl,
+            String acquirer_id,
+            String host_id,
+            Symbol access_strategy,
+            Symbol rw_mode,
+            String ahead_acquirer
+          ) -> void
+
+          def self.exit__read_lock_still_obtained: (
+            RQL::loggerObj logger,
+            bool log_sampled,
+            bool log_lock_try,
+            String lock_key,
+            Integer queue_ttl,
+            String acquirer_id,
+            String host_id,
+            Symbol access_strategy,
+            Symbol rw_mode,
+            String? waiting_acquirer
+          ) -> void
+
           def self.obtain__free_to_acquire: (
             RQL::loggerObj logger,
             bool log_sampled,
@@ -170,7 +236,8 @@ module RedisQueuedLocks
             Integer queue_ttl,
             String acquirer_id,
             String host_id,
-            Symbol access_strategy
+            Symbol access_strategy,
+            Symbol rw_mode
           ) -> void
         end
       end

data/sig/redis_queued_locks/acquirer/acquire_lock/try_to_lock.rbs

@@ -17,7 +17,8 @@ module RedisQueuedLocks
         #     acq_id: String,
         #     hst_id: String,
         #     ts: Integer?,
-        #     ttl: Integer?
+        #     ttl: Integer?,
+        #     rw_mode: Symbol
         #   }
         # }
 
@@ -29,7 +30,8 @@ module RedisQueuedLocks
           Symbol read_write_mode,
           String lock_key_queue,
           String read_lock_key_queue,
-          String write_lock_key_queue,
+          String lock_readers_key,
+          String read_lock_key,
           String acquirer_id,
           String host_id,
           Integer|Float acquirer_position,

data/sig/redis_queued_locks/acquirer/acquire_lock/yield_expire.rbs

@@ -11,6 +11,9 @@ module RedisQueuedLocks
           RC::client redis,
           RQL::loggerObj logger,
           String lock_key,
+          String lock_readers_key,
+          String read_lock_key,
+          Symbol rw_mode,
           String acquirer_id,
           String host_id,
           Symbol access_strategy,

data/sig/redis_queued_locks/acquirer/acquire_lock/yield_with_expire/log_visitor.rbs

@@ -12,7 +12,8 @@ module RedisQueuedLocks
             Integer queue_ttl,
             String acquirer_id,
             String host_id,
-            Symbol access_strategy
+            Symbol access_strategy,
+            Symbol rw_mode
           ) -> void
 
           def self.decrease_lock: (
@@ -23,7 +24,8 @@ module RedisQueuedLocks
             Integer queue_ttl,
             String acquirer_id,
             String host_id,
-            Symbol access_strategy
+            Symbol access_strategy,
+            Symbol rw_mode
           ) -> void
         end
       end

data/sig/redis_queued_locks/acquirer/extend_lock_ttl.rbs

@@ -6,11 +6,14 @@ module RedisQueuedLocks
     module ExtendLockTTL
       EXTEND_LOCK_PTTL: String
 
-      type extendResult = { ok: bool, result: Symbol }
+      type extendResult = { ok: bool, result: { extended_locks_count: Integer } | Symbol }
       def self.extend_lock_ttl: (
         RC::client redis_client,
         String lock_name,
         Integer milliseconds,
+        Symbol read_write_mode,
+        bool all_read_locks,
+        String acquirer_id,
         RQL::loggerObj logger,
         RQL::instrObj instrumenter,
         untyped? instrument,
@@ -23,6 +26,21 @@ module RedisQueuedLocks
         RQL::Instrument::samplerObj instr_sampler,
         bool instr_sample_this
       ) -> extendResult
+
+      private def self.extend_read_lock_ttl: (
+        RC::client redis_client,
+        String lock_name,
+        String lock_key,
+        String acquirer_id,
+        Integer milliseconds
+      ) -> extendResult
+
+      private def self.extend_all_read_locks_ttl: (
+        RC::client redis_client,
+        String lock_name,
+        String lock_key,
+        Integer milliseconds
+      ) -> extendResult
     end
   end
 end

data/sig/redis_queued_locks/acquirer/lock_info.rbs

@@ -3,8 +3,16 @@ use RedisClient as RC
 module RedisQueuedLocks
   module Acquirer
     module LockInfo
-      type lockInfo = Hash[String,String|Float|Integer]
+      type readerInfo = Hash[String,String|Float|Integer|nil]
+      type lockInfo = Hash[String,String|Float|Integer|Array[readerInfo]]
       def self.lock_info: (RC::client redis_client, String lock_name) -> lockInfo?
+      private def self.read_lock_info: (
+        RC::client redis_client,
+        String lock_name,
+        String lock_key,
+        Array[String] redis_time,
+        Array[[String, Float]] read_locks
+      ) -> lockInfo?
     end
   end
 end

data/sig/redis_queued_locks/acquirer/locks.rbs

@@ -3,14 +3,23 @@ use RedisClient as RC
 module RedisQueuedLocks
   module Acquirer
     module Locks
+      type readerInfo = Hash[String,String|Float|Integer|nil]
+      type lockInfo = Hash[String,String|Float|Integer|Array[readerInfo]]
       type lockList = Set[String]
-      type locksInfo = Set[{ lock: String, status: Symbol, info: Hash[String,String|Float|Integer] }]
+      type locksInfo = Set[{ lock: String, status: Symbol, info: lockInfo }]
       type locks = lockList | locksInfo
 
       def self.locks: (RC::client redis_client, scan_size: Integer, with_info: bool) -> locks
 
       private def self.scan_locks: (RC::client redis_client, Integer scan_size) -> lockList
       private def self.extract_locks_info: (RC::client redis_client, Set[::String] lock_keys) -> locksInfo
+      private def self.read_lock_info: (
+        RC::client redis_client,
+        String lock_name,
+        String lock_key,
+        Array[String] redis_time,
+        Array[[String, Float]] read_locks
+      ) -> lockInfo?
     end
   end
 end

data/sig/redis_queued_locks/acquirer/queue_info.rbs

@@ -3,10 +3,8 @@ use RedisClient as RC
 module RedisQueuedLocks
   module Acquirer
     module QueueInfo
-      type queueInfo = {
-        'lock_queue' => String,
-        'queue' => Array[{ 'acq_id' => String, 'score' => Integer|Float }]
-      }
+      type queueRequest = Hash[String,String|Integer|Float]
+      type queueInfo = Hash[String,String|Array[queueRequest]]
       def self.queue_info: (RC::client redis_client, String lock_name) -> queueInfo?
     end
   end

data/sig/redis_queued_locks/acquirer/queues.rbs

@@ -4,7 +4,7 @@ module RedisQueuedLocks
   module Acquirer
     module Queues
       type queueList = Set[String]
-      type queuesInfo = Set[{ queue: String, requests: Array[Hash[String,Float]] }]
+      type queuesInfo = Set[{ queue: String, requests: Array[Hash[String,String|Float]] }]
       type queues = queueList | queuesInfo
 
       def self.queues: (RC::client redis_client, scan_size: Integer, with_info: bool) -> queues

data/sig/redis_queued_locks/acquirer/release_lock.rbs

@@ -32,7 +32,14 @@ module RedisQueuedLocks
       ) -> releaseResult
 
       type fullReleaseResult = { ok: bool, result: { queue: Symbol, lock: Symbol } }
-      private def self.fully_release_lock: (RC::client redis, String lock_key, String lock_key_queue) -> fullReleaseResult
+      private def self.fully_release_lock: (
+        RC::client redis,
+        String lock_name,
+        String lock_key,
+        String lock_key_queue,
+        String read_lock_key_queue,
+        String lock_readers_key
+      ) -> fullReleaseResult
     end
   end
 end

data/sig/redis_queued_locks/acquirer/release_read_lock.rbs

@@ -0,0 +1,44 @@
+use RedisQueuedLocks as RQL
+use RedisClient as RC
+
+module RedisQueuedLocks
+  module Acquirer
+    module ReleaseReadLock
+      extend RQL::Utilities
+
+      type releaseResult = {
+        ok: bool,
+        result: {
+          rel_time: Integer|Float,
+          rel_key: String,
+          rel_acq_id: String,
+          lock_res: Symbol
+        }
+      }
+      def self.release_read_lock: (
+        RC::client redis,
+        String lock_name,
+        String acquirer_id,
+        RQL::instrObj instrumenter,
+        RQL::loggerObj logger,
+        untyped? instrument,
+        bool log_sampling_enabled,
+        Integer log_sampling_percent,
+        RQL::Logging::samplerObj log_sampler,
+        bool log_sample_this,
+        bool instr_sampling_enabled,
+        Integer instr_sampling_percent,
+        RQL::Instrument::samplerObj instr_sampler,
+        bool instr_sample_this
+      ) -> releaseResult
+
+      type fullReleaseResult = { ok: bool, result: { lock: Symbol } }
+      private def self.fully_release_read_lock: (
+        RC::client redis,
+        String lock_readers_key,
+        String read_lock_key,
+        String acquirer_id
+      ) -> fullReleaseResult
+    end
+  end
+end