redis_queued_locks 1.20.0 → 1.22.0

data/lib/redis_queued_locks/swarm.rb

@@ -2,6 +2,7 @@
 
 # @api public
 # @since 1.9.0
+# @version 1.13.0
 # rubocop:disable Metrics/ClassLength
 class RedisQueuedLocks::Swarm
   require_relative 'swarm/redis_client_builder'
@@ -76,7 +77,16 @@ class RedisQueuedLocks::Swarm
   #
   # @api public
   # @since 1.9.0
+  # @version 1.21.0
   def swarm_info(zombie_ttl: rql_client.config['swarm.flush_zombies.zombie_ttl'])
+    # NOTE: (arguments) the same ranges as the config keys;
+    if !zombie_ttl.is_a?(::Integer) || zombie_ttl <= 0
+      raise(
+        RedisQueuedLocks::SwarmArgumentError,
+        "`:zombie_ttl` argument should be a positive Integer, got #{zombie_ttl.inspect}."
+      )
+    end
+
     RedisQueuedLocks::Swarm::Acquirers.acquirers(
       rql_client.redis_client,
       zombie_ttl
@@ -104,12 +114,32 @@ class RedisQueuedLocks::Swarm
   #
   # @api public
   # @since 1.9.0
-  # @version 1.20.0
+  # @version 1.21.0
   def flush_zombies(
     zombie_ttl: rql_client.config['swarm.flush_zombies.zombie_ttl'],
     lock_scan_size: rql_client.config['swarm.flush_zombies.zombie_lock_scan_size'],
     queue_scan_size: rql_client.config['swarm.flush_zombies.zombie_queue_scan_size']
   )
+    # NOTE: (arguments) the same ranges as the config keys;
+    if !zombie_ttl.is_a?(::Integer) || zombie_ttl <= 0
+      raise(
+        RedisQueuedLocks::SwarmArgumentError,
+        "`:zombie_ttl` argument should be a positive Integer, got #{zombie_ttl.inspect}."
+      )
+    end
+    if !lock_scan_size.is_a?(::Integer) || lock_scan_size <= 0
+      raise(
+        RedisQueuedLocks::SwarmArgumentError,
+        "`:lock_scan_size` argument should be a positive Integer, got #{lock_scan_size.inspect}."
+      )
+    end
+    if !queue_scan_size.is_a?(::Integer) || queue_scan_size <= 0
+      raise(
+        RedisQueuedLocks::SwarmArgumentError,
+        "`:queue_scan_size` argument should be a positive Integer, got #{queue_scan_size.inspect}."
+      )
+    end
+
     RedisQueuedLocks::Swarm::FlushZombies.flush_zombies(
       rql_client.redis_client,
       zombie_ttl,
@@ -125,11 +155,25 @@ class RedisQueuedLocks::Swarm
   #
   # @api public
   # @since 1.9.0
-  # @version 1.20.0
+  # @version 1.21.0
   def zombie_locks(
     zombie_ttl: rql_client.config['swarm.flush_zombies.zombie_ttl'],
     lock_scan_size: rql_client.config['swarm.flush_zombies.zombie_lock_scan_size']
   )
+    # NOTE: (arguments) the same ranges as the config keys;
+    if !zombie_ttl.is_a?(::Integer) || zombie_ttl <= 0
+      raise(
+        RedisQueuedLocks::SwarmArgumentError,
+        "`:zombie_ttl` argument should be a positive Integer, got #{zombie_ttl.inspect}."
+      )
+    end
+    if !lock_scan_size.is_a?(::Integer) || lock_scan_size <= 0
+      raise(
+        RedisQueuedLocks::SwarmArgumentError,
+        "`:lock_scan_size` argument should be a positive Integer, got #{lock_scan_size.inspect}."
+      )
+    end
+
     RedisQueuedLocks::Swarm::ZombieInfo.zombie_locks(
       rql_client.redis_client,
       zombie_ttl,
@@ -142,13 +186,27 @@ class RedisQueuedLocks::Swarm
   # @option lock_scan_size [Integer]
   # @return [Set<String>]
   #
-  # @api ppublic
+  # @api public
   # @since 1.9.0
-  # @version 1.20.0
+  # @version 1.21.0
   def zombie_acquirers(
     zombie_ttl: rql_client.config['swarm.flush_zombies.zombie_ttl'],
     lock_scan_size: rql_client.config['swarm.flush_zombies.zombie_lock_scan_size']
   )
+    # NOTE: (arguments) the same ranges as the config keys;
+    if !zombie_ttl.is_a?(::Integer) || zombie_ttl <= 0
+      raise(
+        RedisQueuedLocks::SwarmArgumentError,
+        "`:zombie_ttl` argument should be a positive Integer, got #{zombie_ttl.inspect}."
+      )
+    end
+    if !lock_scan_size.is_a?(::Integer) || lock_scan_size <= 0
+      raise(
+        RedisQueuedLocks::SwarmArgumentError,
+        "`:lock_scan_size` argument should be a positive Integer, got #{lock_scan_size.inspect}."
+      )
+    end
+
     RedisQueuedLocks::Swarm::ZombieInfo.zombie_acquirers(
       rql_client.redis_client,
       zombie_ttl,
@@ -162,7 +220,16 @@ class RedisQueuedLocks::Swarm
   #
   # @api public
   # @since 1.9.0
+  # @version 1.21.0
   def zombie_hosts(zombie_ttl: rql_client.config['swarm.flush_zombies.zombie_ttl'])
+    # NOTE: (arguments) the same ranges as the config keys;
+    if !zombie_ttl.is_a?(::Integer) || zombie_ttl <= 0
+      raise(
+        RedisQueuedLocks::SwarmArgumentError,
+        "`:zombie_ttl` argument should be a positive Integer, got #{zombie_ttl.inspect}."
+      )
+    end
+
     RedisQueuedLocks::Swarm::ZombieInfo.zombie_hosts(rql_client.redis_client, zombie_ttl)
   end
 
@@ -172,11 +239,25 @@ class RedisQueuedLocks::Swarm
   #
   # @api public
   # @since 1.9.0
-  # @version 1.20.0
+  # @version 1.21.0
   def zombies_info(
     zombie_ttl: rql_client.config['swarm.flush_zombies.zombie_ttl'],
     lock_scan_size: rql_client.config['swarm.flush_zombies.zombie_lock_scan_size']
   )
+    # NOTE: (arguments) the same ranges as the config keys;
+    if !zombie_ttl.is_a?(::Integer) || zombie_ttl <= 0
+      raise(
+        RedisQueuedLocks::SwarmArgumentError,
+        "`:zombie_ttl` argument should be a positive Integer, got #{zombie_ttl.inspect}."
+      )
+    end
+    if !lock_scan_size.is_a?(::Integer) || lock_scan_size <= 0
+      raise(
+        RedisQueuedLocks::SwarmArgumentError,
+        "`:lock_scan_size` argument should be a positive Integer, got #{lock_scan_size.inspect}."
+      )
+    end
+
     RedisQueuedLocks::Swarm::ZombieInfo.zombies_info(
       rql_client.redis_client,
       zombie_ttl,

data/lib/redis_queued_locks/utilities.rb

@@ -39,7 +39,7 @@ module RedisQueuedLocks::Utilities
   # @return [Boolean]
   #
   # @api public
-  # @since ?.?.?
+  # @since 1.16.0
   RUBY_OVER_4 = Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('4.0.0')
 
   # @yield

data/lib/redis_queued_locks/version.rb

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

data/rbs_collection.lock.yaml

@@ -9,6 +9,10 @@ gems:
     revision: c69c75ba79d7c19870f8d0e6fa7fe2c1d356e5ae
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
+- name: json
+  version: '0'
+  source:
+    type: stdlib
 - name: logger
   version: '1.7'
   source:

data/rbs_collection.yaml

@@ -2,7 +2,7 @@ sources:
   - type: git
     name: ruby/gem_rbs_collection
     remote: https://github.com/ruby/gem_rbs_collection.git
-    revision: main
+    revision: c69c75ba79d7c19870f8d0e6fa7fe2c1d356e5ae # NOTE: pinned for reproducible checks; bump deliberately (`bundle exec rbs collection update`)
     repo_dir: gems
 
 path: .gem_rbs_collection
@@ -13,3 +13,4 @@ gems:
   - name: timeout
   - name: logger
   - name: monitor
+  - name: json # NOTE: used by the runtime type checking only, not by the library code

data/sig/manifest.yml

@@ -4,3 +4,4 @@ dependencies:
   - securerandom
   - logger
   - monitor
+  - json # NOTE: used by the runtime type checking only, not by the library code

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

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

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

@@ -9,13 +9,13 @@ module RedisQueuedLocks
           RC::client redis,
           RQL::loggerObj logger,
           String lock_key,
-          Symbol read_write_mode,
+          RQL::readWriteMode read_write_mode,
           String lock_key_queue,
           String read_lock_key_queue,
           Integer queue_ttl,
           String acquirer_id,
           String host_id,
-          Symbol access_strategy,
+          RQL::accessStrategy access_strategy,
           bool log_sampled,
           bool instr_sampled
         ) -> { ok: bool, result: Integer }

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

@@ -8,7 +8,8 @@ module RedisQueuedLocks
           RQL::instrObj instrumenter,
           bool instr_sampled,
           String lock_key,
-          Symbol rw_mode,
+          RQL::readWriteMode rw_mode,
+          Integer priority,
           Integer? ttl,
           String acq_id,
           String hst_id,
@@ -21,7 +22,8 @@ module RedisQueuedLocks
           RQL::instrObj instrumenter,
           bool instr_sampled,
           String lock_key,
-          Symbol rw_mode,
+          RQL::readWriteMode rw_mode,
+          Integer priority,
           Integer? ttl,
           String acq_id,
           String hst_id,
@@ -34,7 +36,8 @@ module RedisQueuedLocks
           RQL::instrObj instrumenter,
           bool instr_sampled,
           String lock_key,
-          Symbol rw_mode,
+          RQL::readWriteMode rw_mode,
+          Integer priority,
           Integer? ttl,
           String acq_id,
           String hst_id,
@@ -47,7 +50,8 @@ module RedisQueuedLocks
           RQL::instrObj instrumenter,
           bool instr_sampled,
           String lock_key,
-          Symbol rw_mode,
+          RQL::readWriteMode rw_mode,
+          Integer priority,
           Integer? ttl,
           String acq_id,
           String hst_id,
@@ -61,7 +65,8 @@ module RedisQueuedLocks
           RQL::instrObj instrumenter,
           bool instr_sampled,
           String lock_key,
-          Symbol rw_mode,
+          RQL::readWriteMode rw_mode,
+          Integer priority,
           Integer? ttl,
           String acq_id,
           String hst_id,
@@ -70,6 +75,21 @@ module RedisQueuedLocks
           Integer|Float hold_time,
           untyped? instrument
         ) -> void
+
+        def self.lock_obtaining_failed: (
+          RQL::instrObj instrumenter,
+          bool instr_sampled,
+          String lock_key,
+          RQL::readWriteMode rw_mode,
+          Integer priority,
+          Integer ttl,
+          String acq_id,
+          String hst_id,
+          Integer|Float ts,
+          Integer|Float acq_time,
+          Symbol result,
+          untyped? instrument
+        ) -> void
       end
     end
   end

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

@@ -11,8 +11,9 @@ module RedisQueuedLocks
           Integer queue_ttl,
           String acquirer_id,
           String host_id,
-          Symbol access_strategy,
-          Symbol rw_mode
+          RQL::accessStrategy access_strategy,
+          RQL::readWriteMode rw_mode,
+          Integer priority
         ) -> void
 
         def self.start_try_to_lock_cycle: (
@@ -22,8 +23,9 @@ module RedisQueuedLocks
           Integer queue_ttl,
           String acquirer_id,
           String host_id,
-          Symbol access_strategy,
-          Symbol rw_mode
+          RQL::accessStrategy access_strategy,
+          RQL::readWriteMode rw_mode,
+          Integer priority
         ) -> void
 
         def self.dead_score_reached__reset_acquirer_position: (
@@ -33,8 +35,9 @@ module RedisQueuedLocks
           Integer queue_ttl,
           String acquirer_id,
           String host_id,
-          Symbol access_strategy,
-          Symbol rw_mode
+          RQL::accessStrategy access_strategy,
+          RQL::readWriteMode rw_mode,
+          Integer priority
         ) -> void
 
         def self.extendable_reentrant_lock_obtained: (
@@ -45,8 +48,9 @@ module RedisQueuedLocks
           String acquirer_id,
           String host_id,
           Integer|Float acq_time,
-          Symbol access_strategy,
-          Symbol rw_mode
+          RQL::accessStrategy access_strategy,
+          RQL::readWriteMode rw_mode,
+          Integer priority
         ) -> void
 
         def self.reentrant_lock_obtained: (
@@ -57,8 +61,9 @@ module RedisQueuedLocks
           String acquirer_id,
           String host_id,
           Integer|Float acq_time,
-          Symbol access_strategy,
-          Symbol rw_mode
+          RQL::accessStrategy access_strategy,
+          RQL::readWriteMode rw_mode,
+          Integer priority
         ) -> void
 
         def self.lock_obtained: (
@@ -69,8 +74,23 @@ module RedisQueuedLocks
           String acquirer_id,
           String host_id,
           Integer|Float acq_time,
-          Symbol access_strategy,
-          Symbol rw_mode
+          RQL::accessStrategy access_strategy,
+          RQL::readWriteMode rw_mode,
+          Integer priority
+        ) -> void
+
+        def self.lock_obtaining_failed: (
+          RQL::loggerObj logger,
+          bool log_sampled,
+          String lock_key,
+          Integer queue_ttl,
+          String acquirer_id,
+          String host_id,
+          Integer|Float acq_time,
+          RQL::accessStrategy access_strategy,
+          RQL::readWriteMode rw_mode,
+          Integer priority,
+          Symbol result
         ) -> void
       end
     end

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

@@ -13,8 +13,8 @@ module RedisQueuedLocks
             Integer queue_ttl,
             String acquirer_id,
             String host_id,
-            Symbol access_strategy,
-            Symbol rw_mode
+            RQL::accessStrategy access_strategy,
+            RQL::readWriteMode rw_mode
           ) -> void
 
           def self.rconn_fetched: (
@@ -25,8 +25,8 @@ module RedisQueuedLocks
             Integer queue_ttl,
             String acquirer_id,
             String host_id,
-            Symbol access_strategy,
-            Symbol rw_mode
+            RQL::accessStrategy access_strategy,
+            RQL::readWriteMode rw_mode
           ) -> void
 
           def self.same_process_conflict_detected: (
@@ -37,8 +37,8 @@ module RedisQueuedLocks
             Integer queue_ttl,
             String acquirer_id,
             String host_id,
-            Symbol access_strategy,
-            Symbol rw_mode
+            RQL::accessStrategy access_strategy,
+            RQL::readWriteMode rw_mode
           ) -> void
 
           def self.same_process_conflict_analyzed: (
@@ -49,8 +49,8 @@ module RedisQueuedLocks
             Integer queue_ttl,
             String acquirer_id,
             String host_id,
-            Symbol access_strategy,
-            Symbol rw_mode,
+            RQL::accessStrategy access_strategy,
+            RQL::readWriteMode rw_mode,
             Symbol sp_conflict_status
           ) -> void
 
@@ -62,8 +62,8 @@ module RedisQueuedLocks
             Integer queue_ttl,
             String acquirer_id,
             String host_id,
-            Symbol access_strategy,
-            Symbol rw_mode,
+            RQL::accessStrategy access_strategy,
+            RQL::readWriteMode rw_mode,
             Symbol sp_conflict_status,
             Integer? ttl,
             ::Float spc_processed_timestamp
@@ -77,8 +77,8 @@ module RedisQueuedLocks
             Integer queue_ttl,
             String acquirer_id,
             String host_id,
-            Symbol access_strategy,
-            Symbol rw_mode,
+            RQL::accessStrategy access_strategy,
+            RQL::readWriteMode rw_mode,
             Symbol sp_conflict_status,
             ::Float spc_processed_timestamp
           ) -> void
@@ -91,8 +91,8 @@ module RedisQueuedLocks
             Integer queue_ttl,
             String acquirer_id,
             String host_id,
-            Symbol access_strategy,
-            Symbol rw_mode,
+            RQL::accessStrategy access_strategy,
+            RQL::readWriteMode rw_mode,
             Symbol sp_conflict_status,
             ::Float spc_processed_timestamp
           ) -> void
@@ -105,8 +105,8 @@ module RedisQueuedLocks
             Integer queue_ttl,
             String acquirer_id,
             String host_id,
-            Symbol access_strategy,
-            Symbol rw_mode,
+            RQL::accessStrategy access_strategy,
+            RQL::readWriteMode rw_mode,
             Symbol sp_conflict_status,
             ::Float spc_processed_timestamp
           ) -> void
@@ -119,8 +119,9 @@ module RedisQueuedLocks
             Integer queue_ttl,
             String acquirer_id,
             String host_id,
-            Symbol access_strategy,
-            Symbol rw_mode
+            RQL::accessStrategy access_strategy,
+            RQL::readWriteMode rw_mode,
+            Integer priority
           ) -> void
 
           def self.remove_expired_acqs: (
@@ -131,8 +132,22 @@ module RedisQueuedLocks
             Integer queue_ttl,
             String acquirer_id,
             String host_id,
-            Symbol access_strategy,
-            Symbol rw_mode
+            RQL::accessStrategy access_strategy,
+            RQL::readWriteMode rw_mode
+          ) -> void
+
+          def self.dead_request_removed: (
+            RQL::loggerObj logger,
+            bool log_sampled,
+            bool log_lock_try,
+            String lock_key,
+            Integer queue_ttl,
+            String acquirer_id,
+            String host_id,
+            RQL::accessStrategy access_strategy,
+            RQL::readWriteMode rw_mode,
+            String dead_acquirer,
+            Integer dead_priority
           ) -> void
 
           def self.get_first_from_queue: (
@@ -143,9 +158,10 @@ module RedisQueuedLocks
             Integer queue_ttl,
             String acquirer_id,
             String host_id,
-            Symbol access_strategy,
-            Symbol rw_mode,
-            String? waiting_acquirer
+            RQL::accessStrategy access_strategy,
+            RQL::readWriteMode rw_mode,
+            String? waiting_acquirer,
+            Integer? waiting_priority
           ) -> void
 
           def self.exit__queue_ttl_reached: (
@@ -156,8 +172,8 @@ module RedisQueuedLocks
             Integer queue_ttl,
             String acquirer_id,
             String host_id,
-            Symbol access_strategy,
-            Symbol rw_mode
+            RQL::accessStrategy access_strategy,
+            RQL::readWriteMode rw_mode
           ) -> void
 
           def self.exit__no_first: (
@@ -168,9 +184,10 @@ module RedisQueuedLocks
             Integer queue_ttl,
             String acquirer_id,
             String host_id,
-            Symbol access_strategy,
-            Symbol rw_mode,
+            RQL::accessStrategy access_strategy,
+            RQL::readWriteMode rw_mode,
             String? waiting_acquirer,
+            Integer? waiting_priority,
             Hash[String,untyped] current_lock_data
           ) -> void
 
@@ -182,9 +199,10 @@ module RedisQueuedLocks
             Integer queue_ttl,
             String acquirer_id,
             String host_id,
-            Symbol access_strategy,
-            Symbol rw_mode,
+            RQL::accessStrategy access_strategy,
+            RQL::readWriteMode rw_mode,
             String? waiting_acquirer,
+            Integer? waiting_priority,
             String locked_by_acquirer,
             Hash[String,untyped] current_lock_data
           ) -> void
@@ -197,9 +215,10 @@ module RedisQueuedLocks
             Integer queue_ttl,
             String acquirer_id,
             String host_id,
-            Symbol access_strategy,
-            Symbol rw_mode,
-            String ahead_acquirer
+            RQL::accessStrategy access_strategy,
+            RQL::readWriteMode rw_mode,
+            String ahead_acquirer,
+            Integer? ahead_priority
           ) -> void
 
           def self.exit__read_request_ahead: (
@@ -210,9 +229,10 @@ module RedisQueuedLocks
             Integer queue_ttl,
             String acquirer_id,
             String host_id,
-            Symbol access_strategy,
-            Symbol rw_mode,
-            String ahead_acquirer
+            RQL::accessStrategy access_strategy,
+            RQL::readWriteMode rw_mode,
+            String ahead_acquirer,
+            Integer? ahead_priority
           ) -> void
 
           def self.exit__read_lock_still_obtained: (
@@ -223,9 +243,10 @@ module RedisQueuedLocks
             Integer queue_ttl,
             String acquirer_id,
             String host_id,
-            Symbol access_strategy,
-            Symbol rw_mode,
-            String? waiting_acquirer
+            RQL::accessStrategy access_strategy,
+            RQL::readWriteMode rw_mode,
+            String? waiting_acquirer,
+            Integer? waiting_priority
           ) -> void
 
           def self.obtain__free_to_acquire: (
@@ -236,8 +257,8 @@ module RedisQueuedLocks
             Integer queue_ttl,
             String acquirer_id,
             String host_id,
-            Symbol access_strategy,
-            Symbol rw_mode
+            RQL::accessStrategy access_strategy,
+            RQL::readWriteMode rw_mode
           ) -> void
         end
       end