bunny 0.9.5 → 0.9.6

data/ChangeLog.md

@@ -1,3 +1,12 @@
+## Changes between Bunny 0.9.5 and 0.9.6
+
+### 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.
+
+
 ## Changes between Bunny 0.9.4 and 0.9.5
 
 ### connection.close Raises Exceptions on Connection Thread

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 = true
+    end
+
     def kill
       @thread.kill
       @thread.join

data/lib/bunny/session.rb

@@ -259,8 +259,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
@@ -399,11 +404,6 @@ module Bunny
         @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
@@ -617,7 +617,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/version.rb

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

data/spec/higher_level_api/integration/connection_stop_spec.rb

@@ -1,12 +1,15 @@
 require "spec_helper"
 
 describe Bunny::Session do
-  it "can be closed" do
-    c  = Bunny.new
-    c.start
-    ch = c.create_channel
+  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_connected
+      c.stop
+      c.should be_closed
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bunny
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 0.9.6
   prerelease: 
 platform: ruby
 authors: