redis_queued_locks 1.16.2 → 1.18.0

data/Rakefile

@@ -11,18 +11,47 @@ require 'rubocop-rake'
 require 'rubocop-on-rbs'
 require 'rubocop-thread_safety'
 
-RuboCop::RakeTask.new(:rubocop) do |t|
+# NOTE: Ruby sources and RBS signatures are linted by separate runs with separate configs:
+#   Ruby cops (and the project index they use) must not see RBS signatures;
+desc 'Run RuboCop for Ruby sources'
+RuboCop::RakeTask.new('rubocop:ruby') do |t|
+  # NOTE: replace the default "Running RuboCop..." message (printed when verbose);
+  t.verbose = false
+  puts 'Running RuboCop (Ruby sources)...'
   config_path = File.expand_path(File.join('.rubocop.yml'), __dir__)
   t.options = [
     '--config', config_path,
     '--plugin', 'rubocop-rspec',
     '--plugin', 'rubocop-performance',
     '--plugin', 'rubocop-rake',
-    '--plugin', 'rubocop-on-rbs',
     '--plugin', 'rubocop-thread_safety'
   ]
 end
 
+desc 'Run RuboCop for RBS signatures and inline RBS annotations'
+RuboCop::RakeTask.new('rubocop:rbs') do |t|
+  # NOTE: replace the default "Running RuboCop..." message (printed when verbose);
+  t.verbose = false
+  puts 'Running RuboCop (RBS signatures and inline RBS annotations)...'
+  config_path = File.expand_path(File.join('.rubocop.rbs.yml'), __dir__)
+  t.options = [
+    '--config', config_path,
+    '--plugin', 'rubocop-on-rbs'
+  ]
+end
+
+desc 'Run RuboCop for Ruby sources and RBS signatures'
+task :rubocop do
+  # NOTE: run both linters even if the first one fails (a failed RuboCop task aborts);
+  failed = %w[rubocop:ruby rubocop:rbs].reject do |task_name|
+    Rake::Task[task_name].invoke
+    true
+  rescue SystemExit
+    false
+  end
+  abort("RuboCop failed: #{failed.join(', ')}") if failed.any?
+end
+
 RSpec::Core::RakeTask.new(:rspec)
 Steep::RakeTask.new(:steep)
 

data/lib/redis_queued_locks/acquirer/acquire_lock/delay_execution.rb

@@ -12,7 +12,7 @@ module RedisQueuedLocks::Acquirer::AcquireLock::DelayExecution
   # @api private
   # @since 1.0.0
   def delay_execution(retry_delay, retry_jitter)
-    delay = (retry_delay + ::Kernel.rand(retry_jitter)).to_f / 1_000
-    ::Kernel.sleep(delay)
+    delay = (retry_delay + Kernel.rand(retry_jitter)).to_f / 1_000
+    Kernel.sleep(delay)
   end
 end

data/lib/redis_queued_locks/acquirer/acquire_lock/dequeue_from_lock_queue/log_visitor.rb

@@ -11,11 +11,12 @@ module RedisQueuedLocks::Acquirer::AcquireLock::DequeueFromLockQueue::LogVisitor
     # @param acquirer_id [String]
     # @param host_id [String]
     # @param access_strategy [Symbol]
+    # @param rw_mode [Symbol]
     # @return [void]
     #
     # @api private
     # @since 1.7.0
-    # @version 1.9.0
+    # @version 1.18.0
     def dequeue_from_lock_queue(
       logger,
       log_sampled,
@@ -23,7 +24,8 @@ module RedisQueuedLocks::Acquirer::AcquireLock::DequeueFromLockQueue::LogVisitor
       queue_ttl,
       acquirer_id,
       host_id,
-      access_strategy
+      access_strategy,
+      rw_mode
     )
       return unless log_sampled
 
@@ -33,7 +35,8 @@ module RedisQueuedLocks::Acquirer::AcquireLock::DequeueFromLockQueue::LogVisitor
         "queue_ttl => #{queue_ttl} " \
         "acq_id => '#{acquirer_id}' " \
         "hst_id => '#{host_id}' " \
-        "acs_strat => '#{access_strategy}"
+        "acs_strat => '#{access_strategy}' " \
+        "rw_mode => '#{rw_mode}'"
       end rescue nil
     end
   end

data/lib/redis_queued_locks/acquirer/acquire_lock/dequeue_from_lock_queue.rb

@@ -2,6 +2,7 @@
 
 # @api private
 # @since 1.7.0
+# @version 1.18.0
 module RedisQueuedLocks::Acquirer::AcquireLock::DequeueFromLockQueue
   require_relative 'dequeue_from_lock_queue/log_visitor'
 
@@ -9,9 +10,8 @@ module RedisQueuedLocks::Acquirer::AcquireLock::DequeueFromLockQueue
   # @param logger [::Logger,#debug]
   # @param lock_key [String]
   # @param read_write_mode [Symbol]
-  # @param lock_key_queue [String]
-  # @param read_lock_key_queue [String]
-  # @param write_lock_key_queue [String]
+  # @param lock_key_queue [String] Queue of write lock requests.
+  # @param read_lock_key_queue [String] Queue of read lock requests.
   # @param queue_ttl [Integer]
   # @param acquirer_id [String]
   # @param host_id [String]
@@ -22,7 +22,7 @@ module RedisQueuedLocks::Acquirer::AcquireLock::DequeueFromLockQueue
   #
   # @api private
   # @since 1.7.0
-  # @version 1.13.0
+  # @version 1.18.0
   def dequeue_from_lock_queue(
     redis,
     logger,
@@ -30,7 +30,6 @@ module RedisQueuedLocks::Acquirer::AcquireLock::DequeueFromLockQueue
     read_write_mode,
     lock_key_queue,
     read_lock_key_queue,
-    write_lock_key_queue,
     queue_ttl,
     acquirer_id,
     host_id,
@@ -38,12 +37,15 @@ module RedisQueuedLocks::Acquirer::AcquireLock::DequeueFromLockQueue
     log_sampled,
     instr_sampled
   )
+    # NOTE: the request lives in the queue of the requested mode
+    request_queue = (read_write_mode == :read) ? read_lock_key_queue : lock_key_queue
+
     # @type var result: Integer
-    result = redis.call('ZREM', lock_key_queue, acquirer_id)
+    result = redis.call('ZREM', request_queue, acquirer_id)
 
     LogVisitor.dequeue_from_lock_queue(
       logger, log_sampled,
-      lock_key, queue_ttl, acquirer_id, host_id, access_strategy
+      lock_key, queue_ttl, acquirer_id, host_id, access_strategy, read_write_mode
     )
 
     { ok: true, result: result }

data/lib/redis_queued_locks/acquirer/acquire_lock/instr_visitor.rb

@@ -7,6 +7,7 @@ module RedisQueuedLocks::Acquirer::AcquireLock::InstrVisitor
     # @param instrumenter [#notify]
     # @param instr_sampled [Boolean]
     # @param lock_key [String]
+    # @param rw_mode [Symbol]
     # @param ttl [Integer, NilClass]
     # @param acq_id [String]
     # @param hst_id [String]
@@ -17,11 +18,12 @@ module RedisQueuedLocks::Acquirer::AcquireLock::InstrVisitor
     #
     # @api private
     # @since 1.7.0
-    # @version 1.9.0
+    # @version 1.18.0
     def extendable_reentrant_lock_obtained(
       instrumenter,
       instr_sampled,
       lock_key,
+      rw_mode,
       ttl,
       acq_id,
       hst_id,
@@ -31,13 +33,14 @@ module RedisQueuedLocks::Acquirer::AcquireLock::InstrVisitor
     )
       return unless instr_sampled
       instrumenter.notify('redis_queued_locks.extendable_reentrant_lock_obtained', {
-        lock_key:, ttl:, acq_id:, hst_id:, ts:, acq_time:, instrument:
+        lock_key:, rw_mode:, ttl:, acq_id:, hst_id:, ts:, acq_time:, instrument:
       }) rescue nil
     end
 
     # @param instrumenter [#notify]
     # @param instr_sampled [Boolean]
     # @param lock_key [String]
+    # @param rw_mode [Symbol]
     # @param ttl [Integer, NilClass]
     # @param acq_id [String]
     # @param hst_id [String]
@@ -48,11 +51,12 @@ module RedisQueuedLocks::Acquirer::AcquireLock::InstrVisitor
     #
     # @api private
     # @since 1.7.0
-    # @version 1.9.0
+    # @version 1.18.0
     def reentrant_lock_obtained(
       instrumenter,
       instr_sampled,
       lock_key,
+      rw_mode,
       ttl,
       acq_id,
       hst_id,
@@ -62,13 +66,14 @@ module RedisQueuedLocks::Acquirer::AcquireLock::InstrVisitor
     )
       return unless instr_sampled
       instrumenter.notify('redis_queued_locks.reentrant_lock_obtained', {
-        lock_key:, ttl:, acq_id:, hst_id:, ts:, acq_time:, instrument:
+        lock_key:, rw_mode:, ttl:, acq_id:, hst_id:, ts:, acq_time:, instrument:
       }) rescue nil
     end
 
     # @param instrumenter [#notify]
     # @param instr_sampled [Boolean]
     # @param lock_key [String]
+    # @param rw_mode [Symbol]
     # @param ttl [Integer, NilClass]
     # @param acq_id [String]
     # @param hst_id [String]
@@ -79,11 +84,12 @@ module RedisQueuedLocks::Acquirer::AcquireLock::InstrVisitor
     #
     # @api private
     # @since 1.7.0
-    # @version 1.9.0
+    # @version 1.18.0
     def lock_obtained(
       instrumenter,
       instr_sampled,
       lock_key,
+      rw_mode,
       ttl,
       acq_id,
       hst_id,
@@ -93,13 +99,14 @@ module RedisQueuedLocks::Acquirer::AcquireLock::InstrVisitor
     )
       return unless instr_sampled
       instrumenter.notify('redis_queued_locks.lock_obtained', {
-        lock_key:, ttl:, acq_id:, hst_id:, ts:, acq_time:, instrument:
+        lock_key:, rw_mode:, ttl:, acq_id:, hst_id:, ts:, acq_time:, instrument:
       }) rescue nil
     end
 
     # @param instrumenter [#notify]
     # @param instr_sampled [Boolean]
     # @param lock_key [String]
+    # @param rw_mode [Symbol]
     # @param ttl [Integer, NilClass]
     # @param acq_id [String]
     # @param hst_id [String]
@@ -111,11 +118,12 @@ module RedisQueuedLocks::Acquirer::AcquireLock::InstrVisitor
     #
     # @api private
     # @since 1.7.0
-    # @version 1.9.0
+    # @version 1.18.0
     def reentrant_lock_hold_completes(
       instrumenter,
       instr_sampled,
       lock_key,
+      rw_mode,
       ttl,
       acq_id,
       hst_id,
@@ -126,13 +134,14 @@ module RedisQueuedLocks::Acquirer::AcquireLock::InstrVisitor
     )
       return unless instr_sampled
       instrumenter.notify('redis_queued_locks.reentrant_lock_hold_completes', {
-        hold_time:, ttl:, acq_id:, hst_id:, ts:, lock_key:, acq_time:, instrument:
+        hold_time:, ttl:, acq_id:, hst_id:, ts:, lock_key:, rw_mode:, acq_time:, instrument:
       }) rescue nil
     end
 
     # @param instrumenter [#notify]
     # @param instr_sampled [Boolean]
     # @param lock_key [String]
+    # @param rw_mode [Symbol]
     # @param ttl [Integer, NilClass]
     # @param acq_id [String]
     # @param hst_id [String]
@@ -144,11 +153,12 @@ module RedisQueuedLocks::Acquirer::AcquireLock::InstrVisitor
     #
     # @api private
     # @since 1.7.0
-    # @version 1.9.0
+    # @version 1.18.0
     def lock_hold_and_release(
       instrumenter,
       instr_sampled,
       lock_key,
+      rw_mode,
       ttl,
       acq_id,
       hst_id,
@@ -159,7 +169,7 @@ module RedisQueuedLocks::Acquirer::AcquireLock::InstrVisitor
     )
       return unless instr_sampled
       instrumenter.notify('redis_queued_locks.lock_hold_and_release', {
-        hold_time:, ttl:, acq_id:, hst_id:, ts:, lock_key:, acq_time:, instrument:
+        hold_time:, ttl:, acq_id:, hst_id:, ts:, lock_key:, rw_mode:, acq_time:, instrument:
       }) rescue nil
     end
   end

data/lib/redis_queued_locks/acquirer/acquire_lock/log_visitor.rb

@@ -13,11 +13,12 @@ module RedisQueuedLocks::Acquirer::AcquireLock::LogVisitor
     # @param acquirer_id [String]
     # @param host_id [String]
     # @param access_strategy [Symbol]
+    # @param rw_mode [Symbol]
     # @return [void]
     #
     # @api private
     # @since 1.7.0
-    # @version 1.9.0
+    # @version 1.18.0
     def start_lock_obtaining(
       logger,
       log_sampled,
@@ -25,7 +26,8 @@ module RedisQueuedLocks::Acquirer::AcquireLock::LogVisitor
       queue_ttl,
       acquirer_id,
       host_id,
-      access_strategy
+      access_strategy,
+      rw_mode
     )
       return unless log_sampled
 
@@ -35,7 +37,8 @@ module RedisQueuedLocks::Acquirer::AcquireLock::LogVisitor
         "queue_ttl => #{queue_ttl} " \
         "acq_id => '#{acquirer_id}' " \
         "hst_id => '#{host_id}' " \
-        "acs_strat => '#{access_strategy}'"
+        "acs_strat => '#{access_strategy}' " \
+        "rw_mode => '#{rw_mode}'"
       end rescue nil
     end
 
@@ -46,11 +49,12 @@ module RedisQueuedLocks::Acquirer::AcquireLock::LogVisitor
     # @param acquirer_id [String]
     # @param host_id [String]
     # @param access_strategy [Symbol]
+    # @param rw_mode [Symbol]
     # @return [void]
     #
     # @api private
     # @since 1.7.0
-    # @version 1.9.0
+    # @version 1.18.0
     def start_try_to_lock_cycle(
       logger,
       log_sampled,
@@ -58,7 +62,8 @@ module RedisQueuedLocks::Acquirer::AcquireLock::LogVisitor
       queue_ttl,
       acquirer_id,
       host_id,
-      access_strategy
+      access_strategy,
+      rw_mode
     )
       return unless log_sampled
 
@@ -68,7 +73,8 @@ module RedisQueuedLocks::Acquirer::AcquireLock::LogVisitor
         "queue_ttl => #{queue_ttl} " \
         "acq_id => '#{acquirer_id}' " \
         "hst_id => '#{host_id}' " \
-        "acs_strat => '#{access_strategy}'"
+        "acs_strat => '#{access_strategy}' " \
+        "rw_mode => '#{rw_mode}'"
       end rescue nil
     end
 
@@ -79,11 +85,12 @@ module RedisQueuedLocks::Acquirer::AcquireLock::LogVisitor
     # @param acquirer_id [String]
     # @param host_id [String]
     # @param access_strategy [Symbol]
+    # @param rw_mode [Symbol]
     # @return [void]
     #
     # @api private
     # @since 1.7.0
-    # @version 1.9.0
+    # @version 1.18.0
     def dead_score_reached__reset_acquirer_position(
       logger,
       log_sampled,
@@ -91,7 +98,8 @@ module RedisQueuedLocks::Acquirer::AcquireLock::LogVisitor
       queue_ttl,
       acquirer_id,
       host_id,
-      access_strategy
+      access_strategy,
+      rw_mode
     )
       return unless log_sampled
 
