redis_queued_locks 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5dbd11cefb9d18a816eb4c63fe1178f87325c30d75efc2bc806d29f41994fc2c
-  data.tar.gz: 9697f4bf452aaaa7cade45320c50d16b510c657074ba97513c5f8de9c51f6c49
+  metadata.gz: 6e1e1a54762132f92451d595938cb467b7b644dffc0817abe99209e1f92160f8
+  data.tar.gz: 297eec3d7fcee35d12e7f3509e8e3dfd4b8b3c52889c7570a79cd6a30f45eda4
 SHA512:
-  metadata.gz: b28ef92375c7eef4d6c43fccb5e44105d653fb00e052edcf67316f8da13578ad7b39086b3799782592b38bf046760f8faa1238b92de293b83eb1e4a7c441413e
-  data.tar.gz: dfd3891ae8d0303b88ac95268056addc3b4e03f862a5200166de9553b412eee78b77f42193f133f9dd340793b67928806e2e05451517585c2282fb7e4c871d1f
+  metadata.gz: 6d2c64622bd3b8465a749b5f6a8050d5fd1d5b623990f91421f91004c444baab12114964ded28d5ac0fa43fed56f3e893798feb31b00ab173d536e57fcfdfaa4
+  data.tar.gz: 02ee9d8742ffd3a7b16b8c23b8d4c4f58a8cb1b9db4d215ece4bf34de0c79830bd3417186b2d75dbbd48f6845d736361af7503f641e7faa16d139cbe193263d3

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.0.4] - 2024-02-26
+### Changed
+- changed default configuration values of `RedisQueuedLocks::Client` config;
+
 ## [0.0.3] - 2024-02-26
 ### Changed
 - Instrumentation events:

data/README.md

@@ -2,6 +2,67 @@
 
 Distributed lock implementation with "lock acquisition queue" capabilities based on the Redis Database.
 
+## Configuration
+
+```ruby
+redis_client = RedisClient.config.new_pool # NOTE: provide your own RedisClient instance
+
+clinet = RedisQueuedLocks::Client.new(redis_client) do |config|
+  # (default: 3) (supports nil)
+  # - nil means "infinite retries" and you are only limited by the "try_to_lock_timeout" config;
+  config.retry_count = 3
+
+  # (milliseconds) (default: 200)
+  config.retry_delay = 200
+
+  # (milliseconds) (default: 50)
+  config.retry_jitter = 50
+
+  # (seconds) (supports nil)
+  # - nil means "no timeout" and you are only limited by "retry_count" config;
+  config.try_to_lock_timeout = 10
+
+  # (milliseconds) (default: 1)
+  # - expiration precision. affects the ttl (ttl + precision);
+  config.exp_precision = 1
+
+  # (milliseconds) (default: 5_000)
+  # - lock's time to live
+  config.default_lock_ttl = 5_000
+
+  # (seconds) (default: 15)
+  # - lock request timeout. after this timeout your lock request in queue will be requeued;
+  config.default_queue_ttl = 15
+
+  # (default: 100)
+  # - how many items will be released at a time in RedisQueuedLocks::Client#clear_locks logic;
+  # - affects the performancs capabilites (redis, rubyvm);
+  config.lock_release_batch_size = 100
+
+  # (default: RedisQueuedLocks::Instrument::VoidNotifier)
+  # - instrumentation layer;
+  # - you can provde your own instrumenter with `#notify(event, payload = {})`
+  #   - event: <string> requried;
+  #   - payload: <hash> requried;
+  # - disabled by default via VoidNotifier;
+  config.instrumenter = RedisQueuedLocks::Instrument::ActiveSupport
+end
+```
+
+## Usage
+
+```ruby
+redis_clinet = RedisClient.config.new_pool # NOTE: provide your ounw RedisClient instance
+rq_lock = RedisQueuedLocks::Client.new(redis_client) do |config|
+  # NOTE: some your application-related configs
+end
+```
+
+- `#lock`
+- `#lock!`
+- `#unlock`
+- `#clear_locks`
+
 ## Instrumentation events
 
 - `"redis_queued_locks.lock_obtained"`
@@ -32,6 +93,6 @@ Distributed lock implementation with "lock acquisition queue" capabilities based
 - `"redis_queued_locks.explicit_all_locks_release"`
   - an event signalizes about the explicit all locks release (invoked via `RedisQueuedLock#clear_locks`);
   - payload:
-    - `rel_time` - `float`/`milliseconds` - time spent on the lock release;
+    - `rel_time` - `float`/`milliseconds` - time spent on "realese all locks" operation;
     - `at` - `integer`/`epoch` - the time when the operation has ended;
     - `rel_keys` - `integer` - released redis keys count (`released queu keys` + `released lock keys`);

data/lib/redis_queued_locks/client.rb

@@ -10,10 +10,10 @@ class RedisQueuedLocks::Client
     setting :retry_count, 3
     setting :retry_delay, 200 # NOTE: milliseconds
     setting :retry_jitter, 50 # NOTE: milliseconds
-    setting :default_timeout, 10 # NOTE: seconds
+    setting :try_to_lock_timeout, 10 # NOTE: seconds
     setting :exp_precision, 1 # NOTE: milliseconds
     setting :default_lock_ttl, 5_000 # NOTE: milliseconds
-    setting :default_queue_ttl, 30 # NOTE: seconds
+    setting :default_queue_ttl, 15 # NOTE: seconds
     setting :lock_release_batch_size, 100
     setting :instrumenter, RedisQueuedLocks::Instrument::VoidNotifier
 
@@ -23,7 +23,7 @@ class RedisQueuedLocks::Client
     validate('retry_count') { |val| val == nil || (val.is_a?(::Integer) && val >= 0) }
     validate('retry_delay', :integer)
     validate('retry_jitter', :integer)
-    validate('default_timeout', :integer)
+    validate('try_to_lock_timeout') { |val| val == nil || (val.is_a?(::Integer) && val >= 0) }
     validate('exp_precision', :integer)
     validate('default_lock_tt', :integer)
     validate('default_queue_ttl', :integer)
@@ -86,7 +86,7 @@ class RedisQueuedLocks::Client
     thread_id: RedisQueuedLocks::Resource.get_thread_id,
     ttl: config[:default_lock_ttl],
     queue_ttl: config[:default_queue_ttl],
-    timeout: config[:default_timeout],
+    timeout: config[:try_to_lock_timeout],
     retry_count: config[:retry_count],
     retry_delay: config[:retry_delay],
     retry_jitter: config[:retry_jitter],

data/lib/redis_queued_locks/version.rb

@@ -4,6 +4,7 @@ module RedisQueuedLocks
   # @return [String]
   #
   # @api public
-  # @since 0.0.3
-  VERSION = '0.0.3'
+  # @since 0.0.1
+  # @version 0.0.4
+  VERSION = '0.0.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis_queued_locks
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Rustam Ibragimov