redlock 2.0.1 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13a2ef1c0096e1135a1996719fbeb679234b639e0debecba4fa6d72f3fcd174a
-  data.tar.gz: e8e247b8be0ded9272f04addfbcbc6b99c1c6ad4429f344c74d61101af7e1682
+  metadata.gz: eb95cd103dd1856b7c75459b121bd5905d2884f520850552552bdb1c39f7502b
+  data.tar.gz: 165945b2aca8e081ad2704fa9eb699bd2e08e75f973fc7ae802163eed88dce8b
 SHA512:
-  metadata.gz: 81bf9233769810cc1a3f08a6927dc5ffddfa5c31ed158071daf1ad2ffc8303060094dbd78aa4af4185148b49878e36fcf54483a41378277e3bb306dd45c483e6
-  data.tar.gz: b0f198c408d7281c8d1d45ef57ce612a964571bf728969601ecfd448f6e482c83567cef66d94fab6bcf722909bd19ef3120ad2ae56171dc83fae815ad81111a9
+  metadata.gz: 79ba3e5ab3dc1704b2af22efb3f038a43b8b9fd773492ba8e6d8f8e0b162cdd4df3671e2267ac80ff3e1f1a3d0edb3b3cc29430637f6d3efa146fd1f6d4fd100
+  data.tar.gz: '0929d107e6ffb002498a26b5afe0d59e41eacc7265ade1402584b1c25a52509ddbedd40eb24acfacfefa718f343ffe9f055adff4f3f7b390e61971543dea4451'

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/CHANGELOG.md

@@ -0,0 +1,40 @@
+
+# Change Log
+All notable changes to this project will be documented in this file.
+ 
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+ 
+## [Unreleased] - yyyy-mm-dd
+ 
+Here we write upgrading notes for brands. It's a team effort to make them as
+straightforward as possible.
+ 
+### Added
+ 
+### Changed
+ 
+### Fixed
+ 
+
+## [2.0.1] - 2023-02-14
+ 
+### Added
+ 
+### Changed
+   
+### Fixed
+
+* always treat redis instance as pool-like #125
+
+## [2.0.0] - 2023-02-09
+ 
+### Added
+
+* support for redis >= 6.0
+ 
+### Changed
+
+* **BREAKING**: The library now only works with `RedisClient` instance.
+   
+### Fixed

data/README.md

@@ -15,7 +15,8 @@ This is an implementation of a proposed [distributed lock algorithm with Redis](
 
 ## Compatibility
 
-Redlock works with Redis versions 6.0 or later.
+* It works with Redis server versions 6.0 or later.
+* Redlock >= 2.0 only works with [`RedisClient`](https://github.com/redis-rb/redis-client) client instance.
 
 ## Installation
 

data/lib/redlock/client.rb

@@ -4,6 +4,15 @@ require 'securerandom'
 module Redlock
   include Scripts
 
+  class LockAcquisitionError < StandardError
+    attr_reader :errors
+
+    def initialize(message, errors)
+      super(message)
+      @errors = errors
+    end
+  end
+
   class Client
     DEFAULT_REDIS_HOST    = ENV["DEFAULT_REDIS_HOST"] || "localhost"
     DEFAULT_REDIS_PORT    = ENV["DEFAULT_REDIS_PORT"] || "6379"
@@ -160,12 +169,35 @@ module Redlock
           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 lock(resource, val, ttl, allow_new_lock)
         recover_from_script_flush do
           @redis.with { |conn|
@@ -232,6 +264,7 @@ module Redlock
     def try_lock_instances(resource, ttl, options)
       retry_count = options[:retry_count] || @retry_count
       tries = options[:extend] ? 1 : (retry_count + 1)
+      last_error = nil
 
       tries.times do |attempt_number|
         # Wait a random delay before retrying.
@@ -239,8 +272,12 @@ module Redlock
 
         lock_info = lock_instances(resource, ttl, options)
         return lock_info if lock_info
+      rescue => e
+        last_error = e
       end
 
+      raise last_error if last_error
+
       false
     end
 
@@ -261,9 +298,15 @@ module Redlock
     def lock_instances(resource, ttl, options)
       value = (options[:extend] || { value: SecureRandom.uuid })[:value]
       allow_new_lock = options[:extend_only_if_locked] ? 'no' : 'yes'
+      errors = []
 
       locked, time_elapsed = timed do
-        @servers.select { |s| s.lock resource, value, ttl, allow_new_lock }.size
+        @servers.count do |s|
+          s.lock(resource, value, ttl, allow_new_lock)
+        rescue => e
+          errors << e
+          false
+        end
       end
 
       validity = ttl - time_elapsed - drift(ttl)
@@ -272,6 +315,11 @@ module Redlock
         { validity: validity, resource: resource, value: value }
       else
         @servers.each { |s| s.unlock(resource, value) }
+
+        if errors.size >= @quorum
+          raise LockAcquisitionError.new('Too many Redis errors prevented lock acquisition', errors)
+        end
+
         false
       end
     end

data/lib/redlock/version.rb

@@ -1,3 +1,3 @@
 module Redlock
-  VERSION = '2.0.1'
+  VERSION = '2.0.3'
 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'
+  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')
 
@@ -76,6 +86,38 @@ RSpec.describe Redlock::Client do
     context 'when lock is available' do
       after(:each) { lock_manager.unlock(@lock_info) if @lock_info }
 
+      context 'when redis connection error occurs' do
+        let(:servers_with_quorum) {
+          [
+            "redis://#{redis1_host}:#{redis1_port}",
+            "redis://#{redis2_host}:#{redis2_port}",
+            unreachable_redis
+          ]
+        }
+
+        let(:servers_without_quorum) {
+          [
+            "redis://#{redis1_host}:#{redis1_port}",
+            unreachable_redis,
+            unreachable_redis
+          ]
+        }
+
+        it 'locks if majority of redis instances are available' do
+          redlock = Redlock::Client.new(servers_with_quorum)
+
+          expect(redlock.lock(resource_key, ttl)).to be_truthy
+        end
+
+        it 'fails to acquire a lock if majority of Redis instances are not available' do
+          redlock = Redlock::Client.new(servers_without_quorum)
+
+          expect {
+            redlock.lock(resource_key, ttl)
+          }.to raise_error(Redlock::LockAcquisitionError)
+        end
+      end
+
       it 'locks' do
         @lock_info = lock_manager.lock(resource_key, ttl)
 
@@ -266,7 +308,10 @@ RSpec.describe Redlock::Client do
 
         expect {
           lock_manager.lock(resource_key, ttl)
-        }.to raise_error(RedisClient::CannotConnectError)
+        }.to raise_error(Redlock::LockAcquisitionError) do |e|
+          expect(e.errors[0]).to be_a(RedisClient::CannotConnectError)
+          expect(e.errors.count).to eq 1
+        end
       end
     end
 
@@ -278,7 +323,10 @@ RSpec.describe Redlock::Client do
         redis_instance.instance_variable_set(:@redis, unreachable_redis)
         expect {
           lock_manager.lock(resource_key, ttl)
-        }.to raise_error(RedisClient::CannotConnectError)
+        }.to raise_error(Redlock::LockAcquisitionError) do |e|
+          expect(e.errors[0]).to be_a(RedisClient::CannotConnectError)
+          expect(e.errors.count).to eq 1
+        end
         redis_instance.instance_variable_set(:@redis, old_redis)
         expect(lock_manager.lock(resource_key, ttl)).to be_truthy
       end
@@ -308,11 +356,15 @@ RSpec.describe Redlock::Client do
           # This time we do not pass it through to Redis, in order to simulate a passing
           # call to LOAD SCRIPT followed by another NOSCRIPT error. Imagine someone
           # repeatedly calling SCRIPT FLUSH on our Redis instance.
-          expect(@manipulated_instance).to receive(:load_scripts)
+          expect(@manipulated_instance).to receive(:load_scripts).exactly(8).times
 
           expect {
             lock_manager.lock(resource_key, ttl)
-          }.to raise_error(/NOSCRIPT/)
+          }.to raise_error(Redlock::LockAcquisitionError) do |e|
+            expect(e.errors[0]).to be_a(RedisClient::CommandError)
+            expect(e.errors[0].message).to match(/NOSCRIPT/)
+            expect(e.errors.count).to eq 1
+          end
         end
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redlock
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.3
 platform: ruby
 authors:
 - Leandro Moreira
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-14 00:00:00.000000000 Z
+date: 2023-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis-client
@@ -16,14 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        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'
+        version: 0.14.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: connection_pool
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +128,7 @@ files:
 - ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - CONTRIBUTORS
 - Gemfile
 - LICENSE
@@ -143,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
@@ -158,8 +165,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Distributed lock using Redis written in Ruby.
 test_files: