zookeeper 1.2.13 → 1.2.14

data/.gitignore

@@ -11,3 +11,7 @@ tmp/
 .rvmrc
 .zkserver
 coverage
+
+*.swp
+*.swo
+

data/CHANGELOG

@@ -1,3 +1,11 @@
+v1.2.14 merge add_auth pull request, reduce chances for ContinuationTimeoutError
+
+  * added support for the add_auth call (h/t: @bradhe) see pull req #25
+
+  * fix a corner case where some pending Continuations may get stuck without
+    being shutdown when the event thread exits. This would lead to a 
+    ContinuationTimeoutError being raised after 30s as a failsafe. 
+
 v1.2.13 fix build under rbenv
 
   * h/t to Eric Lindvall for fixing #22 in http://git.io/PEPgnA

data/Gemfile

@@ -4,10 +4,6 @@ gemspec
 
 gem 'rake', '~> 0.9.0'
 
-platform :mri_19 do
-  gem 'simplecov', :group => :coverage, :require => false
-end
-
 group :test do
   gem "rspec", "~> 2.8.0"
   gem 'eventmachine', '1.0.0.beta.4'
@@ -16,22 +12,20 @@ group :test do
   gem 'zk-server', '~> 1.0.0'
 end
 
-platform :mri_19 do
-  gem 'simplecov', :group => :coverage, :require => false
-end
+# ffs, :platform appears to be COMLETELY BROKEN so we just DO THAT HERE
+# ...BY HAND
 
-group :docs do
-  platform :mri_19 do
-    gem 'yard', '~> 0.8.0'
-    gem 'redcarpet'
+if RUBY_VERSION != '1.8.7' && !defined?(JRUBY_VERSION)
+  gem 'simplecov', :group => :coverage, :require => false
+  gem 'yard', '~> 0.8.0', :group => :docs
+  gem 'redcarpet',        :group => :docs
+
+  group :development do
+    gem 'pry'
+    gem 'guard',        :require => false
+    gem 'guard-rspec',  :require => false
+    gem 'guard-shell',  :require => false
   end
 end
 
-group :development do
-  gem 'pry'
-  gem 'guard',        :require => false
-  gem 'guard-rspec',  :require => false
-  gem 'guard-shell',  :require => false
-end
-
 # vim:ft=ruby

data/README.markdown

@@ -44,6 +44,10 @@ If you run into problems with installing this gem (specifically with linking ex.
 
 [ruby-build]: https://github.com/sstephenson/ruby-build
 
+### A note for REE users
+
+The zookeeper client is required to send a heartbeat packet every N seconds to the server. If it misses its deadline 3 times in a row, the session will be lost. The way the client is implemented in versions `>= 1.2`, a *ruby* thread acts as the event thread (this was necessary to provide a fork-safe client with a parent process that is able to preserve state). Some users have reported issues where under load in "massive codebases," they have problems where calls will time out. Given the nature of the thread scheduler in 1.8, one should be careful if upgrading from `0.4.4` to `>= 1.2`.
+
 ## Usage
 
 Connect to a server:

data/ext/c_zookeeper.rb

@@ -34,7 +34,7 @@ class CZookeeper
   end
 
   # wrap these calls in our sync->async special sauce
-  %w[get set exists create delete get_acl set_acl get_children].each do |sym|
+  %w[get set exists create delete get_acl set_acl get_children add_auth].each do |sym|
     class_eval(<<-EOS, __FILE__, __LINE__+1)
       def #{sym}(*args)
         submit_and_block(:#{sym}, *args)
@@ -278,17 +278,15 @@ class CZookeeper
         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
+      # 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" }
+      logger.debug { "there are #{remaining.length} completions to awaken" }
 
-        @reg.in_flight.clear
+      @reg.in_flight.clear
 
-        while cb = remaining.shift
-          cb.shutdown!
-        end
+      while cb = remaining.shift
+        cb.shutdown!
       end
     rescue ShuttingDownException
       logger.error { "event thread saw @_shutting_down, bailing without entering loop" }

data/ext/zkrb.c

@@ -25,7 +25,7 @@
  * provide a fork-safe library when you have native threads you don't own
  * running around. If you fork when a thread holds a mutex, and that thread
  * is not the fork-caller, that mutex can never be unlocked, and is therefore
- * a ticking time-bomb in the child. The only way to guarantee safety is to 
+ * a ticking time-bomb in the child. The only way to guarantee safety is to
  * either replace all of your mutexes and conditions and such after a fork
  * (which is what we do on the ruby side), or avoid the problem altogether
  * and not use a multithreaded library on the backend. Since we can't replace
@@ -42,11 +42,11 @@
  * open socket it's got before calling zookeeper_close. This prevents
  * corruption of the client/server state. Without this code, zookeeper_close
  * in the child would actually send an "Ok, we're closing" message with the
- * parent's session id, causing the parent to hit an assert() case in 
+ * parent's session id, causing the parent to hit an assert() case in
  * zookeeper_process, and cause a SIGABRT. With this code in place, we get back
  * a ZCONNECTIONLOSS from zookeeper_close in the child (which we ignore), and
  * the parent continues on.
- * 
+ *
  * You will notice below we undef 'THREADED', which would be set if we were
  * using the 'mt' library. We also conditionally include additional cases
  * ('SYNC', 'SYNC_WATCH') inside of some of the methods defined here. These
@@ -138,7 +138,7 @@ inline static void assert_valid_params(VALUE reqid, VALUE path) {
     case T_BIGNUM:
       break;
     default:
-      rb_raise(rb_eTypeError, "reqid must be Fixnum/Bignum");  
+      rb_raise(rb_eTypeError, "reqid must be Fixnum/Bignum");
   }
 
   Check_Type(path, T_STRING);
@@ -212,7 +212,7 @@ static int destroy_zkrb_instance(zkrb_instance_data_t* zk) {
 
     rv = zookeeper_close(zk->zh);
 
-    zkrb_debug("obj_id: %lx, zookeeper_close returned %d, calling context: %p", zk->object_id, rv, ctx); 
+    zkrb_debug("obj_id: %lx, zookeeper_close returned %d, calling context: %p", zk->object_id, rv, ctx);
     zkrb_calling_context_free((zkrb_calling_context *) ctx);
   }
 
@@ -415,6 +415,19 @@ static VALUE method_sync(VALUE self, VALUE reqid, VALUE path) {
   return INT2FIX(rc);
 }
 
+static VALUE method_add_auth(VALUE self, VALUE reqid, VALUE scheme, VALUE cert) {
+  int rc = ZOK;
+
+  Check_Type(scheme, T_STRING);
+  Check_Type(cert, T_STRING);
+
+  FETCH_DATA_PTR(self, zk);
+
+  rc = zkrb_call_zoo_add_auth(zk->zh, RSTRING_PTR(scheme), RSTRING_PTR(cert), RSTRING_LEN(cert), zkrb_void_callback, CTX_ALLOC(zk, reqid));
+
+  return INT2FIX(rc);
+}
+
 
 static VALUE method_create(VALUE self, VALUE reqid, VALUE path, VALUE data, VALUE async, VALUE acls, VALUE flags) {
   STANDARD_PREAMBLE(self, zk, reqid, path, async, Qfalse, call_type);
@@ -500,7 +513,7 @@ static VALUE method_get(VALUE self, VALUE reqid, VALUE path, VALUE async, VALUE
   int data_len = MAX_ZNODE_SIZE;
   struct Stat stat;
 
-  char * data = NULL; 
+  char * data = NULL;
   if (IS_SYNC(call_type)) {
     data = malloc(MAX_ZNODE_SIZE); /* ugh */
     memset(data, 0, sizeof(data));
@@ -533,7 +546,7 @@ static VALUE method_get(VALUE self, VALUE reqid, VALUE path, VALUE async, VALUE
 
     default:
       invalid_call_type=1;
-      goto cleanup;    
+      goto cleanup;
       break;
   }
 
@@ -598,7 +611,7 @@ static VALUE method_set_acl(VALUE self, VALUE reqid, VALUE path, VALUE acls, VAL
 
   int rc=ZOK, invalid_call_type=0;
   switch (call_type) {
-    
+
 #ifdef THREADED
     case SYNC:
       rc = zkrb_call_zoo_set_acl(zk->zh, RSTRING_PTR(path), FIX2INT(version), aclptr);
@@ -662,7 +675,7 @@ static VALUE method_get_acl(VALUE self, VALUE reqid, VALUE path, VALUE async) {
 #define is_shutting_down(self) RTEST(rb_iv_get(self, "@_shutting_down"))
 
 static VALUE method_zkrb_get_next_event(VALUE self, VALUE blocking) {
-  // dbg.h 
+  // dbg.h
   check_debug(!is_closed(self), "we are closed, not trying to get event");
 
   char buf[64];
@@ -672,12 +685,12 @@ static VALUE method_zkrb_get_next_event(VALUE self, VALUE blocking) {
     check_debug(!is_closed(self), "we're closed in the middle of method_zkrb_get_next_event, bailing");
 
     zkrb_event_t *event = zkrb_dequeue(zk->queue, 1);
-    
+
     if (event == NULL) {
-      if (NIL_P(blocking) || (blocking == Qfalse)) { 
+      if (NIL_P(blocking) || (blocking == Qfalse)) {
         goto error;
-      } 
-      else { 
+      }
+      else {
         // if we're shutting down, don't enter this section, we don't want to block
         check_debug(!is_shutting_down(self), "method_zkrb_get_next_event, we're shutting down, don't enter blocking section");
 
@@ -706,7 +719,7 @@ static VALUE method_zkrb_get_next_event(VALUE self, VALUE blocking) {
     return hash;
   }
 
-  error: 
+  error:
     return Qnil;
 }
 
@@ -763,7 +776,7 @@ static VALUE method_zkrb_iterate_event_loop(VALUE self) {
   FETCH_DATA_PTR(self, zk);
 
   fd_set rfds, wfds, efds;
-  FD_ZERO(&rfds); FD_ZERO(&wfds); FD_ZERO(&efds); 
+  FD_ZERO(&rfds); FD_ZERO(&wfds); FD_ZERO(&efds);
 
   int fd=0, interest=0, events=0, rc=0, maxfd=0;
   struct timeval tv;
@@ -797,7 +810,7 @@ static VALUE method_zkrb_iterate_event_loop(VALUE self) {
   if (rc > 0) {
     if (FD_ISSET(fd, &rfds)) {
       events |= ZOOKEEPER_READ;
-    } 
+    }
     if (FD_ISSET(fd, &wfds)) {
       events |= ZOOKEEPER_WRITE;
     }
@@ -845,7 +858,7 @@ static VALUE method_close_handle(VALUE self) {
     zkrb_debug_inst(self, "CLOSING_ZK_INSTANCE");
     print_zkrb_instance_data(zk);
   }
-  
+
   // this is a value on the ruby side we can check to see if destroy_zkrb_instance
   // has been called
   rb_iv_set(self, "@_closed", Qtrue);
@@ -927,6 +940,7 @@ static void zkrb_define_methods(void) {
   rb_define_method(CZookeeper, "zkrb_set",          method_set,           5);
   rb_define_method(CZookeeper, "zkrb_set_acl",      method_set_acl,       5);
   rb_define_method(CZookeeper, "zkrb_get_acl",      method_get_acl,       3);
+  rb_define_method(CZookeeper, "zkrb_add_auth",     method_add_auth,      3);
 
   rb_define_singleton_method(CZookeeper, "zoo_set_log_level", method_zoo_set_log_level, 1);
 
@@ -940,9 +954,6 @@ static void zkrb_define_methods(void) {
   DEFINE_METHOD(zkrb_iterate_event_loop, 0);
   DEFINE_METHOD(zkrb_get_next_event_st, 0);
 
-  // TODO
-  // DEFINE_METHOD(add_auth, 3);
-
   // methods for the ruby-side event manager
   DEFINE_METHOD(zkrb_get_next_event, 1);
   DEFINE_METHOD(zkrb_get_next_event_st, 0);

data/ext/zookeeper_base.rb

@@ -33,7 +33,7 @@ class ZookeeperBase
 
 
   def_delegators :czk, :get_children, :exists, :delete, :get, :set,
-    :set_acl, :get_acl, :client_id, :sync, :wait_until_connected
+    :set_acl, :get_acl, :client_id, :sync, :add_auth, :wait_until_connected
 
   def self.threadsafe_inquisitor(*syms)
     syms.each do |sym|

data/java/java_base.rb

@@ -321,6 +321,13 @@ class JavaBase
     end
   end
 
+  def add_auth(req_id, scheme, cert)
+    handle_keeper_exception do
+      jzk.addAuthInfo(scheme, cert.to_java_bytes)
+      Code::Ok
+    end
+  end
+
   def create(req_id, path, data, callback, acl, flags)
     handle_keeper_exception do
       acl   = Array(acl).map{ |a| JZKD::ACL.from_ruby_acl(a) }

data/lib/zookeeper/client_methods.rb

@@ -13,6 +13,17 @@ module ClientMethods
     super
   end
 
+  def add_auth(options = {})
+    assert_open
+    assert_supported_keys(options, [:scheme, :cert])
+    assert_required_keys(options, [:scheme, :cert])
+
+    req_id = setup_call(:add_auth, options)
+    rc = super(req_id, options[:scheme], options[:cert])
+
+    { :req_id => req_id, :rc => rc }
+  end
+
   def get(options = {})
     assert_open
     assert_supported_keys(options, [:path, :watcher, :watcher_context, :callback, :callback_context])

data/lib/zookeeper/continuation.rb

@@ -61,8 +61,9 @@ module Zookeeper
       :set_acl => 3,
       :get_children => 2,
       :state => 0,
+      :add_auth => 2
     }
-    
+
     # maps the method name to the async return hash keys it should use to
     # deliver the results
     METH_TO_ASYNC_RESULT_KEYS = {
@@ -74,6 +75,7 @@ module Zookeeper
       :get_acl      => [:rc, :acl, :stat],
       :set_acl      => [:rc],
       :get_children => [:rc, :strings, :stat],
+      :add_auth     => [:rc]
     }
 
     attr_accessor :meth, :block, :rval

data/lib/zookeeper/version.rb

@@ -1,4 +1,4 @@
 module Zookeeper
-  VERSION = '1.2.13'
+  VERSION = '1.2.14'
   DRIVER_VERSION = '3.3.5'
 end

data/spec/shared/connection_examples.rb

@@ -273,6 +273,19 @@ shared_examples_for "connection" do
     end # async
   end # set
 
+  describe :add_auth do
+    it %[should return ZOK if everything goes swimingly] do
+      result = zk.add_auth(:scheme => 'digest', :cert => 'test_user:test_password')
+
+      rv = result[:rc]
+
+      # gahhh, this shouldn't be like this.... :P
+      rv = rv.respond_to?(:intValue) ? rv.intValue : rv
+
+      rv.should == Zookeeper::ZOK
+    end
+  end
+
   describe :get_children do
     before do
       @children = %w[child0 child1 child2]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: zookeeper
 version: !ruby/object:Gem::Version 
-  hash: 5
+  hash: 3
   prerelease: 
   segments: 
   - 1
   - 2
-  - 13
-  version: 1.2.13
+  - 14
+  version: 1.2.14
 platform: ruby
 authors: 
 - Phillip Pearson
@@ -20,7 +20,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-08-08 00:00:00 Z
+date: 2012-08-15 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: logging