redlock 2.0.2 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bdda4faebf87c2d1fb0026a3142497d5ae14092340bce6e35e46f51635e5c6a
-  data.tar.gz: a9f5636898a2a3ece98b95a286bd88f417e68d119b1f1ad60bd75b5d1da94baf
+  metadata.gz: a0dee2cedbef9dc37a61a0708dc788287d3ab70b96bfd2561267ddd580e128f9
+  data.tar.gz: 7e6292d1b22149c3c538c7f3bbd0285a9a7c51ef472d2ec22e99190927da5967
 SHA512:
-  metadata.gz: 0b10ec10f00ce9282d604b1d0c8a2e845d8d95a6684a5a235d6d39b598efa6324725c4d088e8016b11d473b0195a1e29a451e79fad115f04f6b217493be297cf
-  data.tar.gz: e1d54bb8bb8a108e0989d1c11baa44cbfc4c971029fb23819d000758b42739698342ef803a826990757c888d113fb8a49663df1f3812603965c5498361596f86
+  metadata.gz: 4fccf4ff8a3c5647e828a71b6b982b67f5bc1cc702a88279752ce53fc88addc4f5ffaa657f4c7f5f5ca09bfb9ee27f2aee8f7551a9bfa655f176d99c98d76051
+  data.tar.gz: ef9d3a5f10ec4b62b41ee890a69eb91ff16d92832ca75d82fb1387145330f979d8d01b614bf0893ad29669056f479a44f64278effcdbcc74150be2a4a2258f3d

data/.github/workflows/ci.yml

@@ -13,7 +13,7 @@ jobs:
 
     strategy:
       matrix:
-        ruby-version: [3.1, "3.0", "2.7", "2.6", "2.5", "ruby-head"]
+        ruby-version: [3.2, 3.1, "3.0", "2.7", "2.6", "2.5", "ruby-head"]
 
     steps:
       - uses: actions/checkout@v2

data/README.md

@@ -176,14 +176,29 @@ lock_manager.get_remaining_ttl_for_resource(resource)
 
 ## Redis client configuration
 
-`Redlock::Client` expects URLs or Redis objects on initialization. Redis objects should be used for configuring the connection in more detail, i.e. setting username and password.
+`Redlock::Client` expects URLs, or configurations or Redis objects on initialization. Redis objects should be used for configuring the connection in more detail, i.e. setting username and password.
 
 ```ruby
 servers = [ 'redis://localhost:6379', RedisClient.new(:url => 'redis://someotherhost:6379') ]
 redlock = Redlock::Client.new(servers)
 ```
 
-Redlock works seamlessly with [redis sentinel](http://redis.io/topics/sentinel), which is supported in redis 3.2+.
+To utilize `Redlock::Client` with sentinels you can pass an instance of `RedisClient` or just a configuration hash as part of the servers array during initialization.
+
+```ruby
+config = {
+  name: "mymaster",
+  sentinels: [
+    { host: "127.0.0.1", port: 26380 },
+    { host: "127.0.0.1", port: 26381 },
+  ],
+  role: :master
+}
+client = RedisClient.sentinel(**config).new_client
+servers = [ config, client ]
+redlock = Redlock::Client.new(servers)
+```
+Redlock supports the same configuration hash as `RedisClient`.
 
 ## Redlock configuration
 

data/lib/redlock/client.rb

@@ -1,10 +1,11 @@
+require 'monitor'
 require 'redis-client'
 require 'securerandom'
 
 module Redlock
   include Scripts
 
-  class LockAcquisitionError < StandardError
+  class LockAcquisitionError < LockError
     attr_reader :errors
 
     def initialize(message, errors)
@@ -163,21 +164,50 @@ module Redlock
       end
 
       def initialize(connection)
+        @monitor = Monitor.new
+
         if connection.respond_to?(:with)
           @redis = connection
         else
           if connection.respond_to?(:client)
             @redis = connection
           else
-            @redis = RedisClient.new(connection)
+            @redis = initialize_client(connection)
           end
           @redis.extend(ConnectionPoolLike)
         end
       end
 
+      def initialize_client(options)
+        if options.key?(:sentinels)
+          if url = options.delete(:url)
+            uri = URI.parse(url)
+            if !options.key?(:name) && uri.host
+              options[:name] = uri.host
+            end
+
+            if !options.key?(:password) && uri.password && !uri.password.empty?
+              options[:password] = uri.password
+            end
+
+            if !options.key?(:username) && uri.user && !uri.user.empty?
+              options[:username] = uri.user
+            end
+          end
+
+          RedisClient.sentinel(**options).new_client
+        else
+          RedisClient.config(**options).new_client
+        end
+      end
+
+      def synchronize
+        @monitor.synchronize { @redis.with { |connection| yield(connection) } }
+      end
+
       def lock(resource, val, ttl, allow_new_lock)
         recover_from_script_flush do
-          @redis.with { |conn|
+          synchronize { |conn|
             conn.call('EVALSHA', Scripts::LOCK_SCRIPT_SHA, 1, resource, val, ttl, allow_new_lock)
           }
         end
@@ -185,7 +215,7 @@ module Redlock
 
       def unlock(resource, val)
         recover_from_script_flush do
-          @redis.with { |conn|
+          synchronize { |conn|
             conn.call('EVALSHA', Scripts::UNLOCK_SCRIPT_SHA, 1, resource, val)
           }
         end
@@ -195,7 +225,7 @@ module Redlock
 
       def get_remaining_ttl(resource)
         recover_from_script_flush do
-          @redis.with { |conn|
+          synchronize { |conn|
             conn.call('EVALSHA', Scripts::PTTL_SCRIPT_SHA, 1, resource)
           }
         end
@@ -212,7 +242,7 @@ module Redlock
           Scripts::PTTL_SCRIPT
         ]
 
-        @redis.with do |connnection|
+        synchronize do |connnection|
           scripts.each do |script|
             connnection.call('SCRIPT', 'LOAD', script)
           end

data/lib/redlock/version.rb

@@ -1,3 +1,3 @@
 module Redlock
-  VERSION = '2.0.2'
+  VERSION = '2.0.4'
 end

data/redlock.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'redis-client', '~> 0.14.1'
+  spec.add_dependency 'redis-client', '>= 0.14.1', '< 1.0.0'
 
   spec.add_development_dependency 'connection_pool', '~> 2.2'
   spec.add_development_dependency 'coveralls', '~> 0.8'

data/spec/client_spec.rb

@@ -59,6 +59,16 @@ RSpec.describe Redlock::Client do
       lock_manager.unlock(lock_info)
     end
 
+    it 'accepts Configuration hashes' do
+      config = { url: "redis://#{redis1_host}:#{redis1_port}" }
+      _redlock = Redlock::Client.new([config])
+
+      lock_info = lock_manager.lock(resource_key, ttl)
+      expect(lock_info).to be_a(Hash)
+      expect(resource_key).to_not be_lockable(lock_manager, ttl)
+      lock_manager.unlock(lock_info)
+    end
+
     it 'does not load scripts' do
       redis_client.call('SCRIPT', 'FLUSH')
 

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: redlock
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.4
 platform: ruby
 authors:
 - Leandro Moreira
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-15 00:00:00.000000000 Z
+date: 2023-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.14.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.14.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: connection_pool
   requirement: !ruby/object:Gem::Requirement
@@ -144,7 +150,7 @@ homepage: https://github.com/leandromoreira/redlock-rb
 licenses:
 - BSD-2-Clause
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -159,8 +165,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Distributed lock using Redis written in Ruby.
 test_files: