redis_queued_locks 0.0.18 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0993079d1a7cca97094c741d65c4ef1e8a5694184212b6597960e0b3c91d83cb'
-  data.tar.gz: 22535e254fa22db6bfb0225f391e3d4606ad680bb401034fcbdfcd8e93a1fc5c
+  metadata.gz: c77f863ddb9f33c75a636ea12281ce1f4df1215d50f43b113b5be5f79b679526
+  data.tar.gz: 9585690846e55b141e089d26ac160f6481297cfa6f43d21df1403411903221be
 SHA512:
-  metadata.gz: 7db77251aefc59a83a9727d756774f5eb6b30a156fd058d69ec5170d252cc8fb875b2f213da2e15a4bdf9f5565565aa5ca699545ac0a83dcbc333fbed8c7aec1
-  data.tar.gz: 659c47a6aaa421ade9c7ffaea000a7133c1ba72f5ab0a2e66bc56f5ad72f84f4d9525fc86024e5d52b8196a6dfc7b0a714100462915a91405c97c3b3d77d3e26
+  metadata.gz: 9e132a1464d92aa59539d5489d5b7d777399de6c38f313cbad063b819e0e32503591532eb010f5c6b87da41096172e9dde8f5fa2fc84623ca2256b84cd3fa98d
+  data.tar.gz: ea8dc9808a5c16697e5606ce8394c987ceb8df4f561fbf06250bd7669188665f56825a582e9c82240a52b6376767eedda9afeed588f960498fb32070466c512c

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.0.19] - 2024-03-12
+### Added
+- An ability to set the invocation time period to the block of code invoked under
+  the obtained lock;
+
 ## [0.0.18] - 2024-03-04
 ### Changed
 - Semantic results for methods returning `{ ok: true/false, result: Any }` hash objects.

data/README.md

@@ -167,6 +167,7 @@ def lock(
   ttl: config[:default_lock_ttl],
   queue_ttl: config[:default_queue_ttl],
   timeout: config[:try_to_lock_timeout],
+  timed: false,
   retry_count: config[:retry_count],
   retry_delay: config[:retry_delay],
   retry_jitter: config[:retry_jitter],
@@ -185,6 +186,8 @@ def lock(
   - Lifetime of the acuier's lock request. In seconds.
 - `timeout` - `[Integer,NilClass]`
   - Time period whe should try to acquire the lock (in seconds). Nil means "without timeout".
+- `timed` - `[Boolean]`
+  - Limit the invocation time period of the passed block of code by the lock's TTL.
 - `retry_count` - `[Integer,NilClass]`
   - How many times we should try to acquire a lock. Nil means "infinite retries".
 - `retry_delay` - `[Integer]`

data/lib/redis_queued_locks/acquier/yield_expire.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+module RedisQueuedLocks::Acquier::YieldExpire
+  # @param redis [RedisClient] Redis connection manager.
+  # @param lock_key [String] Lock key to be expired.
+  # @param timed [Boolean] Should the lock be wrapped by Tiemlout with with lock's ttl
+  # @param ttl_shift [Float] Lock's TTL shifting. Should affect block's ttl. In millisecodns.
+  # @param ttl [Integer,NilClass] Lock's time to live (in ms). Nil means "without timeout".
+  # @param block [Block] Custom logic that should be invoked unter the obtained lock.
+  # @return [Any,NilClass] nil is returned no block parametr is provided.
+  #
+  # @api private
+  # @since 0.1.0
+  def yield_with_expire(redis, lock_key, timed, ttl_shift, ttl, &block)
+    if block_given?
+      if timed && ttl != nil
+        timeout = ((ttl - ttl_shift) / 1000.0).yield_self { |time| (time < 0) ? 0.0 : time }
+        yield_with_timeout(timeout, lock_key, ttl, &block)
+      else
+        yield
+      end
+    end
+  ensure
+    redis.call('EXPIRE', lock_key, '0')
+  end
+
+  private
+
+  # @param timeout [Float]
+  # @parma lock_key [String]
+  # @param lock_ttl [Integer,NilClass]
+  # @param block [Blcok]
+  # @return [Any]
+  #
+  # @api private
+  # @since 0.1.0
+  def yield_with_timeout(timeout, lock_key, lock_ttl, &block)
+    ::Timeout.timeout(timeout, &block)
+  rescue ::Timeout::Error
+    raise(RedisQueuedLocks::TimedLockTimeoutError, <<~ERROR_MESSAGE)
+      Passed <timed> block of code exceeded the lock TTL (lock: "#{lock_key}", ttl: #{lock_ttl})
+    ERROR_MESSAGE
+  end
+end

data/lib/redis_queued_locks/acquier.rb

@@ -6,7 +6,7 @@
 module RedisQueuedLocks::Acquier
   require_relative 'acquier/try'
   require_relative 'acquier/delay'
-  require_relative 'acquier/expire'
+  require_relative 'acquier/yield_expire'
   require_relative 'acquier/release'
 
   # @since 0.1.0
@@ -14,7 +14,7 @@ module RedisQueuedLocks::Acquier
   # @since 0.1.0
   extend Delay
   # @since 0.1.0
-  extend Expire
+  extend YieldExpire
   # @since 0.1.0
   extend Release
 
@@ -44,6 +44,8 @@ module RedisQueuedLocks::Acquier
     #   Lifetime of the acuier's lock request. In seconds.
     # @option timeout [Integer]
     #   Time period whe should try to acquire the lock (in seconds).
+    # @option timed [Boolean]
+    #   Limit the invocation time period of the passed block of code by the lock's TTL.
     # @option retry_count [Integer,NilClass]
     #   How many times we should try to acquire a lock. Nil means "infinite retries".
     # @option retry_delay [Integer]
@@ -80,6 +82,7 @@ module RedisQueuedLocks::Acquier
       ttl:,
       queue_ttl:,
       timeout:,
+      timed:,
       retry_count:,
       retry_delay:,
       retry_jitter:,
@@ -119,7 +122,7 @@ module RedisQueuedLocks::Acquier
       acq_dequeue = -> { dequeue_from_lock_queue(redis, lock_key_queue, acquier_id) }
 
       # Step 2: try to lock with timeout
-      with_timeout(timeout, lock_key, raise_errors, on_timeout: acq_dequeue) do
+      with_acq_timeout(timeout, lock_key, raise_errors, on_timeout: acq_dequeue) do
         acq_start_time = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
 
         # Step 2.1: caclically try to obtain the lock
@@ -140,6 +143,7 @@ module RedisQueuedLocks::Acquier
 
           # Step X: save the intermediate results to the result observer
           acq_process[:result] = result
+          acq_process[:acq_end_time] = acq_end_time
 
           # Step 2.1: analyze an acquirement attempt
           if ok
@@ -212,7 +216,9 @@ module RedisQueuedLocks::Acquier
         # Step 3.a: acquired successfully => run logic or return the result of acquirement
         if block_given?
           begin
-            yield_with_expire(redis, lock_key, &block)
+            yield_time = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
+            ttl_shift = ((yield_time - acq_process[:acq_end_time]) * 1000).ceil(2)
+            yield_with_expire(redis, lock_key, timed, ttl_shift, ttl, &block)
           ensure
             acq_process[:rel_time] = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
             acq_process[:hold_time] = (
@@ -526,7 +532,7 @@ module RedisQueuedLocks::Acquier
     #
     # @api private
     # @since 0.1.0
-    def with_timeout(timeout, lock_key, raise_errors, on_timeout: nil, &block)
+    def with_acq_timeout(timeout, lock_key, raise_errors, on_timeout: nil, &block)
       ::Timeout.timeout(timeout, &block)
     rescue ::Timeout::Error
       on_timeout.call unless on_timeout == nil

data/lib/redis_queued_locks/client.rb

@@ -71,6 +71,8 @@ class RedisQueuedLocks::Client
   #   Lifetime of the acuier's lock request. In seconds.
   # @option timeout [Integer,NilClass]
   #   Time period whe should try to acquire the lock (in seconds). Nil means "without timeout".
+  # @option timed [Boolean]
+  #   Limit the invocation time period of the passed block of code by the lock's TTL.
   # @option retry_count [Integer,NilClass]
   #   How many times we should try to acquire a lock. Nil means "infinite retries".
   # @option retry_delay [Integer]
@@ -103,6 +105,7 @@ class RedisQueuedLocks::Client
     ttl: config[:default_lock_ttl],
     queue_ttl: config[:default_queue_ttl],
     timeout: config[:try_to_lock_timeout],
+    timed: false,
     retry_count: config[:retry_count],
     retry_delay: config[:retry_delay],
     retry_jitter: config[:retry_jitter],
@@ -121,6 +124,7 @@ class RedisQueuedLocks::Client
       ttl:,
       queue_ttl:,
       timeout:,
+      timed:,
       retry_count:,
       retry_delay:,
       retry_jitter:,
@@ -141,6 +145,7 @@ class RedisQueuedLocks::Client
     ttl: config[:default_lock_ttl],
     queue_ttl: config[:default_queue_ttl],
     timeout: config[:try_to_lock_timeout],
+    timed: false,
     retry_count: config[:retry_count],
     retry_delay: config[:retry_delay],
     retry_jitter: config[:retry_jitter],
@@ -153,6 +158,7 @@ class RedisQueuedLocks::Client
       ttl:,
       queue_ttl:,
       timeout:,
+      timed:,
       retry_count:,
       retry_delay:,
       retry_jitter:,

data/lib/redis_queued_locks/errors.rb

@@ -20,4 +20,8 @@ module RedisQueuedLocks
   # @api public
   # @since 0.1.0
   LockAcquiermentRetryLimitError = Class.new(Error)
+
+  # @api pulic
+  # @since 0.1.0
+  TimedLockTimeoutError = Class.new(Error)
 end

data/lib/redis_queued_locks/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis_queued_locks
 version: !ruby/object:Gem::Version
-  version: 0.0.18
+  version: 0.0.19
 platform: ruby
 authors:
 - Rustam Ibragimov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-04 00:00:00.000000000 Z
+date: 2024-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis-client
@@ -57,9 +57,9 @@ files:
 - lib/redis_queued_locks.rb
 - lib/redis_queued_locks/acquier.rb
 - lib/redis_queued_locks/acquier/delay.rb
-- lib/redis_queued_locks/acquier/expire.rb
 - lib/redis_queued_locks/acquier/release.rb
 - lib/redis_queued_locks/acquier/try.rb
+- lib/redis_queued_locks/acquier/yield_expire.rb
 - lib/redis_queued_locks/client.rb
 - lib/redis_queued_locks/data.rb
 - lib/redis_queued_locks/debugger.rb

data/lib/redis_queued_locks/acquier/expire.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-# @api private
-# @since 0.1.0
-module RedisQueuedLocks::Acquier::Expire
-  # @param redis [RedisClient] Redis connection manager.
-  # @param lock_key [String] Lock key to be expired.
-  # @param block [Block] Custom logic that should be invoked unter the obtained lock.
-  # @return [Any,NilClass] nil is returned no block parametr is provided.
-  #
-  # @api private
-  # @since 0.1.0
-  def yield_with_expire(redis, lock_key, &block)
-    yield if block_given?
-  ensure
-    redis.call('EXPIRE', lock_key, '0')
-  end
-end