redlock 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: e2d0a189eba4a2f362d02f034cfa0957eba666eb
-  data.tar.gz: 18f9e90023c218eb9b5d65a71946b39fb98a8617
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MWU3MmRhNjM0OWFkYTMyOTMzNzBiNDFjYjFmZDkwOGRhNGFkMzgzMQ==
+  data.tar.gz: !binary |-
+    M2EyYWE0YTk5NTg3MThiZWIzNjA2OGRhMjE3MzY1ZjBmMmU2OTI2Zg==
 SHA512:
-  metadata.gz: 65cd0b7c60b9756eba2f0fcce27677b9f26e32db74f3cbea7f036744ae52bfd0e50f8ce72cddb538fafc49a409c0f7a6257976d9234be8305d8a77151958980d
-  data.tar.gz: 0531fe15435ad4601ad83c8aa107ac6e3073f4f2be49682c74ff379f9b9c20f603e140b51c604b5baffdfb7650a3e4762cdea9495870fa1b684f99bcbab6930d
+  metadata.gz: !binary |-
+    MDI3YjUyYjQxOTJmNzAyZTE5MGY3MjlhNWYyMjVmZDE4YWQ1YTRkMDA0ODcw
+    M2RlYmQ0NTA3NGUwZjdlYWM0MjM1MjFiNjY4N2YwMzkwM2I5M2MxZjM5OWVi
+    YzdlYzVmOTBlOTRkNzRhNjNhYjNhYzU0OGU1ZTJhNzg0NjUxMjQ=
+  data.tar.gz: !binary |-
+    MDFmYTU0MjRhZWFhOGY2NTM5YmM4NmQ2ZTA2MDI5NzQ1NjVlZjc2ODhhM2Nm
+    N2JkNmJlZTI5ODU3NzM3MmIxZjUxY2M5ZmZhOTNiOThiNzdmOGI1Zjc2ZTI3
+    ZDkxZGExNTBkY2Y3MGMyMmU0M2U4MmM4OWE5MWZhNTM5Mjg5ODQ=

data/README.md

@@ -79,11 +79,23 @@ lock_manager.lock("resource_key", 2000) do |locked|
 end
 ```
 
+There's also a bang version that only executes the block if the lock is successfully acquired, returning the block's value as a result, or raising an exception otherwise:
+
+```ruby
+begin
+  block_result = lock_manager.lock!("resource_key", 2000) do
+    # critical code
+  end
+rescue Redlock::LockException
+  # error handling
+end
+```
+
 ## Run tests
 
 Make sure you have at least 1 redis instances up.
 
-   $ rspec
+    $ rspec
 
 ## Disclaimer
 

data/lib/redlock.rb

@@ -2,4 +2,6 @@ require 'redlock/version'
 
 module Redlock
   autoload :Client, 'redlock/client'
+
+  LockError = Class.new(StandardError)
 end

data/lib/redlock/client.rb

@@ -34,9 +34,11 @@ module Redlock
     # Params:
     # +resource+:: the resource (or key) string to be locked.
     # +ttl+:: The time-to-live in ms for the lock.
-    # +block+:: an optional block that automatically unlocks the lock.
-    def lock(resource, ttl, &block)
-      lock_info = try_lock_instances(resource, ttl)
+    # +extend+: A lock ("lock_info") to extend.
+    # +block+:: an optional block to be executed; after its execution, the lock (if successfully
+    # acquired) is automatically unlocked.
+    def lock(resource, ttl, extend: nil, &block)
+      lock_info = try_lock_instances(resource, ttl, extend)
 
       if block_given?
         begin
@@ -57,6 +59,18 @@ module Redlock
       @servers.each { |s| s.unlock(lock_info[:resource], lock_info[:value]) }
     end
 
+    # Locks a resource, executing the received block only after successfully acquiring the lock,
+    # and returning its return value as a result.
+    # See Redlock::Client#lock for parameters.
+    def lock!(*args, **keyword_args)
+      fail 'No block passed' unless block_given?
+
+      lock(*args, **keyword_args) do |lock_info|
+        raise LockError, 'failed to acquire lock' unless lock_info
+        return yield
+      end
+    end
+
     private
 
     class RedisInstance
@@ -68,6 +82,15 @@ module Redlock
         end
       eos
 
+      # thanks to https://github.com/sbertrang/redis-distlock/blob/master/lib/Redis/DistLock.pm
+      # also https://github.com/sbertrang/redis-distlock/issues/2 which proposes the value-checking
+      # and @maltoe for https://github.com/leandromoreira/redlock-rb/pull/20#discussion_r38903633
+      LOCK_SCRIPT = <<-eos
+        if redis.call("exists", KEYS[1]) == 0 or redis.call("get", KEYS[1]) == ARGV[1] then
+          return redis.call("set", KEYS[1], ARGV[1], "PX", ARGV[2])
+        end
+      eos
+
       def initialize(connection)
         if connection.respond_to?(:client)
           @redis = connection
@@ -79,7 +102,7 @@ module Redlock
       end
 
       def lock(resource, val, ttl)
-        @redis.set(resource, val, nx: true, px: ttl)
+        @redis.evalsha(@lock_script_sha, keys: [resource], argv: [val, ttl])
       end
 
       def unlock(resource, val)
@@ -92,12 +115,13 @@ module Redlock
 
       def load_scripts
         @unlock_script_sha = @redis.script(:load, UNLOCK_SCRIPT)
+        @lock_script_sha = @redis.script(:load, LOCK_SCRIPT)
       end
     end
 
-    def try_lock_instances(resource, ttl)
+    def try_lock_instances(resource, ttl, extend)
       @retry_count.times do
-        lock_info = lock_instances(resource, ttl)
+        lock_info = lock_instances(resource, ttl, extend)
         return lock_info if lock_info
 
         # Wait a random delay before retrying
@@ -107,8 +131,8 @@ module Redlock
       false
     end
 
-    def lock_instances(resource, ttl)
-      value = SecureRandom.uuid
+    def lock_instances(resource, ttl, extend)
+      value = extend ? extend.fetch(:value) : SecureRandom.uuid
 
       locked, time_elapsed = timed do
         @servers.select { |s| s.lock(resource, value, ttl) }.size
@@ -128,7 +152,7 @@ module Redlock
       # Add 2 milliseconds to the drift to account for Redis expires
       # precision, which is 1 millisecond, plus 1 millisecond min drift
       # for small TTLs.
-      drift = (ttl * CLOCK_DRIFT_FACTOR).to_i + 2
+      (ttl * CLOCK_DRIFT_FACTOR).to_i + 2
     end
 
     def timed

data/lib/redlock/testing.rb

@@ -4,17 +4,17 @@ module Redlock
 
     alias_method :try_lock_instances_without_testing, :try_lock_instances
 
-    def try_lock_instances(resource, ttl)
+    def try_lock_instances(resource, ttl, extend)
       if @testing_mode == :bypass
         {
           validity: ttl,
           resource: resource,
-          value: SecureRandom.uuid
+          value: extend ? extend.fetch(:value) : SecureRandom.uuid
         }
       elsif @testing_mode == :fail
         false
       else
-        try_lock_instances_without_testing resource, ttl
+        try_lock_instances_without_testing resource, ttl, extend
       end
     end
 
@@ -25,12 +25,13 @@ module Redlock
     end
 
     class RedisInstance
+      alias_method :load_scripts_without_testing, :load_scripts
+
       def load_scripts
-        begin
-          @unlock_script_sha = @redis.script(:load, UNLOCK_SCRIPT)
-        rescue Redis::CommandError
-          # ignore
-        end
+        load_scripts_without_testing
+      rescue Redis::CommandError
+        # FakeRedis doesn't have #script, but doesn't need it either.
+        raise unless defined?(::FakeRedis)
       end
     end
   end

data/lib/redlock/version.rb

@@ -1,3 +1,3 @@
 module Redlock
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/spec/client_spec.rb

@@ -35,6 +35,25 @@ RSpec.describe Redlock::Client do
 
         expect(@lock_info).to be_lock_info_for(resource_key)
       end
+
+      it 'can extend its own lock' do
+        my_lock_info = lock_manager.lock(resource_key, ttl)
+        @lock_info = lock_manager.lock(resource_key, ttl, extend: my_lock_info)
+        expect(@lock_info).to be_lock_info_for(resource_key)
+        expect(@lock_info[:value]).to eq(my_lock_info[:value])
+      end
+
+      it "sets the given value when trying to extend a non-existent lock" do
+        @lock_info = lock_manager.lock(resource_key, ttl, extend: {value: 'hello world'})
+        expect(@lock_info).to be_lock_info_for(resource_key)
+        expect(@lock_info[:value]).to eq('hello world') # really we should test what's in redis
+      end
+
+      it "doesn't extend somebody else's lock" do
+        @lock_info = lock_manager.lock(resource_key, ttl)
+        second_attempt = lock_manager.lock(resource_key, ttl)
+        expect(second_attempt).to eq(false)
+      end
     end
 
     context 'when lock is not available' do
@@ -46,6 +65,12 @@ RSpec.describe Redlock::Client do
 
         expect(lock_info).to eql(false)
       end
+
+      it "can't extend somebody else's lock" do
+        yet_another_lock_info = @another_lock_info.merge value: 'gibberish'
+        lock_info = lock_manager.lock(resource_key, ttl, extend: yet_another_lock_info)
+        expect(lock_info).to eql(false)
+      end
     end
 
     describe 'block syntax' do
@@ -107,4 +132,47 @@ RSpec.describe Redlock::Client do
       expect(resource_key).to be_lockable(lock_manager, ttl)
     end
   end
+
+  describe 'lock!' do
+    context 'when lock is available' do
+      it 'locks' do
+        lock_manager.lock!(resource_key, ttl) do
+          expect(resource_key).to_not be_lockable(lock_manager, ttl)
+        end
+      end
+
+      it "returns the received block's return value" do
+        rv = lock_manager.lock!(resource_key, ttl) { :success }
+        expect(rv).to eql(:success)
+      end
+
+      it 'automatically unlocks' do
+        lock_manager.lock!(resource_key, ttl) {}
+        expect(resource_key).to be_lockable(lock_manager, ttl)
+      end
+
+      it 'automatically unlocks when block raises exception' do
+        lock_manager.lock!(resource_key, ttl) { fail } rescue nil
+        expect(resource_key).to be_lockable(lock_manager, ttl)
+      end
+    end
+
+    context 'when lock is not available' do
+      before { @another_lock_info = lock_manager.lock(resource_key, ttl) }
+      after { lock_manager.unlock(@another_lock_info) }
+
+      it 'raises a LockError' do
+        expect { lock_manager.lock!(resource_key, ttl) {} }.to raise_error(Redlock::LockError)
+      end
+
+      it 'does not execute the block' do
+        expect do
+          begin
+            lock_manager.lock!(resource_key, ttl) { fail }
+          rescue Redlock::LockError
+          end
+        end.to_not raise_error
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redlock
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Leandro Moreira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-13 00:00:00.000000000 Z
+date: 2015-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -17,7 +17,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3'
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.0.5
   type: :runtime
@@ -27,7 +27,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3'
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.0.5
 - !ruby/object:Gem::Dependency
@@ -48,14 +48,14 @@ dependencies:
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -120,12 +120,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []