redis_queued_locks 1.12.1 → 1.14.0

data/Rakefile

@@ -2,20 +2,28 @@
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'steep/rake_task'
 require 'rubocop'
 require 'rubocop/rake_task'
 require 'rubocop-performance'
 require 'rubocop-rspec'
 require 'rubocop-rake'
+require 'rubocop-on-rbs'
+require 'rubocop-thread_safety'
 
 RuboCop::RakeTask.new(:rubocop) do |t|
   config_path = File.expand_path(File.join('.rubocop.yml'), __dir__)
-  t.options = ['--config', config_path]
-  t.requires << 'rubocop-rspec'
-  t.requires << 'rubocop-performance'
-  t.requires << 'rubocop-rake'
+  t.options = [
+    '--config', config_path,
+    '--plugin', 'rubocop-rspec',
+    '--plugin', 'rubocop-performance',
+    '--plugin', 'rubocop-rake',
+    '--plugin', 'rubocop-on-rbs',
+    '--plugin', 'rubocop-thread_safety'
+  ]
 end
 
 RSpec::Core::RakeTask.new(:rspec)
+Steep::RakeTask.new(:steep)
 
 task default: :rspec

data/Steepfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+target :lib do
+  signature 'sig'
+
+  check 'lib'
+  ignore 'spec'
+
+  library 'timeout'
+  library 'securerandom'
+  library 'logger'
+  library 'monitor'
+
+  configure_code_diagnostics(Steep::Diagnostic::Ruby.strict)
+end

data/github_ci/ruby3.3.gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec path: '..'
+
+gem 'activesupport'
+gem 'armitage-rubocop'
+gem 'bundler'
+gem 'pry'
+gem 'rake'
+gem 'rbs'
+gem 'rspec'
+gem 'rspec-retry' # NOTE: temporary decision for non-refactored tests
+gem 'simplecov'
+gem 'simplecov-lcov'
+gem 'steep'

data/github_ci/ruby3.3.gemfile.lock

@@ -0,0 +1,217 @@
+PATH
+  remote: ..
+  specs:
+    redis_queued_locks (1.13.0)
+      redis-client (~> 0.20)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (8.0.2)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    armitage-rubocop (1.75.7.7)
+      rubocop (= 1.75.7)
+      rubocop-capybara (= 2.22.1)
+      rubocop-factory_bot (= 2.27.1)
+      rubocop-on-rbs (= 1.7.0)
+      rubocop-performance (= 1.25.0)
+      rubocop-rails (= 2.32.0)
+      rubocop-rake (= 0.7.1)
+      rubocop-rspec (= 3.6.0)
+      rubocop-rspec_rails (= 2.31.0)
+      rubocop-thread_safety (= 0.7.2)
+    ast (2.4.3)
+    base64 (0.3.0)
+    benchmark (0.4.1)
+    bigdecimal (3.2.1)
+    coderay (1.1.3)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.3)
+    csv (3.3.5)
+    diff-lcs (1.6.2)
+    docile (1.4.1)
+    drb (2.2.3)
+    ffi (1.17.2)
+    ffi (1.17.2-aarch64-linux-gnu)
+    ffi (1.17.2-aarch64-linux-musl)
+    ffi (1.17.2-arm-linux-gnu)
+    ffi (1.17.2-arm-linux-musl)
+    ffi (1.17.2-arm64-darwin)
+    ffi (1.17.2-x86-linux-gnu)
+    ffi (1.17.2-x86-linux-musl)
+    ffi (1.17.2-x86_64-darwin)
+    ffi (1.17.2-x86_64-linux-gnu)
+    ffi (1.17.2-x86_64-linux-musl)
+    fileutils (1.7.3)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
+    json (2.12.2)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    listen (3.9.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    logger (1.7.0)
+    method_source (1.1.0)
+    minitest (5.25.5)
+    mutex_m (0.3.0)
+    parallel (1.27.0)
+    parser (3.3.8.0)
+      ast (~> 2.4.1)
+      racc
+    prism (1.4.0)
+    pry (0.15.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.8.1)
+    rack (3.1.15)
+    rainbow (3.1.1)
+    rake (13.3.0)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.11.1)
+      ffi (~> 1.0)
+    rbs (3.9.4)
+      logger
+    redis-client (0.24.0)
+      connection_pool
+    regexp_parser (2.10.0)
+    rspec (3.13.1)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.4)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-retry (0.6.2)
+      rspec-core (> 3.3)
+    rspec-support (3.13.4)
+    rubocop (1.75.7)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.44.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-capybara (2.22.1)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    rubocop-factory_bot (2.27.1)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    rubocop-on-rbs (1.7.0)
+      lint_roller (~> 1.1)
+      rbs (~> 3.5)
+      rubocop (>= 1.72.1, < 2.0)
+      zlib
+    rubocop-performance (1.25.0)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+    rubocop-rails (2.32.0)
+      activesupport (>= 4.2.0)
+      lint_roller (~> 1.1)
+      rack (>= 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
+    rubocop-rake (0.7.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1)
+    rubocop-rspec (3.6.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    rubocop-rspec_rails (2.31.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+      rubocop-rspec (~> 3.5)
+    rubocop-thread_safety (0.7.2)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    ruby-progressbar (1.13.0)
+    securerandom (0.4.1)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.13.1)
+    simplecov-lcov (0.8.0)
+    simplecov_json_formatter (0.1.4)
+    steep (1.10.0)
+      activesupport (>= 5.1)
+      concurrent-ruby (>= 1.1.10)
+      csv (>= 3.0.9)
+      fileutils (>= 1.1.0)
+      json (>= 2.1.0)
+      language_server-protocol (>= 3.17.0.4, < 4.0)
+      listen (~> 3.0)
+      logger (>= 1.3.0)
+      mutex_m (>= 0.3.0)
+      parser (>= 3.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rbs (~> 3.9)
+      securerandom (>= 0.1)
+      strscan (>= 1.0.0)
+      terminal-table (>= 2, < 5)
+      uri (>= 0.12.0)
+    strscan (3.1.5)
+    terminal-table (4.0.0)
+      unicode-display_width (>= 1.1.1, < 4)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    uri (1.0.3)
+    zlib (3.2.1)
+
+PLATFORMS
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm-linux-gnu
+  arm-linux-musl
+  arm64-darwin
+  ruby
+  x86-linux-gnu
+  x86-linux-musl
+  x86_64-darwin
+  x86_64-linux-gnu
+  x86_64-linux-musl
+
+DEPENDENCIES
+  activesupport
+  armitage-rubocop
+  bundler
+  pry
+  rake
+  rbs
+  redis_queued_locks!
+  rspec
+  rspec-retry
+  simplecov
+  simplecov-lcov
+  steep
+
+BUNDLED WITH
+   2.6.9

data/lib/redis_queued_locks/{acquier → acquirer}/acquire_lock/delay_execution.rb

@@ -2,17 +2,17 @@
 
 # @api private
 # @since 1.0.0
-module RedisQueuedLocks::Acquier::AcquireLock::DelayExecution
+module RedisQueuedLocks::Acquirer::AcquireLock::DelayExecution
   # Sleep with random time-shifting (it is necessary for empty lock-acquirement time slots).
   #
   # @param retry_delay [Integer] In milliseconds
   # @param retry_jitter [Integer] In milliseconds
-  # @return [void]
+  # @return [Integer] Slept seconds
   #
   # @api private
   # @since 1.0.0
   def delay_execution(retry_delay, retry_jitter)
-    delay = (retry_delay + rand(retry_jitter)).to_f / 1_000
-    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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 1.7.0
+module RedisQueuedLocks::Acquirer::AcquireLock::DequeueFromLockQueue::LogVisitor
+  class << self
+    # @param logger [::Logger,#debug]
+    # @param log_sampled [Boolean]
+    # @param lock_key [String]
+    # @param queue_ttl [Integer]
+    # @param acquirer_id [String]
+    # @param host_id [String]
+    # @param access_strategy [Symbol]
+    # @return [void]
+    #
+    # @api private
+    # @since 1.7.0
+    # @version 1.9.0
+    def dequeue_from_lock_queue(
+      logger,
+      log_sampled,
+      lock_key,
+      queue_ttl,
+      acquirer_id,
+      host_id,
+      access_strategy
+    )
+      return unless log_sampled
+
+      logger.debug do
+        "[redis_queued_locks.fail_fast_or_limits_reached_or_deadlock__dequeue] " \
+        "lock_key => '#{lock_key}' " \
+        "queue_ttl => #{queue_ttl} " \
+        "acq_id => '#{acquirer_id}' " \
+        "hst_id => '#{host_id}' " \
+        "acs_strat => '#{access_strategy}"
+      end rescue nil
+    end
+  end
+end

data/lib/redis_queued_locks/{acquier → acquirer}/acquire_lock/dequeue_from_lock_queue.rb

@@ -2,41 +2,50 @@
 
 # @api private
 # @since 1.7.0
-module RedisQueuedLocks::Acquier::AcquireLock::DequeueFromLockQueue
+module RedisQueuedLocks::Acquirer::AcquireLock::DequeueFromLockQueue
   require_relative 'dequeue_from_lock_queue/log_visitor'
 
   # @param redis [RedisClient]
   # @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 queue_ttl [Integer]
-  # @param acquier_id [String]
+  # @param acquirer_id [String]
   # @param host_id [String]
   # @param access_strategy [Symbol]
   # @param log_sampled [Boolean]
   # @param instr_sampled [Boolean]
-  # @return [Hash<Symbol,Any>] Format: { ok: true/false, result: Any }
+  # @return [Hash<Symbol,Any>] Format: { ok: true/false, result: Integer }
   #
   # @api private
   # @since 1.7.0
-  # @version 1.9.0
+  # @version 1.13.0
   def dequeue_from_lock_queue(
     redis,
     logger,
     lock_key,
+    read_write_mode,
     lock_key_queue,
+    read_lock_key_queue,
+    write_lock_key_queue,
     queue_ttl,
-    acquier_id,
+    acquirer_id,
     host_id,
     access_strategy,
     log_sampled,
     instr_sampled
   )
-    result = redis.call('ZREM', lock_key_queue, acquier_id)
+    # @type var result: Integer
+    result = redis.call('ZREM', lock_key_queue, acquirer_id)
+
     LogVisitor.dequeue_from_lock_queue(
       logger, log_sampled,
-      lock_key, queue_ttl, acquier_id, host_id, access_strategy
+      lock_key, queue_ttl, acquirer_id, host_id, access_strategy
     )
-    RedisQueuedLocks::Data[ok: true, result: result]
+
+    { ok: true, result: result }
   end
 end

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

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 1.7.0
+module RedisQueuedLocks::Acquirer::AcquireLock::InstrVisitor
+  class << self
+    # @param instrumenter [#notify]
+    # @param instr_sampled [Boolean]
+    # @param lock_key [String]
+    # @param ttl [Integer, NilClass]
+    # @param acq_id [String]
+    # @param hst_id [String]
+    # @param ts [Numeric]
+    # @param acq_time [Numeric]
+    # @param instrument [NilClass,Any]
+    # @return [void]
+    #
+    # @api private
+    # @since 1.7.0
+    # @version 1.9.0
+    def extendable_reentrant_lock_obtained(
+      instrumenter,
+      instr_sampled,
+      lock_key,
+      ttl,
+      acq_id,
+      hst_id,
+      ts,
+      acq_time,
+      instrument
+    )
+      return unless instr_sampled
+      instrumenter.notify('redis_queued_locks.extendable_reentrant_lock_obtained', {
+        lock_key:, ttl:, acq_id:, hst_id:, ts:, acq_time:, instrument:
+      }) rescue nil
+    end
+
+    # @param instrumenter [#notify]
+    # @param instr_sampled [Boolean]
+    # @param lock_key [String]
+    # @param ttl [Integer, NilClass]
+    # @param acq_id [String]
+    # @param hst_id [String]
+    # @param ts [Numeric]
+    # @param acq_time [Numeric]
+    # @param instrument [NilClass,Any]
+    # @return [void]
+    #
+    # @api private
+    # @since 1.7.0
+    # @version 1.9.0
+    def reentrant_lock_obtained(
+      instrumenter,
+      instr_sampled,
+      lock_key,
+      ttl,
+      acq_id,
+      hst_id,
+      ts,
+      acq_time,
+      instrument
+    )
+      return unless instr_sampled
+      instrumenter.notify('redis_queued_locks.reentrant_lock_obtained', {
+        lock_key:, ttl:, acq_id:, hst_id:, ts:, acq_time:, instrument:
+      }) rescue nil
+    end
+
+    # @param instrumenter [#notify]
+    # @param instr_sampled [Boolean]
+    # @param lock_key [String]
+    # @param ttl [Integer, NilClass]
+    # @param acq_id [String]
+    # @param hst_id [String]
+    # @param ts [Numeric]
+    # @param acq_time [Numeric]
+    # @param instrument [NilClass,Any]
+    # @return [void]
+    #
+    # @api private
+    # @since 1.7.0
+    # @version 1.9.0
+    def lock_obtained(
+      instrumenter,
+      instr_sampled,
+      lock_key,
+      ttl,
+      acq_id,
+      hst_id,
+      ts,
+      acq_time,
+      instrument
+    )
+      return unless instr_sampled
+      instrumenter.notify('redis_queued_locks.lock_obtained', {
+        lock_key:, ttl:, acq_id:, hst_id:, ts:, acq_time:, instrument:
+      }) rescue nil
+    end
+
+    # @param instrumenter [#notify]
+    # @param instr_sampled [Boolean]
+    # @param lock_key [String]
+    # @param ttl [Integer, NilClass]
+    # @param acq_id [String]
+    # @param hst_id [String]
+    # @param ts [Numeric]
+    # @param acq_time [Numeric]
+    # @param hold_time [Numeric]
+    # @param instrument [NilClass,Any]
+    # @return [void]
+    #
+    # @api private
+    # @since 1.7.0
+    # @version 1.9.0
+    def reentrant_lock_hold_completes(
+      instrumenter,
+      instr_sampled,
+      lock_key,
+      ttl,
+      acq_id,
+      hst_id,
+      ts,
+      acq_time,
+      hold_time,
+      instrument
+    )
+      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:
+      }) rescue nil
+    end
+
+    # @param instrumenter [#notify]
+    # @param instr_sampled [Boolean]
+    # @param lock_key [String]
+    # @param ttl [Integer, NilClass]
+    # @param acq_id [String]
+    # @param hst_id [String]
+    # @param ts [Numeric]
+    # @param acq_time [Numeric]
+    # @param hold_time [Numeric]
+    # @param instrument [NilClass,Any]
+    # @return [void]
+    #
+    # @api private
+    # @since 1.7.0
+    # @version 1.9.0
+    def lock_hold_and_release(
+      instrumenter,
+      instr_sampled,
+      lock_key,
+      ttl,
+      acq_id,
+      hst_id,
+      ts,
+      acq_time,
+      hold_time,
+      instrument
+    )
+      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:
+      }) rescue nil
+    end
+  end
+end