redis_queued_locks 1.13.0 → 1.15.0

data/lib/redis_queued_locks/config/dsl.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 # @api private
-# @since [1.13.0]
+# @since 1.13.0
 module RedisQueuedLocks::Config::DSL
   # @api private
-  # @since [1.13.0]
+  # @since 1.13.0
   module ClassMethods
     # NOTE:
     #   1. Style/DefWithParentheses rubocop's cop incorrectly drops `()` from method definition
@@ -15,7 +15,7 @@ module RedisQueuedLocks::Config::DSL
     # @return [Hash<String,Block>]
     #
     # @api private
-    # @since [1.13.0]
+    # @since 1.13.0
     def config_setters()= @config_setters # rubocop:disable Style/DefWithParentheses
 
     # NOTE:
@@ -27,7 +27,7 @@ module RedisQueuedLocks::Config::DSL
     # @return [Hash<String,Block>]
     #
     # @api private
-    # @since [1.13.0]
+    # @since 1.13.0
     def config_validators()= @config_validators # rubocop:disable Style/DefWithParentheses
 
     # @param config_key [String]
@@ -35,7 +35,7 @@ module RedisQueuedLocks::Config::DSL
     # @return [Bool]
     #
     # @api private
-    # @since [1.13.0]
+    # @since 1.13.0
     def validate(config_key, &validator)
       config_validators[config_key] = validator
     end
@@ -45,7 +45,7 @@ module RedisQueuedLocks::Config::DSL
     # @return [void]
     #
     # @api private
-    # @since [1.13.0]
+    # @since 1.13.0
     def setting(config_key, config_value)
       config_setters[config_key] = proc do |config|
         config[config_key] = config_value
@@ -57,7 +57,7 @@ module RedisQueuedLocks::Config::DSL
     # @return [Hash<String,Blcok>]
     #
     # @api private
-    # @since [1.13.0]
+    # @since 1.13.0
     def config_setters
       self.class.config_setters # steep:ignore
     end
@@ -65,7 +65,7 @@ module RedisQueuedLocks::Config::DSL
     # @return [Hash<String,Blcok>]
     #
     # @api private
-    # @since [1.13.0]
+    # @since 1.13.0
     def config_validators
       self.class.config_validators # steep:ignore
     end
@@ -76,7 +76,7 @@ module RedisQueuedLocks::Config::DSL
     # @return [void]
     #
     # @api private
-    # @since [1.13.0]
+    # @since 1.13.0
     def included(child_klass)
       child_klass.instance_variable_set(
         :@config_setters,

data/lib/redis_queued_locks/config.rb

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
 
 # @api private
-# @since [1.13.0]
+# @since 1.13.0
+# @version 1.14.0
 # rubocop:disable Metrics/ClassLength
 class RedisQueuedLocks::Config
   require_relative 'config/dsl'
 
   # @api private
-  # @since [1.13.0]
+  # @since 1.13.0
   include DSL
 
   setting('retry_count', 3)
@@ -18,6 +19,8 @@ class RedisQueuedLocks::Config
   setting('default_queue_ttl', 15) # NOTE: in seconds)
   setting('detailed_acq_timeout_error', false)
   setting('lock_release_batch_size', 100)
+  setting('clear_locks_of__lock_scan_size', 300)
+  setting('clear_locks_of__queue_scan_size', 300)
   setting('key_extraction_batch_size', 500)
   setting('instrumenter', RedisQueuedLocks::Instrument::VoidNotifier)
   setting('uniq_identifier', -> { RedisQueuedLocks::Resource.calc_uniq_identity })
@@ -79,6 +82,8 @@ class RedisQueuedLocks::Config
   validate('default_queue_ttl') { |val| val.is_a?(Integer) }
   validate('detailed_acq_timeout_error') { |val| val == true || val == false }
   validate('lock_release_batch_size') { |val| val.is_a?(Integer) }
+  validate('clear_locks_of__lock_scan_size') { |val| val.is_a?(Integer) }
+  validate('clear_locks_of__queue_scan_size') { |val| val.is_a?(Integer) }
   validate('instrumenter') { |val| RedisQueuedLocks::Instrument.valid_interface?(val) }
   validate('uniq_identifier') { |val| val.is_a?(Proc) }
   validate('logger') { |val| RedisQueuedLocks::Logging.valid_interface?(val) }
@@ -109,13 +114,13 @@ class RedisQueuedLocks::Config
   # @return [Hash<Symbol,Any>]
   #
   # @api private
-  # @since [1.13.0]
+  # @since 1.13.0
   attr_reader :config_state
 
   # @return [void]
   #
   # @api private
-  # @since [1.13.0]
+  # @since 1.13.0
   def initialize(&configuration)
     @config_state = {}
     config_setters.each_value { |setter| setter.call(@config_state) }
@@ -128,7 +133,7 @@ class RedisQueuedLocks::Config
   # @return [void]
   #
   # @api private
-  # @since [1.13.0]
+  # @since 1.13.0
   def configure(&configuration)
     yield(self) if block_given?
   end
@@ -139,7 +144,7 @@ class RedisQueuedLocks::Config
   # @raise [RedisQueuedLocks::ConfigNotFoundError]
   #
   # @api public
-  # @since [1.13.0]
+  # @since 1.13.0
   def [](config_key)
     prevent_key__non_existent(config_key)
     config_state[config_key]
@@ -153,7 +158,7 @@ class RedisQueuedLocks::Config
   # @raise [RedisQueuedLocks::ConfigValidationError]
   #
   # @api public
-  # @since [1.13.0]
+  # @since 1.13.0
   def []=(config_key, config_value)
     prevent_key__non_existent(config_key)
     prevent_key__invalid_type(config_key, config_value)
@@ -178,7 +183,7 @@ class RedisQueuedLocks::Config
   # @return [Hash<String,Any>]
   #
   # @api public
-  # @since [1.13.0]
+  # @since 1.13.0
   def slice(config_key_pattern)
     key_selector = "#{config_key_pattern}."
     key_splitter = key_selector.size
@@ -201,7 +206,7 @@ class RedisQueuedLocks::Config
   # @raise [RedisQueuedLocks::ConfigNotFoundError]
   #
   # @api private
-  # @since [1.13.0]
+  # @since 1.13.0
   def prevent_key__non_existent(config_key)
     unless config_state.key?(config_key)
       raise(
@@ -218,7 +223,7 @@ class RedisQueuedLocks::Config
   # @raise [RedisQueuedLocks::ConfigValidationError]
   #
   # @api private
-  # @sicne [1.13.0]
+  # @since 1.13.0
   def prevent_key__invalid_type(config_key, config_value)
     unless config_validators[config_key].call(config_value)
       raise(

data/lib/redis_queued_locks/errors.rb

@@ -50,14 +50,14 @@ module RedisQueuedLocks
   class SwarmArgumentError < ArgumentError; end
 
   # @api public
-  # @since [1.13.0]
+  # @since 1.13.0
   class ConfigError < Error; end
 
   # @api public
-  # @since [1.13.0]
+  # @since 1.13.0
   class ConfigNotFoundError < ConfigError; end
 
   # @api pub;ic
-  # @since [1.13.0]
+  # @since 1.13.0
   class ConfigValidationError < ConfigError; end
 end

data/lib/redis_queued_locks/swarm.rb

@@ -158,7 +158,7 @@ class RedisQueuedLocks::Swarm
   end
 
   # @option zombie_ttl [Integer]
-  # @option lock_sacn_size [Integer]
+  # @option lock_scan_size [Integer]
   # @return [Hash<Symbol,Set<String>>]
   #
   # @api public

data/lib/redis_queued_locks/utilities.rb

@@ -2,6 +2,7 @@
 
 # @api private
 # @since 1.0.0
+# @version 1.14.0
 module RedisQueuedLocks::Utilities
   require_relative 'utilities/lock'
 
@@ -44,6 +45,14 @@ module RedisQueuedLocks::Utilities
     yield rescue nil
   end
 
+  # @return [Integer]
+  #
+  # @api private
+  # @since 1.14.0
+  def clock_gettime
+    ::Process.clock_gettime(::Process::CLOCK_MONOTONIC, :microsecond)
+  end
+
   # Possible statuses (at the moment of Ruby@3.4):
   #   - "created"
   #   - "blocking"

data/lib/redis_queued_locks/version.rb

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

data/lib/redis_queued_locks.rb

@@ -4,7 +4,6 @@ require 'timeout'
 require 'redis-client'
 require 'securerandom'
 require 'logger'
-require 'objspace'
 
 # @api public
 # @since 1.0.0

data/rbs_collection.lock.yaml

@@ -1,20 +1,12 @@
 ---
 path: ".gem_rbs_collection"
 gems:
-- name: base64
-  version: '0.1'
-  source:
-    type: git
-    name: ruby/gem_rbs_collection
-    revision: e2749137770bcff57a062d47b0d08922071f3d37
-    remote: https://github.com/ruby/gem_rbs_collection.git
-    repo_dir: gems
 - name: connection_pool
   version: '2.4'
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: 0a6ea105a0afc7eaee4494585a7775f47eea6145
+    revision: 52a7ef8a9328fb2413e3b42dd8ee37deb703a940
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: logger
@@ -25,10 +17,6 @@ gems:
   version: '0'
   source:
     type: stdlib
-- name: objspace
-  version: '0'
-  source:
-    type: stdlib
 - name: securerandom
   version: '0'
   source:

data/rbs_collection.yaml

@@ -8,9 +8,10 @@ sources:
 path: .gem_rbs_collection
 
 gems:
+  - name: redis-client
+  - name: securerandom
   - name: timeout
   - name: redis-client
   - name: securerandom
   - name: logger
-  - name: objspace
   - name: monitor

data/redis_queued_locks.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
     "|> Distributed locks with \"prioritized lock acquisition queue\" capabilities " \
     "based on the Redis Database.\n" \
     "|> Each lock request is put into the request queue " \
-    "(each lock is hosted by it's own queue separately from other queues) and processed " \
+    "(each lock is hosted by its own queue separately from other queues) and processed " \
     "in order of their priority (FIFO).\n" \
     "|> Each lock request lives some period of time (RTTL) " \
     "(with requeue capabilities) which guarantees the request queue will never be stacked.\n" \

data/sig/manifest.yml

@@ -3,5 +3,4 @@ dependencies:
   - redis-client
   - securerandom
   - logger
-  - objspace
   - monitor

data/sig/redis_queued_locks/acquirer/acquire_lock.rbs

@@ -4,6 +4,7 @@ use RedisClient as RC
 module RedisQueuedLocks
   module Acquirer
     module AcquireLock
+      extend RQL::Utilities
       extend RQL::Acquirer::AcquireLock::TryToLock
       extend RQL::Acquirer::AcquireLock::DelayExecution
       extend RQL::Acquirer::AcquireLock::YieldExpire

data/sig/redis_queued_locks/acquirer/release_locks_of.rbs

@@ -0,0 +1,46 @@
+use RedisQueuedLocks as RQL
+use RedisClient as RC
+
+module RedisQueuedLocks
+  module Acquirer
+    module ReleaseLocksOf
+      extend RQL::Utilities
+
+      type releaseResult = {
+        ok: bool,
+        result: {
+          rel_key_cnt: Integer,
+          tch_queue_cnt: Integer,
+          rel_time: Integer|Float
+        }
+      }
+      def self.release_locks_of: (
+        String host_id,
+        String acquirer_id,
+        RC::client redis,
+        Integer lock_scan_size,
+        Integer queue_scan_size,
+        RQL::loggerObj logger,
+        RQL::instrObj instrumenter,
+        untyped instrument,
+        bool log_sampling_enabled,
+        Integer log_sampling_percent,
+        RQL::Logging::samplerObj log_sampler,
+        bool log_sample_this,
+        bool instr_sampling_enabled,
+        Integer instr_sampling_percent,
+        RQL::Instrument::samplerObj instr_sampler,
+        bool instr_sample_this
+      ) -> releaseResult
+
+      type fullyReleaseAllLocksResult = { ok: bool, result: { rel_key_cnt: Integer, tch_queue_cnt: Integer } }
+      private def self.fully_release_locks_of: (
+        String refused_host_id,
+        String refused_acquirer_id,
+        RC::client redis,
+        Integer locks_scan_size,
+        Integer queue_scan_size
+      ) -> fullyReleaseAllLocksResult
+    end
+  end
+end

data/sig/redis_queued_locks/client.rbs

@@ -121,6 +121,8 @@ module RedisQueuedLocks
       ?ractor_id: Integer|String,
       ?identity: String
     ) -> String
+    alias ccurrent_acq_id current_acquirer_id
+    alias acq_id current_acquirer_id
 
     def current_host_id: (
       ?process_id: Integer|String,
@@ -128,6 +130,8 @@ module RedisQueuedLocks
       ?ractor_id: Integer|String,
       ?identity: String
     ) -> String
+    alias current_hst_id current_host_id
+    alias hst_id current_host_id
 
     def possible_host_ids: (?String identity) -> Array[String]
 
@@ -163,6 +167,42 @@ module RedisQueuedLocks
     ) -> RQL::Acquirer::ReleaseAllLocks::releaseResult
     alias release_locks clear_locks
 
+    def clear_locks_of: (
+      host_id: String,
+      acquirer_id: String,
+      ?lock_scan_size: Integer,
+      ?queue_scan_size: Integer,
+      ?logger: RQL::loggerObj,
+      ?instrumenter: RQL::instrObj,
+      ?instrument: untyped?,
+      ?log_sampling_enabled: bool,
+      ?log_sampling_percent: Integer,
+      ?log_sampler: RQL::Logging::samplerObj,
+      ?log_sample_this: bool,
+      ?instr_sampling_enabled: bool,
+      ?instr_sampling_percent: Integer,
+      ?instr_sampler: RQL::Instrument::samplerObj,
+      ?instr_sample_this: bool
+    ) -> RQL::Acquirer::ReleaseLocksOf::releaseResult
+    alias release_locks_of clear_locks_of
+
+    def clear_current_locks: (
+      ?lock_scan_size: Integer,
+      ?queue_scan_size: Integer,
+      ?logger: RQL::loggerObj,
+      ?instrumenter: RQL::instrObj,
+      ?instrument: untyped?,
+      ?log_sampling_enabled: bool,
+      ?log_sampling_percent: Integer,
+      ?log_sampler: RQL::Logging::samplerObj,
+      ?log_sample_this: bool,
+      ?instr_sampling_enabled: bool,
+      ?instr_sampling_percent: Integer,
+      ?instr_sampler: RQL::Instrument::samplerObj,
+      ?instr_sample_this: bool
+    ) -> RQL::Acquirer::ReleaseLocksOf::releaseResult
+    alias release_current_locks clear_current_locks
+
     def locks: (?scan_size: Integer, ?with_info: bool) -> RQL::Acquirer::Locks::locks
              | (?scan_size: Integer, ?with_info: true) -> RQL::Acquirer::Locks::locksInfo
              | (?scan_size: Integer, ?with_info: false) -> RQL::Acquirer::Locks::lockList

data/sig/redis_queued_locks/utilities.rbs

@@ -7,5 +7,6 @@ module RedisQueuedLocks
     def self?.ractor_status: (Ractor ractor) -> String
     def self?.ractor_alive?: (Ractor ractor) -> bool
     def self?.thread_state: (Thread thread) -> String
+    def self?.clock_gettime: () -> Integer
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis_queued_locks
 version: !ruby/object:Gem::Version
-  version: 1.13.0
+  version: 1.15.0
 platform: ruby
 authors:
 - Rustam Ibragimov
@@ -25,7 +25,7 @@ dependencies:
         version: '0.20'
 description: |-
   |> Distributed locks with "prioritized lock acquisition queue" capabilities based on the Redis Database.
-  |> Each lock request is put into the request queue (each lock is hosted by it's own queue separately from other queues) and processed in order of their priority (FIFO).
+  |> Each lock request is put into the request queue (each lock is hosted by its own queue separately from other queues) and processed in order of their priority (FIFO).
   |> Each lock request lives some period of time (RTTL) (with requeue capabilities) which guarantees the request queue will never be stacked.
   |> In addition to the classic `queued` (FIFO) strategy RQL supports `random` (RANDOM) lock obtaining strategy when any acquirer from the lock queue can obtain the lock regardless the position in the queue.
   |> Provides flexible invocation flow, parametrized limits (lock request ttl, lock ttl, queue ttl, lock attempts limit, fast failing, etc), logging and instrumentation.
@@ -70,6 +70,7 @@ files:
 - lib/redis_queued_locks/acquirer/queues.rb
 - lib/redis_queued_locks/acquirer/release_all_locks.rb
 - lib/redis_queued_locks/acquirer/release_lock.rb
+- lib/redis_queued_locks/acquirer/release_locks_of.rb
 - lib/redis_queued_locks/client.rb
 - lib/redis_queued_locks/config.rb
 - lib/redis_queued_locks/config/dsl.rb
@@ -126,6 +127,7 @@ files:
 - sig/redis_queued_locks/acquirer/queues.rbs
 - sig/redis_queued_locks/acquirer/release_all_locks.rbs
 - sig/redis_queued_locks/acquirer/release_lock.rbs
+- sig/redis_queued_locks/acquirer/release_locks_of.rbs
 - sig/redis_queued_locks/client.rbs
 - sig/redis_queued_locks/config.rbs
 - sig/redis_queued_locks/config/dsl.rbs
@@ -178,7 +180,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Distributed locks with "prioritized lock acquisition queue" capabilities
   based on the Redis Database.