redlock 2.0.5 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7672717848770741429fd13a59ea4b6a6f734ffd8b519a9c3e27c5562f553cec
-  data.tar.gz: 627314f12eaf57b1e44bde9cfe2388716705c93b27f95479aa5c70553b3c754b
+  metadata.gz: 229c8a5a2a6c074810df969cd50e20bac41f8bf47e3d5714fe21975888702fb0
+  data.tar.gz: d9e1079662c2ef7ddd23d3e03696c48d6b9ae7fe37c0b65760c3a90be07bc239
 SHA512:
-  metadata.gz: 31b8beb93afa3cd62e741637aa221b71522810a8df54d33ea54874eed7d8fac894da1622f97528704027b870dd7945bdb53dd7424fbfb47c47430f6f659d2a90
-  data.tar.gz: 3602f85cafd155cdaef70499231a0885f1df13f58abc1859c526d11f43ea303a2ee746928166002b5495e53b5ce8fa84700d76c583463bed3adef25da263c5d8
+  metadata.gz: 6a3436508b649c79682b310ff57094aa06a532ebde60b193d720dcc88116166a9bacc5e60701515528ef9cf8b7946e246c2bc8341a75eb948cc23ecd1a7be8ff
+  data.tar.gz: d2fc1c15c559a684f87b08ccd1e7e3adc9988323111803c1ca66f2df5381890c09802218dc86477e1de2099bd7aafca1e5e368c9f15fd85ea9f5d433846c0928

data/.github/workflows/ci.yml

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

data/Makefile

@@ -1,9 +1,9 @@
 default: test
 test:
-	docker-compose run --rm test
+	docker compose run --rm test
 
 build:
-	docker-compose run --rm test gem build redlock.gemspec
+	docker compose run --rm test gem build redlock.gemspec
 
 publish:
-	docker-compose run --rm test gem push `ls -lt *gem | head -n 1 | awk '{ print $$9 }'`
+	docker compose run --rm test gem push `ls -lt *gem | head -n 1 | awk '{ print $$9 }'`

data/lib/redlock/client.rb

@@ -244,11 +244,25 @@ module Redlock
         end
       end
 
+      # Exception classes that may be raised for NOSCRIPT errors.
+      # RedisClient::CommandError is raised when using redis-client directly.
+      # Redis::CommandError (or its subclass Redis::NoScriptError) is raised
+      # when using the redis gem wrapper.
+      # See: https://github.com/leandromoreira/redlock-rb/issues/124
+      # See: https://github.com/leandromoreira/redlock-rb/issues/148
+      def script_error_classes
+        @script_error_classes ||= begin
+          classes = [RedisClient::CommandError]
+          classes << Redis::CommandError if defined?(Redis::CommandError)
+          classes
+        end
+      end
+
       def recover_from_script_flush
         retry_on_noscript = true
         begin
           yield
-        rescue RedisClient::CommandError => e
+        rescue *script_error_classes => e
           # When somebody has flushed the Redis instance's script cache, we might
           # want to reload our scripts. Only attempt this once, though, to avoid
           # going into an infinite loop.
@@ -319,7 +333,8 @@ module Redlock
         @servers.each { |s| s.unlock(resource, value) }
 
         if errors.size >= @quorum
-          raise LockAcquisitionError.new('Too many Redis errors prevented lock acquisition', errors)
+          err_msgs = errors.map { |e| "#{e.class}: #{e.message}" }.join("\n")
+          raise LockAcquisitionError.new("Too many Redis errors prevented lock acquisition:\n#{err_msgs}", errors)
         end
 
         false

data/lib/redlock/version.rb

@@ -1,3 +1,3 @@
 module Redlock
-  VERSION = '2.0.5'
+  VERSION = '2.1.0'
 end

data/redlock.gemspec

@@ -5,14 +5,15 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'redlock/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'redlock'
-  spec.version       = Redlock::VERSION
-  spec.authors       = ['Leandro Moreira']
-  spec.email         = ['leandro.ribeiro.moreira@gmail.com']
-  spec.summary       = 'Distributed lock using Redis written in Ruby.'
-  spec.description   = 'Distributed lock using Redis written in Ruby. Highly inspired by https://github.com/antirez/redlock-rb.'
-  spec.homepage      = 'https://github.com/leandromoreira/redlock-rb'
-  spec.license       = 'BSD-2-Clause'
+  spec.name                  = 'redlock'
+  spec.version               = Redlock::VERSION
+  spec.authors               = ['Leandro Moreira']
+  spec.email                 = ['leandro.ribeiro.moreira@gmail.com']
+  spec.summary               = 'Distributed lock using Redis written in Ruby.'
+  spec.description           = 'Distributed lock using Redis written in Ruby. Highly inspired by https://github.com/antirez/redlock-rb.'
+  spec.homepage              = 'https://github.com/leandromoreira/redlock-rb'
+  spec.license               = 'BSD-2-Clause'
+  spec.required_ruby_version = '>= 2.7.0'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
@@ -21,8 +22,8 @@ Gem::Specification.new do |spec|
   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'
-  spec.add_development_dependency 'json', '>= 2.3.0', '~> 2.3.1'
+  spec.add_development_dependency 'coveralls_reborn', '~> 0.29'
+  spec.add_development_dependency 'json', '>= 2.3.0'
   spec.add_development_dependency 'rake', '>= 11.1.2', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3', '>= 3.0.0'
 end

data/spec/client_spec.rb

@@ -110,7 +110,13 @@ RSpec.describe Redlock::Client do
 
           expect {
             redlock.lock(resource_key, ttl)
-          }.to raise_error(Redlock::LockAcquisitionError)
+          }.to raise_error do |error|
+            expect(error).to be_a(Redlock::LockAcquisitionError)
+            expect(error.message).to include('Too many Redis errors prevented lock acquisition')
+            expect(error.message).to include('RedisClient::CannotConnectError')
+            expect(error.message).to include('Connection refused')
+            expect(error.errors.size).to eq(2)
+          end
         end
       end
 
@@ -371,6 +377,108 @@ RSpec.describe Redlock::Client do
       end
     end
 
+    context 'when using the redis gem (Redis::CommandError)' do
+      # The redis gem raises Redis::CommandError (or Redis::NoScriptError) instead of
+      # RedisClient::CommandError. This tests that both error hierarchies are handled.
+      # See: https://github.com/leandromoreira/redlock-rb/issues/124
+      # See: https://github.com/leandromoreira/redlock-rb/issues/148
+
+      before(:all) do
+        # Define Redis::CommandError if not already defined (simulates redis gem being loaded)
+        unless defined?(Redis::CommandError)
+          module Redis
+            class CommandError < StandardError; end
+          end
+          @redis_command_error_defined_by_test = true
+        end
+      end
+
+      after(:all) do
+        # Clean up the mock class if we defined it
+        if @redis_command_error_defined_by_test
+          Redis.send(:remove_const, :CommandError)
+          Object.send(:remove_const, :Redis) if Redis.constants.empty?
+        end
+      end
+
+      describe '#script_error_classes' do
+        it 'includes RedisClient::CommandError' do
+          redis_instance = lock_manager.instance_variable_get(:@servers).first
+          expect(redis_instance.send(:script_error_classes)).to include(RedisClient::CommandError)
+        end
+
+        it 'includes Redis::CommandError when defined' do
+          redis_instance = lock_manager.instance_variable_get(:@servers).first
+          # Clear memoization to pick up the newly defined class
+          redis_instance.instance_variable_set(:@script_error_classes, nil)
+          expect(redis_instance.send(:script_error_classes)).to include(Redis::CommandError)
+        end
+      end
+
+      context 'when Redis::CommandError NOSCRIPT is raised' do
+        it 'recovers by reloading scripts' do
+          redis_instance = lock_manager.instance_variable_get(:@servers).first
+          # Clear memoization to ensure Redis::CommandError is included
+          redis_instance.instance_variable_set(:@script_error_classes, nil)
+
+          call_count = 0
+          allow(redis_instance).to receive(:synchronize).and_wrap_original do |original_method, &block|
+            call_count += 1
+            if call_count == 1
+              # First call raises Redis::CommandError with NOSCRIPT
+              raise Redis::CommandError, 'NOSCRIPT No matching script'
+            else
+              original_method.call(&block)
+            end
+          end
+
+          expect(redis_instance).to receive(:load_scripts).and_call_original
+
+          # Should recover and successfully lock
+          lock_info = lock_manager.lock(resource_key, ttl)
+          expect(lock_info).to be_truthy
+          lock_manager.unlock(lock_info) if lock_info
+        end
+
+        it 'does not retry more than once per operation' do
+          redis_instance = lock_manager.instance_variable_get(:@servers).first
+          redis_instance.instance_variable_set(:@script_error_classes, nil)
+
+          # Always raise Redis::CommandError NOSCRIPT
+          allow(redis_instance).to receive(:synchronize).and_raise(
+            Redis::CommandError, 'NOSCRIPT No matching script'
+          )
+
+          load_scripts_count = 0
+          allow(redis_instance).to receive(:load_scripts) { load_scripts_count += 1 }
+
+          expect {
+            lock_manager.lock(resource_key, ttl)
+          }.to raise_error(Redlock::LockAcquisitionError)
+
+          # Should have called load_scripts once per retry attempt (8 times total:
+          # lock + unlock for each of retry_count+1 attempts, but unlock swallows errors)
+          expect(load_scripts_count).to eq(8)
+        end
+
+        it 're-raises non-NOSCRIPT Redis::CommandError' do
+          redis_instance = lock_manager.instance_variable_get(:@servers).first
+          redis_instance.instance_variable_set(:@script_error_classes, nil)
+
+          allow(redis_instance).to receive(:synchronize).and_raise(
+            Redis::CommandError, 'ERR some other error'
+          )
+
+          expect {
+            lock_manager.lock(resource_key, ttl)
+          }.to raise_error(Redlock::LockAcquisitionError) do |e|
+            expect(e.errors[0]).to be_a(Redis::CommandError)
+            expect(e.errors[0].message).to eq('ERR some other error')
+          end
+        end
+      end
+    end
+
     describe 'block syntax' do
       context 'when lock is available' do
         it 'locks' do

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: redlock
 version: !ruby/object:Gem::Version
-  version: 2.0.5
+  version: 2.1.0
 platform: ruby
 authors:
 - Leandro Moreira
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-28 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis-client
@@ -45,19 +44,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: coveralls_reborn
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.29'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.29'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -65,9 +64,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.3.0
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.3.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -75,9 +71,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.3.0
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.3.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -150,7 +143,6 @@ homepage: https://github.com/leandromoreira/redlock-rb
 licenses:
 - BSD-2-Clause
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -158,15 +150,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Distributed lock using Redis written in Ruby.
 test_files: