redis-semaphore 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 309187f46b275cd806075cad1bbe6957dac9b81d
-  data.tar.gz: 290e95937ffc62ca1026be42ad33d2b9017be559
+  metadata.gz: 8b9f39ef8423ccca320813836891182abf1d93ec
+  data.tar.gz: f631ca62601208fe26125808c049abe755de3ad9
 SHA512:
-  metadata.gz: bc1eefa40196e5e95f8c4f74258b8136eb8179262a784bff743c5729a17631de3fbbd7b13b888eaffd43b7b63de8fa3209ea226d3009d66de9a18467742be594
-  data.tar.gz: 8c69c42bfb18035f63fb15d94cbd92593344a2e08dee9883ddde9598e534dcef0227a6d51542496cea6582ac9c1751d7fe830965e5134e62502c5a7c886c0ca7
+  metadata.gz: 3c38139829552918fbc64bef11059fd3ac8a8117d6f25bbda7bfac2d355c791232d9a2b9c5458cc173d53b8d210b0aa01efd61e8c7aff6e1a5dc22253a6c1070
+  data.tar.gz: 0be29fe2f67e984c6e2757c0da6df45eba3ec8a97702cae4a623e185407e347f0642f624338ec66213c012e9f26220c71f4155e26cc1b9bd8a65ba65381689f9

data/README.md

