Merge pull request #8 from nickelser/update_changelog

Update changelog

.travis.yml

@@ -1,7 +1,9 @@
 language: ruby
 rvm:
-  - 2.2.0
+  - 2.2.6
-  - 2.3.1
+  - 2.3.7
+  - 2.4.4
+  - 2.5.1
 services:
   - memcached
   - redis-server

CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.3.3
+
+- Default TTL for keys to allow for short-lived locking keys (thanks to Ian Remillard) without leaking memory.
+- Vastly improve initial lock acquisition, especially on Redis (thanks to Jeremy Wadscak).
+
 ## 0.3.2
 
 - Custom lock tokens (thanks to avokhmin).

README.md

@@ -72,6 +72,15 @@ suo.lock do |token|
 end
 ```
 
+### Time To Live
+
+```ruby
+Suo::Client::Redis.new("bar_resource", ttl: 60) #ttl in seconds
+```
+
+A key representing a set of lockable resources is removed once the last resource lock is released and the `ttl` time runs out. When another lock is acquired and the key has been removed the key has to be recreated.
+
+
 ## TODO
  - more race condition tests
 

lib/suo/client/base.rb

@@ -5,7 +5,8 @@ module Suo
         acquisition_timeout: 0.1,
         acquisition_delay: 0.01,
         stale_lock_expiration: 3600,
-        resources: 1
+        resources: 1,
+        ttl: 60,
       }.freeze
 
       BLANK_STR = "".freeze
@@ -55,16 +56,13 @@ module Suo
         retry_with_timeout do
           val, cas = get
 
-          if val.nil?
+          cas = initial_set if val.nil?
-            initial_set
-            next
-          end
 
           cleared_locks = deserialize_and_clear_locks(val)
 
           refresh_lock(cleared_locks, token)
 
-          break if set(serialize_locks(cleared_locks), cas)
+          break if set(serialize_locks(cleared_locks), cas, expire: cleared_locks.empty?)
         end
       end
 
@@ -81,7 +79,7 @@ module Suo
           acquisition_lock = remove_lock(cleared_locks, token)
 
           break unless acquisition_lock
-          break if set(serialize_locks(cleared_locks), cas)
+          break if set(serialize_locks(cleared_locks), cas, expire: cleared_locks.empty?)
         end
       rescue LockClientError => _ # rubocop:disable Lint/HandleExceptions
         # ignore - assume success due to optimistic locking
@@ -101,10 +99,7 @@ module Suo
         retry_with_timeout do
           val, cas = get
 
-          if val.nil?
+          cas = initial_set if val.nil?
-            initial_set
-            next
-          end
 
           cleared_locks = deserialize_and_clear_locks(val)
 

lib/suo/client/memcached.rb

@@ -16,12 +16,18 @@ module Suo
         @client.get_cas(@key)
       end
 
-      def set(newval, cas)
+      def set(newval, cas, expire: false)
-        @client.set_cas(@key, newval, cas)
+        if expire
+          @client.set_cas(@key, newval, cas, @options[:ttl])
+        else
+          @client.set_cas(@key, newval, cas)
+        end
       end
 
       def initial_set(val = BLANK_STR)
         @client.set(@key, val)
+        _val, cas = @client.get_cas(@key)
+        cas
       end
     end
   end

lib/suo/client/redis.rb

@@ -18,9 +18,13 @@ module Suo
         [@client.get(@key), nil]
       end
 
-      def set(newval, _)
+      def set(newval, _, expire: false)
         ret = @client.multi do |multi|
-          multi.set(@key, newval)
+          if expire
+            multi.setex(@key, @options[:ttl], newval)
+          else
+            multi.set(@key, newval)
+          end
         end
 
         ret && ret[0] == OK_STR
@@ -35,7 +39,8 @@ module Suo
       end
 
       def initial_set(val = BLANK_STR)
-        @client.set(@key, val)
+        set(val, nil)
+        nil
       end
     end
   end

lib/suo/version.rb

@@ -1,3 +1,3 @@
 module Suo
-  VERSION = "0.3.2".freeze
+  VERSION = "0.3.3".freeze
 end

suo.gemspec

@@ -16,7 +16,6 @@ Gem::Specification.new do |spec|
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.bindir        = "bin"
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
@@ -28,7 +27,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rubocop", "~> 0.30.0"
+  spec.add_development_dependency "rubocop", "~> 0.49.0"
   spec.add_development_dependency "minitest", "~> 5.5.0"
   spec.add_development_dependency "codeclimate-test-reporter", "~> 0.4.7"
 end