bunny 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c8f1c8052f218b6d4ed95579a93e03ee9014fea5
-  data.tar.gz: 739d9b25a80d0c6063124229fe8226fe45390ed3
+  metadata.gz: 0b9d1b9674fc6fe77346de7896e4ac8900c4c047
+  data.tar.gz: 19972fd3c10baf9a7acf1bc2c49a43ed995baeaa
 SHA512:
-  metadata.gz: 0fe50e8b79c8611edf5f6b3f152b21680fdcb9790bf73126a2c3e4e2bbc38d485b26cef1edf0bde99eca2e8d34c784776396cd4cf8a26829b53ca7974de45430
-  data.tar.gz: 2cb6bf110f3c9508eb055e37c2aebac6ff0915e6d89e014934738b9671041e6b34a9af13aca165d057d296a73efd6f2497efaaa4c0049726b9a362cf31c26e35
+  metadata.gz: ba09b21e9cbe72298decba6a551ecc554e17ff58c7f88a907979a4859453c7674341989588fd407d6923de40ebaa9e6af9cbbe31615e41d223a8c4163c5f89a0
+  data.tar.gz: df71d64b16826cfb887db8bcec84ecc114410cfaa92e9c97ca2d03cc003ffa7558998fcad6019031729c999888642ec82a69e2b00d10e3984b538dec61ebd800

data/ChangeLog.md

@@ -1,3 +1,11 @@
+## Changes between Bunny 1.2.1 and 1.2.2
+
+### Synchronization Improvements for Session#close
+
+`Bunny::Session#close` now better synchronizes state transitions,
+eliminating a few race condition scenarios with I/O reader thread.
+
+
 ## Changes between Bunny 1.2.0 and 1.2.1
 
 ### Better Synchronization for Publisher Confirms

data/Gemfile

@@ -35,7 +35,7 @@ end
 
 group :test do
   gem "rspec", ">= 2.13.0"
-  gem "rabbitmq_http_api_client", "~> 1.0.0"
+  gem "rabbitmq_http_api_client", "~> 1.1.0"
 end
 
 gemspec

data/lib/bunny/exchange.rb

@@ -55,7 +55,7 @@ module Bunny
     # @return [Exchange] An instance that corresponds to the default exchange (of type direct).
     # @api public
     def self.default(channel_or_connection)
-      self.new(channel_from(channel_or_connection), :direct, AMQ::Protocol::EMPTY_STRING, :no_declare => true)
+      self.new(channel_or_connection, :direct, AMQ::Protocol::EMPTY_STRING, :no_declare => true)
     end
 
     # @param [Bunny::Channel] channel_or_connection Channel this exchange will use. {Bunny::Session} instances are supported only for

data/lib/bunny/reader_loop.rb

@@ -14,6 +14,8 @@ module Bunny
       @session        = session
       @session_thread = session_thread
       @logger         = @session.logger
+
+      @mutex          = Mutex.new
     end
 
 
@@ -29,34 +31,37 @@ module Bunny
     def run_loop
       loop do
         begin
-          break if @stopping || @network_is_down
+          break if @mutex.synchronize { @stopping || @stopped || @network_is_down }
           run_once
-        rescue Errno::EBADF => ebadf
-          break if @stopping
-          # ignored, happens when we loop after the transport has already been closed
         rescue AMQ::Protocol::EmptyResponseError, IOError, SystemCallError => e
-          break if @stopping
-          log_exception(e)
+          break if terminate? || @session.closing? || @session.closed?
 
+          log_exception(e)
           @network_is_down = true
-
           if @session.automatically_recover?
             @session.handle_network_failure(e)
           else
             @session_thread.raise(Bunny::NetworkFailure.new("detected a network failure: #{e.message}", e))
           end
         rescue ShutdownSignal => _
+          @mutex.synchronize { @stopping = true }
           break
         rescue Exception => e
-          break if @stopping
-          log_exception(e)
+          break if terminate?
+          if !(@session.closing? || @session.closed?)
+            log_exception(e)
 
-          @network_is_down = true
-          @session_thread.raise(Bunny::NetworkFailure.new("caught an unexpected exception in the network loop: #{e.message}", e))
+            @network_is_down = true
+            @session_thread.raise(Bunny::NetworkFailure.new("caught an unexpected exception in the network loop: #{e.message}", e))
+          end
+        rescue Errno::EBADF => ebadf
+          break if terminate?
+          # ignored, happens when we loop after the transport has already been closed
+          @mutex.synchronize { @stopping = true }
         end
       end
 
-      @stopped = true
+      @mutex.synchronize { @stopped = true }
     end
 
     def run_once
@@ -83,11 +88,21 @@ module Bunny
     end
 
     def stop
-      @stopping = true
+      @mutex.synchronize { @stopping = true }
     end
 
     def stopped?
-      @stopped
+      @mutex.synchronize { @stopped = true }
+    end
+
+    def stopping?
+      @mutex.synchronize { @stopping = true }
+    end
+
+    def terminate_with(e)
+      @mutex.synchronize { @stopping = true }
+
+      self.raise(e)
     end
 
     def raise(e)
@@ -105,12 +120,26 @@ module Bunny
       end
     end
 
+    protected
+
     def log_exception(e)
-      @logger.error "Exception in the reader loop: #{e.class.name}: #{e.message}"
-      @logger.error "Backtrace: "
-      e.backtrace.each do |line|
-        @logger.error "\t#{line}"
+      if !(io_error?(e) && (@session.closing? || @session.closed?))
+        @logger.error "Exception in the reader loop: #{e.class.name}: #{e.message}"
+        @logger.error "Backtrace: "
+        e.backtrace.each do |line|
+          @logger.error "\t#{line}"
+        end
       end
     end
+
+    def io_error?(e)
+      [AMQ::Protocol::EmptyResponseError, IOError, SystemCallError].any? do |klazz|
+        e.is_a?(klazz)
+      end
+    end
+
+    def terminate?
+      @mutex.synchronize { @stopping || @stopped }
+    end
   end
 end

data/lib/bunny/session.rb

@@ -172,6 +172,7 @@ module Bunny
       # transport operations/continuations mutex. A workaround for
       # the non-reentrant Ruby mutexes. MK.
       @transport_mutex     = @mutex_impl.new
+      @status_mutex        = @mutex_impl.new
       @channels            = Hash.new
 
       @origin_thread       = Thread.current
@@ -233,7 +234,7 @@ module Bunny
     def start
       return self if connected?
 
-      @status        = :connecting
+      @status_mutex.synchronize { @status = :connecting }
       # reset here for cases when automatic network recovery kicks in
       # when we were blocked. MK.
       @blocked       = false
@@ -259,7 +260,7 @@ module Bunny
 
         @default_channel = self.create_channel
       rescue Exception => e
-        @status = :not_connected
+        @status_mutex.synchronize { @status = :not_connected }
         raise e
       end
 
@@ -295,16 +296,18 @@ module Bunny
 
     # Closes the connection. This involves closing all of its channels.
     def close
-      if @transport.open?
-        close_all_channels
+      @status_mutex.synchronize { @status = :closing }
+
+      ignoring_io_errors do
+        if @transport.open?
+          close_all_channels
 
-        Bunny::Timeout.timeout(@transport.disconnect_timeout, ClientTimeout) do
           self.close_connection(true)
         end
-      end
 
-      clean_up_on_shutdown
-      @status = :closed
+        clean_up_on_shutdown
+      end
+      @status_mutex.synchronize { @status = :closed }
     end
     alias stop close
 
@@ -328,14 +331,22 @@ module Bunny
       status == :connecting
     end
 
+    # @return [Boolean] true if this AMQP 0.9.1 connection is closing
+    # @api private
+    def closing?
+      @status_mutex.synchronize { @status == :closing }
+    end
+
     # @return [Boolean] true if this AMQP 0.9.1 connection is closed
     def closed?
-      status == :closed
+      @status_mutex.synchronize { @status == :closed }
     end
 
     # @return [Boolean] true if this AMQP 0.9.1 connection is open
     def open?
-      (status == :open || status == :connected || status == :connecting) && @transport.open?
+      @status_mutex.synchronize do
+        (status == :open || status == :connected || status == :connecting) && @transport.open?
+      end
     end
     alias connected? open?
 
@@ -506,7 +517,7 @@ module Bunny
 
       shut_down_all_consumer_work_pools!
       maybe_shutdown_heartbeat_sender
-      @status   = :not_connected
+      @status_mutex.synchronize { @status = :not_connected }
     end
 
     # Handles incoming frames and dispatches them.
@@ -597,7 +608,7 @@ module Bunny
     def handle_network_failure(exception)
       raise NetworkErrorWrapper.new(exception) unless @threaded
 
-      @status = :disconnected
+      @status_mutex.synchronize { @status = :disconnected }
 
       if !recovering_from_network_failure?
         begin
@@ -696,7 +707,7 @@ module Bunny
       @continuations.push(method)
 
       clean_up_on_shutdown
-      @origin_thread.raise(@last_connection_error)
+      @origin_thread.terminate_with(@last_connection_error)
     end
 
     def clean_up_on_shutdown
@@ -793,7 +804,7 @@ module Bunny
         if threaded?
           # this is the easiest way to wait until the loop
           # is guaranteed to have terminated
-          @reader_loop.raise(ShutdownSignal)
+          @reader_loop.terminate_with(ShutdownSignal)
           # joining the thread here may take forever
           # on JRuby because sun.nio.ch.KQueueArrayWrapper#kevent0 is
           # a native method that cannot be (easily) interrupted.
@@ -928,7 +939,7 @@ module Bunny
       @server_authentication_mechanisms = (connection_start.mechanisms || "").split(" ")
       @server_locales                   = Array(connection_start.locales)
 
-      @status = :connected
+      @status_mutex.synchronize { @status = :connected }
     end
 
     # @private
@@ -1004,7 +1015,7 @@ module Bunny
       end
       connection_open_ok = frame2.decode_payload
 
-      @status = :open
+      @status_mutex.synchronize { @status = :open }
       if @heartbeat && @heartbeat > 0
         initialize_heartbeat_sender
       end
@@ -1023,7 +1034,7 @@ module Bunny
             close_transport
           end
 
-          @origin_thread.raise(e)
+          @origin_thread.terminate_with(e)
         else
           raise "could not open connection: server did not respond with connection.open-ok but #{connection_open_ok.inspect} instead"
         end
@@ -1146,6 +1157,14 @@ module Bunny
         n
       end
     end
+
+    def ignoring_io_errors(&block)
+      begin
+        block.call
+      rescue AMQ::Protocol::EmptyResponseError, IOError, SystemCallError, Bunny::NetworkFailure => _
+        # ignore
+      end
+    end
   end # Session
 
   # backwards compatibility

data/lib/bunny/version.rb

@@ -2,5 +2,5 @@
 
 module Bunny
   # @return [String] Version of the library
-  VERSION = "1.2.1"
+  VERSION = "1.2.2"
 end

data/spec/higher_level_api/integration/connection_recovery_spec.rb

@@ -29,7 +29,7 @@ unless ENV["CI"]
       q.purge
       x = ch.default_exchange
       x.publish("msg", :routing_key => q.name)
-      sleep 0.2
+      sleep 0.5
       q.message_count.should == 1
       q.purge
     end
@@ -37,7 +37,7 @@ unless ENV["CI"]
     def ensure_queue_binding_recovery(x, q, routing_key = "")
       q.purge
       x.publish("msg", :routing_key => routing_key)
-      sleep 0.2
+      sleep 0.5
       q.message_count.should == 1
       q.purge
     end

data/spec/higher_level_api/integration/exchange_declare_spec.rb

@@ -11,6 +11,15 @@ describe Bunny::Exchange do
     connection.close
   end
 
+  context "of default type" do
+    it "is declared with an empty name" do
+      ch = connection.create_channel
+
+      x = Bunny::Exchange.default(ch)
+
+      x.name.should == ''
+    end
+  end
 
   context "of type fanout" do
     context "with a non-predefined name" do

data/spec/stress/connection_open_close_spec.rb

@@ -12,7 +12,7 @@ unless defined?(JRUBY_VERSION) && !ENV["FORCE_JRUBY_RUN"]
         end
 
     n.times do |i|
-      it "can be closed (take #{i})" do
+      it "can be closed (automatic recovery disabled, take #{i})" do
         c  = Bunny.new(:automatically_recover => false)
         c.start
         ch = c.create_channel
@@ -23,9 +23,39 @@ unless defined?(JRUBY_VERSION) && !ENV["FORCE_JRUBY_RUN"]
       end
     end
 
+    n.times do |i|
+      it "can be closed in the Hello, World example (take #{i})" do
+        c  = Bunny.new(:automatically_recover => false)
+        c.start
+        ch = c.create_channel
+        x  = ch.default_exchange
+        q  = ch.queue("", :exclusive => true)
+        q.subscribe do |delivery_info, properties, payload|
+          # no-op
+        end
+        20.times { x.publish("hello", :routing_key => q.name) }
+
+        c.should be_connected
+        c.stop
+        c.should be_closed
+      end
+    end
+
+    n.times do |i|
+      it "can be closed (automatic recovery enabled, take #{i})" do
+        c  = Bunny.new(:automatically_recover => true)
+        c.start
+        ch = c.create_channel
+
+        c.should be_connected
+        c.stop
+        c.should be_closed
+      end
+    end
+
     context "in the single threaded mode" do
       n.times do |i|
-        it "can be closed (take #{i})" do
+        it "can be closed (single threaded mode, take #{i})" do
           c  = Bunny.new(:automatically_recover => false, :threaded => false)
           c.start
           ch = c.create_channel

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bunny
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Chris Duncan
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-11 00:00:00.000000000 Z
+date: 2014-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amq-protocol