redlock 0.1.8 → 0.2.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NzQwMDRhZWQ2ZjUyM2FjMTgxMzJiY2Q1ZmY5YzI3ODk1ZWY4NTNmMA==
-  data.tar.gz: !binary |-
-    ZDliZjZlMmM3OGNmZGMyYzhlNWI3YjBlMmUyNGRmNGY0Yjk0N2FkYw==
+SHA1:
+  metadata.gz: 3820d9812a87989c395ff8b4856a4cea7801d84b
+  data.tar.gz: 7cc006346948cf1132be55de820949f37cb9f07d
 SHA512:
-  metadata.gz: !binary |-
-    ZTZjYWUyNmI2NTliZjliODZkM2ZhYzczZDAyM2RlM2FiY2Y5MTkxMDk4YjVk
-    YzVhMGJjMjBiMTM4NDYzY2ZkNWNiYzRmODk5YWFlZTJlMzczMTZlMzI4ZmRh
-    YTNkZDNhNjgxNzcxOTlhNGE2YTdjNzgyZTgwNTY0YWY4OTUwMjc=
-  data.tar.gz: !binary |-
-    NDllNDgxMmQ0ODk1NTdlNTNkMjczN2EyYjQyMjE2MWU5YmJmMDVlMmJkY2Q1
-    YTZjNTE5NjFjNTI3Mjc3NzJiZDBlMDIwYzUwM2NlMGM1YjE0NDVkNDIzODFm
-    MjVhNjU3OTI4NzY0YzY3OTE1ZDhiNGRhNmRlMzM5OGE3YjczMTI=
+  metadata.gz: ba94bdcbdd4f659a6564baad82a3f022ea64f541789579803f33bfd0981ee6a3df53b6887a05791f3794202c85748ae85bdd357d1703d690464e6f0844b3e899
+  data.tar.gz: c36ec9b01716486eeacdd9a82f27cbaa8d6b3165da1e17e11196ac4d700dfe82acf439e6b027b8852f5f33241af08927fea6c2d2f379ffca8392b1ac69a69c1d

data/Gemfile.lock

@@ -1,45 +1,45 @@
 PATH
   remote: .
   specs:
-    redlock (0.1.8)
+    redlock (0.2.0)
       redis (~> 3, >= 3.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    coveralls (0.8.13)
-      json (~> 1.8)
-      simplecov (~> 0.11.0)
+    coveralls (0.8.19)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.12.0)
       term-ansicolor (~> 1.3)
       thor (~> 0.19.1)
-      tins (~> 1.6.0)
-    diff-lcs (1.2.5)
+      tins (~> 1.6)
+    diff-lcs (1.3)
     docile (1.1.5)
-    json (1.8.3)
-    rake (11.1.2)
-    redis (3.3.0)
-    rspec (3.4.0)
-      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.4)
-      rspec-support (~> 3.4.0)
-    rspec-expectations (3.4.0)
+    json (2.0.3)
+    rake (11.3.0)
+    redis (3.3.3)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.1)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-support (3.4.1)
-    simplecov (0.11.2)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    simplecov (0.12.0)
       docile (~> 1.1.0)
-      json (~> 1.8)
+      json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
-    term-ansicolor (1.3.2)
+    term-ansicolor (1.4.0)
       tins (~> 1.0)
-    thor (0.19.1)
-    tins (1.6.0)
+    thor (0.19.4)
+    tins (1.13.0)
 
 PLATFORMS
   ruby
@@ -49,3 +49,6 @@ DEPENDENCIES
   rake (~> 11.1, >= 11.1.2)
   redlock!
   rspec (~> 3, >= 3.0.0)
+
+BUNDLED WITH
+   1.12.5

data/README.md

@@ -8,8 +8,6 @@
 [![Inline docs](http://inch-ci.org/github/leandromoreira/redlock-rb.svg?branch=master)](http://inch-ci.org/github/leandromoreira/redlock-rb)
 [![Join the chat at https://gitter.im/leandromoreira/redlock-rb](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/leandromoreira/redlock-rb?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-[![Codeship](https://codeship.com/projects/901ff180-c1ad-0132-1a88-3eb2295b72b3/status?branch=master)](https://codeship.com/projects/901ff180-c1ad-0132-1a88-3eb2295b72b3/status?branch=master)
-
 
 # Redlock - A ruby distributed lock using redis.
 
@@ -123,6 +121,20 @@ rescue Redlock::LockError
 end
 ```
 
+It's possible to customize the retry logic providing the following options:
+
+```ruby
+  lock_manager = Redlock::Client.new(
+                  servers, {
+                  retry_count:   3,
+                  retry_delay:   200, # milliseconds
+                  retry_jitter:  50,  # milliseconds
+                  retry_timeout: 0.1  # seconds
+                 })
+```
+
+For more information you can check [documentation](https://github.com/leandromoreira/redlock-rb/blob/master/lib/redlock/client.rb#L13-L20)
+
 
 ## Run tests
 

data/lib/redlock/client.rb

@@ -7,14 +7,16 @@ module Redlock
     DEFAULT_REDIS_TIMEOUT = 0.1
     DEFAULT_RETRY_COUNT   = 3
     DEFAULT_RETRY_DELAY   = 200
+    DEFAULT_RETRY_JITTER  = 50
     CLOCK_DRIFT_FACTOR    = 0.01
 
     # Create a distributed lock manager implementing redlock algorithm.
     # Params:
     # +servers+:: The array of redis connection URLs or Redis connection instances. Or a mix of both.
-    # +options+:: You can override the default value for `retry_count` and `retry_delay`.
+    # +options+:: You can override the default value for `retry_count`, `retry_delay` and `retry_gitter`.
     #    * `retry_count`   being how many times it'll try to lock a resource (default: 3)
     #    * `retry_delay`   being how many ms to sleep before try to lock again (default: 200)
+    #    * `retry_jitter`  being how many ms to jitter retry delay (default: 50)
     #    * `redis_timeout` being how the Redis timeout will be set in seconds (default: 0.1)
     def initialize(servers = DEFAULT_REDIS_URLS, options = {})
       redis_timeout = options[:redis_timeout] || DEFAULT_REDIS_TIMEOUT
@@ -28,13 +30,16 @@ module Redlock
       @quorum = servers.length / 2 + 1
       @retry_count = options[:retry_count] || DEFAULT_RETRY_COUNT
       @retry_delay = options[:retry_delay] || DEFAULT_RETRY_DELAY
+      @retry_jitter = options[:retry_jitter] || DEFAULT_RETRY_JITTER
     end
 
     # Locks a resource for a given time.
     # Params:
     # +resource+:: the resource (or key) string to be locked.
     # +ttl+:: The time-to-live in ms for the lock.
-    # +extend+: A lock ("lock_info") to extend.
+    # +options+:: Hash of optional parameters
+    #  * +extend+: A lock ("lock_info") to extend.
+    #  * +extend_only_if_life+: If +extend+ is given, only acquire lock if currently held
     # +block+:: an optional block to be executed; after its execution, the lock (if successfully
     # acquired) is automatically unlocked.
     def lock(resource, ttl, options = {}, &block)
@@ -86,40 +91,24 @@ module Redlock
       # 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
+        if (redis.call("exists", KEYS[1]) == 0 and ARGV[3] == "yes") or redis.call("get", KEYS[1]) == ARGV[1] then
           return redis.call("set", KEYS[1], ARGV[1], "PX", ARGV[2])
         end
       eos
 
-      EXTEND_LIFE_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
         else
-          @redis  = Redis.new(connection)
+          @redis = Redis.new(connection)
         end
 
         load_scripts
       end
 
-      def lock(resource, val, ttl)
+      def lock(resource, val, ttl, allow_new_lock)
         recover_from_script_flush do
-          @redis.evalsha @lock_script_sha, keys: [resource], argv: [val, ttl]
-        end
-      end
-
-      def extend(resource, val, ttl)
-        recover_from_script_flush do
-          rc = @redis.evalsha @extend_life_script_sha, keys: [resource], argv: [val, ttl]
-          rc == 0
+          @redis.evalsha @lock_script_sha, keys: [resource], argv: [val, ttl, allow_new_lock]
         end
       end
 
@@ -136,7 +125,6 @@ module Redlock
       def load_scripts
         @unlock_script_sha = @redis.script(:load, UNLOCK_SCRIPT)
         @lock_script_sha = @redis.script(:load, LOCK_SCRIPT)
-        @extend_life_script_sha = @redis.script(:load, EXTEND_LIFE_SCRIPT)
       end
 
       def recover_from_script_flush
@@ -161,23 +149,23 @@ module Redlock
     def try_lock_instances(resource, ttl, options)
       tries = options[:extend] ? 1 : @retry_count
 
-      tries.times do
+      tries.times do |attempt_number|
+        # Wait a random delay before retrying.
+        sleep((@retry_delay + rand(@retry_jitter)).to_f / 1000) if attempt_number > 0
+
         lock_info = lock_instances(resource, ttl, options)
         return lock_info if lock_info
-
-        # Wait a random delay before retrying
-        sleep(rand(@retry_delay).to_f / 1000)
       end
 
       false
     end
 
     def lock_instances(resource, ttl, options)
-      value  = options[:extend] ? options[:extend].fetch(:value) : SecureRandom.uuid
-      method = options[:extend_life] ? :extend : :lock
+      value = options.fetch(:extend, { value: SecureRandom.uuid })[:value]
+      allow_new_lock = (options[:extend_life] || options[:extend_only_if_life]) ? 'no' : 'yes'
 
       locked, time_elapsed = timed do
-        @servers.select { |s| s.send(method, resource, value, ttl) }.size
+        @servers.select { |s| s.lock resource, value, ttl, allow_new_lock }.size
       end
 
       validity = ttl - time_elapsed - drift(ttl)

data/lib/redlock/version.rb

@@ -1,3 +1,3 @@
 module Redlock
-  VERSION = '0.1.8'
+  VERSION = '0.2.0'
 end

data/spec/client_spec.rb

@@ -3,7 +3,8 @@ require 'securerandom'
 
 RSpec.describe Redlock::Client do
   # It is recommended to have at least 3 servers in production
-  let(:lock_manager) { Redlock::Client.new }
+  let(:lock_manager_opts) { { retry_count: 3 } }
+  let(:lock_manager) { Redlock::Client.new(Redlock::Client::DEFAULT_REDIS_URLS, lock_manager_opts) }
   let(:resource_key) { SecureRandom.hex(3)  }
   let(:ttl) { 1000 }
 
@@ -43,16 +44,16 @@ RSpec.describe Redlock::Client do
         expect(@lock_info[:value]).to eq(my_lock_info[:value])
       end
 
-      context 'when extend_life flag is given' do
+      context 'when extend_only_if_life flag is given' do
         it 'does not extend a non-existent lock' do
-          @lock_info = lock_manager.lock(resource_key, ttl, extend: {value: 'hello world'}, extend_life: true)
+          @lock_info = lock_manager.lock(resource_key, ttl, extend: {value: 'hello world'}, extend_only_if_life: true)
           expect(@lock_info).to eq(false)
         end
       end
 
-      context 'when extend_life flag is not given' do
+      context 'when extend_only_if_life flag is not given' do
         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'}, extend_life: false)
+          @lock_info = lock_manager.lock(resource_key, ttl, extend: {value: 'hello world'}, extend_only_if_life: false)
           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
@@ -80,6 +81,33 @@ RSpec.describe Redlock::Client do
         lock_info = lock_manager.lock(resource_key, ttl, extend: yet_another_lock_info)
         expect(lock_info).to eql(false)
       end
+
+      it 'retries up to \'retry_count\' times' do
+        expect(lock_manager).to receive(:lock_instances).exactly(
+          lock_manager_opts[:retry_count]).times.and_return(false)
+        lock_manager.lock(resource_key, ttl)
+      end
+
+      it 'sleeps in between retries' do
+        expect(lock_manager).to receive(:sleep).exactly(lock_manager_opts[:retry_count] - 1).times
+        lock_manager.lock(resource_key, ttl)
+      end
+
+      it 'sleeps at least the specified retry_delay in milliseconds' do
+        expected_minimum = described_class::DEFAULT_RETRY_DELAY
+        expect(lock_manager).to receive(:sleep) do |sleep|
+          expect(sleep).to satisfy { |value| value >= expected_minimum / 1000.to_f }
+        end.at_least(:once)
+        lock_manager.lock(resource_key, ttl)
+      end
+
+      it 'sleeps a maximum of retry_delay + retry_jitter in milliseconds' do
+        expected_maximum = described_class::DEFAULT_RETRY_DELAY + described_class::DEFAULT_RETRY_JITTER
+        expect(lock_manager).to receive(:sleep) do |sleep|
+          expect(sleep).to satisfy { |value| value < expected_maximum / 1000.to_f }
+        end.at_least(:once)
+        lock_manager.lock(resource_key, ttl)
+      end
     end
 
     context 'when script cache has been flushed' do

metadata

@@ -1,87 +1,87 @@
 --- !ruby/object:Gem::Specification
 name: redlock
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.2.0
 platform: ruby
 authors:
 - Leandro Moreira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-24 00:00:00.000000000 Z
+date: 2017-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
   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::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.13
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.13
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '11.1'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 11.1.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '11.1'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 11.1.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
   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
 description: Distributed lock using Redis written in Ruby. Highly inspired by https://github.com/antirez/redlock-rb.
@@ -91,9 +91,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CONTRIBUTORS
 - Gemfile
 - Gemfile.lock
@@ -118,17 +118,17 @@ 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: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Distributed lock using Redis written in Ruby.