redlock 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ea5ebfa119462a5500c078e0f113480b0178429
-  data.tar.gz: aad002651ed21a7782d63794f7d4cb9073e529e9
+  metadata.gz: 86073e680a1deb905852ddfcd28042cf81729875
+  data.tar.gz: 76cffc3d01b4fa649ad4ae4276149453282c0ed4
 SHA512:
-  metadata.gz: b099d48798f351476f7a225a924c6a0c2671b4ef25aad314f573b152a5ca587d43fdb2b29ca4fc6dc1031e9dc6060c99dace1f96eb06b57a47dc544a2df20901
-  data.tar.gz: ac4a7b903e6913e691f99b536cd31462a2da41fe14cfa23fd30665b35bae78d9a8da1e2495721f9aa53b6bcb44fc922423e86cf56cf14bec5f82ef9e38698351
+  metadata.gz: 8b0687bd912eff82bb3f4607de313d681d1e18971cbd3b6b484bae0fabae38b258ef423f0c00256b45e633fbc83abea9b38c57fbf08ce4d6567a2c254701eeb7
+  data.tar.gz: 86dc485ebc704b9d46bd6878d18f9b7403c13840721a2475b4b61b5c7b4099a40db3375045df8c8be7e9270d52f9560854b489a3656805046d995e253b1d126b

data/.travis.yml

@@ -2,7 +2,7 @@ language: ruby
 services:
     - redis-server
 rvm:
-  - "2.0.0"
+  - "2.2.2"
 script: bundle exec rspec spec
 sudo: false
 cache: bundler

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    redlock (0.1.6)
+    redlock (0.1.7)
       redis (~> 3, >= 3.3.0)
 
 GEM

data/README.md

@@ -95,6 +95,22 @@ rescue Redlock::LockError
 end
 ```
 
+To extend the life of the lock, provided that you didn't let it expire:
+
+```ruby
+begin
+  block_result = lock_manager.lock!("resource_key", 2000) do |lock_info|
+    # critical code
+    lock_manager.extend_life!(lock_info, 3000)
+    # more critical code
+  end
+rescue Redlock::LockError
+  # error handling
+end
+```
+There's also a non-bang version that returns true when the lock was
+extended
+
 ## Run tests
 
 Make sure you have at least 1 redis instances up.

data/lib/redlock/client.rb

@@ -52,6 +52,30 @@ module Redlock
       end
     end
 
+    def extend_life(to_extend, ttl)
+      value = to_extend.fetch(:value)
+      resource = to_extend.fetch(:resource)
+
+
+      extended, time_elapsed = timed do
+        @servers.all? { |s| s.extend_life(resource, value, ttl) }
+      end
+
+      validity = ttl - time_elapsed - drift(ttl)
+
+      if extended
+        { validity: validity, resource: resource, value: value }
+      else
+        @servers.each { |s| s.unlock(resource, value) }
+        false
+      end
+    end
+
+    def extend_life!(to_extend, ttl)
+      new_lock_info = self.extend_life(to_extend, ttl)
+      raise LockError, 'failed to extend lock' unless new_lock_info
+    end
+
     # Unlocks a resource.
     # Params:
     # +lock_info+:: the lock that has been acquired when you locked the resource.
@@ -91,6 +115,16 @@ module Redlock
         end
       eos
 
+      EXTEND_LOCK_SCRIPT = <<-eos
+        if redis.call("get", KEYS[1]) == ARGV[1] then
+          redis.call("expire", KEYS[1], ARGV[2])
+          return 0
+        else
+          return 1
+        end
+      eos
+
+
       def initialize(connection)
         if connection.respond_to?(:client)
           @redis = connection
@@ -107,6 +141,13 @@ module Redlock
         end
       end
 
+      def extend_life(resource, val, ttl)
+        recover_from_script_flush do
+          rc = @redis.evalsha @extend_lock_script_sha, keys: [resource], argv: [val, ttl]
+          rc == 0
+        end
+      end
+
       def unlock(resource, val)
         recover_from_script_flush do
           @redis.evalsha @unlock_script_sha, keys: [resource], argv: [val]
@@ -120,6 +161,7 @@ module Redlock
       def load_scripts
         @unlock_script_sha = @redis.script(:load, UNLOCK_SCRIPT)
         @lock_script_sha = @redis.script(:load, LOCK_SCRIPT)
+        @extend_lock_script_sha = @redis.script(:load, EXTEND_LOCK_SCRIPT)
       end
 
       def recover_from_script_flush

data/lib/redlock/version.rb

@@ -1,3 +1,3 @@
 module Redlock
-  VERSION = '0.1.6'
+  VERSION = '0.1.7'
 end

data/spec/client_spec.rb

@@ -170,6 +170,40 @@ RSpec.describe Redlock::Client do
     end
   end
 
+  describe "extend" do
+    context 'when lock is available' do
+      before { @lock_info = lock_manager.lock(resource_key, ttl) }
+      after(:each) { lock_manager.unlock(@lock_info) if @lock_info }
+
+      it 'can extend its own lock' do
+        lock_info = lock_manager.extend_life(@lock_info, ttl)
+        expect(lock_info).to be_lock_info_for(resource_key)
+      end
+
+      it "can't extend a nonexistent lock" do
+        lock_manager.unlock(@lock_info)
+        lock_info = lock_manager.extend_life(@lock_info, ttl)
+        expect(lock_info).to eq(false)
+      end
+    end
+  end
+
+  describe "extend!" do
+    context 'when lock is available' do
+      before { @lock_info = lock_manager.lock(resource_key, ttl) }
+      after(:each) { lock_manager.unlock(@lock_info) if @lock_info }
+
+      it 'can extend its own lock' do
+        expect{ lock_manager.extend_life!(@lock_info, ttl) }.to_not raise_error
+      end
+
+      it "can't extend a nonexistent lock" do
+        lock_manager.unlock(@lock_info)
+        expect{ lock_manager.extend_life!(@lock_info, ttl) }.to raise_error(Redlock::LockError)
+      end
+    end
+  end
+
   describe 'lock!' do
     context 'when lock is available' do
       it 'locks' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redlock
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Leandro Moreira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-12 00:00:00.000000000 Z
+date: 2016-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis