zookeeper 1.2.2 → 1.2.3

data/CHANGELOG

@@ -1,3 +1,12 @@
+v1.2.3 ensure that all threads are woken up on shutdown
+
+  * There was an edge case where a call would be queued up and its thread
+    sleeping waiting for a response, but that response would never come because
+    the connection was shut down. This version includes a patch for that case
+    to ensure that if a call is in 'pending' state, and shutdown time arrives
+    that all pending threads will receive a Zookeeper::Exceptions::NotConnected
+    exception.
+
 v1.2.2 avoid race while waiting for connection
 
   * There was a possible race in CZookeeper#wait_until_connected where if we

data/ext/c_zookeeper.rb

@@ -143,13 +143,13 @@ class CZookeeper
   # requests may still be added during this time, but they will not be
   # processed until you call resume
   def pause_before_fork_in_parent
-    logger.debug { "#{self.class}##{__method__}" }
+    logger.debug { "##{__method__}" }
     @mutex.synchronize { stop_event_thread }
   end
 
   # call this if 'pause' was previously called to start the event loop again
   def resume_after_fork_in_parent
-    logger.debug { "#{self.class}##{__method__}" }
+    logger.debug { "##{__method__}" }
 
     @mutex.synchronize do 
       @_shutting_down = nil
@@ -184,6 +184,10 @@ class CZookeeper
     # submits a job for processing 
     # blocks the caller until result has returned
     def submit_and_block(meth, *args)
+      @mutex.synchronize do
+        raise Exceptions::NotConnected if @_shutting_down
+      end
+
       cnt = Continuation.new(meth, *args)
       @reg.lock 
       begin
@@ -206,7 +210,7 @@ class CZookeeper
     #
     def stop_event_thread
       if @event_thread
-        logger.debug { "#{self.class}##{__method__}" }
+        logger.debug { "##{__method__}" }
         shut_down!
         wake_event_loop!
         @event_thread.join 
@@ -235,7 +239,7 @@ class CZookeeper
 
     def event_thread_body
       Thread.current.abort_on_exception = true
-      logger.debug { "#{self.class}##{__method__} starting event thread" }
+      logger.debug { "##{__method__} starting event thread" }
 
       event_thread_await_running
 
@@ -249,21 +253,34 @@ class CZookeeper
       # ok, if we're exiting the event loop, and we still have a valid connection
       # and there's still completions we're waiting to hear about, then we
       # should pump the handle before leaving this loop
-      if @_shutting_down and not (@_closed or is_unrecoverable or @reg.in_flight.empty?)
-        logger.debug { "we're in shutting down state, ensuring we have no in-flight completions" }
+      if @_shutting_down and not (@_closed or is_unrecoverable)
+        logger.debug { "we're in shutting down state, there are #{@reg.in_flight.length} in_flight completions" }
 
-        until @reg.in_flight.empty?
+        until @reg.in_flight.empty? or is_unrecoverable or @_closed
           zkrb_iterate_event_loop
           iterate_event_delivery
+          logger.debug { "there are #{@reg.in_flight} in_flight completions left" }
         end
 
         logger.debug { "finished completions" }
       end
 
+      if @_shutting_down # in shutting down state, no more can be added to @reg
+        # anything left over after all that gets the finger
+        remaining = @reg.next_batch + @reg.in_flight.values
+
+        logger.debug { "there are #{remaining.length} completions to awaken" }
+
+        @reg.in_flight.clear
+
+        while cb = remaining.shift
+          cb.shutdown!
+        end
+      end
     rescue ShuttingDownException
       logger.error { "event thread saw @_shutting_down, bailing without entering loop" }
     ensure
-      logger.debug { "#{self.class}##{__method__} exiting" }
+      logger.debug { "##{__method__} exiting" }
     end
 
     def submit_pending_calls
@@ -285,7 +302,7 @@ class CZookeeper
 
     def iterate_event_delivery
       while hash = zkrb_get_next_event_st()
-        logger.debug { "#{self.class}##{__method__} got #{hash.inspect} " }
+        logger.debug { "##{__method__} got #{hash.inspect} " }
 
         if (hash[:req_id] == ZKRB_GLOBAL_CB_REQ) && (hash[:type] == -1)
           ev_state = hash[:state]
@@ -324,14 +341,14 @@ class CZookeeper
 
     # use this method to set the @_shutting_down flag to true
     def shut_down!
-      logger.debug { "#{self.class}##{__method__}" }
+      logger.debug { "##{__method__}" }
 
       @mutex.synchronize { @_shutting_down = true }
     end
 
     # called by underlying C code to signal we're running
     def zkc_set_running_and_notify!
-      logger.debug { "#{self.class}##{__method__}" }
+      logger.debug { "##{__method__}" }
 
       @mutex.synchronize do
         @_running = true

data/lib/zookeeper.rb

@@ -40,7 +40,7 @@ module Zookeeper
   @@logger = nil unless defined?(@@logger)
   
   def self.logger
-    @@logger || ::Logging.logger['Zookeeper']
+    @@logger
   end
 
   def self.logger=(logger)

data/lib/zookeeper/common.rb

@@ -130,7 +130,7 @@ protected
   def dispatch_next_callback(hash)
     return nil unless hash
 
-    Zookeeper.logger.debug { "get_next_event returned: #{prettify_event(hash).inspect}" }
+    logger.debug { "get_next_event returned: #{prettify_event(hash).inspect}" }
     
     is_completion = hash.has_key?(:rc)
     

data/lib/zookeeper/continuation.rb

@@ -22,7 +22,7 @@ module Zookeeper
         @mutex = Mutex.new
       end
 
-      def synchronized
+      def synchronize
         @mutex.lock
         begin
           yield self
@@ -85,10 +85,6 @@ module Zookeeper
 
       # make this error reporting more robust if necessary, right now, just set to state
       @error  = nil
-      
-      # set to true when an event occurs that would cause the caller to
-      # otherwise block forever
-      @interrupt = false
     end
 
     # the caller calls this method and receives the response from the async loop
@@ -99,6 +95,8 @@ module Zookeeper
         case @error
         when nil
           # ok, nothing to see here, carry on
+        when :shutdown
+          raise Exceptions::NotConnected, "the connection is shutting down"
         when ZOO_EXPIRED_SESSION_STATE
           raise Exceptions::SessionExpired, "connection has expired"
         else
@@ -162,6 +160,15 @@ module Zookeeper
       @meth == :state
     end
 
+    # interrupt the sleeping thread with a NotConnected error
+    def shutdown!
+      @mutex.synchronize do
+        return if @rval or @error
+        @error = :shutdown
+        @cond.broadcast
+      end
+    end
+
     protected
 
       # an args array with the only difference being that if there's a user

data/lib/zookeeper/version.rb

@@ -1,4 +1,4 @@
 module Zookeeper
-  VERSION = '1.2.2'
+  VERSION = '1.2.3'
   DRIVER_VERSION = '3.3.5'
 end

data/spec/chrooted_connection_spec.rb

@@ -61,7 +61,7 @@ describe 'Zookeeper chrooted' do
 
   describe do
     before :all do
-      Zookeeper.logger.warn "running before :all"
+      logger.warn "running before :all"
 
       with_open_zk do |z|
         z.create(:path => chroot_path, :data => '')

data/spec/shared/connection_examples.rb

@@ -11,7 +11,7 @@ shared_examples_for "connection" do
   end
 
   after :all do
-    Zookeeper.logger.warn "running shared examples after :all"
+    logger.warn "running shared examples after :all"
 
     with_open_zk(connection_string) do |z|
       rm_rf(z, path)

data/spec/support/00_logging.rb

@@ -3,12 +3,14 @@ module Zookeeper
 end
 
 layout = Logging.layouts.pattern(
-  :pattern => '%.1l, [%d #%p]:  %m\n',
+  :pattern => '%.1l, [%d #%p] %25.25c{2}:  %m\n',
   :date_pattern => '%Y-%m-%d %H:%M:%S.%6N' 
 )
 
 appender = (ENV['ZOOKEEPER_DEBUG'] || ENV['ZKRB_DEBUG']) ? Logging.appenders.stderr : Logging.appenders.file(Zookeeper::TEST_LOG_PATH)
 appender.layout = layout
+appender.auto_flushing = 25
+appender.flush_period = 5
 
 %w[spec Zookeeper].each do |name|
   ::Logging.logger[name].tap do |log|

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: zookeeper
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 1
   - 2
-  - 2
-  version: 1.2.2
+  - 3
+  version: 1.2.3
 platform: ruby
 authors: 
 - Phillip Pearson
@@ -20,7 +20,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-21 00:00:00 Z
+date: 2012-05-23 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: backports
@@ -193,3 +193,4 @@ test_files:
 - spec/support/progress_formatter.rb
 - spec/support/zookeeper_spec_helpers.rb
 - spec/zookeeper_spec.rb
+has_rdoc: