zookeeper 1.2.0 → 1.2.1

data/CHANGELOG

@@ -1,3 +1,17 @@
+v1.2.1 simplify assert_open
+
+  * The client methods were all calling assert_open before performing an
+    action. This was meant as a fail-early lightweight check of the connection
+    state and it worked well when we were running against the mt code. Now this
+    requires us to use a Continuation and make our way through the event loop.
+    There is a possible deadlock this release should solve that was caused by 
+    the assert_open code holding a lock while making an async call through
+    the event loop. This is no longer the case. The assert_open call only checks
+    that the current handle hasn't been closed, the connection-state checking
+    now occurs before submitting a request on the event iteration thread, and
+    the behavior should be the same as it was before. If the underlying
+    connection is not in the 'connected' state, an exception will be raised.
+
 v1.2.0 Stop the World, I Wanna fork()
 
   * changed pause/resume methods to pause_before_fork_in_parent

data/ext/zookeeper_base.rb

@@ -117,8 +117,7 @@ class ZookeeperBase
   # if either of these happen, the user will need to renegotiate a connection via reopen
   def assert_open
     @mutex.synchronize do
-      raise Exceptions::SessionExpired if state == ZOO_EXPIRED_SESSION_STATE
-      raise Exceptions::NotConnected   unless connected?
+      raise Exceptions::NotConnected if closed?
       if forked?
         raise InheritedConnectionError, <<-EOS.gsub(/(?:^|\n)\s*/, ' ').strip
           You tried to use a connection inherited from another process 

data/lib/zookeeper.rb

@@ -5,6 +5,7 @@ require 'monitor'
 require 'forwardable'
 require 'logger'
 require 'benchmark'
+require 'logging'
 
 module Zookeeper
   # establishes the namespace
@@ -33,13 +34,13 @@ require_relative 'zookeeper/client'
 
 module Zookeeper
   include Constants
-
-  unless defined?(@@logger)
-    @@logger = ::Logger.new($stderr).tap { |l| l.level = ENV['ZOOKEEPER_DEBUG'] ? ::Logger::DEBUG : ::Logger::ERROR } 
-  end
-
+  #::Logger.new($stderr).tap { |l| l.level = ENV['ZOOKEEPER_DEBUG'] ? ::Logger::DEBUG : ::Logger::ERROR } 
+  #
+  
+  @@logger = nil unless defined?(@@logger)
+  
   def self.logger
-    @@logger
+    @@logger || ::Logging.logger['Zookeeper']
   end
 
   def self.logger=(logger)

data/lib/zookeeper/continuation.rb

@@ -82,6 +82,9 @@ module Zookeeper
       @mutex  = Mutex.new
       @cond   = ConditionVariable.new
       @rval   = nil
+
+      # 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
@@ -90,9 +93,17 @@ module Zookeeper
 
     # the caller calls this method and receives the response from the async loop
     def value
-      @mutex.lock
-      begin
-        @cond.wait(@mutex) until @rval
+      @mutex.synchronize do
+        @cond.wait(@mutex) until @rval or @error
+
+        case @error
+        when nil
+          # ok, nothing to see here, carry on
+        when ZOO_EXPIRED_SESSION_STATE
+          raise Exceptions::SessionExpired, "connection has expired"
+        else
+          raise Exceptions::NotConnected, "connection state is #{STATE_NAMES[@error]}"
+        end
 
         case @rval.length
         when 1
@@ -100,8 +111,6 @@ module Zookeeper
         else
           return @rval
         end
-      ensure
-        @mutex.unlock rescue nil
       end
     end
 
@@ -124,13 +133,24 @@ module Zookeeper
     # implementation, but it's more important to get *something* working and
     # passing specs, then refactor to make everything sane
     # 
+    #
     def submit(czk)
+      state = czk.zkrb_state    # check the state of the connection
+
+      if @meth == :state        # if the method is a state call
+        @rval = [state]         # we're done, no error
+        return deliver!
+
+      elsif state != ZOO_CONNECTED_STATE  # otherwise, we must be connected
+        @error = state                    # so set the error
+        return deliver!                   # and we're out
+      end
+
       rc, *_ = czk.__send__(:"zkrb_#{@meth}", *async_args)
       
