slyphon-zookeeper 0.9.2 → 0.9.3

data/CHANGELOG

@@ -1,3 +1,12 @@
+v0.9.3 Event thread shutdown fix, Windows compatibility fix
+
+  * Use a 'shutdown thread' to coordinate cleanup if close is called from the
+    event thread (prevents deadlock)
+
+  * Default Logger now uses $stderr instead of opening /dev/null [#16]
+
+  * Gemfile/gemspec/Rakefile refactoring.
+
 v0.9.2 More efficient and simpler wrappers for GIL release
 
   * After a code review by Andrew Wason (rectalogic), use a much simpler

data/Gemfile

@@ -2,9 +2,16 @@ source :rubygems
 
 gemspec
 
-platforms :mri_18 do
-  gem 'ruby-debug'
+group :test do
+  gem "rspec", "~> 2.8.0"
+  gem 'flexmock', '~> 0.8.11'
+  gem 'eventmachine', '1.0.0.beta.4'
+  gem 'evented-spec', '~> 0.9.0'
 end
 
+group :development do
+  gem 'rake', '~> 0.9.0'
+  gem 'pry'
+end
 
 # vim:ft=ruby

data/README.markdown

@@ -1,21 +1,22 @@
-zookeeper
+# zookeeper #
 
-An interface to the Zookeeper distributed configuration server.
+An interface to the Zookeeper cluster coordination server.
 
-For a higher-level interface with a slightly more convenient API and features
-such as locks, have a look at [ZK](https://github.com/slyphon/zk) (also
-available is [ZK-EventMachine](https://github.com/slyphon/zk-eventmachine) for
-those who prefer async).
+For a higher-level interface with a more convenient API and features such as locks, have a look at [ZK](https://github.com/slyphon/zk) (also available is [ZK-EventMachine](https://github.com/slyphon/zk-eventmachine) for those who prefer async).
 
-Unfortunately, since this is a fork of twitter/zookeeper, we don't have our own
-Issues tracker. Issues should be filed under [ZK](https://github.com/slyphon/zk/issues).
+## Big Plans for 1.0 ##
+
+The 1.0 release will feature a reorganization of the heirarchy. There will be a single top-level `Zookeeper` namespace (as opposed to the current layout, with 5-6 different top-level constants), and for the next several releases, there will be a backwards compatible require for users that still need to use the old names.
 
 ## License
 
-Copyright 2008 Phillip Pearson, and 2010 Twitter, Inc. Licensed under the
-MIT License.  See the included LICENSE file.  Portions copyright 2008-2010
-the Apache Software Foundation, licensed under the Apache 2 license, and
-used with permission.
+Copyright 2008 Phillip Pearson, and 2010 Twitter, Inc. 
+Licensed under the MIT License.  See the included LICENSE file.  
+
+Portions copyright 2008-2010 the Apache Software Foundation, licensed under the
+Apache 2 license, and used with permission.
+
+Portions contributed to the open source community by HPDC, L.P.
 
 ## Install
 
@@ -42,10 +43,17 @@ The following methods are initially supported:
 * get\_acl
 * set\_acl
 
-All support async callbacks.  get, get\_children and stat support both
-watchers and callbacks.
+All support async callbacks.  get, get\_children and stat support both watchers and callbacks.
+
+Calls take a dictionary of parameters.  With the exception of set\_acl, the only required parameter is :path.  Each call returns a dictionary with at minimum two keys :req\_id and :rc.
+
+### A Bit about this repository ###
+
+Twitter's open source office was kind enough to transfer this repository to facilitate development and administration of this repository. The `zookeeper` gem's last three releases were recorded in branches `v0.4.2`, `v0.4.3` and `v0.4.4`. Releases of the `slyphon-zookeeper` gem were cut off of the fork, and unfortunately (due to an oversight on my part) were tagged with unrelated versions. Those were tagged with names `release/0.9.2`. 
+
+The plan is to keep the `slyphon-zookeeper` tags, and to tag the `zookeeper` releases `twitter/release/0.4.x`.
+
+Further work will be carried out on this repository. The `0.9.3` release of the zookeeper gem will be released under the 'zookeeper' name, and will bring the two divergent (conceptual) branches of development together.
+
 
-Calls take a dictionary of parameters.  With the exception of set\_acl, the
-only required parameter is :path.  Each call returns a dictionary with at
-minimum two keys :req\_id and :rc.
 

data/Rakefile

@@ -2,17 +2,19 @@
 #   ENV.fetch('GEM_HOME').split('@').last
 # end
 
-GEM_FILES = FileList['slyphon-zookeeper-*.gem']
+GEM_FILES = FileList['*zookeeper-*.gem']
 
 namespace :mb do
   namespace :gems do
     task :build do
-      sh "rvm 1.8.7 do gem build slyphon-zookeeper.gemspec"
+      sh "rvm 1.8.7 do gem build zookeeper.gemspec"
       ENV['JAVA_GEM'] = '1'
-      sh "rvm 1.8.7 do gem build slyphon-zookeeper.gemspec"
+      sh "rvm 1.8.7 do gem build zookeeper.gemspec"
     end
 
-    task :push do
+    task :push => :build do
+      raise "No gemfiles to push!" if GEM_FILES.empty?
+
       GEM_FILES.each do |gem|
         sh "gem push #{gem}"
       end
@@ -28,16 +30,8 @@ end
 
 gemset_name = 'zookeeper'
 
-directory 'tmp'
-
 # this nonsense w/ tmp and the Gemfile is a bundler optimization
 
-GEMSPEC_LINK = 'tmp/slyphon-zookeeper.gemspec'
-
-file GEMSPEC_LINK => 'tmp' do
-  ln_s '../slyphon-zookeeper.gemspec', GEMSPEC_LINK
-end
-
 %w[1.8.7 1.9.2 jruby rbx 1.9.3].each do |ns_name|
   rvm_ruby = (ns_name == 'rbx') ? "rbx-2.0.testing" : ns_name
 
@@ -50,11 +44,16 @@ end
   bundle_task_name    = "mb:#{ns_name}:bundle_install"
   rspec_task_name     = "mb:#{ns_name}:run_rspec"
 
-  phony_gemfile_link_name = File.expand_path("tmp/Gemfile.#{ns_name}")
+  phony_gemfile_link_name = "Gemfile.#{ns_name}"
+  phony_gemfile_lock_name = "#{phony_gemfile_link_name}.lock"
 
-  file phony_gemfile_link_name => GEMSPEC_LINK do
+  file phony_gemfile_link_name do
     # apparently, rake doesn't deal with symlinks intelligently :P
-    ln_s('../Gemfile', phony_gemfile_link_name) unless File.exists?(phony_gemfile_link_name)
+    ln_s('Gemfile', phony_gemfile_link_name) unless File.symlink?(phony_gemfile_link_name)
+  end
+
+  task :clean do
+    rm_rf [phony_gemfile_lock_name, phony_gemfile_lock_name]
   end
 
   task create_gemset_name do
@@ -95,12 +94,21 @@ end
 
   task "mb:#{ns_name}" => rspec_task_name
 
-  task "mb:test_all" => rspec_task_name
+  task "mb:test_all_rubies" => rspec_task_name
+end
+
+task "mb:test_all" do
+  require 'benchmark'
+  t = Benchmark.realtime do
+    Rake::Task['mb:test_all_rubies'].invoke
+  end
+
+  $stderr.puts "Test run took: #{t} s"
 end
 
 task :default => 'mb:1.9.3'
 
-task :clean do
+task :clobber do
   rm_rf 'tmp'
 end
 

data/ext/extconf.rb

@@ -50,7 +50,7 @@ end
 
 Dir.chdir(HERE) do
   if File.exist?("lib")
-    puts "Zkc already built; run 'rake clean' first if you need to rebuild."
+    puts "Zkc already built; run 'rake clobber' in ext/ first if you need to rebuild."
   else
     puts "Building zkc."
 

data/ext/zookeeper_base.rb

@@ -104,10 +104,14 @@ class ZookeeperBase
   end
 
   def close
-    @mutex.synchronize do
-      stop_dispatch_thread!
-      @czk.close
+    shutdown_thread = Thread.new do
+      @mutex.synchronize do
+        stop_dispatch_thread!
+        @czk.close
+      end
     end
+
+    shutdown_thread.join unless event_dispatch_thread?
   end
 
   # the C lib doesn't strip the chroot path off of returned path values, which

data/java/zookeeper_base.rb

@@ -222,14 +222,19 @@ class ZookeeperBase
   end
 
   def close
-    @mutex.synchronize do
-      return if @_closed
-      @_closed = true    # these are probably unnecessary
-      @_running = false
-
-      stop_dispatch_thread!
-      @jzk.close if @jzk
+    shutdown_thread = Thread.new do
+      @mutex.synchronize do
+        unless @_closed
+          @_closed = true    # these are probably unnecessary
+          @_running = false
+
+          stop_dispatch_thread!
+          @jzk.close if @jzk
+        end
+      end
     end
+
+    shutdown_thread.join unless event_dispatch_thread?
   end
 
   def state

data/lib/zookeeper.rb

@@ -23,7 +23,7 @@ require 'zookeeper_base'
 
 class Zookeeper < ZookeeperBase
   unless defined?(@@logger)
-    @@logger = Logger.new('/dev/null').tap { |l| l.level = Logger::FATAL } # UNIX: FOR GREAT JUSTICE !!
+    @@logger = Logger.new($stderr).tap { |l| l.level = Logger::ERROR } 
   end
 
   def self.logger

data/lib/zookeeper/common.rb

@@ -90,9 +90,15 @@ protected
 
         # we now release the mutex so that dispatch_next_callback can grab it
         # to do what it needs to do while delivering events
-        @dispatch_shutdown_cond.wait
-
-        @dispatcher.join
+        #
+        # wait for a maximum of 2 sec for dispatcher to signal exit (should be
+        # fast)
+        @dispatch_shutdown_cond.wait(2)
+
+        # wait for another 2 sec for the thread to join
+        unless @dispatcher.join(2)
+          logger.error { "Dispatch thread did not join cleanly, continuing" }
+        end
         @dispatcher = nil
       end
     end

data/lib/zookeeper/version.rb

@@ -0,0 +1,6 @@
+# this "namespacing" is retarded. fix this in 1.0
+# @private
+module ZookeeperVersion
+  VERSION = '0.9.3'
+  DRIVER_VERSION = '3.3.5'
+end

data/spec/chrooted_connection_spec.rb

@@ -16,52 +16,10 @@ describe 'Zookeeper chrooted' do
     @zk and @zk.close
   end
 
-
   def zk
     @zk
   end
 
-  def with_open_zk(host='localhost:2181')
-    z = Zookeeper.new(host)
-    yield z
-  ensure
-    if z
-      z.close
-
-      wait_until do 
-        begin
-          !z.connected?
-        rescue RuntimeError
-          true
-        end
-      end
-    end
-  end
-
-  # this is not as safe as the one in ZK, just to be used to clean up
-  # when we're the only one adjusting a particular path
-  def rm_rf(z, path)
-    z.get_children(:path => path).tap do |h|
-      if h[:rc].zero?
-        h[:children].each do |child|
-          rm_rf(z, File.join(path, child))
-        end
-      elsif h[:rc] == ZookeeperExceptions::ZNONODE
-        # no-op
-      else
-        raise "Oh noes! unexpected return value! #{h.inspect}"
-      end
-    end
-
-    rv = z.delete(:path => path)
-
-    unless (rv[:rc].zero? or rv[:rc] == ZookeeperExceptions::ZNONODE)
-      raise "oh noes! failed to delete #{path}" 
-    end
-
-    path
-  end
-
   describe 'non-existent' do
     describe 'with existing parent' do
       let(:chroot_path) { '/one-level' }

data/spec/shared/connection_examples.rb

@@ -1,27 +1,21 @@
 require 'shared/all_success_return_values'
 
 shared_examples_for "connection" do
-  def ensure_node(path, data)
-    if zk.stat(:path => path)[:stat].exists?
-      zk.set(:path => path, :data => data)
-    else
-      zk.create(:path => path, :data => data)
-    end
-  end
 
   before :each do
-    ensure_node(path, data)
+    ensure_node(zk, path, data)
   end
 
   after :each do
-    ensure_node(path, data)
+    ensure_node(zk, path, data)
   end
 
   after :all do
     Zookeeper.logger.warn "running shared examples after :all"
-    z = Zookeeper.new("localhost:2181")
-    z.delete(:path => path)
-    z.close
+
+    with_open_zk(connection_string) do |z|
+      rm_rf(z, path)
+    end
   end
 
   # unfortunately, we can't test w/o exercising other parts of the driver, so
@@ -1003,5 +997,22 @@ shared_examples_for "connection" do
       zk.event_dispatch_thread?.should_not be_true
     end
   end
+
+  describe :close do
+    describe 'from the event dispatch thread' do
+      it %[should not deadlock] do
+
+        evil_cb = lambda do |*|
+          logger.debug { "calling close event_dispatch_thread? #{zk.event_dispatch_thread?}" }
+          zk.close
+        end
+
+        zk.stat(:path => path, :callback => evil_cb)
+
+        wait_until { zk.closed? }
+        zk.should be_closed
+      end
+    end
+  end
 end
 

data/spec/spec_helper.rb

@@ -25,6 +25,7 @@ if ENV['ZKRB_NOLOG']
   Zookeeper.set_debug_level(0)
 end
 
+
 module ZookeeperSpecHeleprs
   class TimeoutError < StandardError; end
 
@@ -32,6 +33,59 @@ module ZookeeperSpecHeleprs
     Zookeeper.logger
   end
 
+  def ensure_node(zk, path, data)
+    return if zk.closed?
+    if zk.stat(:path => path)[:stat].exists?
+      zk.set(:path => path, :data => data)
+    else
+      zk.create(:path => path, :data => data)
+    end
+  end
+
+  def with_open_zk(host='localhost:2181')
+    z = Zookeeper.new(host)
+    yield z
+  ensure
+    if z
+      unless z.closed?
+        z.close
+
+        wait_until do 
+          begin
+            !z.connected?
+          rescue RuntimeError
+            true
+          end
+        end
+      end
+    end
+  end
+
+  # this is not as safe as the one in ZK, just to be used to clean up
+  # when we're the only one adjusting a particular path
+  def rm_rf(z, path)
+    z.get_children(:path => path).tap do |h|
+      if h[:rc].zero?
+        h[:children].each do |child|
+          rm_rf(z, File.join(path, child))
+        end
+      elsif h[:rc] == ZookeeperExceptions::ZNONODE
+        # no-op
+      else
+        raise "Oh noes! unexpected return value! #{h.inspect}"
+      end
+    end
+
+    rv = z.delete(:path => path)
+
+    unless (rv[:rc].zero? or rv[:rc] == ZookeeperExceptions::ZNONODE)
+      raise "oh noes! failed to delete #{path}" 
+    end
+
+    path
+  end
+
+
   # method to wait until block passed returns true or timeout (default is 10 seconds) is reached 
   # raises TiemoutError on timeout
   def wait_until(timeout=10)

data/spec/zookeeper_spec.rb

@@ -5,10 +5,10 @@ require 'shared/connection_examples'
 describe 'Zookeeper' do
   let(:path) { "/_zktest_" }
   let(:data) { "underpants" } 
-  let(:zk_host) { 'localhost:2181' }
+  let(:connection_string) { 'localhost:2181' }
 
   before do
-    @zk = Zookeeper.new(zk_host)
+    @zk = Zookeeper.new(connection_string)
   end
 
   after do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: slyphon-zookeeper
 version: !ruby/object:Gem::Version 
-  hash: 63
+  hash: 61
   prerelease: 
   segments: 
   - 0
   - 9
-  - 2
-  version: 0.9.2
+  - 3
+  version: 0.9.3
 platform: ruby
 authors: 
 - Phillip Pearson
@@ -20,105 +20,21 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-27 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 2
-        - 0
-        - 0
-        version: 2.0.0
-  type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: flexmock
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 41
-        segments: 
-        - 0
-        - 8
-        - 11
-        version: 0.8.11
-  type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: eventmachine
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        hash: 2025692189
-        segments: 
-        - 1
-        - 0
-        - 0
-        - beta
-        - 4
-        version: 1.0.0.beta.4
-  type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: evented-spec
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 59
-        segments: 
-        - 0
-        - 9
-        - 0
-        version: 0.9.0
-  type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: rake
-  prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 59
-        segments: 
-        - 0
-        - 9
-        - 0
-        version: 0.9.0
-  type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: pry
-  prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id006
-description: twitter's zookeeper client
+date: 2012-05-03 00:00:00 Z
+dependencies: []
+
+description: |+
+  A low-level multi-Ruby wrapper around the ZooKeeper API bindings.
+  For a friendlier interface, see http://github.com/slyphon/zk
+  
+  Currently supported:
+  
+  MRI: 1.8.7, 1.9.2, 1.9.3
+  JRuby: ~> 1.6.7
+  Rubinius: 2.0.testing
+  
+  This library uses version 3.3.5 of zookeeper bindings.
+  
 email: 
 - slyphon@gmail.com
 executables: []
@@ -162,8 +78,8 @@ files:
 - lib/zookeeper/em_client.rb
 - lib/zookeeper/exceptions.rb
 - lib/zookeeper/stat.rb
+- lib/zookeeper/version.rb
 - notes.txt
-- slyphon-zookeeper.gemspec
 - spec/c_zookeeper_spec.rb
 - spec/chrooted_connection_spec.rb
 - spec/default_watcher_spec.rb
@@ -180,6 +96,7 @@ files:
 - test/test_esoteric.rb
 - test/test_watcher1.rb
 - test/test_watcher2.rb
+- zookeeper.gemspec
 homepage: https://github.com/slyphon/zookeeper
 licenses: []
 
@@ -213,7 +130,7 @@ rubyforge_project:
 rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
-summary: twitter's zookeeper client
+summary: Low level zookeeper client
 test_files: 
 - spec/c_zookeeper_spec.rb
 - spec/chrooted_connection_spec.rb

data/slyphon-zookeeper.gemspec

@@ -1,36 +0,0 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-
-Gem::Specification.new do |s|
-  s.name        = "slyphon-zookeeper"
-  s.version     = '0.9.2'
-
-  s.authors     = ["Phillip Pearson", "Eric Maland", "Evan Weaver", "Brian Wickman", "Neil Conway", "Jonathan D. Simms"]
-  s.email       = ["slyphon@gmail.com"]
-  s.summary     = %q{twitter's zookeeper client}
-  s.description = s.summary
-  s.homepage    = 'https://github.com/slyphon/zookeeper'
-
-  s.add_development_dependency "rspec", ">= 2.0.0"
-  s.add_development_dependency 'flexmock', '~> 0.8.11'
-  s.add_development_dependency 'eventmachine', '1.0.0.beta.4'
-  s.add_development_dependency 'evented-spec', '~> 0.9.0'
-  s.add_development_dependency 'rake', '~> 0.9.0'
-  s.add_development_dependency 'pry'
-
-  s.files         = `git ls-files`.split("\n")
-  s.require_paths = ["lib"]
-
-  if ENV['JAVA_GEM'] or defined?(::JRUBY_VERSION)
-    s.platform = 'java'
-    s.add_runtime_dependency('slyphon-log4j',         '= 1.2.15')
-    s.add_runtime_dependency('slyphon-zookeeper_jar', '= 3.3.5')
-    s.require_paths += %w[java]
-  else
-    s.require_paths += %w[ext]
-    s.extensions = 'ext/extconf.rb'
-  end
-
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-end