redis_queued_locks 1.10.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2028a137ac36d716a0f9728656f536c373d21691fe64bf5fa1970db160fbe51
-  data.tar.gz: 3d065601fac650cf7d2a8fcb63745ffbf91ecd2cc553d936c693b2e45fee752f
+  metadata.gz: 9e8dd94852534ed373615917be290e53b29e203e7b88907d24631869ab4f2deb
+  data.tar.gz: 9b78929772d22f8ae6cbb628d306a85c44d4eec2f6a41e68bccfa0d754db80b5
 SHA512:
-  metadata.gz: e7d6698032bab56ebb0cc85abf3b13bcffe499c019708b845962bb626ac0e27d3da35c27462816c3c37d664117ba3c6a8c916dca231fb9fffdb862695cf2c261
-  data.tar.gz: 7b139c4bff4587783dc0df0f67bc7b985569ff5590aaaa8cb4370cdf2d3f9f9954bf9c99ade1a60e47e48ac4c450b58c308dce32ab10e0e1b5a40d6003ed5019
+  metadata.gz: 14e6e0c7ff71c9bc0d8a4ff1088a0b9983a8bd365fa10b17236996b3cb20e291fb951e648c79430b2d4091179024385648a343b36913443a9459c3c9e2a71b18
+  data.tar.gz: f0aa55c8561513a87d3c8f347db2f9a0710c62b4fe6d03fd6b512fec56c2631da77b86080bbbdf051bfc82d6abe2016f8baf37e43b3eebc973bd404bb7f80a35

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 ## [Unreleased]
 
+## [1.12.0] - 2024-08-11
+### Changed
+- Timed blocks of code and their timeout errors: reduced error message object allocations;
+
+## [1.11.0] - 2024-08-11
+### Changed
+- Lock Acquierment Timeout (`acq_timeout`/`queue_ttl`): more correct timeout error interception
+  inside the `RedisQueuedLocks::Acquier::AcquireLock::WithAcqTimeout` logic that now raises and
+  intercepts an internal timeout error class in order to prevent interceptions of
+  other timeouts that can be raised from the wrapped block of code;
+
 ## [1.10.0] - 2024-08-11
 ### Changed
 - Timed invocations (`"timeed blocks of code"` / `timed: true`):
@@ -8,6 +19,8 @@
       now uses `Timeout#timeout`'s custom exception class/message replacement API;
     - `rescue Timeout::Error` can lead to incorrect exception interception: intercept block's-related
       Timeout::Error that is not RQL-related error;
+- Updated development dependencies;
+- Some minor readme updates;
 ### Added
 - `RedisQueuedLocks::Swarm`: missing YARDocs;
 - Separated `Logging Configuration` readme section (that is placed inside the main configuration section already);

data/lib/redis_queued_locks/acquier/acquire_lock/with_acq_timeout.rb

@@ -19,9 +19,11 @@ module RedisQueuedLocks::Acquier::AcquireLock::WithAcqTimeout
   #   Callback invoked on Timeout::Error.
   # @return [Any]
   #
+  # @raise [RedisQueuedLocks::LockAcquiermentIntermediateTimeoutError]
+  #
   # @api private
   # @since 1.0.0
-  # @version 1.8.0
+  # @version 1.11.0
   def with_acq_timeout(
     redis,
     timeout,
@@ -32,8 +34,12 @@ module RedisQueuedLocks::Acquier::AcquireLock::WithAcqTimeout
     on_timeout: nil,
     &block
   )
-    ::Timeout.timeout(timeout, &block)
-  rescue ::Timeout::Error
+    # TODO:
+    #   think about the runtime error class-object creation that perevent any timeout error
+    #   interception collisions (but remember: it can lead to regular internal ruby method/constant
+    #   cache invalidation);
+    ::Timeout.timeout(timeout, RedisQueuedLocks::LockAcquiermentIntermediateTimeoutError, &block)
+  rescue RedisQueuedLocks::LockAcquiermentIntermediateTimeoutError
     on_timeout.call unless on_timeout == nil
 
     if raise_errors

data/lib/redis_queued_locks/acquier/acquire_lock/yield_expire.rb

@@ -107,28 +107,22 @@ module RedisQueuedLocks::Acquier::AcquireLock::YieldExpire
   # @param block [Blcok]
   # @return [Any]
   #
+  # @raise [RedisQueuedLocks::TimedLockTimeoutError]
+  #
   # @api private
   # @since 1.3.0
-  # @version 1.10.0
+  # @version 1.12.0
   def yield_with_timeout(timeout, lock_key, lock_ttl, acquier_id, host_id, meta, &block)
-    ::Timeout.timeout(
-      timeout,
+    ::Timeout.timeout(timeout, RedisQueuedLocks::TimedLockIntermediateTimeoutError, &block)
+  rescue RedisQueuedLocks::TimedLockIntermediateTimeoutError
+    raise(
       RedisQueuedLocks::TimedLockTimeoutError,
-      # NOTE:
-      #   - this string is generated on each invocation cuz we need to raise custom exception
-      #     from the Timeout API in order to prevent incorred Timeout::Error interception when
-      #     the intercepted error is caused from the block not from the RQL;
-      #   - we can't omit this string object creation at the moment via original Ruby's Timeout API;
-      # TODO:
-      #   - refine Timeout#timeout (via Ruby's Refinement API) in order to provide lazy exception
-      #     message initialization;
       "Passed <timed> block of code exceeded the lock TTL " \
       "(lock: \"#{lock_key}\", " \
       "ttl: #{lock_ttl}, " \
       "meta: #{meta ? meta.inspect : '<no-meta>'}, " \
       "acq_id: \"#{acquier_id}\", " \
       "hst_id: \"#{host_id}\")",
-      &block
     )
   end
 end

data/lib/redis_queued_locks/errors.rb

@@ -13,6 +13,10 @@ module RedisQueuedLocks
   # @since 1.0.0
   LockAlreadyObtainedError = Class.new(Error)
 
+  # @api private
+  # @since 1.11.0
+  LockAcquiermentIntermediateTimeoutError = Class.new(::Timeout::Error)
+
   # @api public
   # @since 1.0.0
   LockAcquiermentTimeoutError = Class.new(Error)
@@ -21,6 +25,10 @@ module RedisQueuedLocks
   # @since 1.0.0
   LockAcquiermentRetryLimitError = Class.new(Error)
 
+  # @api private
+  # @since 1.12.0
+  TimedLockIntermediateTimeoutError = Class.new(::Timeout::Error)
+
   # @api pulic
   # @since 1.0.0
   TimedLockTimeoutError = Class.new(Error)

data/lib/redis_queued_locks/version.rb

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

data/lib/redis_queued_locks.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
+require 'timeout'
 require 'redis-client'
 require 'qonfig'
-require 'timeout'
 require 'securerandom'
 require 'logger'
 require 'objspace'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis_queued_locks
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.12.0
 platform: ruby
 authors:
 - Rustam Ibragimov
@@ -135,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.17
 signing_key:
 specification_version: 4
 summary: Distributed locks with "prioritized lock acquisition queue" capabilities