redlock 1.3.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7de9b6b9d70bce2578e474bdfe8dfa15c22bb57e0c876ac7127d826a5b6ba9b4
-  data.tar.gz: c294d219107aa4a8682ba4ff303e150497ea61b2dd4abb71d3cac15e78c218bd
+  metadata.gz: 679d1c44fcda7a2eaa70bdfe38c30e4ee79e417bef0b3ce064aceaf0a9cc0bbb
+  data.tar.gz: 48b6a41c4cc27b8ff8878647dd494a6b87e3b17e540b75d8699e32d4ee982aa5
 SHA512:
-  metadata.gz: b0eeead2b1307f12487603d72a7a5e00d6aba1d697a5327ac484a4fa4cc00575e0fcedd43a38aa34ee93da7322550630ad3cec158a5ef0fcf98849033c90ec85
-  data.tar.gz: 712d3c40ab8c4278f4649f373bfcb6ca4eeb2361461a48ad42d17f44a9d1becba460b82ed99f6b035232698267ad5046831230960b47171d9fa09d9ba0d4b692
+  metadata.gz: a31815a7da2fa6f5c3af35734294cdb34fdfba19dc12eaf25abe950db65be1356afc397ff29a73823d267d99d0069f86651385c1e262da6ced7541345212abda
+  data.tar.gz: cd4e41fe60732180b4b5f3d848715954074f8a063c1513c89e73a37311d5d4c0d8fbe1bbd92b063955324929f07bf59232040de104bfeb14d18837d297910d59

data/.github/workflows/ci.yml

@@ -2,9 +2,9 @@ name: Ruby CI
 
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
-    branches: [ master ]
+    branches: [ main ]
 
 jobs:
   test:

data/.gitignore

@@ -2,3 +2,4 @@
 coverage/
 .bundle/
 dump.rdb
+Gemfile.lock

data/Makefile

@@ -7,6 +7,3 @@ build:
 
 publish:
 	docker-compose run --rm test gem push `ls -lt *gem | head -n 1 | awk '{ print $$9 }'`
-
-updateLock:
-	docker-compose run --rm test bundle lock --update

data/README.md

@@ -15,7 +15,7 @@ This is an implementation of a proposed [distributed lock algorithm with Redis](
 
 ## Compatibility
 
-Redlock works with Redis versions 2.6 or later.
+Redlock works with Redis versions 6.0 or later.
 
 ## Installation
 
@@ -151,7 +151,7 @@ lock_manager.get_remaining_ttl_for_lock(lock_info)
 
 lock_manager.unlock(lock_info)
 lock_manager.get_remaining_ttl_for_lock(lock_info)
-#=> nil 
+#=> nil
 ```
 
 Use `get_remaining_ttl_for_resource` if you do not hold a lock, but want to know the remaining TTL on a locked resource:
@@ -164,13 +164,13 @@ lock_info = lock_manager.lock(resource, 2000)
 lock_manager.locked?(resource)
 #=> true
 lock_manager.get_remaining_ttl_for_resource(resource)
-#=> 1975 
+#=> 1975
 
 # Sometime later
 lock_manager.locked?(resource)
 #=> false
 lock_manager.get_remaining_ttl_for_resource(resource)
-#=> nil 
+#=> nil
 ```
 
 ## Redis client configuration
@@ -178,7 +178,7 @@ lock_manager.get_remaining_ttl_for_resource(resource)
 `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.
 
 ```ruby
-servers = [ 'redis://localhost:6379', Redis.new(:url => 'redis://someotherhost:6379') ]
+servers = [ 'redis://localhost:6379', RedisClient.new(:url => 'redis://someotherhost:6379') ]
 redlock = Redlock::Client.new(servers)
 ```
 

data/lib/redlock/client.rb

@@ -1,4 +1,4 @@
-require 'redis'
+require 'redis-client'
 require 'securerandom'
 
 module Redlock
@@ -160,7 +160,7 @@ module Redlock
           if connection.respond_to?(:client)
             @redis = connection
           else
-            @redis = Redis.new(connection)
+            @redis = RedisClient.new(connection)
           end
           @redis.extend(ConnectionPoolLike)
         end
@@ -168,13 +168,13 @@ module Redlock
 
       def lock(resource, val, ttl, allow_new_lock)
         recover_from_script_flush do
-          @redis.with { |conn| conn.evalsha Scripts::LOCK_SCRIPT_SHA, keys: [resource], argv: [val, ttl, allow_new_lock] }
+          @redis.call('EVALSHA', Scripts::LOCK_SCRIPT_SHA, 1, resource, val, ttl, allow_new_lock)
         end
       end
 
       def unlock(resource, val)
         recover_from_script_flush do
-          @redis.with { |conn| conn.evalsha Scripts::UNLOCK_SCRIPT_SHA, keys: [resource], argv: [val] }
+          @redis.call('EVALSHA', Scripts::UNLOCK_SCRIPT_SHA, 1, resource, val)
         end
       rescue
         # Nothing to do, unlocking is just a best-effort attempt.
@@ -182,9 +182,9 @@ module Redlock
 
       def get_remaining_ttl(resource)
         recover_from_script_flush do
-          @redis.with { |conn| conn.evalsha Scripts::PTTL_SCRIPT_SHA, keys: [resource] }
+          @redis.call('EVALSHA', Scripts::PTTL_SCRIPT_SHA, 1, resource)
         end
-      rescue Redis::BaseConnectionError
+      rescue RedisClient::ConnectionError
         nil
       end
 
@@ -197,8 +197,10 @@ module Redlock
           Scripts::PTTL_SCRIPT
         ]
 
-        scripts.each do |script|
-          @redis.with { |conn| conn.script(:load, script) }
+        @redis.with do |connnection|
+          scripts.each do |script|
+            connnection.call('SCRIPT', 'LOAD', script)
+          end
         end
       end
 
@@ -206,7 +208,7 @@ module Redlock
         retry_on_noscript = true
         begin
           yield
-        rescue Redis::CommandError => e
+        rescue RedisClient::CommandError => 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.

data/lib/redlock/testing.rb

@@ -41,7 +41,7 @@ module Redlock
 
       def load_scripts
         load_scripts_without_testing unless Redlock::Client.testing_mode == :bypass
-      rescue Redis::CommandError
+      rescue RedisClient::CommandError
         # FakeRedis doesn't have #script, but doesn't need it either.
         raise unless defined?(::FakeRedis)
       rescue NoMethodError

data/lib/redlock/version.rb

@@ -1,3 +1,3 @@
 module Redlock
-  VERSION = '1.3.2'
+  VERSION = '2.0.0'
 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', '>= 3.0.0', '< 6.0'
+  spec.add_dependency 'redis-client'
 
   spec.add_development_dependency 'connection_pool', '~> 2.2'
   spec.add_development_dependency 'coveralls', '~> 0.8'

data/spec/client_spec.rb

@@ -1,13 +1,12 @@
 require 'spec_helper'
 require 'securerandom'
-require 'redis'
 require 'connection_pool'
 
 RSpec.describe Redlock::Client do
   # It is recommended to have at least 3 servers in production
   let(:lock_manager_opts) { { retry_count: 3 } }
   let(:lock_manager) { Redlock::Client.new(Redlock::Client::DEFAULT_REDIS_URLS, lock_manager_opts) }
-  let(:redis_client) { Redis.new(url: "redis://#{redis1_host}:#{redis1_port}") }
+  let(:redis_client) { RedisClient.new(url: "redis://#{redis1_host}:#{redis1_port}") }
   let(:resource_key) { SecureRandom.hex(3)  }
   let(:ttl) { 1000 }
   let(:redis1_host) { ENV["REDIS1_HOST"] || "localhost" }
@@ -17,7 +16,7 @@ RSpec.describe Redlock::Client do
   let(:redis3_host) { ENV["REDIS3_HOST"] || "127.0.0.1" }
   let(:redis3_port) { ENV["REDIS3_PORT"] || "6379" }
   let(:unreachable_redis) {
-    redis = Redis.new(url: 'redis://localhost:46864')
+    redis = RedisClient.new(url: 'redis://localhost:46864')
     def redis.with
       yield self
     end
@@ -26,18 +25,18 @@ RSpec.describe Redlock::Client do
 
   describe 'initialize' do
     it 'accepts both redis URLs and Redis objects' do
-      servers = [ "redis://#{redis1_host}:#{redis1_port}", Redis.new(url: "redis://#{redis2_host}:#{redis2_port}") ]
+      servers = [ "redis://#{redis1_host}:#{redis1_port}", RedisClient.new(url: "redis://#{redis2_host}:#{redis2_port}") ]
       redlock = Redlock::Client.new(servers)
 
       redlock_servers = redlock.instance_variable_get(:@servers).map do |s|
-        s.instance_variable_get(:@redis).connection[:host]
+        s.instance_variable_get(:@redis).config.host
       end
 
       expect(redlock_servers).to match_array([redis1_host, redis2_host])
     end
 
     it 'accepts ConnectionPool objects' do
-      pool = ConnectionPool.new { Redis.new(url: "redis://#{redis1_host}:#{redis1_port}") }
+      pool = ConnectionPool.new { RedisClient.new(url: "redis://#{redis1_host}:#{redis1_port}") }
       redlock = Redlock::Client.new([pool])
 
       lock_info = lock_manager.lock(resource_key, ttl)
@@ -46,12 +45,15 @@ RSpec.describe Redlock::Client do
     end
 
     it 'does not load scripts' do
-      redis_client.script(:flush)
+      redis_client.call('SCRIPT', 'FLUSH')
 
-      pool = ConnectionPool.new { Redis.new(url: "redis://#{redis1_host}:#{redis1_port}") }
+      pool = ConnectionPool.new { RedisClient.new(url: "redis://#{redis1_host}:#{redis1_port}") }
       redlock = Redlock::Client.new([pool])
 
-      expect(redis_client.info["number_of_cached_scripts"]).to eq("0")
+      raw_info = redis_client.call('INFO')
+      number_of_cached_scripts = raw_info[/number_of_cached_scripts\:\d+/].split(':').last
+
+      expect(number_of_cached_scripts).to eq("0")
     end
   end
 
@@ -74,7 +76,7 @@ RSpec.describe Redlock::Client do
       it 'interprets lock time as milliseconds' do
         ttl = 20000
         @lock_info = lock_manager.lock(resource_key, ttl)
-        expect(redis_client.pttl(resource_key)).to be_within(200).of(ttl)
+        expect(redis_client.call('PTTL', resource_key)).to be_within(200).of(ttl)
       end
 
       it 'can extend its own lock' do
@@ -106,7 +108,7 @@ RSpec.describe Redlock::Client do
 
         lock_info = lock_manager.lock(resource_key, ttl, extend: lock_info, extend_only_if_locked: true)
         expect(lock_info).not_to be_nil
-        expect(redis_client.pttl(resource_key)).to be_within(200).of(ttl)
+        expect(redis_client.call('PTTL', resource_key)).to be_within(200).of(ttl)
       end
 
       context 'when extend_only_if_locked flag is not given' do
@@ -249,7 +251,7 @@ RSpec.describe Redlock::Client do
 
         expect {
           lock_manager.lock(resource_key, ttl)
-        }.to raise_error(Redis::CannotConnectError)
+        }.to raise_error(RedisClient::CannotConnectError)
       end
     end
 
@@ -261,7 +263,7 @@ RSpec.describe Redlock::Client do
         redis_instance.instance_variable_set(:@redis, unreachable_redis)
         expect {
           lock_manager.lock(resource_key, ttl)
-        }.to raise_error(Redis::CannotConnectError)
+        }.to raise_error(RedisClient::CannotConnectError)
         redis_instance.instance_variable_set(:@redis, old_redis)
         expect(lock_manager.lock(resource_key, ttl)).to be_truthy
       end
@@ -270,10 +272,10 @@ RSpec.describe Redlock::Client do
     context 'when script cache has been flushed' do
       before(:each) do
         @manipulated_instance = lock_manager.instance_variable_get(:@servers).first
-        @manipulated_instance.instance_variable_get(:@redis).script(:flush)
+        @manipulated_instance.instance_variable_get(:@redis).call('SCRIPT', 'FLUSH')
       end
 
-      it 'does not raise a Redis::CommandError: NOSCRIPT error' do
+      it 'does not raise a RedisClient::CommandError: NOSCRIPT error' do
         expect {
           lock_manager.lock(resource_key, ttl)
         }.to_not raise_error

metadata

@@ -1,35 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: redlock
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Leandro Moreira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-17 00:00:00.000000000 Z
+date: 2023-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: redis
+  name: redis-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: connection_pool
   requirement: !ruby/object:Gem::Requirement
@@ -102,22 +96,22 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3'
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3'
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
 description: Distributed lock using Redis written in Ruby. Highly inspired by https://github.com/antirez/redlock-rb.
 email:
 - leandro.ribeiro.moreira@gmail.com
@@ -130,7 +124,6 @@ files:
 - ".rspec"
 - CONTRIBUTORS
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - Makefile
 - README.md
@@ -165,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Distributed lock using Redis written in Ruby.

data/Gemfile.lock

@@ -1,62 +0,0 @@
-PATH
-  remote: .
-  specs:
-    redlock (1.3.2)
-      redis (>= 3.0.0, < 6.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    connection_pool (2.3.0)
-    coveralls (0.8.23)
-      json (>= 1.8, < 3)
-      simplecov (~> 0.16.1)
-      term-ansicolor (~> 1.3)
-      thor (>= 0.19.4, < 2.0)
-      tins (~> 1.6)
-    diff-lcs (1.5.0)
-    docile (1.4.0)
-    json (2.3.1)
-    rake (13.0.6)
-    redis (5.0.5)
-      redis-client (>= 0.9.0)
-    redis-client (0.10.0)
-      connection_pool
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.1)
-    simplecov (0.16.1)
-      docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    sync (0.5.0)
-    term-ansicolor (1.7.1)
-      tins (~> 1.0)
-    thor (1.2.1)
-    tins (1.31.1)
-      sync
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  connection_pool (~> 2.2)
-  coveralls (~> 0.8)
-  json (~> 2.3.1, >= 2.3.0)
-  rake (~> 13.0, >= 11.1.2)
-  redlock!
-  rspec (~> 3, >= 3.0.0)
-
-BUNDLED WITH
-   2.3.7