@@ -101,7 +109,8 @@ module RedisQueuedLocks::Acquirer::AcquireLock::LogVisitor
         "queue_ttl => #{queue_ttl} " \
         "acq_id => '#{acquirer_id}' " \
         "hst_id => '#{host_id}' " \
-        "acs_strat => '#{access_strategy}'"
+        "acs_strat => '#{access_strategy}' " \
+        "rw_mode => '#{rw_mode}'"
       end rescue nil
     end
 
@@ -113,11 +122,12 @@ module RedisQueuedLocks::Acquirer::AcquireLock::LogVisitor
     # @param host_id [String]
     # @param acq_time [Numeric]
     # @param access_strategy [Symbol]
+    # @param rw_mode [Symbol]
     # @return [void]
     #
     # @api private
     # @since 1.7.0
-    # @version 1.9.0
+    # @version 1.18.0
     def extendable_reentrant_lock_obtained(
       logger,
       log_sampled,
@@ -126,7 +136,8 @@ module RedisQueuedLocks::Acquirer::AcquireLock::LogVisitor
       acquirer_id,
       host_id,
       acq_time,
-      access_strategy
+      access_strategy,
+      rw_mode
     )
       return unless log_sampled
 
@@ -135,8 +146,9 @@ module RedisQueuedLocks::Acquirer::AcquireLock::LogVisitor
         "lock_key => '#{lock_key}' " \
         "queue_ttl => #{queue_ttl} " \
         "acq_id => '#{acquirer_id}' " \
-        "host_id => '#{host_id}' " \
+        "hst_id => '#{host_id}' " \
         "acs_strat => '#{access_strategy}' " \
+        "rw_mode => '#{rw_mode}' " \
         "acq_time => #{acq_time} (ms)"
       end rescue nil
     end
@@ -149,11 +161,12 @@ module RedisQueuedLocks::Acquirer::AcquireLock::LogVisitor
     # @param host_id [String]
     # @param acq_time [Numeric]
     # @param access_strategy [Symbol]
+    # @param rw_mode [Symbol]
     # @return [void]
     #
     # @api private
     # @since 1.7.0
-    # @version 1.9.0
+    # @version 1.18.0
     def reentrant_lock_obtained(
       logger,
       log_sampled,
@@ -162,7 +175,8 @@ module RedisQueuedLocks::Acquirer::AcquireLock::LogVisitor
       acquirer_id,
       host_id,
       acq_time,
-      access_strategy
+      access_strategy,
+      rw_mode
     )
       return unless log_sampled
 
@@ -173,6 +187,7 @@ module RedisQueuedLocks::Acquirer::AcquireLock::LogVisitor
         "acq_id => '#{acquirer_id}' " \
         "hst_id => '#{host_id}' " \
         "acs_strat => '#{access_strategy}' " \
+        "rw_mode => '#{rw_mode}' " \
         "acq_time => #{acq_time} (ms)"
       end rescue nil
     end
@@ -185,11 +200,12 @@ module RedisQueuedLocks::Acquirer::AcquireLock::LogVisitor
     # @param host_id [String]
     # @param acq_time [Numeric]
     # @param access_strategy [Symbol]
+    # @param rw_mode [Symbol]
     # @return [void]
     #
     # @api private
     # @since 1.7.0
-    # @version 1.9.0
+    # @version 1.18.0
     def lock_obtained(
       logger,
       log_sampled,
@@ -198,7 +214,8 @@ module RedisQueuedLocks::Acquirer::AcquireLock::LogVisitor
       acquirer_id,
       host_id,
       acq_time,
-      access_strategy
+      access_strategy,
+      rw_mode
     )
       return unless log_sampled
 
@@ -209,6 +226,7 @@ module RedisQueuedLocks::Acquirer::AcquireLock::LogVisitor
         "acq_id => '#{acquirer_id}' " \
         "hst_id => '#{host_id}' " \
         "acs_strat => '#{access_strategy}' " \
+        "rw_mode => '#{rw_mode}' " \
         "acq_time => #{acq_time} (ms)"
       end rescue nil
     end