redis_queued_locks 1.1.0 → 1.3.0

data/lib/redis_queued_locks/resource.rb

@@ -1,26 +1,32 @@
 # frozen_string_literal: true
 
 # @api private
-# @since 0.1.0
+# @since 1.0.0
 module RedisQueuedLocks::Resource
   # @return [String]
   #
   # @api private
-  # @since 0.1.0
+  # @since 1.0.0
   KEY_PATTERN = 'rql:lock*'
 
   # @return [String]
   #
   # @api private
-  # @since 0.1.0
+  # @since 1.0.0
   LOCK_PATTERN = 'rql:lock:*'
 
   # @return [String]
   #
   # @api private
-  # @since 0.1.0
+  # @since 1.0.0
   LOCK_QUEUE_PATTERN = 'rql:lock_queue:*'
 
+  # @return [Integer] Redis time error (in milliseconds).
+  #
+  # @api private
+  # @since 1.3.0
+  REDIS_TIMESHIFT_ERROR = 2
+
   class << self
     # Returns 16-byte unique identifier. It is used for uniquely
     # identify current process between different nodes/pods of your application
@@ -29,7 +35,7 @@ module RedisQueuedLocks::Resource
     # @return [String]
     #
     # @api private
-    # @since 0.1.0
+    # @since 1.0.0
     def calc_uniq_identity
       SecureRandom.hex(8)
     end
@@ -42,7 +48,7 @@ module RedisQueuedLocks::Resource
     # @return [String]
     #
     # @api private
-    # @since 0.1.0
+    # @since 1.0.0
     def acquier_identifier(process_id, thread_id, fiber_id, ractor_id, identity)
       "rql:acq:#{process_id}/#{thread_id}/#{fiber_id}/#{ractor_id}/#{identity}"
     end
@@ -51,7 +57,7 @@ module RedisQueuedLocks::Resource
     # @return [String]
     #
     # @api private
-    # @since 0.1.0
+    # @since 1.0.0
     def prepare_lock_key(lock_name)
       "rql:lock:#{lock_name}"
     end
@@ -60,7 +66,7 @@ module RedisQueuedLocks::Resource
     # @return [String]
     #
     # @api private
-    # @since 0.1.0
+    # @since 1.0.0
     def prepare_lock_queue(lock_name)
       "rql:lock_queue:#{lock_name}"
     end
@@ -68,7 +74,7 @@ module RedisQueuedLocks::Resource
     # @return [Float] Redis's <Set> score that is calculated from the time (epoch) as a float.
     #
     # @api private
-    # @since 0.1.0
+    # @since 1.0.0
     def calc_initial_acquier_position
       Time.now.to_f
     end
@@ -77,7 +83,7 @@ module RedisQueuedLocks::Resource
     # @return [Float] Redis's <Set> score barrier for acquiers that should be removed from queue.
     #
     # @api private
-    # @since 0.1.0
+    # @since 1.0.0
     def acquier_dead_score(queue_ttl)
       Time.now.to_f - queue_ttl
     end
@@ -91,7 +97,7 @@ module RedisQueuedLocks::Resource
     #   Is the lock request time limit has reached or not.
     #
     # @api private
-    # @since 0.1.0
+    # @since 1.0.0
     def dead_score_reached?(acquier_position, queue_ttl)
       (acquier_position + queue_ttl) < Time.now.to_f
     end
@@ -100,7 +106,7 @@ module RedisQueuedLocks::Resource
     # @return [String]
     #
     # @api private
-    # @since 0.1.0
+    # @since 1.0.0
     def lock_key_from_queue(lock_queue)
       # NOTE: 15 is a start position of the lock name
       "rql:lock:#{lock_queue[15..]}"
@@ -109,7 +115,7 @@ module RedisQueuedLocks::Resource
     # @return [Integer]
     #
     # @api private
-    # @since 0.1.0
+    # @since 1.0.0
     def get_thread_id
       ::Thread.current.object_id
     end