@@ -10,8 +10,8 @@ The mutex and semaphore is blocking, not polling, and has a fair queue serving p
 
 For more info see [Wikipedia](http://en.wikipedia.org/wiki/Semaphore_(programming)).
 
-Changes for 0.3.0
-=================
+Important change in v0.3.0
+===========================
 
 If you've been using `redis-semaphore` before version `0.3.0` you should be aware that the interface for `lock` has changed slightly. Before `0.3` calling `semaphore.lock(0)` (with `0` as the timeout) would block the semaphore indefinitely, just like a redis `blpop` command would.
 
@@ -98,6 +98,8 @@ s = Redis::Semaphore.new(:another_name, :redis => r)
 #...
 ```
 
+Note that it's [a bad idea to reuse the same redis client across threads](https://github.com/dv/redis-semaphore/issues/18), due to the blocking nature of the `blpop` command. We might add support for this in a future version.
+
 If an exception happens during a lock, the lock will automatically be released:
 
 ```ruby
@@ -217,6 +219,10 @@ Testing
 Changelog
 ---------
 
+###0.3.1 April 17, 2016 (Pending)
+- Fix `sem.lock(0)` bug (thanks eugenk!).
+- Fix `release_stale_locks!` deadlock bug (thanks mfischer-zd for the bug-report!).
+
 ###0.3.0 January 24, 2016
 - Change API to include non-blocking option for `#lock` (thanks tomclose!).
 - Fix unwanted persisting of `available_key` (thanks dany1468!).
@@ -227,50 +233,7 @@ Changelog
 - Add expiration option (thanks jcalvert!).
 - Update API version logic.
 
-###0.2.3 September 7, 2014
-- Block-based locking return the value of the block (thanks frobcode!).
-
-###0.2.2 June 16, 2014
-- Fixed bug in `all_tokens` (thanks presskey!).
-- Fixed bug in error message (thanks Dmitriy!).
-
-###0.2.1 August 6, 2013
-- Remove dependency on Redis 2.6+ using fallback for TIME command (thanks dubdromic!).
-- Add ```:use_local_time``` option
-
-###0.2.0 June 2, 2013
-- Use Redis TIME command for lock timeouts (thanks dubdromic!).
-- Version increase because of new dependency on Redis 2.6+
-
-###0.1.7 April 18, 2013
-- Fix bug where ```release_stale_locks!``` was not public (thanks scomma!).
-
-###0.1.6 March 31, 2013
-- Add non-ownership of tokens
-- Add stale client timeout (thanks timgaleckas!).
-
-###0.1.5 October 1, 2012
-- Add detection of Redis::Namespace definition to avoid potential bug (thanks ruud!).
-
-###0.1.4 October 1, 2012
-- Fixed empty namespaces (thanks ruurd!).
-
-###0.1.3 July 9, 2012
-- Tokens are now identifiable (thanks timgaleckas!).
-
-###0.1.2 June 1, 2012
-- Add redis-namespace support (thanks neovintage!).
-
-### 0.1.1 September 17, 2011
-- When an exception is raised during locked period, ensure it unlocks.
-
-### 0.1.0 August 4, 2011
-- Initial release.
-
-Author
-------
-
-[David Verhasselt](http://davidverhasselt.com) - david@crowdway.com
+More in [CHANGELOG](CHANGELOG.md).
 
 Contributors
 ------------
@@ -291,3 +254,9 @@ Thanks to these awesome people for their contributions:
 - [Jonathan Calvert](https://github.com/jcalvert)
 - [mikeryz](https://github.com/mikeryz)
 - [tomclose](https://github.com/tomclose)
+- [Eugen Kuksa](https://github.com/eugenk)
+- [Eugene Kenny](https://github.com/eugeneius)
+
+### "Merge"-button clicker
+
+[David Verhasselt](http://davidverhasselt.com) - david@crowdway.com

data/lib/redis/semaphore.rb

@@ -62,14 +62,13 @@ class Redis
 
       if timeout.nil? || timeout > 0
         # passing timeout 0 to blpop causes it to block
-        token_pair = @redis.blpop(available_key, timeout || 0)
+        _key, current_token = @redis.blpop(available_key, timeout || 0)
       else
-        token_pair = @redis.lpop(available_key)
+        current_token = @redis.lpop(available_key)
       end
 
-      return false if token_pair.nil?
+      return false if current_token.nil?
 
-      current_token = token_pair[1]
       @tokens.push(current_token)
       @redis.hset(grabbed_key, current_token, current_time.to_f)
       return_value = current_token
@@ -135,7 +134,7 @@ class Redis
     end
 
     def release_stale_locks!
-      simple_mutex(:release_locks, 10) do
+      simple_expiring_mutex(:release_locks, 10) do
         @redis.hgetall(grabbed_key).each do |token, locked_at|
           timed_out_at = locked_at.to_f + @stale_client_timeout
 
@@ -148,17 +147,37 @@ class Redis
 
   private
 
-    def simple_mutex(key_name, expires = nil)
-      key_name = namespaced_key(key_name) if key_name.kind_of? Symbol
-      token = @redis.getset(key_name, API_VERSION)
+    def simple_expiring_mutex(key_name, expires_in)
+      # Using the locking mechanism as described in
+      # http://redis.io/commands/setnx
 
-      return false unless token.nil?
-      @redis.expire(key_name, expires) unless expires.nil?
+      key_name = namespaced_key(key_name)
+      cached_current_time = current_time.to_f
+      my_lock_expires_at = cached_current_time + expires_in + 1
+
+      got_lock = @redis.setnx(key_name, my_lock_expires_at)
+
+      if !got_lock
+        # Check if expired
+        other_lock_expires_at = @redis.get(key_name).to_f
+
+        if other_lock_expires_at < cached_current_time
+          old_expires_at = @redis.getset(key_name, my_lock_expires_at).to_f
+
+          # Check if another client started cleanup yet. If not,
+          # then we now have the lock.
+          got_lock = (old_expires_at == other_lock_expires_at)
+        end
+      end
+
+      return false if !got_lock
 
       begin
-        yield token
+        yield
       ensure
-        @redis.del(key_name)
+        # Make sure not to delete the lock in case someone else already expired
+        # our lock, with one second in between to account for some lag.
+        @redis.del(key_name) if my_lock_expires_at > (current_time.to_f - 1)
       end
     end
 

data/spec/semaphore_spec.rb

@@ -137,6 +137,12 @@ describe "redis" do
 
       expect(did_we_get_in).to be false
     end
+
+    it "should be locked when the timeout is zero" do
+      semaphore.lock(0) do
+        expect(semaphore.locked?).to be true
+      end
+    end
   end
 
   describe "semaphore with expiration" do
@@ -268,4 +274,37 @@ describe "redis" do
     end
   end
 
+  # Private method tests, do not use
+  describe "simple_expiring_mutex" do
+    let(:semaphore) { Redis::Semaphore.new(:my_semaphore, :redis => @redis) }
+
+    before do
+      semaphore.class.send(:public, :simple_expiring_mutex)
+    end
+
+    it "gracefully expires stale lock" do
+      expiration = 1
+
+      thread =
+        Thread.new do
+          semaphore.simple_expiring_mutex(:test, expiration) do
+            sleep 3
+          end
+        end
+
+      sleep 1.5
+
+      expect(semaphore.simple_expiring_mutex(:test, expiration)).to be_falsy
+
+      sleep expiration
+
+      it_worked = false
+      semaphore.simple_expiring_mutex(:test, expiration) do
+        it_worked = true
+      end
+
+      expect(it_worked).to be_truthy
+      thread.join
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -5,3 +5,8 @@ Bundler.require(:development)
 $TESTING=true
 $:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 require 'redis/semaphore'
+
+RSpec.configure do |c|
+  c.filter_run focus: true
+  c.run_all_when_everything_filtered = true
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-semaphore
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - David Verhasselt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-24 00:00:00.000000000 Z
+date: 2016-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -28,16 +28,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '11'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.14'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -114,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Implements a distributed semaphore or mutex using Redis.