zk 1.7.0 → 1.7.1

data/Gemfile

@@ -42,7 +42,7 @@ end
 group :test do
   gem 'rspec', '~> 2.8.0'
   gem 'flexmock', '~> 0.8.10'
-  gem 'zk-server', '~> 1.0.1'
+  gem 'zk-server', '~> 1.1.4'
 end
 
 # Specify your gem's dependencies in zk.gemspec

data/README.markdown

@@ -65,6 +65,11 @@ In addition to all of that, I would like to think that the public API the ZK::Cl
 [zk-eventmachine]: https://github.com/slyphon/zk-eventmachine
 
 ## NEWS ##
+
+### v1.7.1 ###
+
+* Fixes nasty bug "LockWaitTimeout causes lock to be forever unusable" (#49)
+
 ### v1.7.0 ###
 
 * Added Locker timeout feature for blocking calls. (issue #40)

data/RELEASES.markdown

@@ -1,5 +1,11 @@
 This file notes feature differences and bugfixes contained between releases. 
 
+### v1.7.1 ###
+
+* Fixes nasty bug "LockWaitTimeout causes lock to be forever unusable" (#49)
+
+The code path in the case of a LockWaitTimeout would skip the lock node cleanup, so a given lock name would become unusable until the timed-out-locker's session went away. This fixes that case and adds specs.
+
 ### v1.7.0 ###
 
 * Added Locker timeout feature for blocking calls. (issue #40)

data/lib/zk/client/base.rb

@@ -198,7 +198,7 @@ module ZK
       #   @option opts [Object] :context (nil) an object passed to the `:callback`
       #     given as the `context` param
       #
-      #   @option opts [:create,nil] :or (nil) syntactic sugar to say 'if this
+      #   @option opts [:set,nil] :or (nil) syntactic sugar to say 'if this
       #     path already exists, then set its contents.' Note that this will
       #     also create all intermediate paths as it delegates to
       #     {ZK::Client::Unixisms#mkdir_p}.  Note that this option can only be
@@ -233,7 +233,7 @@ module ZK
       #   @option opts [Object] :context (nil) an object passed to the `:callback`
       #     given as the `context` param
       #
-      #   @option opts [:create,nil] :or (nil) syntactic sugar to say 'if this
+      #   @option opts [:set,nil] :or (nil) syntactic sugar to say 'if this
       #     path already exists, then set its contents.' Note that this will
       #     also create all intermediate paths as it delegates to
       #     {ZK::Client::Unixisms#mkdir_p}.  Note that this option can only be

data/lib/zk/locker/exclusive_locker.rb

@@ -92,6 +92,13 @@ module ZK
 
             @node_deletion_watcher.block_until_deleted(opts)
           rescue WeAreTheLowestLockNumberException
+          rescue ZK::Exceptions::LockWaitTimeoutError
+            # in the case of a timeout exception, we need to ensure the lock
+            # path is cleaned up, since we're not interested in acquisition
+            # anymore
+            logger.warn { "got ZK::Exceptions::LockWaitTimeoutError, cleaning up lock path" }
+            cleanup_lock_path!
+            raise
           ensure
             logger.debug { "block_until_deleted returned" } 
           end

data/lib/zk/locker/shared_locker.rb

@@ -109,6 +109,12 @@ module ZK
             end
 
             @node_deletion_watcher.block_until_deleted(opts)
+          rescue ZK::Exceptions::LockWaitTimeoutError
+            # in the case of a timeout exception, we need to ensure the lock
+            # path is cleaned up, since we're not interested in acquisition
+            # anymore
+            cleanup_lock_path!
+            raise
           rescue NoWriteLockFoundException
             # next_lowest_write_lock_name may raise NoWriteLockFoundException,
             # which means we should not block as we have the lock (there is nothing to wait for)

data/lib/zk/version.rb

@@ -1,3 +1,3 @@
 module ZK
-  VERSION = "1.7.0"
+  VERSION = "1.7.1"
 end

data/spec/zk/locker/exclusive_locker_spec.rb

@@ -82,7 +82,8 @@ shared_examples_for 'ZK::Locker::ExclusiveLocker' do
     end
 
     describe 'blocking' do
-      let(:read_lock_path_template) { "/_zklocking/#{path}/#{ZK::Locker::SHARED_LOCK_PREFIX}" }
+      let(:lock_path_base) { File.join(ZK::Locker.default_root_lock_node, path) }
+      let(:read_lock_path_template) { File.join(lock_path_base, ZK::Locker::SHARED_LOCK_PREFIX) }
 
       before do
         zk.mkdir_p(root_lock_path)
@@ -139,6 +140,8 @@ shared_examples_for 'ZK::Locker::ExclusiveLocker' do
       it %[should time out waiting for the lock] do
         ary = []
 
+        zk.children(lock_path_base).length.should == 1
+
         locker.lock.should be_false
 
         th = Thread.new do
@@ -157,6 +160,8 @@ shared_examples_for 'ZK::Locker::ExclusiveLocker' do
 
         th.join(2).should == th
 
+        zk.children(lock_path_base).length.should == 1
+
         ary.should be_empty
         @exc.should_not be_nil
         @exc.should be_kind_of(ZK::Exceptions::LockWaitTimeoutError)

data/spec/zk/locker/shared_locker_spec.rb

@@ -148,6 +148,10 @@ shared_examples_for 'ZK::Locker::SharedLocker' do
         it %[should raise LockWaitTimeoutError] do
           ary = []
 
+          write_lock_dir = File.dirname(@write_lock_path)
+
+          zk.children(write_lock_dir).length.should == 1
+
           locker.lock.should be_false
 
           th = Thread.new do
@@ -166,6 +170,8 @@ shared_examples_for 'ZK::Locker::SharedLocker' do
 
           th.join(2).should == th
 
+          zk.children(write_lock_dir).length.should == 1
+
           ary.should be_empty
           @exc.should be_kind_of(ZK::Exceptions::LockWaitTimeoutError)
         end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: zk
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 9
   prerelease: 
   segments: 
   - 1
   - 7
-  - 0
-  version: 1.7.0
+  - 1
+  version: 1.7.1
 platform: ruby
 authors: 
 - Jonathan D. Simms
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-08-29 00:00:00 Z
+date: 2012-09-22 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: zookeeper
@@ -186,7 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: A high-level wrapper around the zookeeper driver