zookeeper 1.0.6 → 1.1.0

data/ext/zookeeper_base.rb

@@ -1,5 +1,3 @@
-# require File.expand_path('../c_zookeeper', __FILE__)
-
 require_relative 'c_zookeeper'
 require 'forwardable'
 
@@ -33,29 +31,8 @@ class ZookeeperBase
   ZOO_LOG_LEVEL_DEBUG  = 4
 
 
-  # this is unfortunately necessary to prevent a really horrendous race in
-  # shutdown, where some other thread calls close in the middle of a
-  # synchronous operation (thanks to the GIL-releasing wrappers, we now
-  # have this problem). so we need to make sure only one thread can be calling
-  # a synchronous operation at a time. 
-  #
-  # this might be solved by waiting for a condition where there are no "in flight"
-  # operations (thereby allowing multiple threads to make requests simultaneously),
-  # but this would represent quite a bit of added complexity, and questionable
-  # performance gains.
-  #
-  def self.synchronized_delegation(provider, *syms)
-    syms.each do |sym|
-      class_eval(<<-EOM, __FILE__, __LINE__+1)
-        def #{sym}(*a, &b)
-          @mutex.synchronize { #{provider}.#{sym}(*a, &b) }
-        end
-      EOM
-    end
-  end
-
-  synchronized_delegation :@czk, :get_children, :exists, :delete, :get, :set,
-    :set_acl, :get_acl, :client_id, :sync, :wait_until_connected
+  def_delegators :@czk, :get_children, :exists, :delete, :get, :set,
+    :set_acl, :get_acl, :client_id, :sync, :wait_until_connected, :pause, :resume
 
   # some state methods need to be more paranoid about locking to ensure the correct
   # state is returned
@@ -216,7 +193,8 @@ class ZookeeperBase
   def closed?
     @mutex.synchronize { !@czk or @czk.closed? } 
   end
- 
+
+
 protected
   # this is a hack: to provide consistency between the C and Java drivers when
   # using a chrooted connection, we wrap the callback in a block that will
@@ -224,6 +202,9 @@ protected
   # sequential call). This is the only place where we can hook *just* the C
   # version. The non-async manipulation is handled in ZookeeperBase#create.
   # 
+  # TODO: need to move the continuation setup into here, so that it can get 
+  #       added to the callback hash
+  # 
   def setup_completion(req_id, meth_name, call_opts)
     if (meth_name == :create) and cb = call_opts[:callback]
       call_opts[:callback] = lambda do |hash|

data/lib/zookeeper/client_methods.rb

@@ -98,7 +98,7 @@ module ClientMethods
   #
   # @note There is a discrepancy between the zkc and java versions. zkc takes
   #   a string_callback_t, java takes a VoidCallback. You should most likely use
-  #   the ZookeeperCallbacks::VoidCallback and not rely on the string value.
+  #   the Zookeeper::Callbacks::VoidCallback and not rely on the string value.
   #
   def sync(options = {})
     assert_open

data/lib/zookeeper/common.rb

@@ -143,14 +143,15 @@ protected
     # we want to rerun the callback at a later time when we eventually do have
     # a valid response.
     if hash[:type] == Zookeeper::Constants::ZOO_SESSION_EVENT
+      # XXX: setup_completion changed arity, is this setup_completion necessary anymore?
       is_completion ? setup_completion(hash[:req_id], callback_context) : setup_watcher(hash[:req_id], callback_context)
     end
+
     if callback_context
       callback = is_completion ? callback_context[:callback] : callback_context[:watcher]
 
       hash[:context] = callback_context[:context]
 
-      # TODO: Eventually enforce derivation from Zookeeper::Callback
       if callback.respond_to?(:call)
         callback.call(hash)
       else
@@ -164,7 +165,7 @@ protected
 
   def assert_supported_keys(args, supported)
     unless (args.keys - supported).empty?
-      raise Zookeeper::Exceptions::BadArguments,  # this heirarchy is kind of retarded
+      raise Zookeeper::Exceptions::BadArguments,
             "Supported arguments are: #{supported.inspect}, but arguments #{args.keys.inspect} were supplied instead"
     end
   end

data/lib/zookeeper/constants.rb

@@ -57,6 +57,7 @@ module Constants
   ZSESSIONMOVED             = -118
 
   ZKRB_GLOBAL_CB_REQ = -1
+  ZKRB_ASYNC_CONTN_ID = -2
 
   # @private
   CONNECTED_EVENT_VALUES = [Constants::ZKRB_GLOBAL_CB_REQ, 

data/lib/zookeeper/continuation.rb

@@ -0,0 +1,155 @@
+module Zookeeper
+  # @private
+  # sigh, slightly different than the userland callbacks, the continuation
+  # provides sync call semantics around an async api
+  class Continuation
+    include Constants
+    include Logger
+
+    # for keeping track of which continuations are pending, and which ones have
+    # been submitted and are awaiting a repsonse
+    class Registry < Struct.new(:pending, :in_flight)
+      extend Forwardable
+
+      def_delegators :@mutex, :lock, :unlock
+
+      def initialize
+        super([], {})
+        @mutex = Mutex.new
+      end
+
+      def synchronized
+        @mutex.lock
+        begin
+          yield self
+        ensure
+          @mutex.unlock
+        end
+      end
+
+      # does not lock the mutex, returns true if there are pending jobs
+      def pending?
+        !self.pending.empty?
+      end
+    end
+
+    # *sigh* what is the index in the *args array of the 'callback' param
+    CALLBACK_ARG_IDX = {
+      :get => 2,
+      :set => 3,
+      :exists => 2,
+      :create => 3,
+      :delete => 3,
+      :get_acl => 2,
+      :set_acl => 3,
+      :get_children => 2,
+    }
+    
+    # maps the method name to the async return hash keys it should use to
+    # deliver the results
+    METH_TO_ASYNC_RESULT_KEYS = {
+      :get          => [:rc, :data, :stat],
+      :set          => [:rc, :stat],
+      :exists       => [:rc, :stat],
+      :create       => [:rc, :string],
+      :delete       => [:rc],
+      :get_acl      => [:rc, :acl, :stat],
+      :set_acl      => [:rc],
+      :get_children => [:rc, :strings, :stat],
+    }
+
+    attr_accessor :meth, :block, :rval
+
+    def initialize(meth, *args)
+      @meth   = meth
+      @args   = args
+      @mutex  = Mutex.new
+      @cond   = ConditionVariable.new
+      @rval   = 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
+    def value
+      @mutex.lock
+      begin
+        @cond.wait(@mutex) until @rval
+
+        case @rval.length
+        when 1
+          return @rval.first
+        else
+          return @rval
+        end
+      ensure
+        @mutex.unlock
+      end
+    end
+
+    # receive the response from the server, set @rval, notify caller
+    def call(hash)
+      logger.debug { "continuation req_id #{req_id}, got hash: #{hash.inspect}" }
+      @rval = hash.values_at(*METH_TO_ASYNC_RESULT_KEYS.fetch(meth))
+      logger.debug { "delivering result #{@rval.inspect}" }
+      deliver!
+    end
+
+    def user_callback?
+      !!@args.at(callback_arg_idx)
+    end
+
+    # this method is called by the event thread to submit the request
+    # passed the CZookeeper instance, makes the async call and deals with the results
+    #
+    # BTW: in case you were wondering this is a completely stupid
+    # implementation, but it's more important to get *something* working and
+    # passing specs, then refactor to make everything sane
+    # 
+    def submit(czk)
+      rc, *_ = czk.__send__(:"zkrb_#{@meth}", *async_args)
+      
+      if user_callback? or (rc != ZOK)      # if this is an async call, or we failed to submit it
+        @rval = [rc]                        # create the repsonse
+        deliver!                            # wake the caller and we're out
+      end
+    end
+
+    def req_id
+      @args.first
+    end
+
+    protected
+
+      # an args array with the only difference being that if there's a user
+      # callback provided, we don't handle delivering the end result
+      def async_args
+        ary = @args.dup
+
+        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
+      end
+
+      def callback_arg_idx
+        CALLBACK_ARG_IDX.fetch(meth) { raise ArgumentError, "unknown method #{meth.inspect}" } 
+      end
+
+      def deliver!
+        @mutex.lock
+        begin
+          @cond.signal
+        ensure
+          @mutex.unlock
+        end
+      end
+  end # Base
+end
+

data/lib/zookeeper/exceptions.rb

@@ -77,6 +77,13 @@ stacktrace:
   class ShuttingDownException   < ZookeeperException; end
   class DataTooLargeException   < ZookeeperException; end
 
+  # raised when an operation is performed on an instance without a valid
+  # zookeeper handle. (C version)
+  class HandleClosedException < ZookeeperException; end
+
+  # maybe use this for continuation
+  class InterruptedException  < ZookeeperException ; end
+
   # raised when the user tries to use a connection after a fork()
   # without calling reopen() in the C client
   #

data/lib/zookeeper/logger.rb

@@ -14,6 +14,13 @@ module Zookeeper
     end
 
     private
+      def log_realtime(what)
+        logger.debug do
+          t = Benchmark.realtime { yield }
+          "#{what} took #{t} sec"
+        end
+      end
+
       def logger
         ::Zookeeper.logger
       end

data/lib/zookeeper/monitor.rb

@@ -0,0 +1,19 @@
+module Zookeeper
+  # just like stdlib Monitor but provides the SAME API AS MUTEX, FFS!
+  class Monitor
+    include MonitorMixin
+
+    alias try_enter try_mon_enter
+    alias enter mon_enter
+    alias exit mon_exit
+
+    # here, HERE!
+    # *here* are the methods that are the same
+    # god *dammit*
+
+    alias lock mon_enter
+    alias unlock mon_exit
+    alias try_lock try_mon_enter
+  end
+end
+

data/lib/zookeeper/version.rb

@@ -1,4 +1,4 @@
 module Zookeeper
-  VERSION = '1.0.6'
+  VERSION = '1.1.0'
   DRIVER_VERSION = '3.3.5'
 end

data/lib/zookeeper.rb

@@ -4,6 +4,7 @@ require 'thread'
 require 'monitor'
 require 'forwardable'
 require 'logger'
+require 'benchmark'
 
 module Zookeeper
   # establishes the namespace
@@ -13,12 +14,14 @@ require File.expand_path('../zookeeper/core_ext', __FILE__)
 
 require 'backports' if RUBY_VERSION =~ /\A1\.8\./
 
+require_relative 'zookeeper/monitor'
 require_relative 'zookeeper/logger'
 require_relative 'zookeeper/forked'
 require_relative 'zookeeper/latch'
 require_relative 'zookeeper/acls'
 require_relative 'zookeeper/constants'
 require_relative 'zookeeper/exceptions'
+require_relative 'zookeeper/continuation'
 require_relative 'zookeeper/common'
 require_relative 'zookeeper/callbacks'
 require_relative 'zookeeper/stat'

data/spec/forked_connection_spec.rb

@@ -15,6 +15,7 @@ unless defined?(::JRUBY_VERSION)
     end
 
     before do
+
       if defined?(::Rubinius)
         pending("this test is currently broken in rbx")
 #       elsif ENV['TRAVIS']
@@ -23,9 +24,11 @@ unless defined?(::JRUBY_VERSION)
         @zk = Zookeeper.new(connection_string)
         rm_rf(@zk, path)
       end
+      logger.debug { "----------------< BEFORE: END >-------------------" }
     end
 
     after do
+      logger.debug { "----------------< AFTER: BEGIN >-------------------" }
       if @pid and process_alive?(@pid)
         begin
           Process.kill('KILL', @pid)
@@ -53,6 +56,7 @@ unless defined?(::JRUBY_VERSION)
     end
 
     it %[should do the right thing and not fail] do
+      logger.debug { "----------------< TEST: BEGIN >-------------------" }
       @zk.wait_until_connected
 
       mkdir_p(@zk, pids_root)
@@ -73,20 +77,24 @@ unless defined?(::JRUBY_VERSION)
 
       logger.debug { "------------------->   FORK   <---------------------------" }
 
+      @zk.pause
+
       @pid = fork do
         logger.debug { "reopening connection in child: #{$$}" }
         @zk.reopen
         logger.debug { "creating path" }
         rv = @zk.create(:path => "#{pids_root}/child", :data => $$.to_s)
-        logger.debug { "created path #{rv}" }
+        logger.debug { "created path #{rv[:path]}" }
         @zk.close
 
         logger.debug { "close finished" }
         exit!(0)
       end
 
+      @zk.resume
+
       event_waiter_th = Thread.new do
-        @latch.await(10) unless @event 
+        @latch.await(5) unless @event 
         @event
       end
 
@@ -99,8 +107,7 @@ unless defined?(::JRUBY_VERSION)
       status.should be_success
 
       event_waiter_th.join(5).should == event_waiter_th
-      @event.should_not be nil
+      @event.should_not be_nil
     end
   end
 end
-

data/spec/shared/connection_examples.rb

@@ -21,7 +21,7 @@ shared_examples_for "connection" do
   # unfortunately, we can't test w/o exercising other parts of the driver, so
   # if "set" is broken, this test will fail as well (but whaddyagonnado?)
   describe :get do
-    describe :sync do
+    describe :sync, :sync => true do
       it_should_behave_like "all success return values"
 
       before do
@@ -38,7 +38,7 @@ shared_examples_for "connection" do
       end
     end
 
-    describe :sync_watch do
+    describe :sync_watch, :sync => true do
       it_should_behave_like "all success return values"
 
       before do
@@ -65,7 +65,7 @@ shared_examples_for "connection" do
       end
     end
 
-    describe :async do
+    describe :async, :async => true do
       before do
         @cb = Zookeeper::Callbacks::DataCallback.new
 
@@ -90,16 +90,18 @@ shared_examples_for "connection" do
       end
     end
 
-    describe :async_watch do
+    describe :async_watch, :async => true, :method => :get, :watch => true do
       it_should_behave_like "all success return values"
 
       before do
+        logger.debug { "-----------------> MAKING ASYNC GET REQUEST WITH WATCH <--------------------" }
         @cb = Zookeeper::Callbacks::DataCallback.new
         @watcher = Zookeeper::Callbacks::WatcherCallback.new
 
         @rv = zk.get(:path => path, :callback => @cb, :callback_context => path, :watcher => @watcher, :watcher_context => path)
         wait_until(1.0) { @cb.completed? }
         @cb.should be_completed
+        logger.debug { "-----------------> ASYNC GET REQUEST WITH WATCH COMPLETE <--------------------" }
       end
 
       it %[should have the stat object in the callback] do
@@ -140,7 +142,7 @@ shared_examples_for "connection" do
       @stat = zk.stat(:path => path)[:stat]
     end
 
-    describe :sync do
+    describe :sync, :sync => true do
       describe 'without version' do
         it_should_behave_like "all success return values"
 
@@ -195,7 +197,7 @@ shared_examples_for "connection" do
       end
     end   # sync
 
-    describe :async do
+    describe :async, :async => true do
       before do
         @cb = Zookeeper::Callbacks::StatCallback.new
       end
@@ -286,7 +288,7 @@ shared_examples_for "connection" do
       end
     end
 
-    describe :sync do
+    describe :sync, :sync => true do
       it_should_behave_like "all success return values"
 
       before do
@@ -308,7 +310,7 @@ shared_examples_for "connection" do
       end
     end
 
-    describe :sync_watch do
+    describe :sync_watch, :sync => true do
       it_should_behave_like "all success return values"
 
       before do
@@ -349,7 +351,7 @@ shared_examples_for "connection" do
       end
     end
 
-    describe :async do
+    describe :async, :async => true do
       it_should_behave_like "all success return values"
 
       before do
@@ -377,7 +379,7 @@ shared_examples_for "connection" do
       end
     end
 
-    describe :async_watch do
+    describe :async_watch, :async => true do
       it_should_behave_like "all success return values"
 
       before do
@@ -429,7 +431,7 @@ shared_examples_for "connection" do
   # NOTE: the jruby version of stat on non-existent node will have a
   # return_code of 0, but the C version will have a return_code of -101
   describe :stat do
-    describe :sync do
+    describe :sync, :sync => true do
       it_should_behave_like "all success return values"
 
       before do
@@ -441,7 +443,7 @@ shared_examples_for "connection" do
       end
     end
 
-    describe :sync_watch do
+    describe :sync_watch, :sync => true do
       it_should_behave_like "all success return values"
 
       before do
@@ -468,7 +470,7 @@ shared_examples_for "connection" do
       end
     end
 
-    describe :async do
+    describe :async, :async => true do
       it_should_behave_like "all success return values"
 
       before do
@@ -488,7 +490,7 @@ shared_examples_for "connection" do
       end
     end
 
-    describe :async_watch do
+    describe :async_watch, :async => true do
       it_should_behave_like "all success return values"
 
       before do
@@ -536,7 +538,7 @@ shared_examples_for "connection" do
       zk.delete(:path => path)
     end
 
-    describe :sync do
+    describe :sync, :sync => true do
       describe 'error' do
         it %[should barf if the data size is too large], :input_size => true do
           large_data = '0' * (1024 ** 2)
@@ -640,7 +642,7 @@ shared_examples_for "connection" do
       end
     end
 
-    describe :async do
+    describe :async, :async => true do
       before do
         @cb = Zookeeper::Callbacks::StringCallback.new
       end
@@ -775,7 +777,7 @@ shared_examples_for "connection" do
   end # create
 
   describe :delete do
-    describe :sync do
+    describe :sync, :sync => true do
       describe 'without version' do
         it_should_behave_like "all success return values"
 
@@ -819,7 +821,7 @@ shared_examples_for "connection" do
       end
     end # sync
 
-    describe :async do
+    describe :async, :async => true do
       before do
         @cb = Zookeeper::Callbacks::VoidCallback.new
       end
@@ -878,7 +880,7 @@ shared_examples_for "connection" do
   end # delete
 
   describe :get_acl do
-    describe :sync do
+    describe :sync, :sync => true do
       it_should_behave_like "all success return values"
 
       before do
@@ -902,7 +904,7 @@ shared_examples_for "connection" do
       end
     end
 
-    describe :async do
+    describe :async, :async => true do
       it_should_behave_like "all success return values"
 
       before do
@@ -939,7 +941,7 @@ shared_examples_for "connection" do
       pending("No idea how to set ACLs")
     end
 
-    describe :sync do
+    describe :sync, :sync => true do
       it_should_behave_like "all success return values"
 
       before do
@@ -960,7 +962,7 @@ shared_examples_for "connection" do
     end
   end
 
-  describe :sync do
+  describe :sync, :sync => true do
     describe :success do
       it_should_behave_like "all success return values"