bunny 1.1.0.pre1 → 1.1.0.pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 840a6fefa94a5fef22bdc0a24178ba01498160bb
-  data.tar.gz: 98b792aa4957d2109ce984742f7cb50551b6503d
+  metadata.gz: 843f81c989d0b413c14b8874bb6f2e4365da3921
+  data.tar.gz: b4fcd0d7a8e3effe884f2b3ecefc2db524aaf545
 SHA512:
-  metadata.gz: 2f50640dcc07103b1f4d6c54230d27ad658bc8b6870874d781718cfca9910abca7c489bbd44acfb8f6f42a237ddf24afe7c484d6a36ab820d18ad846d1ae5585
-  data.tar.gz: 40d9d577e9b65e43882011714cf5f956804818fc692b7d30adc5e131e97ee51ab5b1bcee07434dceb097a571436917bc602078aed331594b32231ef54a8bb2cc
+  metadata.gz: dee6d9086ff1654324c354037d1a35875b2ded96a1b0701c9836d5d2e4d41ff83df212ac5efca7643e50c30304f0be360ddbd4f6d64470634348b625a71f0016
+  data.tar.gz: 3fd0c4d92be3121789bf4dc7349583c24de9534cafb3a686fef5e080211c708a02ba15aef7e555c29c2dec2567439f8dcc11c6889da0788e272703b355b3ac28

data/ChangeLog.md

@@ -1,5 +1,38 @@
+## Changes between Bunny 1.1.0.pre1 and 1.1.0.pre2
+
+### connection.tune.channel_max No Longer Overflows
+
+`connection.tune.channel_max` could previously be configured to values
+greater than 2^16 - 1 (65535). This would result in a silent overflow
+during serialization. The issue was harmless in practice but is still
+a bug that can be quite confusing.
+
+Bunny now caps max number of channels to 65535. This allows it to be
+forward compatible with future RabbitMQ versions that may allow limiting
+total # of open channels via server configuration.
+
+### amq-protocol Update
+
+Minimum `amq-protocol` version is now `1.9.0` which includes
+bug fixes and performance improvements for channel ID allocator.
+
+### Thread Leaks Fixes
+
+Bunny will now correctly release heartbeat sender when allocating
+a new one (usually happens only when connection recovers from a network
+failure).
+
+
 ## Changes between Bunny 1.0.0 and 1.1.0.pre1
 
+### Versioned Delivery Tag Fix
+
+Versioned delivery tag now ensures all the arguments it operates
+(original delivery tag, atomic fixnum instances, etc) are coerced to `Integer`
+before comparison.
+
+GitHub issues: #171.
+
 ### User-Provided Loggers
 
 Bunny now can use any logger that provides the same API as Ruby standard library's `Logger`:

data/README.md

@@ -48,7 +48,7 @@ Specific examples:
 
 Bunny 0.9 and more recent versions support
 
- * CRuby 1.9.3, 1.9.2, 2.0.0, and 1.8.7
+ * CRuby 2.0.0, 1.9.3, 1.9.2, and 1.8.7
  * JRuby 1.7+
  * Rubinius 2.0+
 
@@ -92,7 +92,7 @@ gem install bunny
 To use Bunny in a project managed with Bundler:
 
 ``` ruby
-gem "bunny", ">= 1.0.0.rc2"
+gem "bunny", "~> 1.0.4"
 ```
 
 

data/bunny.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |s|
     map { |mail| Base64.decode64(mail) }
 
   # Dependencies
-  s.add_dependency "amq-protocol", ">= 1.8.0"
+  s.add_dependency "amq-protocol", ">= 1.9.0"
 
   # Files.
   s.has_rdoc = true

data/examples/connection/automatic_recovery_with_republishing.rb

@@ -0,0 +1,109 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require "bundler"
+Bundler.setup
+
+$:.unshift(File.expand_path("../../../lib", __FILE__))
+
+require 'Bunny'
+
+conn = Bunny.new(:heartbeat_interval => 8)
+conn.start
+
+ch0 = conn.create_channel
+ch1 = conn.create_channel
+ch2 = conn.create_channel
+ch3 = conn.create_channel
+
+x   = ch1.topic("hb.examples.recovery.topic", :durable => false)
+q1  = ch1.queue("hb.examples.recovery.client_named_queue1", :durable => false)
+q2  = ch2.queue("hb.examples.recovery.client_named_queue2", :durable => false)
+q3  = ch3.queue("hb.examples.recovery.client_named_queue3", :durable => false)
+
+q1.bind(x, :routing_key => "abc")
+q2.bind(x, :routing_key => "def")
+q3.bind(x, :routing_key => "xyz")
+
+x0  = ch0.fanout("hb.examples.recovery.fanout0")
+x1  = ch1.fanout("hb.examples.recovery.fanout1")
+x2  = ch2.fanout("hb.examples.recovery.fanout2")
+x3  = ch3.fanout("hb.examples.recovery.fanout3")
+
+q4  = ch1.queue("", :exclusive => true)
+q4.bind(x0)
+
+q5  = ch2.queue("", :exclusive => true)
+q5.bind(x1)
+
+q6  = ch3.queue("", :exclusive => true)
+q6.bind(x2)
+q6.bind(x3)
+
+
+q1.subscribe do |delivery_info, metadata, payload|
+  puts "[Q1] Consumed #{payload} on channel #{q1.channel.id}"
+  if ch0.open?
+    puts "Publishing a reply on channel #{ch0.id} which is open"
+    x0.publish(Time.now.to_i.to_s)
+  end
+end
+
+q2.subscribe do |delivery_info, metadata, payload|
+  puts "[Q2] Consumed #{payload} on channel #{q2.channel.id}"
+
+  if ch1.open?
+    puts "Publishing a reply on channel #{ch1.id} which is open"
+    x1.publish(Time.now.to_i.to_s)
+  end
+end
+
+q3.subscribe do |delivery_info, metadata, payload|
+  puts "[Q3] Consumed #{payload} (consumer 1, channel #{q3.channel.id})"
+
+  if ch2.open?
+    puts "Publishing a reply on channel #{ch1.id} which is open"
+    x2.publish(Time.now.to_i.to_s)
+  end
+end
+
+q3.subscribe do |delivery_info, metadata, payload|
+  puts "[Q3] Consumed #{payload} (consumer 2, channel #{q3.channel.id})"
+
+  if ch3.open?
+    puts "Publishing a reply on channel #{ch3.id} which is open"
+    x3.publish(Time.now.to_i.to_s)
+  end
+end
+
+q4.subscribe do |delivery_info, metadata, payload|
+  puts "[Q4] Consumed #{payload} on channel #{q4.channel.id}"
+end
+
+q5.subscribe do |delivery_info, metadata, payload|
+  puts "[Q5] Consumed #{payload} on channel #{q5.channel.id}"
+end
+
+q6.subscribe do |delivery_info, metadata, payload|
+  puts "[Q6] Consumed #{payload} on channel #{q6.channel.id}"
+end
+
+loop do
+  sleep 1
+  data = rand.to_s
+  rk   = ["abc", "def", "xyz", Time.now.to_i.to_s].sample
+
+  begin
+    3.times do
+      x.publish(rand.to_s, :routing_key => rk)
+      puts "Published #{data}, routing key: #{rk} on channel #{x.channel.id}"
+    end
+  # happens when a message is published before the connection
+  # is recovered
+  rescue Exception => e
+    puts "Exception: #{e.message}"
+    # e.backtrace.each do |line|
+    #   puts "\t#{line}"
+    # end
+  end
+end

data/lib/bunny/exceptions.rb

@@ -42,6 +42,18 @@ module Bunny
     end
   end
 
+  # Can indicate either a channel or connection-level issue
+  class NotAllowedError < Exception
+    attr_reader :connection, :connection_close
+
+    def initialize(message, connection, connection_close = nil)
+      super(message)
+
+      @connection       = connection
+      @connection_close = connection_close
+    end
+  end
+
 
   # Raised when TCP connection to RabbitMQ fails because of an unresolved
   # hostname, connectivity problem, etc

data/lib/bunny/session.rb

@@ -36,6 +36,10 @@ module Bunny
     DEFAULT_HEARTBEAT = :server
     # @private
     DEFAULT_FRAME_MAX = 131072
+    # 2^16 - 1, maximum representable signed 16 bit integer.
+    # @private
+    CHANNEL_MAX_LIMIT   = 65535
+    DEFAULT_CHANNEL_MAX = CHANNEL_MAX_LIMIT
 
     # backwards compatibility
     # @private
@@ -78,7 +82,7 @@ module Bunny
 
     # @return [Bunny::Transport]
     attr_reader :transport
-    attr_reader :status, :host, :port, :heartbeat, :user, :pass, :vhost, :frame_max, :threaded
+    attr_reader :status, :host, :port, :heartbeat, :user, :pass, :vhost, :frame_max, :channel_max, :threaded
     attr_reader :server_capabilities, :server_properties, :server_authentication_mechanisms, :server_locales
     attr_reader :default_channel
     attr_reader :channel_id_allocator
@@ -150,7 +154,9 @@ module Bunny
 
       # these are negotiated with the broker during the connection tuning phase
       @client_frame_max   = opts.fetch(:frame_max, DEFAULT_FRAME_MAX)
-      @client_channel_max = opts.fetch(:channel_max, 65536)
+      @client_channel_max = normalize_client_channel_max(opts.fetch(:channel_max, DEFAULT_CHANNEL_MAX))
+      # will be-renegotiated during connection tuning steps. MK.
+      @channel_max        = @client_channel_max
       @client_heartbeat   = self.heartbeat_from(opts)
 
       @client_properties   = opts[:properties] || DEFAULT_CLIENT_PROPERTIES
@@ -288,9 +294,10 @@ module Bunny
 
         maybe_shutdown_reader_loop
         close_transport
-
-        @status = :closed
       end
+
+      shut_down_all_consumer_work_pools!
+      @status = :closed
     end
     alias stop close
 
@@ -480,13 +487,14 @@ module Bunny
       if @transport.open?
         @transport.send_frame(AMQ::Protocol::Connection::Close.encode(200, "Goodbye", 0, 0))
 
-        maybe_shutdown_heartbeat_sender
-        @status   = :not_connected
-
         if sync
           @last_connection_close_ok = wait_on_continuations
         end
       end
+
+      shut_down_all_consumer_work_pools!
+      maybe_shutdown_heartbeat_sender
+      @status   = :not_connected
     end
 
     # Handles incoming frames and dispatches them.
@@ -508,6 +516,17 @@ module Bunny
         @last_connection_error = instantiate_connection_level_exception(method)
         @continuations.push(method)
 
+        begin
+          shut_down_all_consumer_work_pools!
+          maybe_shutdown_reader_loop
+        rescue ShutdownSignal => sse
+          # no-op
+        rescue Exception => e
+          @logger.warn "Caught an exception when cleaning up after receiving connection.close: #{e.message}"
+        ensure
+          close_transport
+        end
+
         @origin_thread.raise(@last_connection_error)
       when AMQ::Protocol::Connection::CloseOk then
         @last_connection_close_ok = method
@@ -647,6 +666,8 @@ module Bunny
                   UnexpectedFrame
                 when 506 then
                   ResourceError
+                when 530 then
+                  NotAllowedError
                 when 541 then
                   InternalError
                 else
@@ -938,7 +959,25 @@ module Bunny
         initialize_heartbeat_sender
       end
 
-      raise "could not open connection: server did not respond with connection.open-ok" unless connection_open_ok.is_a?(AMQ::Protocol::Connection::OpenOk)
+      unless connection_open_ok.is_a?(AMQ::Protocol::Connection::OpenOk)
+        if connection_open_ok.is_a?(AMQ::Protocol::Connection::Close)
+          e = instantiate_connection_level_exception(connection_open_ok)
+          begin
+            shut_down_all_consumer_work_pools!
+            maybe_shutdown_reader_loop
+          rescue ShutdownSignal => sse
+            # no-op
+          rescue Exception => e
+            @logger.warn "Caught an exception when cleaning up after receiving connection.close: #{e.message}"
+          ensure
+            close_transport
+          end
+
+          @origin_thread.raise(e)
+        else
+          raise "could not open connection: server did not respond with connection.open-ok but #{connection_open_ok.inspect} instead"
+        end
+      end
     end
 
     def heartbeat_disabled?(val)
@@ -958,6 +997,7 @@ module Bunny
 
     # @private
     def initialize_heartbeat_sender
+      maybe_shutdown_heartbeat_sender
       @logger.debug "Initializing heartbeat sender..."
       @heartbeat_sender = HeartbeatSender.new(@transport, @logger)
       @heartbeat_sender.start(@heartbeat)
@@ -1038,6 +1078,24 @@ module Bunny
         Logger::WARN
       end
     end
+
+    # @private
+    def shut_down_all_consumer_work_pools!
+      @channels.each do |_, ch|
+        ch.maybe_kill_consumer_work_pool!
+      end
+    end
+
+    def normalize_client_channel_max(n)
+      return CHANNEL_MAX_LIMIT if n > CHANNEL_MAX_LIMIT
+
+      case n
+      when 0 then
+        CHANNEL_MAX_LIMIT
+      else
+        n
+      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.1.0.pre1"
+  VERSION = "1.1.0.pre2"
 end

data/spec/higher_level_api/integration/connection_spec.rb

@@ -147,6 +147,25 @@ describe Bunny::Session do
       end
     end
 
+    context "initialized with :channel_max => 4096" do
+      after :each do
+        subject.close if subject.open?
+      end
+
+      let(:channel_max) { 1024 }
+      let(:subject)     { described_class.new(:channel_max => channel_max) }
+
+      # this assumes RabbitMQ has no lower value configured. In 3.2
+      # it is 0 (no limit) by default and 1024 is still a fairly low value
+      # for future releases. MK.
+      it "negotiates channel max to be 1024" do
+        subject.start
+        subject.channel_max.should == channel_max
+
+        subject.close
+      end
+    end
+
     context "initialized with :ssl => true" do
       let(:subject) do
         described_class.new(:user     => "bunny_gem",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bunny
 version: !ruby/object:Gem::Version
-  version: 1.1.0.pre1
+  version: 1.1.0.pre2
 platform: ruby
 authors:
 - Chris Duncan
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-18 00:00:00.000000000 Z
+date: 2013-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amq-protocol
@@ -20,14 +20,14 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 1.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 1.9.0
 description: Easy to use, feature complete Ruby client for RabbitMQ 2.0 and later
   versions.
 email:
@@ -67,6 +67,7 @@ files:
 - examples/connection/automatic_recovery_with_basic_get.rb
 - examples/connection/automatic_recovery_with_client_named_queues.rb
 - examples/connection/automatic_recovery_with_multiple_consumers.rb
+- examples/connection/automatic_recovery_with_republishing.rb
 - examples/connection/automatic_recovery_with_server_named_queues.rb
 - examples/connection/channel_level_exception.rb
 - examples/connection/disabled_automatic_recovery.rb
@@ -224,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.6
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Popular easy to use Ruby client for RabbitMQ