redis_queued_locks 1.16.2 → 1.18.0

data/lib/redis_queued_locks/swarm/swarm_element/threaded.rb

@@ -125,20 +125,16 @@ class RedisQueuedLocks::Swarm::SwarmElement::Threaded
   #
   # @api private
   # @since 1.9.0
-  # rubocop:disable Style/RedundantBegin
+  # @version 1.17.0
   def status
     sync.synchronize do
       thread_running = swarmed__alive?
       thread_state = swarmed? ? thread_state(swarm_element) : 'non_initialized' # steep:ignore
 
       main_loop_running = swarmed__running?
-      main_loop_state = begin
-        if main_loop_running
-          swarm_loop__status[:result][:main_loop][:state] # steep:ignore
-        else
-          'non_initialized'
-        end
-      end
+      # NOTE: `nil` when the element is not alive (or has been terminated during the request);
+      loop_status = swarm_loop__status if main_loop_running
+      main_loop_state = loop_status ? loop_status[:state] : 'non_initialized'
 
       {
         enabled: enabled?,
@@ -153,7 +149,6 @@ class RedisQueuedLocks::Swarm::SwarmElement::Threaded
       }
     end
   end
-  # rubocop:enable Style/RedundantBegin
 
   private
 
@@ -169,7 +164,7 @@ class RedisQueuedLocks::Swarm::SwarmElement::Threaded
   #
   # @api private
   # @since 1.9.0
-  # rubocop:disable Metrics/MethodLength
+  # @version 1.17.0
   def swarm!
     # NOTE: kill the main loop at start to prevent any async-thread-race-based memory leaks;
     main_loop&.kill
@@ -187,42 +182,37 @@ class RedisQueuedLocks::Swarm::SwarmElement::Threaded
           main_loop_alive = main_loop != nil && main_loop.alive?
           # steep:ignore:end
 
-          # steep:ignore:start
           main_loop_state = (main_loop == nil) ? 'non_initialized' : thread_state(main_loop)
-          # steep:ignore:end
 
           # steep:ignore:start
-          swarm_element_results.push({
-            ok: true,
-            result: { main_loop: { alive: main_loop_alive, state: main_loop_state } }
-          })
+          swarm_element_results.push({ alive: main_loop_alive, state: main_loop_state })
           # steep:ignore:end
         when :is_active
-          is_active = main_loop != nil && main_loop.alive? # steep:ignore
-          swarm_element_results.push({ ok: true, result: { is_active: } }) # steep:ignore
+          swarm_element_results.push(main_loop != nil && main_loop.alive?) # steep:ignore
         when :start
           main_loop&.kill
           @main_loop = spawn_main_loop!.tap { |thread| thread.abort_on_exception = false }
-          swarm_element_results.push({ ok: true, result: nil }) # steep:ignore
+          swarm_element_results.push(true) # steep:ignore
         when :stop
           main_loop&.kill
-          swarm_element_results.push({ ok: true, result: nil }) # steep:ignore
+          swarm_element_results.push(true) # steep:ignore
         end
       end
     end
   end
-  # rubocop:enable Metrics/MethodLength
 
   # @return [Thread] Thread with #abort_onexception == false that wraps loop'ed logic;
   #
   # @api private
   # @since 1.9.0
-  def spawn_main_loop! # steep:ignore
+  # @version 1.17.0
+  def spawn_main_loop!
     # NOTE:
     #   - provide the swarm element looped logic here wrapped into the thread;
     #   - created thread will be reconfigured inside the swarm_element logic with a
     #     `abort_on_exception = false` (cuz the stauts of the thread is
     #     totally controlled by the @swarm_element's logic);
+    raise NotImplementedError, "#{self.class}#spawn_main_loop! is not implemented"
   end
 
   # @return [Boolean]
@@ -261,10 +251,9 @@ class RedisQueuedLocks::Swarm::SwarmElement::Threaded
   #
   # @api private
   # @since 1.9.0
+  # @version 1.17.0
   def swarmed__running?
-    swarmed__alive? && !terminating? && (swarm_loop__is_active.yield_self do |result|
-      result != nil && result[:ok] && result[:result][:is_active] # steep:ignore
-    end)
+    swarmed__alive? && !terminating? && swarm_loop__is_active == true
   end
 
   # @return [Boolean,NilClass]
@@ -284,57 +273,66 @@ class RedisQueuedLocks::Swarm::SwarmElement::Threaded
   #
   # @api private
   # @since 1.9.0
+  # @version 1.17.0
   def swarmed__stopped?
-    swarmed__alive? && (terminating? || !(swarm_loop__is_active.yield_self do |result|
-      result && result[:ok] && result[:result][:is_active] # steep:ignore
-    end))
+    # NOTE: `nil` (no answer) is treated as "not active";
+    swarmed__alive? && (terminating? || swarm_loop__is_active != true)
   end
 
-  # @return [Boolean,NilClass]
+  # @return [Boolean,NilClass] Is the main loop alive (`nil` when the element is not available).
   #
   # @api private
   # @since 1.9.0
+  # @version 1.17.0
   def swarm_loop__is_active
-    return if idle? || swarmed__dead? || terminating?
-    sync.synchronize do
-      swarm_element_commands.push(:is_active) # steep:ignore
-      swarm_element_results.pop # steep:ignore
-    end
+    swarm_loop__send_command(:is_active) #: bool?
   end
 
-  # @return [Hash,NilClass]
+  # @return [Hash<Symbol,Boolean|String>,NilClass]
+  #   Format: `{ alive: <Boolean>, state: <String> }` (`nil` when the element is not available).
   #
   # @api private
   # @since 1.9.0
+  # @version 1.17.0
   def swarm_loop__status
-    return if idle? || swarmed__dead? || terminating?
-    sync.synchronize do
-      swarm_element_commands.push(:status) # steep:ignore
-      swarm_element_results.pop # steep:ignore
-    end
+    swarm_loop__send_command(:status) #: swarmLoopStatus?
   end
 
   # @return [void]
   #
   # @api private
   # @since 1.9.0
+  # @version 1.17.0
   def swarm_loop__start
-    return if idle? || swarmed__dead? || terminating?
-    sync.synchronize do
-      swarm_element_commands.push(:start) # steep:ignore
-      swarm_element_results.pop # steep:ignore
-    end
+    swarm_loop__send_command(:start)
   end
 
   # @return [void]
   #
   # @api private
   # @since 1.9.0
+  # @version 1.17.0
   def swarm_loop__stop
+    swarm_loop__send_command(:stop)
+  end
+
+  # Sends the command to the control thread and waits for its reply. Replies are received
+  # strictly one by one under the lock, so each reply belongs to the sent command.
+  #
+  # @param command [Symbol]
+  # @return [Boolean,Hash<Symbol,Boolean|String>,NilClass]
+  #   The bare reply value (see #swarm!) or `nil` if the element is not available.
+  #
+  # @api private
+  # @since 1.17.0
+  def swarm_loop__send_command(command)
     return if idle? || swarmed__dead? || terminating?
     sync.synchronize do
-      swarm_element_commands.push(:stop) # steep:ignore
-      swarm_element_results.pop # steep:ignore
+      commands = swarm_element_commands
+      results = swarm_element_results
+      next if commands == nil || results == nil
+      commands.push(command)
+      results.pop
     end
   end
 

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

@@ -5,6 +5,6 @@ module RedisQueuedLocks
   #
   # @api public
   # @since 0.0.1
-  # @version 1.16.2
-  VERSION = '1.16.2'
+  # @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/redis_queued_locks.gemspec

@@ -3,7 +3,7 @@
 require_relative 'lib/redis_queued_locks/version'
 
 Gem::Specification.new do |spec|
-  spec.required_ruby_version = '>= 3.3'
+  spec.required_ruby_version = '>= 4.0'
 
   spec.name = 'redis_queued_locks'
   spec.version = RedisQueuedLocks::VERSION

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