bump version, update changelog

CHANGELOG.md

@@ -1,8 +1,16 @@
+## 0.1.3
+
+- Properly throw Suo::LockClientError when the connection itself fails (Memcache server not reachable, etc.)
+
+## 0.1.2
+
+- Fix retry_timeout to properly use the full time (was being calculated incorrectly).
+- Refactor client implementations to re-use more code.
+
 ## 0.1.1
 
 - Use [MessagePack](https://github.com/msgpack/msgpack-ruby) for semaphore serialization.
 
-
 ## 0.1.0
 
 - First release.

README.md

@@ -1,4 +1,4 @@
-# Suo [![Build Status](https://travis-ci.org/nickelser/suo.png?branch=master)](https://travis-ci.org/nickelser/suo)
+# Suo [![Build Status](https://travis-ci.org/nickelser/suo.svg?branch=master)](https://travis-ci.org/nickelser/suo) [![Gem Version](https://badge.fury.io/rb/suo.svg)](http://badge.fury.io/rb/suo)
 
 :lock: Distributed semaphores using Memcached or Redis in Ruby.
 
@@ -42,7 +42,6 @@ end
 ## TODO
  - better stale key handling (refresh blocks)
  - more race condition tests
- - refactor clients to re-use more code
 
 ## History
 

lib/suo/client/base.rb

@@ -1,14 +1,15 @@
 module Suo
   module Client
     class Base
+
       DEFAULT_OPTIONS = {
-        retry_count: 3,
+        retry_timeout: 0.1,
         retry_delay: 0.01,
         stale_lock_expiration: 3600
       }.freeze
 
       def initialize(options = {})
-        @options = self.class.merge_defaults(options).merge(_initialized: true)
+        @options = self.class.merge_defaults(options)
       end
 
       def lock(key, resources = 1, options = {})
@@ -33,32 +34,86 @@ module Suo
       end
 
       class << self
-        def lock(key, resources = 1, options = {}) # rubocop:disable Lint/UnusedMethodArgument
-          fail NotImplementedError
+        def lock(key, resources = 1, options = {})
+          options = merge_defaults(options)
+          acquisition_token = nil
+          token = SecureRandom.base64(16)
+
+          retry_with_timeout(key, options) do
+            val, cas = get(key, options)
+
+            if val.nil?
+              set_initial(key, options)
+              next
+            end
+
+            locks = deserialize_and_clear_locks(val, options)
+
+            if locks.size < resources
+              add_lock(locks, token)
+
+              newval = serialize_locks(locks)
+
+              if set(key, newval, cas, options)
+                acquisition_token = token
+                break
+              end
+            end
+          end
+
+          acquisition_token
         end
 
         def locked?(key, resources = 1, options = {})
-          options = merge_defaults(options)
-          client = options[:client]
-          locks = deserialize_locks(client.get(key))
-
-          locks.size >= resources
+          locks(key, options).size >= resources
         end
 
         def locks(key, options)
           options = merge_defaults(options)
-          client = options[:client]
-          locks = deserialize_locks(client.get(key))
+          val, _ = get(key, options)
+          locks = deserialize_locks(val)
 
-          locks.size
+          locks
         end
 
-        def refresh(key, acquisition_token, options = {}) # rubocop:disable Lint/UnusedMethodArgument
-          fail NotImplementedError
+        def refresh(key, acquisition_token, options = {})
+          options = merge_defaults(options)
+
+          retry_with_timeout(key, options) do
+            val, cas = get(key, options)
+
+            if val.nil?
+              set_initial(key, options)
+              next
+            end
+
+            locks = deserialize_and_clear_locks(val, options)
+
+            refresh_lock(locks, acquisition_token)
+
+            break if set(key, serialize_locks(locks), cas, options)
+          end
         end
 
-        def unlock(key, acquisition_token, options = {}) # rubocop:disable Lint/UnusedMethodArgument
-          fail NotImplementedError
+        def unlock(key, acquisition_token, options = {})
+          options = merge_defaults(options)
+
+          return unless acquisition_token
+
+          retry_with_timeout(key, options) do
+            val, cas = get(key, options)
+
+            break if val.nil?
+
+            locks = deserialize_and_clear_locks(val, options)
+
+            acquisition_lock = remove_lock(locks, acquisition_token)
+
+            break unless acquisition_lock
+            break if set(key, serialize_locks(locks), cas, options)
+          end
+        rescue LockClientError => _ # rubocop:disable Lint/HandleExceptions
+          # ignore - assume success due to optimistic locking
         end
 
         def clear(key, options = {}) # rubocop:disable Lint/UnusedMethodArgument
@@ -66,27 +121,62 @@ module Suo
         end
 
         def merge_defaults(options = {})
-          unless options[:_initialized]
-            options = self::DEFAULT_OPTIONS.merge(options)
+          options = self::DEFAULT_OPTIONS.merge(options)
 
-            fail "Client required" unless options[:client]
-          end
-
-          if options[:retry_timeout]
-            options[:retry_count] = (options[:retry_timeout] / options[:retry_delay].to_f).floor
-          end
+          fail "Client required" unless options[:client]
 
           options
         end
 
         private
 
+        def get(key, options) # rubocop:disable Lint/UnusedMethodArgument
+          fail NotImplementedError
+        end
+
+        def set(key, newval, oldval, options) # rubocop:disable Lint/UnusedMethodArgument
+          fail NotImplementedError
+        end
+
+        def set_initial(key, options) # rubocop:disable Lint/UnusedMethodArgument
+          fail NotImplementedError
+        end
+
+        def synchronize(key, options)
+          yield(key, options)
+        end
+
+        def retry_with_timeout(key, options)
+          count = (options[:retry_timeout] / options[:retry_delay].to_f).ceil
+
+          start = Time.now.to_f
+
+          count.times do
+            now = Time.now.to_f
+            break if now - start > options[:retry_timeout]
+
+            synchronize(key, options) do
+              yield
+            end
+
+            sleep(rand(options[:retry_delay] * 1000).to_f / 1000)
+          end
+        rescue => _
+          raise LockClientError
+        end
+
         def serialize_locks(locks)
           MessagePack.pack(locks.map { |time, token| [time.to_f, token] })
         end
 
+        def deserialize_and_clear_locks(val, options)
+          clear_expired_locks(deserialize_locks(val), options)
+        end
+
         def deserialize_locks(val)
-          MessagePack.unpack(val).map do |time, token|
+          unpacked = (val.nil? || val == "") ? [] : MessagePack.unpack(val)
+
+          unpacked.map do |time, token|
             [Time.at(time), token]
           end
         rescue EOFError => _

lib/suo/client/errors.rb

@@ -1,7 +0,0 @@
-module Suo
-  module Client
-    module Errors
-      class FailedToAcquireLock < StandardError; end
-    end
-  end
-end

lib/suo/client/memcached.rb

@@ -7,130 +7,24 @@ module Suo
       end
 
       class << self
-        def lock(key, resources = 1, options = {})
-          options = merge_defaults(options)
-          acquisition_token = nil
-          token = SecureRandom.base64(16)
-          client = options[:client]
-
-          begin
-            start = Time.now.to_f
-
-            options[:retry_count].times do
-              if options[:retry_timeout]
-                now = Time.now.to_f
-                break if now - start > options[:retry_timeout]
-              end
-
-              val, cas = client.get_cas(key)
-
-              # no key has been set yet; we could simply set it, but would lead to race conditions on the initial setting
-              if val.nil?
-                client.set(key, "")
-                next
-              end
-
-              locks = clear_expired_locks(deserialize_locks(val.to_s), options)
-
-              if locks.size < resources
-                add_lock(locks, token)
-
-                newval = serialize_locks(locks)
-
-                if client.set_cas(key, newval, cas)
-                  acquisition_token = token
-                  break
-                end
-              end
-
-              sleep(rand(options[:retry_delay] * 1000).to_f / 1000)
-            end
-          rescue => _
-            raise FailedToAcquireLock
-          end
-
-          acquisition_token
-        end
-
-        def refresh(key, acquisition_token, options = {})
-          options = merge_defaults(options)
-          client = options[:client]
-
-          begin
-            start = Time.now.to_f
-
-            options[:retry_count].times do
-              if options[:retry_timeout]
-                now = Time.now.to_f
-                break if now - start > options[:retry_timeout]
-              end
-
-              val, cas = client.get_cas(key)
-
-              # much like with initial set - ensure the key is here
-              if val.nil?
-                client.set(key, "")
-                next
-              end
-
-              locks = clear_expired_locks(deserialize_locks(val), options)
-
-              refresh_lock(locks, acquisition_token)
-
-              newval = serialize_locks(locks)
-
-              break if client.set_cas(key, newval, cas)
-
-              sleep(rand(options[:retry_delay] * 1000).to_f / 1000)
-            end
-          rescue => _
-            raise FailedToAcquireLock
-          end
-        end
-
-        def unlock(key, acquisition_token, options = {})
-          options = merge_defaults(options)
-          client = options[:client]
-
-          return unless acquisition_token
-
-          begin
-            start = Time.now.to_f
-
-            options[:retry_count].times do
-              if options[:retry_timeout]
-                now = Time.now.to_f
-                break if now - start > options[:retry_timeout]
-              end
-
-              val, cas = client.get_cas(key)
-
-              break if val.nil? # lock has expired totally
-
-              locks = clear_expired_locks(deserialize_locks(val), options)
-
-              acquisition_lock = remove_lock(locks, acquisition_token)
-
-              break unless acquisition_lock
-
-              newval = serialize_locks(locks)
-
-              break if client.set_cas(key, newval, cas)
-
-              # another client cleared a token in the interim - try again!
-
-              sleep(rand(options[:retry_delay] * 1000).to_f / 1000)
-            end
-          rescue => boom # rubocop:disable Lint/HandleExceptions
-            # since it's optimistic locking - fine if we are unable to release
-            raise boom if ENV["SUO_TEST"]
-          end
-        end
-
         def clear(key, options = {})
           options = merge_defaults(options)
           options[:client].delete(key)
         end
+
+        private
+
+        def get(key, options)
+          options[:client].get_cas(key)
+        end
+
+        def set(key, newval, cas, options)
+          options[:client].set_cas(key, newval, cas)
+        end
+
+        def set_initial(key, options)
+          options[:client].set(key, "")
+        end
       end
     end
   end

lib/suo/client/redis.rb

@@ -7,159 +7,36 @@ module Suo
       end
 
       class << self
-        def lock(key, resources = 1, options = {})
-          options = merge_defaults(options)
-          acquisition_token = nil
-          token = SecureRandom.base64(16)
-          client = options[:client]
-
-          begin
-            start = Time.now.to_f
-
-            options[:retry_count].times do
-              if options[:retry_timeout]
-                now = Time.now.to_f
-                break if now - start > options[:retry_timeout]
-              end
-
-              client.watch(key) do
-                begin
-                  val = client.get(key)
-
-                  locks = clear_expired_locks(deserialize_locks(val.to_s), options)
-
-                  if locks.size < resources
-                    add_lock(locks, token)
-
-                    newval = serialize_locks(locks)
-
-                    ret = client.multi do |multi|
-                      multi.set(key, newval)
-                    end
-
-                    acquisition_token = token if ret[0] == "OK"
-                  end
-                ensure
-                  client.unwatch
-                end
-              end
-
-              break if acquisition_token
-
-              sleep(rand(options[:retry_delay] * 1000).to_f / 1000)
-            end
-          rescue => _
-            raise Suo::Client::FailedToAcquireLock
-          end
-
-          acquisition_token
-        end
-
-        def refresh(key, acquisition_token, options = {})
-          options = merge_defaults(options)
-          client = options[:client]
-          refreshed = false
-
-          begin
-            start = Time.now.to_f
-
-            options[:retry_count].times do
-              if options[:retry_timeout]
-                now = Time.now.to_f
-                break if now - start > options[:retry_timeout]
-              end
-
-              client.watch(key) do
-                begin
-                  val = client.get(key)
-
-                  locks = clear_expired_locks(deserialize_locks(val), options)
-
-                  refresh_lock(locks, acquisition_token)
-
-                  newval = serialize_locks(locks)
-
-                  ret = client.multi do |multi|
-                    multi.set(key, newval)
-                  end
-
-                  refreshed = ret[0] == "OK"
-                ensure
-                  client.unwatch
-                end
-              end
-
-              break if refreshed
-
-              sleep(rand(options[:retry_delay] * 1000).to_f / 1000)
-            end
-          rescue => _
-            raise Suo::Client::FailedToAcquireLock
-          end
-        end
-
-        def unlock(key, acquisition_token, options = {})
-          options = merge_defaults(options)
-          client = options[:client]
-
-          return unless acquisition_token
-
-          begin
-            start = Time.now.to_f
-
-            options[:retry_count].times do
-              cleared = false
-
-              if options[:retry_timeout]
-                now = Time.now.to_f
-                break if now - start > options[:retry_timeout]
-              end
-
-              client.watch(key) do
-                begin
-                  val = client.get(key)
-
-                  if val.nil?
-                    cleared = true
-                    break
-                  end
-
-                  locks = clear_expired_locks(deserialize_locks(val), options)
-
-                  acquisition_lock = remove_lock(locks, acquisition_token)
-
-                  unless acquisition_lock
-                    # token was already cleared
-                    cleared = true
-                    break
-                  end
-
-                  newval = serialize_locks(locks)
-
-                  ret = client.multi do |multi|
-                    multi.set(key, newval)
-                  end
-
-                  cleared = ret[0] == "OK"
-                ensure
-                  client.unwatch
-                end
-              end
-
-              break if cleared
-
-              sleep(rand(options[:retry_delay] * 1000).to_f / 1000)
-            end
-          rescue => boom # rubocop:disable Lint/HandleExceptions
-            # since it's optimistic locking - fine if we are unable to release
-            raise boom if ENV["SUO_TEST"]
-          end
-        end
-
         def clear(key, options = {})
           options = merge_defaults(options)
           options[:client].del(key)
         end
+
+        private
+
+        def get(key, options)
+          [options[:client].get(key), nil]
+        end
+
+        def set(key, newval, _, options)
+          ret = options[:client].multi do |multi|
+            multi.set(key, newval)
+          end
+
+          ret[0] == "OK"
+        end
+
+        def synchronize(key, options)
+          options[:client].watch(key) do
+            yield
+          end
+        ensure
+          options[:client].unwatch
+        end
+
+        def set_initial(key, options)
+          options[:client].set(key, "")
+        end
       end
     end
   end

lib/suo/clients.rb

@@ -8,7 +8,7 @@ require "redis"
 
 require "msgpack"
 
-require "suo/client/errors"
+require "suo/errors"
 require "suo/client/base"
 require "suo/client/memcached"
 require "suo/client/redis"

lib/suo/errors.rb

@@ -0,0 +1,3 @@
+module Suo
+  class LockClientError < StandardError; end
+end

lib/suo/version.rb

@@ -1,3 +1,3 @@
 module Suo
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

suo.gemspec

@@ -20,6 +20,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = "~> 2.0"
+
   spec.add_dependency "dalli"
   spec.add_dependency "redis"
   spec.add_dependency "msgpack"

test/client_test.rb

@@ -11,6 +11,12 @@ module ClientTests
     assert_equal "Client required", exception.message
   end
 
+  def test_throws_failed_error_on_bad_client
+    assert_raises(Suo::LockClientError) do
+      @klass.lock(TEST_KEY, 1, client: {})
+    end
+  end
+
   def test_class_single_resource_locking
     lock1 = @klass.lock(TEST_KEY, 1, client: @klass_client)
     refute_nil lock1
@@ -24,6 +30,7 @@ module ClientTests
     @klass.unlock(TEST_KEY, lock1, client: @klass_client)
 
     locked = @klass.locked?(TEST_KEY, 1, client: @klass_client)
+
     assert_equal false, locked
   end
 
@@ -72,10 +79,29 @@ module ClientTests
     success_counter = Queue.new
     failure_counter = Queue.new
 
-    100.times.map do |i|
+    50.times.map do |i|
       Thread.new do
-        success = @client.lock(TEST_KEY, 50, retry_timeout: 0.9) do
-          sleep(1)
+        success = @client.lock(TEST_KEY, 25, retry_timeout: 0.9) do
+          sleep(3)
+          success_counter << i
+        end
+
+        failure_counter << i unless success
+      end
+    end.map(&:join)
+
+    assert_equal 25, success_counter.size
+    assert_equal 25, failure_counter.size
+  end
+
+  def test_instance_multiple_resource_locking_longer_timeout
+    success_counter = Queue.new
+    failure_counter = Queue.new
+
+    50.times.map do |i|
+      Thread.new do
+        success = @client.lock(TEST_KEY, 25, retry_timeout: 2) do
+          sleep(0.5)
           success_counter << i
         end
 
@@ -84,25 +110,6 @@ module ClientTests
     end.map(&:join)
 
     assert_equal 50, success_counter.size
-    assert_equal 50, failure_counter.size
-  end
-
-  def test_instance_multiple_resource_locking_longer_timeout
-    success_counter = Queue.new
-    failure_counter = Queue.new
-
-    100.times.map do |i|
-      Thread.new do
-        success = @client.lock(TEST_KEY, 50, retry_timeout: 2) do
-          sleep(1)
-          success_counter << i
-        end
-
-        failure_counter << i unless success
-      end
-    end.map(&:join)
-
-    assert_equal 100, success_counter.size
     assert_equal 0, failure_counter.size
   end
 end
@@ -114,7 +121,7 @@ class TestBaseClient < Minitest::Test
 
   def test_not_implemented
     assert_raises(NotImplementedError) do
-      @klass.lock(TEST_KEY, 1)
+      @klass.send(:get, TEST_KEY, {})
     end
   end
 end