@@ -117,7 +123,7 @@ module RedisQueuedLocks::Resource
     # @return [Integer]
     #
     # @api private
-    # @since 0.1.0
+    # @since 1.0.0
     def get_fiber_id
       ::Fiber.current.object_id
     end
@@ -125,7 +131,7 @@ module RedisQueuedLocks::Resource
     # @return [Integer]
     #
     # @api private
-    # @since 0.1.0
+    # @since 1.0.0
     def get_ractor_id
       ::Ractor.current.object_id
     end
@@ -133,7 +139,7 @@ module RedisQueuedLocks::Resource
     # @return [Integer]
     #
     # @api private
-    # @since 0.1.0
+    # @since 1.0.0
     def get_process_id
       ::Process.pid
     end

data/lib/redis_queued_locks/utilities.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # @api private
-# @since 0.1.0
+# @since 1.0.0
 module RedisQueuedLocks::Utilities
   module_function
 
@@ -9,7 +9,7 @@ module RedisQueuedLocks::Utilities
   # @return [Any]
   #
   # @api private
-  # @since 0.1.0
+  # @since 1.0.0
   def run_non_critical(&block)
     yield rescue nil
   end

data/lib/redis_queued_locks/version.rb

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

data/lib/redis_queued_locks.rb

@@ -7,7 +7,7 @@ require 'securerandom'
 require 'logger'
 
 # @api public
-# @since 0.1.0
+# @since 1.0.0
 module RedisQueuedLocks
   require_relative 'redis_queued_locks/version'
   require_relative 'redis_queued_locks/errors'
@@ -20,6 +20,6 @@ module RedisQueuedLocks
   require_relative 'redis_queued_locks/instrument'
   require_relative 'redis_queued_locks/client'
 
-  # @since 0.1.0
+  # @since 1.0.0
   extend RedisQueuedLocks::Debugger::Interface
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis_queued_locks
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Rustam Ibragimov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-02 00:00:00.000000000 Z
+date: 2024-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis-client
@@ -60,7 +60,7 @@ files:
 - lib/redis_queued_locks/acquier/acquire_lock/delay_execution.rb
 - lib/redis_queued_locks/acquier/acquire_lock/try_to_lock.rb
 - lib/redis_queued_locks/acquier/acquire_lock/with_acq_timeout.rb
-- lib/redis_queued_locks/acquier/acquire_lock/yield_with_expire.rb
+- lib/redis_queued_locks/acquier/acquire_lock/yield_expire.rb
 - lib/redis_queued_locks/acquier/clear_dead_requests.rb
 - lib/redis_queued_locks/acquier/extend_lock_ttl.rb
 - lib/redis_queued_locks/acquier/is_locked.rb
@@ -108,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.1
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Queued distributed locks based on Redis.

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

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-# @api private
-# @since 0.1.0
-module RedisQueuedLocks::Acquier::AcquireLock::YieldWithExpire
-  # @since 0.1.0
-  extend RedisQueuedLocks::Utilities
-
-  # @param redis [RedisClient] Redis connection manager.
-  # @param logger [::Logger,#debug] Logger object.
-  # @param lock_key [String] Lock key to be expired.
-  # @param acquier_id [String] Acquier identifier.
-  # @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 queue_ttl [Integer] Lock request lifetime.
-  # @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,
-    logger,
-    lock_key,
-    acquier_id,
-    timed,
-    ttl_shift,
-    ttl,
-    queue_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
-    run_non_critical do
-      logger.debug do
-        "[redis_queued_locks.expire_lock] " \
-        "lock_key => '#{lock_key}' " \
-        "queue_ttl => #{queue_ttl} " \
-        "acq_id => '#{acquier_id}'"
-      end
-    end
-    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,
-      "Passed <timed> block of code exceeded " \
-      "the lock TTL (lock: \"#{lock_key}\", ttl: #{lock_ttl})"
-    )
-  end
-end