redis_queued_locks 1.21.0 → 1.22.0

data/lib/redis_queued_locks/version.rb

@@ -5,6 +5,6 @@ module RedisQueuedLocks
   #
   # @api public
   # @since 0.0.1
-  # @version 1.21.0
-  VERSION = '1.21.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,
@@ -75,7 +80,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,

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,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_obtaining_failed: (
@@ -81,8 +87,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,
           Symbol result
         ) -> void
       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

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

@@ -13,6 +13,7 @@ module RedisQueuedLocks
         LOCK_STATE_QUEUE_REPLIES_AT: Integer
         QUEUE_HEAD_REPLY: Integer
         OPPOSITE_QUEUE_HEAD_REPLY: Integer
+        MAX_DEAD_REQUEST_REMOVALS: Integer
 
         # { ok: bool, result: Symbol }
         # { ok: bool, result: Symbol }
@@ -25,7 +26,7 @@ module RedisQueuedLocks
         #     hst_id: String,
         #     ts: Integer?,
         #     ttl: Integer?,
-        #     rw_mode: Symbol
+        #     rw_mode: RQL::readWriteMode
         #   }
         # }
 
@@ -34,7 +35,7 @@ module RedisQueuedLocks
           RQL::loggerObj logger,
           bool log_lock_try,
           String lock_key,
-          Symbol read_write_mode,
+          RQL::readWriteMode read_write_mode,
           String lock_key_queue,
           String read_lock_key_queue,
           String lock_readers_key,
@@ -43,13 +44,14 @@ module RedisQueuedLocks
           String acquirer_id,
           String host_id,
           Integer|Float acquirer_position,
+          Integer priority,
           Integer? ttl,
           Integer queue_ttl,
           bool lock_index_enabled,
           Integer lock_index_grace_period,
           bool fail_fast,
-          Symbol conflict_strategy,
-          Symbol access_strategy,
+          RQL::conflictStrategy conflict_strategy,
+          RQL::accessStrategy access_strategy,
           Hash[String|Symbol,untyped]? meta,
           bool retry_attempt,
           bool log_sampled,
@@ -63,6 +65,7 @@ module RedisQueuedLocks
           String request_queue,
           String opposite_request_queue,
           Integer|Float acquirer_position,
+          Integer priority,
           String acquirer_id,
           Float acquirer_dead_score,
           String lock_name,
@@ -71,6 +74,14 @@ module RedisQueuedLocks
           Integer lock_index_grace_period
         ) -> void
 
+        def pipeline_dead_requests_removal: (
+          RedisClient::Pipeline pipeline,
+          String request_queue,
+          String opposite_request_queue,
+          Float acquirer_dead_score,
+          Integer priority
+        ) -> void
+
         def pipeline_lock_state: (
           RedisClient::Pipeline pipeline,
           String lock_key,
@@ -81,6 +92,7 @@ module RedisQueuedLocks
           String request_queue,
           String opposite_request_queue,
           Integer|Float acquirer_position,
+          Integer priority,
           Float acquirer_dead_score,
           String lock_name,
           Integer queue_ttl,
@@ -89,7 +101,7 @@ module RedisQueuedLocks
         ) -> void
 
         def find_opposite_request_ahead: (
-          Symbol access_strategy,
+          RQL::accessStrategy access_strategy,
           [String, Float]? opposite_waiting_request,
           Integer|Float acquirer_position,
           String acquirer_id
@@ -104,7 +116,7 @@ module RedisQueuedLocks
 
         def lock_obstacle: (
           bool read_mode,
-          Symbol access_strategy,
+          RQL::accessStrategy access_strategy,
           String acquirer_id,
           String? waiting_acquirer,
           String? opposite_request_ahead,
@@ -122,20 +134,55 @@ module RedisQueuedLocks
           Integer queue_ttl,
           String acquirer_id,
           String host_id,
-          Symbol access_strategy,
-          Symbol read_write_mode,
+          RQL::accessStrategy access_strategy,
+          RQL::readWriteMode read_write_mode,
           String? waiting_acquirer,
-          String? opposite_request_ahead,
+          Integer? waiting_priority,
+          [String, Float]? opposite_waiting_request,
           String? current_lock_obtainer
         ) -> void
 
+        def logged_request_priority: (
+          bool log_sampled,
+          bool log_lock_try,
+          [String, Float]? lock_request
+        ) -> Integer?
+
+        def drop_dead_requests_ahead: (
+          RC::client rconn,
+          RQL::readWriteMode read_write_mode,
+          String request_queue,
+          String opposite_request_queue,
+          String acquirer_id,
+          Integer|Float acquirer_position,
+          Float acquirer_dead_score,
+          RQL::accessStrategy access_strategy,
+          [String, Float]? waiting_request,
+          [String, Float]? opposite_waiting_request
+        ) -> [[String, Float]?, [String, Float]?, Array[[String, Integer]]]?
+
+        def log_dropped_requests: (
+          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 read_write_mode,
+          Array[[String, Integer]] dropped_requests
+        ) -> void
+
+        def dead_request_priority: ([String, Float] lock_request, Float acquirer_dead_score) -> Integer?
+
         def precheck_lock: (
           RC::client rconn,
           RQL::loggerObj logger,
           bool log_sampled,
           bool log_lock_try,
           String lock_key,
-          Symbol read_write_mode,
+          RQL::readWriteMode read_write_mode,
           String lock_readers_key,
           String request_queue,
           String opposite_request_queue,
@@ -143,12 +190,13 @@ module RedisQueuedLocks
           String acquirer_id,
           String host_id,
           Integer|Float acquirer_position,
+          Integer priority,
           Float acquirer_dead_score,
           Integer queue_ttl,
           bool lock_index_enabled,
           Integer lock_index_grace_period,
           bool fail_fast,
-          Symbol access_strategy
+          RQL::accessStrategy access_strategy
         ) -> (lockObstacle | :fail_fast_no_try)?
       end
     end

data/sig/redis_queued_locks/acquirer/acquire_lock/{yield_with_expire → yield_expire}/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
 
           def self.decrease_lock: (
@@ -24,8 +24,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/yield_expire.rbs

@@ -13,10 +13,10 @@ module RedisQueuedLocks
           String lock_key,
           String lock_readers_key,
           String? read_lock_key,
-          Symbol rw_mode,
+          RQL::readWriteMode rw_mode,
           String acquirer_id,
           String host_id,
-          Symbol access_strategy,
+          RQL::accessStrategy access_strategy,
           bool timed,
           Integer|Float ttl_shift,
           Integer ttl,

data/sig/redis_queued_locks/acquirer/acquire_lock.rbs

@@ -37,9 +37,11 @@ module RedisQueuedLocks
         logger: RQL::loggerObj,
         log_lock_try: bool,
         instrument: untyped?,
-        conflict_strategy: Symbol,
-        read_write_mode: Symbol,
-        access_strategy: Symbol,
+        conflict_strategy: RQL::conflictStrategy,
+        read_write_mode: Symbol, # NOTE: (rbs test) validated at runtime (Step 0.1 (RW)): any Symbol is accepted here
+        access_strategy: RQL::accessStrategy,
+        priority: RQL::lockPriority,
+        lock_priorities: Hash[Symbol, Integer],
         log_sampling_enabled: bool,
         log_sampling_percent: Integer,
         log_sampler: RQL::Logging::samplerObj,