zk 0.8.8 → 0.8.9

data/.travis.yml

@@ -0,0 +1,17 @@
+---
+notifications:
+  email:
+    - slyphon@gmail.com
+
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby
+
+before_install:
+  - sudo apt-get update
+  - sudo apt-get install zookeeperd
+
+bundler_args: --without development
+

data/Gemfile

@@ -2,6 +2,17 @@
 source ENV['MBOX_BUNDLER_SOURCE'] if ENV['MBOX_BUNDLER_SOURCE']
 source "http://rubygems.org"
 
+group :development do
+  gem 'pry'
+end
+
+group :test do
+  gem 'rspec', '~> 2.8.0'
+  gem 'flexmock', '~> 0.8.10'
+  gem 'ZenTest', '~> 4.5.0'
+  gem 'rake'
+end
+
 # Specify your gem's dependencies in zk.gemspec
 gemspec
 

data/README.markdown

@@ -1,8 +1,6 @@
 # ZK
 
-ZK is a high-level interface to the Apache [ZooKeeper][] server. It is based on the [zookeeper gem][] which is a multi-Ruby low-level driver. Currently MRI 1.8.7, 1.9.2, and JRuby are supported (rubinius 1.2 is experimental but _should_ work). It is licensed under the [MIT][] license. 
-
-Note: 1.9.3-p0 support is currently under development, there are a few bugs to work out still...
+ZK is a high-level interface to the Apache [ZooKeeper][] server. It is based on the [zookeeper gem][] which is a multi-Ruby low-level driver. Currently MRI 1.8.7, 1.9.2, 1.9.3, and JRuby are supported (rubinius 1.2 is experimental but _should_ work). It is licensed under the [MIT][] license. 
 
 This library is heavily used in a production deployment and is actively developed and maintained.
 
@@ -35,13 +33,13 @@ The [zookeeper gem][] provides a low-level, cross platform library for interfaci
 ZK provides:
 
 * 	a robust lock implementation (both shared and exclusive locks)
-* 	an extension for the [Mongoid][] ORM to provide advisory locks on mongodb records
 * 	a leader election implementation with both "leader" and "observer" roles
 * 	a higher-level interface to the ZooKeeper callback/watcher mechanism than the [zookeeper gem][] provides
 * 	a simple threadpool implementation
 * 	a bounded, dynamically-growable (threadsafe) client pool implementation
 * 	a recursive Find class (like the Find module in ruby-core)
 * 	unix-like rm\_rf and mkdir\_p methods (useful for functional testing)
+* 	an extension for the [Mongoid][] ORM to provide advisory locks on mongodb records
 
 In addition to all of that, I would like to think that the public API the ZK::Client provides is more convenient to use for the common (synchronous) case. For use with [EventMachine][] there is [zk-eventmachine][] which provides a convenient API for writing evented code that uses the ZooKeeper server.
 
@@ -58,7 +56,7 @@ ZK strives to be a complete, correct, and convenient way of interacting with Zoo
 
 * ZK::Client supports asynchronous calls of all basic methods (get, set, delete, etc.) however these versions are kind of inconvenient to use. For a fully evented stack, try [zk-eventmachine][], which is designed to be compatible and convenient to use in event-driven code.
 
-* ZooKeeper "chroot" [connection syntax][chroot] _(search for "chroot" in page)_ is not currently working in the C drivers, and I don't have tests for the Java version. This hasn't been an incredibly high priority item, but support for this feature is intended.
+* ZooKeeper "chroot" [connection syntax][chroot] is currently being developed and should work for most cases. Right now we require that the root path exist before the chrooted client is used, but that may change [in the near future](https://github.com/slyphon/zk/issues/7).
 
 * I am currently in the process of cleaning up the API documentation and converting it to use [YARD][]. 
 

data/Rakefile

@@ -31,3 +31,19 @@ gemset_name = 'zk'
   task "mb:test_all" => rspec_task_name
 end
 
+namespace :spec do
+  task :define do
+    require 'rubygems'
+    require 'bundler/setup'
+    require 'rspec/core/rake_task'
+
+    RSpec::Core::RakeTask.new('spec:runner')
+  end
+
+  task :run => :define do
+    Rake::Task['spec:runner'].invoke
+  end
+end
+
+task :default => 'spec:run'
+

data/lib/z_k/client/state_mixin.rb

@@ -48,8 +48,6 @@ module ZK
         end
       end
 
-      # @private
-      #
       # Register a block to be called on connection, when the client has
       # connected. 
       # 

data/lib/z_k/client/unixisms.rb

@@ -1,6 +1,8 @@
 module ZK
   module Client
     module Unixisms
+      include ZookeeperConstants
+
       # Creates all parent paths and 'path' in zookeeper as persistent nodes with
       # zero data.
       #
@@ -62,7 +64,7 @@ module ZK
       #   watcher, you *will* deadlock!
       def block_until_node_deleted(abs_node_path)
         queue = Queue.new
-        ev_sub = nil
+        subs = []
 
         node_deletion_cb = lambda do |event|
           if event.node_deleted?
@@ -72,16 +74,35 @@ module ZK
           end
         end
 
-        ev_sub = watcher.register(abs_node_path, &node_deletion_cb)
+        subs << event_handler.register(abs_node_path, &node_deletion_cb)
+
+        # NOTE: this pattern may be necessary for other features with blocking semantics!
+
+        session_cb = lambda do |event|
+          queue.enq(event.state)
+        end
 
+        [:expired_session, :connecting, :closed].each do |sym|
+          subs << event_handler.register_state_handler(sym, &session_cb)
+        end
+        
         # set up the callback, but bail if we don't need to wait
         return true unless exists?(abs_node_path, :watch => true)  
 
-        queue.pop # block waiting for node deletion
-        true
+        case queue.pop
+        when :deleted
+          true
+        when ZOO_EXPIRED_SESSION_STATE
+          raise ZookeeperExceptions::ZookeeperException::SessionExpired
+        when ZOO_CONNECTING_STATE
+          raise ZookeeperExceptions::ZookeeperException::NotConnected
+        when ZOO_CLOSED_STATE
+          raise ZookeeperExceptions::ZookeeperException::ConnectionClosed
+        else
+          raise "Hit unexpected case in block_until_node_deleted"
+        end
       ensure
-        # be sure we clean up after ourselves
-        ev_sub.unregister if ev_sub
+        subs.each(&:unregister)
       end
     end
   end

data/lib/z_k/event_handler.rb

@@ -85,9 +85,16 @@ module ZK
     end
     alias :subscribe :register
 
-    # registers a "state of the connection" handler
+    # Registers a "state of the connection" handler
     #
-    # @param [String] state the state you want to register for
+    # Valid states are: connecting, associating, connected, auth_failed,
+    # expired_session. Of all of these, you are probably most likely
+    # interested in `expired_session` and `connecting`, which are fired
+    # when you either lose your session (and have to completely reconnect),
+    # or when there's a temporary loss in connection and Zookeeper recommends
+    # you go into 'safe mode'.
+    #
+    # @param [String] state The state you want to register for.
     # @param [Block] block the block to execute on state changes
     # @yield [event] yields your block with
     #

data/lib/z_k/extensions.rb

@@ -71,6 +71,7 @@ module ZK
         def state_event?
           path.nil? or path.empty?
         end
+        alias session_event? state_event?
 
         # has this watcher been called because of a change to a zookeeper node?
         def node_event?

data/lib/z_k/version.rb

@@ -1,3 +1,3 @@
 module ZK
-  VERSION = "0.8.8"
+  VERSION = "0.8.9"
 end

data/spec/informal/lock_with_dead_session.rb

@@ -0,0 +1,80 @@
+#!/usr/bin/env ruby
+
+require 'zk'
+require 'logger'
+
+$stderr.sync = true
+
+ZK.logger = log = Logger.new('informal.log').tap { |l| l.level = Logger::DEBUG }
+Zookeeper.logger = log
+Zookeeper.set_debug_level(4)
+
+class ::Exception
+  def to_std_format
+    "#{self.class}: #{message}\n" + backtrace {|n| "\t#{n}"}.join("\n")
+  end
+end
+
+def safe_join(th, timeout=nil)
+  begin
+    th.join(timeout)
+  rescue Exception => e
+    $stderr.puts "#{th[:name]} raised #{e.to_std_format}"
+  end
+end
+
+def print_error
+  yield
+rescue Exception => e
+  $stderr.puts "caught exception in #{Thread.current[:name]}: #{e.to_std_format}"
+end
+
+lock_name = 'the_big_sleep'
+
+q = Queue.new
+
+
+th1 = Thread.new do
+  print_error do
+    ZK.open do |zk|
+      $stderr.puts "first connection session_id: 0x%x" % zk.session_id
+      sub = zk.on_expired_session do |state|
+        $stderr.puts "OH NOES! thread 1 got an expired session! #{state.inspect}"
+      end
+
+      zk.with_lock(lock_name) do
+        q.push(:ok_sleeping)
+        sleep # we now sleep with the fishes
+      end
+    end
+  end
+end
+
+th1[:name] = 'thread 1'
+
+q.pop
+
+Thread.pass until th1.status == 'sleep'
+
+$stderr.puts "ok, now try to acquire lock"
+
+th2 = Thread.new do
+  print_error do
+    ZK.open do |zk|
+      $stderr.puts "second connection session_id: 0x%x" % zk.session_id
+
+      sub = zk.on_expired_session do |state|
+        $stderr.puts "OH NOES! thread 2 got an expired session! #{state.inspect}"
+      end
+
+      zk.with_lock(lock_name) do
+        $stderr.puts "acquired the lock in second thread"
+      end
+    end
+  end
+end
+
+th2[:name] = 'thread 2'
+
+[th1, th2].each(&method(:safe_join))
+

data/spec/spec_helper.rb

@@ -11,7 +11,9 @@ ZK_TEST_PORT = 2181
 LOG_FILE = File.open(File.join(ZK::ZK_ROOT, 'test.log'), 'a').tap { |f| f.sync = true }
 
 ZK.logger = Logger.new(LOG_FILE).tap { |log| log.level = Logger::DEBUG }
-#Zookeeper.logger = ZK.logger
+Zookeeper.logger = ZK.logger
+
+ZK.logger.debug { "LOG OPEN" }
 
 # Requires supporting ruby files with custom matchers and macros, etc,
 # in spec/support/ and its subdirectories.

data/spec/z_k/client_spec.rb

@@ -2,7 +2,8 @@ require 'spec_helper'
 
 describe ZK::Client do
   before do
-    @zk = ZK.new("localhost:#{ZK_TEST_PORT}")
+    @connection_string = "localhost:#{ZK_TEST_PORT}"
+    @zk = ZK.new(@connection_string)
     wait_until{ @zk.connected? }
     @zk.rm_rf('/test')
   end
@@ -82,6 +83,7 @@ describe ZK::Client do
         @a = false
 
         th = Thread.new do
+          
           @zk.block_until_node_deleted(@path)
           @a = true
         end
@@ -94,6 +96,69 @@ describe ZK::Client do
         wait_until(2) { @a }
         @a.should be_true
       end
+
+      shared_examples_for 'session death' do
+        def deliver_session_event_to(event_num, zk)
+          # jeez, Zookeeper callbacks are so frustratingly stupid
+          bogus_event = ZookeeperCallbacks::WatcherCallback.new
+          bogus_event.initialize_context(:type => -1, :state => event_num, :path => '', :context => 'bogustestevent')
+          # XXX: this is bad because we're in the wrong thread, but we'll fix this after the next Zookeeper release
+          zk.event_handler.process(bogus_event)
+        end
+
+        before do
+          @other_zk = ZK.new(@connection_string)
+        end
+
+        after do
+          @other_zk.close! unless @other_zk.closed?
+        end
+
+        it %[should wake up in the case of an expired session and throw an exception] do
+          @a = false
+
+          @other_zk.event_handler.register_state_handler(zoo_state) do |event|
+            @a = event
+          end
+
+          th = Thread.new do
+            @other_zk.block_until_node_deleted(@path)
+          end
+
+          wait_until(2) { th.status == 'sleep' }
+
+          # not on the other thread, this may be bad
+          deliver_session_event_to(zoo_state, @other_zk)
+
+          # ditto, this is probably happening synchrnously
+          wait_until(2) { @a }
+
+          lambda { th.join(2) }.should raise_error(zoo_error_class)
+        end
+      end
+
+      describe 'exceptional conditions' do
+        describe 'ZOO_EXPIRED_SESSION_STATE' do
+          let(:zoo_state) { ZookeeperConstants::ZOO_EXPIRED_SESSION_STATE }
+          let(:zoo_error_class) { ZookeeperExceptions::ZookeeperException::SessionExpired }
+
+          it_behaves_like 'session death'
+        end
+
+        describe 'ZOO_CONNECTING_STATE' do
+          let(:zoo_state) { ZookeeperConstants::ZOO_CONNECTING_STATE }
+          let(:zoo_error_class) { ZookeeperExceptions::ZookeeperException::NotConnected }
+
+          it_behaves_like 'session death'
+        end
+
+        describe 'ZOO_CLOSED_STATE' do
+          let(:zoo_state) { ZookeeperConstants::ZOO_CLOSED_STATE }
+          let(:zoo_error_class) { ZookeeperExceptions::ZookeeperException::ConnectionClosed }
+
+          it_behaves_like 'session death'
+        end
+      end
     end
   end
 
@@ -106,6 +171,64 @@ describe ZK::Client do
       @zk.session_passwd.should be_kind_of(String)
     end
   end
+
+  describe 'reopen' do
+    describe 'watchers' do
+      before do
+        @path = '/testwatchers'
+        @queue = Queue.new
+      end
+
+      after do
+        @zk.delete(@path)
+      end
+
+      def ensure_event_delivery!
+        @sub ||= @zk.event_handler.register(@path) do |event|
+          logger.debug { "got event: #{event.inspect}" } 
+          @queue << event
+        end
+
+        @zk.exists?(@path, :watch => true).should be_false
+        @zk.create(@path, '')
+
+        logger.debug { "waiting for event delivery" } 
+
+        wait_until(2) do 
+          begin
+            @events << @queue.pop(true)
+            true
+          rescue ThreadError
+            false
+          end
+        end
+
+        # first watch delivered correctly
+        @events.length.should > 0
+      end
+
+      it %[should fire re-registered watchers after reopen (#9)] do
+        @events = []
+
+        logger.debug { "ensure event delivery" }
+        ensure_event_delivery!
+
+        logger.debug { "reopening connection" }
+        @zk.reopen
+
+        wait_until(2) { @zk.connected? }
+
+        logger.debug { "deleting path" }
+        @zk.delete(@path)
+
+        logger.debug { "clearing events" }
+        @events.clear
+
+        logger.debug  { "taunt them a second time" }
+        ensure_event_delivery!
+      end
+    end
+  end
 end
 
 

data/zk.gemspec

@@ -14,10 +14,6 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'slyphon-zookeeper', '~> 0.3.0'
 
-  s.add_development_dependency 'rspec', '~> 2.8.0'
-  s.add_development_dependency 'flexmock', '~> 0.8.10'
-  s.add_development_dependency 'ZenTest', '~> 4.5.0'
-  s.add_development_dependency 'pry'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: zk
 version: !ruby/object:Gem::Version 
-  hash: 47
+  hash: 45
   prerelease: 
   segments: 
   - 0
   - 8
-  - 8
-  version: 0.8.8
+  - 9
+  version: 0.8.9
 platform: ruby
 authors: 
 - Jonathan D. Simms
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-13 00:00:00 Z
+date: 2012-04-21 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: slyphon-zookeeper
@@ -34,68 +34,6 @@ dependencies:
         version: 0.3.0
   type: :runtime
   version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 47
-        segments: 
-        - 2
-        - 8
-        - 0
-        version: 2.8.0
-  type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: flexmock
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 43
-        segments: 
-        - 0
-        - 8
-        - 10
-        version: 0.8.10
-  type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: ZenTest
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 43
-        segments: 
-        - 4
-        - 5
-        - 0
-        version: 4.5.0
-  type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: pry
-  prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id005
 description: |
   A high-level wrapper around the zookeeper driver
 
@@ -112,6 +50,7 @@ files:
 - .dotfiles/rspec-logging
 - .dotfiles/rvmrc
 - .gitignore
+- .travis.yml
 - .yardopts
 - Gemfile
 - LICENSE
@@ -138,6 +77,7 @@ files:
 - lib/z_k/threadpool.rb
 - lib/z_k/version.rb
 - lib/zk.rb
+- spec/informal/lock_with_dead_session.rb
 - spec/log4j.properties
 - spec/message_queue_spec.rb
 - spec/spec_helper.rb
@@ -189,6 +129,7 @@ signing_key:
 specification_version: 3
 summary: A high-level wrapper around the zookeeper driver
 test_files: 
+- spec/informal/lock_with_dead_session.rb
 - spec/log4j.properties
 - spec/message_queue_spec.rb
 - spec/spec_helper.rb