-      # if this is an state call, async call, or we failed to submit it
-      if (@meth == :state) or user_callback? or (rc != ZOK)
-        @rval = [rc]           # create the repsonse
-        deliver!               # wake the caller and we're out
+      if user_callback? or (rc != ZOK)  # async call, or we failed to submit it
+        @rval = [rc]                    # create the repsonse
+        deliver!                        # wake the caller and we're out
       end
     end
 
@@ -152,9 +172,6 @@ module Zookeeper
 
         logger.debug { "async_args, meth: #{meth} ary: #{ary.inspect}, #{callback_arg_idx}" }
 
-        # this is not already an async call
-        # so we replace the req_id with the ZKRB_ASYNC_CONTN_ID so the 
-        # event thread knows to dispatch it itself
         ary[callback_arg_idx] ||= self
 
         ary
@@ -165,11 +182,8 @@ module Zookeeper
       end
 
       def deliver!
-        @mutex.lock
-        begin
+        @mutex.synchronize do
           @cond.signal
-        ensure
-          @mutex.unlock rescue nil
         end
       end
   end # Base

data/lib/zookeeper/logger.rb

@@ -1,16 +1,28 @@
 module Zookeeper
   module Logger
     def self.included(mod)
+      return false if mod < self    # avoid infinite recursion
+      mod.class_eval do 
+        def self.logger
+          ::Zookeeper.logger || ::Logging.logger[logger_name]
+        end
+      end
       mod.extend(self)
     end
 
-    def self.const_missing(sym)
-      return ::Logger.const_get(sym) if ::Logger.const_defined?(sym)
-      super
-    end
+    def self.set_default
+      ::Logging.logger['Zookeeper'].tap do |ch_root|
+        ::Logging.appenders.stderr.tap do |serr|
+          serr.layout = ::Logging.layouts.pattern(
+            :pattern => '%.1l, [%d] %c30.30{2}:  %m\n',
+            :date_pattern => '%Y-%m-%d %H:%M:%S.%6N' 
+          )
 
-    def self.new(*a, &b)
-      ::Logger.new(*a, &b)
+          ch_root.add_appenders(serr)
+        end
+
+        ch_root.level = ENV['ZOOKEEPER_DEBUG'] ? :debug : :off
+      end
     end
 
     private
@@ -22,7 +34,7 @@ module Zookeeper
       end
 
       def logger
-        ::Zookeeper.logger
+        @logger ||= (::Zookeeper.logger || ::Logging.logger[self.class.logger_name]) # logger_name defined in ::Logging::Utils
       end
   end
 end

data/lib/zookeeper/version.rb

@@ -1,4 +1,4 @@
 module Zookeeper
-  VERSION = '1.2.0'
+  VERSION = '1.2.1'
   DRIVER_VERSION = '3.3.5'
 end

data/spec/spec_helper.rb

@@ -16,30 +16,26 @@ require 'zookeeper'
 Dir[File.expand_path('../support/**/*.rb', __FILE__)].sort.each { |f| require(f) }
 
 if ENV['ZKRB_DEBUG']
-  Zookeeper.logger = Logger.new($stderr).tap { |l| l.level = Logger::DEBUG }
   Zookeeper.set_debug_level(4)
-else
-  Zookeeper.logger = Logger.new(File.expand_path('../../test.log', __FILE__)).tap do |log|
-    log.level = Logger::DEBUG
-  end
 end
 
 if ENV['ZKRB_NOLOG']
-  Zookeeper.logger.level = Logger::FATAL
+  ::Logging.logger['Zookeeper'].level = :off
   Zookeeper.set_debug_level(0)
 end
 
-
 RSpec.configure do |config|
   config.mock_with :rspec
-  config.include Zookeeper::SpecHelpers
-  config.extend Zookeeper::SpecHelpers
+  [Zookeeper::SpecHelpers, SpecGlobalLogger].each do |mod|
+    config.include(mod)
+    config.extend(mod)
+  end
 
   if Zookeeper.spawn_zookeeper?
     require 'zk-server'
 
     config.before(:suite) do 
-      Zookeeper.logger.debug { "Starting zookeeper service" }
+      ::Logging.logger['spec'].debug { "Starting zookeeper service" }
       ZK::Server.run do |c|
         c.base_dir    = File.expand_path('../../.zkserver', __FILE__)
         c.client_port = Zookeeper.test_port
@@ -49,7 +45,7 @@ RSpec.configure do |config|
     end
 
     config.after(:suite) do
-      Zookeeper.logger.debug { "stopping zookeeper service" }
+      ::Logging.logger['spec'].debug { "stopping zookeeper service" }
       ZK::Server.shutdown
     end
   end

data/spec/support/00_logging.rb

@@ -0,0 +1,35 @@
+module Zookeeper
+  TEST_LOG_PATH = File.expand_path('../../../test.log', __FILE__)
+end
+
+layout = Logging.layouts.pattern(
+  :pattern => '%.1l, [%d #%p]:  %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
+
+%w[spec Zookeeper].each do |name|
+  ::Logging.logger[name].tap do |log|
+    log.appenders = [appender]
+    log.level = :debug
+  end
+end
+
+module SpecGlobalLogger
+  def logger
+    @spec_global_logger ||= ::Logging.logger['spec']
+  end
+
+  # sets the log level to FATAL for the duration of the block
+  def mute_logger
+    zk_log = Logging.logger['Zookeeper']
+    orig_level, zk_log.level = zk_log.level, :off
+    orig_zk_level, Zookeeper.debug_level = Zookeeper.debug_level, Zookeeper::Constants::ZOO_LOG_LEVEL_ERROR
+    yield
+  ensure
+    zk_log.level = orig_zk_level
+  end
+end
+

data/spec/support/progress_formatter.rb

@@ -5,7 +5,7 @@ module RSpec
     module Formatters
       class ProgressFormatter
         def example_started(example)
-          Zookeeper.logger.info(yellow("=====<([ #{example.full_description} ])>====="))
+          ::Logging.logger['spec'].write(yellow("\n=====<([ #{example.full_description} ])>=====\n"))
           super(example)
         end
       end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: zookeeper
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: 
   segments: 
   - 1
   - 2
-  - 0
-  version: 1.2.0
+  - 1
+  version: 1.2.1
 platform: ruby
 authors: 
 - Phillip Pearson
@@ -20,7 +20,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-18 00:00:00 Z
+date: 2012-05-21 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: backports
@@ -38,6 +38,22 @@ dependencies:
         version: 2.5.1
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: logging
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 7
+        - 2
+        version: 1.7.2
+  type: :runtime
+  version_requirements: *id002
 description: |+
   A low-level multi-Ruby wrapper around the ZooKeeper API bindings. For a
   friendlier interface, see http://github.com/slyphon/zk. Currently supported:
@@ -119,7 +135,8 @@ files:
 - spec/shared/all_success_return_values.rb
 - spec/shared/connection_examples.rb
 - spec/spec_helper.rb
-- spec/support/00_spawn_zookeeper.rb
+- spec/support/00_logging.rb
+- spec/support/10_spawn_zookeeper.rb
 - spec/support/progress_formatter.rb
 - spec/support/zookeeper_spec_helpers.rb
 - spec/zookeeper_spec.rb
@@ -171,7 +188,8 @@ test_files:
 - spec/shared/all_success_return_values.rb
 - spec/shared/connection_examples.rb
 - spec/spec_helper.rb
-- spec/support/00_spawn_zookeeper.rb
+- spec/support/00_logging.rb
+- spec/support/10_spawn_zookeeper.rb
 - spec/support/progress_formatter.rb
 - spec/support/zookeeper_spec_helpers.rb
 - spec/zookeeper_spec.rb