bunny 1.0.0.pre1 → 1.0.0.pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae97d1a6c3f9bd4e72d67961007677f20b86636b
-  data.tar.gz: d7fd9c501d71379469e61f68e99d0d3292bc3b32
+  metadata.gz: b675d7cc26c0951af3fda991f438c8bbc3cb03c5
+  data.tar.gz: 0cdf2879b75d769676c3dce890bd1d7213a96448
 SHA512:
-  metadata.gz: c405d0617f646cffc2f5fb8ab9950277e1913ed131c6c7aeba95a8ac89742dfe5f56f24332753c7ed1de6ed7490affd33c619f0eaafa9dc6d76cc6c000c64233
-  data.tar.gz: 39cd8727b32ad97113fe5f5f07197da4c3b8fa884de2a86201c00603f2a5df7037a9778653ab19b20b4972e992f296e791fb15c13ffcfe25f42eaa3e517cd837
+  metadata.gz: e881cb1d9695f16102ca8a08bdd9191a38cc044c16e4c1f89a32b2331d0abd6d58a00abc731e3c809d9cd538a1d243eca9029074da228ee28400c2307e7deb4f
+  data.tar.gz: 8390a12a2595bd1f7b65dd83c31686117081aa0672c258935e07c040ccf89222a1160e29cab0d519c24483f13adc24b3d8a5af41598b584d43c6913e1965d18e

data/ChangeLog.md

@@ -1,3 +1,44 @@
+## Changes between Bunny 1.0.0.pre1 and 1.0.0.pre2
+
+### Reentrant Mutex Implementation
+
+Bunny now allows mutex impl to be configurable, uses reentrant Monitor
+by default.
+
+Non-reentrant mutexes is a major PITA and may affect code that
+uses Bunny.
+
+Avg. publishing throughput with Monitor drops slightly from
+5.73 Khz to 5.49 Khz (about 4% decrease), which is reasonable
+for Bunny.
+
+Apps that need these 4% can configure what mutex implementation
+is used on per-connection basis.
+
+### Eliminated Race Condition in Bunny::Session#close
+
+`Bunny::Session#close` had a race condition that caused (non-deterministic)
+exceptions when connection transport was closed before connection
+reader loop was guaranteed to have stopped.
+
+### connection.close Raises Exceptions on Connection Thread
+
+Connection-level exceptions (including when a connection is closed via
+management UI or `rabbitmqctl`) will now be raised on the connection
+thread so they
+
+ * can be handled by applications
+ * do not start connection recovery, which may be uncalled for
+
+### Client TLS Certificates are Optional
+
+Bunny will no longer require client TLS certificates. Note that CA certificate
+list is still necessary.
+
+If RabbitMQ TLS configuration requires peer verification, client certificate
+and private key are mandatory.
+
+
 ## Changes between Bunny 0.9.0 and 1.0.0.pre1
 
 ### Publishing Over Closed Connections

data/lib/bunny/channel.rb

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 require "thread"
+require "monitor"
 require "set"
 
 require "bunny/consumer_work_pool"
@@ -173,10 +174,10 @@ module Bunny
       @work_pool  = work_pool
 
       # synchronizes frameset delivery. MK.
-      @publishing_mutex = Mutex.new
-      @consumer_mutex   = Mutex.new
+      @publishing_mutex = @connection.mutex_impl.new
+      @consumer_mutex   = @connection.mutex_impl.new
 
-      @unconfirmed_set_mutex = Mutex.new
+      @unconfirmed_set_mutex = @connection.mutex_impl.new
 
       self.reset_continuations
 

data/lib/bunny/channel_id_allocator.rb

@@ -1,4 +1,5 @@
 require "thread"
+require "monitor"
 require "amq/int_allocator"
 
 module Bunny
@@ -18,7 +19,7 @@ module Bunny
     # @param [Integer] max_channel Max allowed channel id
     def initialize(max_channel = ((1 << 16) - 1))
       @allocator = AMQ::IntAllocator.new(1, max_channel)
-      @mutex     = Mutex.new
+      @mutex     = Monitor.new
     end
 
 

data/lib/bunny/concurrent/condition.rb

@@ -1,4 +1,5 @@
 require "thread"
+require "monitor"
 
 module Bunny
   # @private
@@ -14,7 +15,7 @@ module Bunny
 
 
       def initialize(description = nil)
-        @mutex           = Mutex.new
+        @mutex           = Monitor.new
         @waiting_threads = []
         @description     = description
       end

data/lib/bunny/heartbeat_sender.rb

@@ -15,7 +15,7 @@ module Bunny
     def initialize(transport, logger)
       @transport = transport
       @logger    = logger
-      @mutex     = Mutex.new
+      @mutex     = Monitor.new
 
       @last_activity_time = Time.now
     end

data/lib/bunny/reader_loop.rb

@@ -51,6 +51,8 @@ module Bunny
           @session_thread.raise(Bunny::NetworkFailure.new("caught an unexpected exception in the network loop: #{e.message}", e))
         end
       end
+
+      @stopped = true
     end
 
     def run_once
@@ -80,6 +82,10 @@ module Bunny
       @stopping = true
     end
 
+    def stopped?
+      @stopped
+    end
+
     def kill
       @thread.kill
       @thread.join

data/lib/bunny/session.rb

@@ -1,5 +1,6 @@
 require "socket"
 require "thread"
+require "monitor"
 
 require "bunny/transport"
 require "bunny/channel_id_allocator"
@@ -144,11 +145,14 @@ module Bunny
       @mechanism           = opts.fetch(:auth_mechanism, "PLAIN")
       @credentials_encoder = credentials_encoder_for(@mechanism)
       @locale              = @opts.fetch(:locale, DEFAULT_LOCALE)
+
+      @mutex_impl          = @opts.fetch(:mutex_impl, Monitor)
+
       # mutex for the channel id => channel hash
-      @channel_mutex       = Mutex.new
+      @channel_mutex       = @mutex_impl.new
       # transport operations/continuations mutex. A workaround for
       # the non-reentrant Ruby mutexes. MK.
-      @transport_mutex     = Mutex.new
+      @transport_mutex     = @mutex_impl.new
       @channels            = Hash.new
 
       @origin_thread       = Thread.current
@@ -186,6 +190,9 @@ module Bunny
       @threaded
     end
 
+    # @private
+    attr_reader :mutex_impl
+
     def configure_socket(&block)
       raise ArgumentError, "No block provided!" if block.nil?
 
@@ -259,8 +266,13 @@ module Bunny
         close_all_channels
 
         Bunny::Timer.timeout(@transport.disconnect_timeout, ClientTimeout) do
-          self.close_connection(false)
+          self.close_connection(true)
         end
+
+        maybe_shutdown_reader_loop
+        close_transport
+
+        @status = :closed
       end
     end
     alias stop close
@@ -370,13 +382,15 @@ module Bunny
 
     # @private
     def close_connection(sync = true)
-      @transport.send_frame(AMQ::Protocol::Connection::Close.encode(200, "Goodbye", 0, 0))
+      if @transport.open?
+        @transport.send_frame(AMQ::Protocol::Connection::Close.encode(200, "Goodbye", 0, 0))
 
-      maybe_shutdown_heartbeat_sender
-      @status   = :not_connected
+        maybe_shutdown_heartbeat_sender
+        @status   = :not_connected
 
-      if sync
-        @last_connection_close_ok = wait_on_continuations
+        if sync
+          @last_connection_close_ok = wait_on_continuations
+        end
       end
     end
 
@@ -392,16 +406,11 @@ module Bunny
         @last_connection_error = instantiate_connection_level_exception(method)
         @continuations.push(method)
 
-        raise @last_connection_error
+        @origin_thread.raise(@last_connection_error)
       when AMQ::Protocol::Connection::CloseOk then
         @last_connection_close_ok = method
         begin
           @continuations.clear
-
-          reader_loop.stop
-          @reader_loop = nil
-
-          @transport.close
         rescue StandardError => e
           @logger.error e.class.name
           @logger.error e.message
@@ -615,7 +624,27 @@ module Bunny
 
     # @private
     def maybe_shutdown_reader_loop
-      @reader_loop.stop if @reader_loop
+      if @reader_loop
+        @reader_loop.stop
+        # We don't need to kill the loop but
+        # this is the easiest way to wait until the loop
+        # is guaranteed to have terminated
+        @reader_loop.kill
+      end
+
+      @reader_loop = nil
+    end
+
+    # @private
+    def close_transport
+      begin
+        @transport.close
+      rescue StandardError => e
+        @logger.error "Exception when closing transport:"
+        @logger.error e.class.name
+        @logger.error e.message
+        @logger.error e.backtrace
+      end
     end
 
     # @private

data/lib/bunny/transport.rb

@@ -1,5 +1,6 @@
 require "socket"
 require "thread"
+require "monitor"
 
 begin
   require "openssl"
@@ -49,7 +50,7 @@ module Bunny
       @connect_timeout    = nil if @connect_timeout == 0
       @disconnect_timeout = @read_write_timeout || @connect_timeout
 
-      @writes_mutex       = Mutex.new
+      @writes_mutex       = @session.mutex_impl.new
 
       maybe_initialize_socket
       prepare_tls_context if @tls_enabled
@@ -311,14 +312,24 @@ module Bunny
     end
 
     def initialize_tls_context(ctx)
-      ctx.cert       = OpenSSL::X509::Certificate.new(@tls_certificate)
-      ctx.key        = OpenSSL::PKey::RSA.new(@tls_key)
+      ctx.cert       = OpenSSL::X509::Certificate.new(@tls_certificate) if @tls_certificate
+      ctx.key        = OpenSSL::PKey::RSA.new(@tls_key) if @tls_key
       ctx.cert_store = if @tls_certificate_store
                          @tls_certificate_store
                        else
                          initialize_tls_certificate_store(@tls_ca_certificates)
                        end
 
+      if !@tls_certificate
+        @logger.warn <<-MSG
+        Using TLS but no client certificate is provided! If RabbitMQ is configured to verify peer
+        certificate, connection upgrade will fail!
+        MSG
+      end
+      if @tls_certificate && !@tls_key
+        @logger.warn "Using TLS but no client private key is provided!"
+      end
+
       # setting TLS/SSL version only works correctly when done
       # vis set_params. MK.
       ctx.set_params(:ssl_version => @opts.fetch(:tls_protocol, DEFAULT_TLS_PROTOCOL))

data/lib/bunny/version.rb

@@ -2,5 +2,5 @@
 
 module Bunny
   # @return [String] Version of the library
-  VERSION = "1.0.0.pre1"
+  VERSION = "1.0.0.pre2"
 end

data/spec/higher_level_api/integration/connection_stop_spec.rb

@@ -0,0 +1,13 @@
+require "spec_helper"
+
+describe Bunny::Session do
+  it "can be closed" do
+    c  = Bunny.new(:automatically_recover => false)
+    c.start
+    ch = c.create_channel
+
+    c.should be_connected
+    c.stop
+    c.should be_closed
+  end
+end

data/spec/higher_level_api/integration/tls_connection_spec.rb

@@ -2,7 +2,7 @@
 require "spec_helper"
 
 unless ENV["CI"]
-  describe "TLS connection to RabbitMQ" do
+  describe "TLS connection to RabbitMQ with client certificates" do
     let(:connection) do
       c = Bunny.new(:user     => "bunny_gem",
                     :password => "bunny_password",
@@ -44,4 +44,46 @@ unless ENV["CI"]
       ch.close
     end
   end
+
+
+  describe "TLS connection to RabbitMQ without client certificates" do
+    let(:connection) do
+      c = Bunny.new(:user     => "bunny_gem",
+                    :password => "bunny_password",
+                    :vhost    => "bunny_testbed",
+                    :tls                   => true,
+                    :tls_ca_certificates   => ["./spec/tls/cacert.pem"])
+      c.start
+      c
+    end
+
+    after :all do
+      connection.close
+    end
+
+    it "provides the same API as a regular connection" do
+      ch = connection.create_channel
+
+      q  = ch.queue("", :exclusive => true)
+      x  = ch.default_exchange
+
+      x.publish("xyzzy", :routing_key => q.name).
+        publish("xyzzy", :routing_key => q.name).
+        publish("xyzzy", :routing_key => q.name).
+        publish("xyzzy", :routing_key => q.name)
+
+      sleep 0.5
+      q.message_count.should == 4
+
+      i = 0
+      q.subscribe do |delivery_info, _, payload|
+        i += 1
+      end
+      sleep 1.0
+      i.should == 4
+      q.message_count.should == 0
+
+      ch.close
+    end
+  end
 end

data/spec/stress/connection_open_close_spec.rb

@@ -0,0 +1,17 @@
+require "spec_helper"
+
+unless RUBY_ENGINE == "jruby"
+  describe Bunny::Session do
+    4000.times do |i|
+      it "can be closed (take #{i})" do
+        c  = Bunny.new(:automatically_recover => false)
+        c.start
+        ch = c.create_channel
+
+        c.should be_connected
+        c.stop
+        c.should be_closed
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bunny
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre1
+  version: 1.0.0.pre2
 platform: ruby
 authors:
 - Chris Duncan
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-25 00:00:00.000000000 Z
+date: 2013-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amq-protocol
@@ -137,6 +137,7 @@ files:
 - spec/higher_level_api/integration/channel_open_spec.rb
 - spec/higher_level_api/integration/confirm_select_spec.rb
 - spec/higher_level_api/integration/connection_spec.rb
+- spec/higher_level_api/integration/connection_stop_spec.rb
 - spec/higher_level_api/integration/consistent_hash_exchange_spec.rb
 - spec/higher_level_api/integration/consumer_cancellation_notification_spec.rb
 - spec/higher_level_api/integration/dead_lettering_spec.rb
@@ -172,6 +173,7 @@ files:
 - spec/stress/channel_open_stress_with_single_threaded_connection_spec.rb
 - spec/stress/concurrent_consumers_stress_spec.rb
 - spec/stress/concurrent_publishers_stress_spec.rb
+- spec/stress/connection_open_close_spec.rb
 - spec/stress/long_running_consumer_spec.rb
 - spec/tls/cacert.pem
 - spec/tls/client_cert.pem
@@ -223,6 +225,7 @@ test_files:
 - spec/higher_level_api/integration/channel_open_spec.rb
 - spec/higher_level_api/integration/confirm_select_spec.rb
 - spec/higher_level_api/integration/connection_spec.rb
+- spec/higher_level_api/integration/connection_stop_spec.rb
 - spec/higher_level_api/integration/consistent_hash_exchange_spec.rb
 - spec/higher_level_api/integration/consumer_cancellation_notification_spec.rb
 - spec/higher_level_api/integration/dead_lettering_spec.rb
@@ -258,6 +261,7 @@ test_files:
 - spec/stress/channel_open_stress_with_single_threaded_connection_spec.rb
 - spec/stress/concurrent_consumers_stress_spec.rb
 - spec/stress/concurrent_publishers_stress_spec.rb
+- spec/stress/connection_open_close_spec.rb
 - spec/stress/long_running_consumer_spec.rb
 - spec/tls/cacert.pem
 - spec/tls/client_cert.pem