bunny 1.1.5 → 1.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d6d07747ed59a23a5fbef7a6146cb8f0ff7438a
-  data.tar.gz: d6734646550b66ac0fa71e5c83f2e8575eb64c5a
+  metadata.gz: 36f1b18ef28b57485f1b419c8d5e325059b23769
+  data.tar.gz: f5ef937248905faf2040ff20b17fb9d72b492baa
 SHA512:
-  metadata.gz: fc90357a545277a52e7d2a889d434def74fadef182547b6572f4aca8639312be02b84fd7a2eb8691be86a144c74c5bcb592adc951bc52a43604041a0135128e1
-  data.tar.gz: 315c643ed31841055b93e1a8db3feb34ca7fe0023a2237dd6b7861e6b9236933d749bb90aaa96a0371a40248f02bc237963a7983a86057efc64d9ad0e22b492a
+  metadata.gz: 7a7f373fdb0ce3a05f3be3f39812cb20e69bf7a63011f4a66858650ff6783236600cde5fc8bad732f0b25df1e3810c99f12da31bbbec32b2dbf046907bec342e
+  data.tar.gz: 0347e24dfc932ae755d76672cb6b84828b2286b0790db0fc5c2eeda45f64dc70086776a9e397dc3581c9aeb4a8725cf924fa5249d4da1c89447d83141b056f2a

data/.travis.yml

@@ -3,7 +3,7 @@ bundler_args: --without development
 before_script: "./bin/ci/before_build.sh"
 script: "bundle exec rspec -cfs spec"
 rvm:
-  - "2.1.0-preview2"
+  - "2.1.0"
   - "2.0"
   - "1.9.3"
   - "jruby"
@@ -17,9 +17,10 @@ services:
 branches:
   only:
     - master
-    - 0.9.x-stable
+    - 1.1.x-stable
 matrix:
   allow_failures:
     - rvm: rbx
+    - rvm: "1.9.2"
     - rvm: "1.8.7"
     - rvm: jruby

data/ChangeLog.md

@@ -1,3 +1,16 @@
+## Changes between Bunny 1.1.5 and 1.1.6
+
+### Cherry-picked Missing Commit from Master
+
+`Bunny::Session#clean_up_on_shutdown` was cherry-picked from master.
+
+### Routing Key Limit
+
+Per AMQP 0-9-1 spec, routing keys cannot be longer than 255 characters.
+`Bunny::Channel#basic_publish` and `Bunny::Exchange#publish` now enforces
+this limit.
+
+
 ## Changes between Bunny 1.1.4 and 1.1.5
 
 ### Thread Leak Plugged
@@ -18,6 +31,7 @@ Contributed by Brian Abreu.
 
 ## Changes between Bunny 1.1.2 and 1.1.3
 
+
 ### Nagle's Algorithm Disabled Correctly
 
 Bunny now properly disables [Nagle's algorithm](http://boundary.com/blog/2012/05/02/know-a-delay-nagles-algorithm-and-you/)

data/Gemfile

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

data/README.md

@@ -92,7 +92,7 @@ gem install bunny
 To use Bunny in a project managed with Bundler:
 
 ``` ruby
-gem "bunny", "~> 1.0.4"
+gem "bunny", "~> 1.1.0"
 ```
 
 

data/examples/connection/automatic_recovery_with_client_named_queues.rb

@@ -27,7 +27,7 @@ loop do
   rk   = ["abc", "def"].sample
 
   begin
-    x.publish(rand.to_s, :routing_key => rk)
+    x.publish(data, :routing_key => rk)
     puts "Published #{data}, routing key: #{rk}"
   # happens when a message is published before the connection
   # is recovered

data/examples/consumers/high_and_low_priority.rb

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require "bundler"
+Bundler.setup
+
+$:.unshift(File.expand_path("../../../lib", __FILE__))
+
+require 'bunny'
+
+HIGH_PRIORITY_Q = "bunny.examples.priority.hilo.high"
+LOW_PRIORITY_Q  = "bunny.examples.priority.hilo.low"
+
+conn = Bunny.new(:heartbeat_interval => 8)
+conn.start
+
+ch1  = conn.create_channel
+ch2  = conn.create_channel
+hi_q = ch1.queue(HIGH_PRIORITY_Q, :durable => false)
+lo_q = ch2.queue(LOW_PRIORITY_Q,  :durable => false)
+
+ch3  = conn.create_channel
+x    = ch3.default_exchange
+
+# create a backlog of low priority messages
+30.times do
+  x.publish(rand.to_s, :routing_key => LOW_PRIORITY_Q)
+end
+
+# and a much smaller one of high priority messages
+3.times do
+  x.publish(rand.to_s, :routing_key => HIGH_PRIORITY_Q)
+end
+
+hi_q.subscribe do |delivery_info, metadata, payload|
+  puts "[high] Consumed #{payload}"
+end
+
+lo_q.subscribe do |delivery_info, metadata, payload|
+  puts "[low] Consumed #{payload}"
+end
+
+loop do
+  sleep 0.5
+  data = rand.to_s
+  rk   = [HIGH_PRIORITY_Q, LOW_PRIORITY_Q].sample
+
+  x.publish(data, :routing_key => rk)
+  puts "Published #{data}, routing key: #{rk}"
+end

data/lib/bunny/channel.rb

@@ -158,6 +158,7 @@ module Bunny
     attr_reader :consumers
 
     DEFAULT_CONTENT_TYPE = "application/octet-stream".freeze
+    SHORTSTR_LIMIT = 255
 
     # @param [Bunny::Session] connection AMQP 0.9.1 connection
     # @param [Integer] id Channel id, pass nil to make Bunny automatically allocate it
@@ -516,6 +517,7 @@ module Bunny
     # @api public
     def basic_publish(payload, exchange, routing_key, opts = {})
       raise_if_no_longer_open!
+      raise ArgumentError, "routing key cannot be longer than #{SHORTSTR_LIMIT} characters" if routing_key && routing_key.size > SHORTSTR_LIMIT
 
       exchange_name = if exchange.respond_to?(:name)
                         exchange.name
@@ -1505,6 +1507,16 @@ module Bunny
       @recoveries_counter.increment
     end
 
+    # @api public
+    def recover_cancelled_consumers!
+      @recover_cancelled_consumers = true
+    end
+
+    # @api public
+    def recovers_cancelled_consumers?
+      !!@recover_cancelled_consumers
+    end
+
     # @endgroup
 
 
@@ -1575,8 +1587,15 @@ module Bunny
         if consumer = @consumers[method.consumer_tag]
           @work_pool.submit do
             begin
-              @consumers.delete(method.consumer_tag)
-              consumer.handle_cancellation(method)
+              if recovers_cancelled_consumers?
+                consumer.handle_cancellation(method)
+                @logger.info "Automatically recovering cancelled consumer #{consumer.consumer_tag} on queue #{consumer.queue_name}"
+
+                consume_with(consumer)
+              else
+                @consumers.delete(method.consumer_tag)
+                consumer.handle_cancellation(method)
+              end
             rescue Exception => e
               @logger.error "Got exception when notifying consumer #{method.consumer_tag} about cancellation!"
               @uncaught_exception_handler.call(e, consumer) if @uncaught_exception_handler

data/lib/bunny/consumer.rb

@@ -39,6 +39,8 @@ module Bunny
       @arguments     = arguments
       # no_ack set to true = no manual ack = automatic ack. MK.
       @no_ack        = no_ack
+
+      @on_cancellation = []
     end
 
     # Defines message delivery handler
@@ -61,14 +63,16 @@ module Bunny
     # @see http://rubybunny.info/articles/extensions.html RabbitMQ Extensions guide
     # @api public
     def on_cancellation(&block)
-      @on_cancellation = block
+      @on_cancellation << block
       self
     end
 
     # Invokes consumer cancellation notification handler
     # @private
     def handle_cancellation(basic_cancel)
-      @on_cancellation.call(basic_cancel) if @on_cancellation
+      @on_cancellation.each do |fn|
+        fn.call(basic_cancel)
+      end
     end
 
     # Cancels this consumer. Messages for this consumer will no longer be delivered. If the queue
@@ -102,6 +106,16 @@ module Bunny
       @no_ack == false
     end
 
+    # @return [String] Name of the queue this consumer is on
+    # @api public
+    def queue_name
+      if @queue.respond_to?(:name)
+        @queue.name
+      else
+        @queue
+      end
+    end
+
     #
     # Recovery
     #
@@ -110,14 +124,5 @@ module Bunny
     def recover_from_network_failure
       @channel.basic_consume_with(self)
     end
-
-    # @private
-    def queue_name
-      if @queue.respond_to?(:name)
-        @queue.name
-      else
-        @queue
-      end
-    end
   end
 end

data/lib/bunny/session.rb

@@ -146,6 +146,7 @@ module Bunny
                                  opts[:automatically_recover] || opts[:automatic_recovery]
                                end
       @network_recovery_interval = opts.fetch(:network_recovery_interval, DEFAULT_NETWORK_RECOVERY_INTERVAL)
+      @recover_from_connection_close = opts.fetch(:recover_from_connection_close, false)
       # in ms
       @continuation_timeout      = opts.fetch(:continuation_timeout, DEFAULT_CONTINUATION_TIMEOUT)
 
@@ -219,6 +220,11 @@ module Bunny
       @transport.configure_socket(&block)
     end
 
+    # @return [Integer] Client socket port
+    def local_port
+      @transport.local_address.ip_port
+    end
+
     # Starts the connection process.
     #
     # @see http://rubybunny.info/articles/getting_started.html
@@ -519,21 +525,13 @@ module Bunny
       when AMQ::Protocol::Channel::CloseOk then
         @continuations.push(method)
       when AMQ::Protocol::Connection::Close then
-        @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
+        if recover_from_connection_close?
+          @logger.warn "Recovering from connection.close (#{method.reply_text})"
+          clean_up_on_shutdown
+          handle_network_failure(instantiate_connection_level_exception(method))
+        else
+          clean_up_and_fail_on_connection_close!(method)
         end
-
-        @origin_thread.raise(@last_connection_error)
       when AMQ::Protocol::Connection::CloseOk then
         @last_connection_close_ok = method
         begin
@@ -590,6 +588,11 @@ module Bunny
       end
     end
 
+    # @private
+    def recover_from_connection_close?
+      @recover_from_connection_close
+    end
+
     # @private
     def handle_network_failure(exception)
       raise NetworkErrorWrapper.new(exception) unless @threaded
@@ -597,17 +600,21 @@ module Bunny
       @status = :disconnected
 
       if !recovering_from_network_failure?
-        @recovering_from_network_failure = true
-        if recoverable_network_failure?(exception)
-          @logger.warn "Recovering from a network failure..."
-          @channels.each do |n, ch|
-            ch.maybe_kill_consumer_work_pool!
+        begin
+          @recovering_from_network_failure = true
+          if recoverable_network_failure?(exception)
+            @logger.warn "Recovering from a network failure..."
+            @channels.each do |n, ch|
+              ch.maybe_kill_consumer_work_pool!
+            end
+            maybe_shutdown_heartbeat_sender
+
+            recover_from_network_failure
+          else
+            # TODO: investigate if we can be a bit smarter here. MK.
           end
-          maybe_shutdown_heartbeat_sender
-
-          recover_from_network_failure
-        else
-          # TODO: investigate if we can be a bit smarter here. MK.
+        ensure
+          @recovering_from_network_failure = false
         end
       end
     end
@@ -684,6 +691,27 @@ module Bunny
       end
     end
 
+    def clean_up_and_fail_on_connection_close!(method)
+      @last_connection_error = instantiate_connection_level_exception(method)
+      @continuations.push(method)
+
+      clean_up_on_shutdown
+      @origin_thread.raise(@last_connection_error)
+    end
+
+    def clean_up_on_shutdown
+      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
+    end
+
     # @private
     def hostname_from(options)
       options[:host] || options[:hostname] || DEFAULT_HOST

data/lib/bunny/transport.rb

@@ -55,6 +55,10 @@ module Bunny
       @host
     end
 
+    def local_address
+      @socket.local_address
+    end
+
     def uses_tls?
       @tls_enabled
     end

data/lib/bunny/version.rb

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

data/spec/higher_level_api/integration/basic_publish_spec.rb

@@ -87,3 +87,77 @@ if RUBY_VERSION <= "1.9"
     end
   end
 end
+
+
+describe "Published message" do
+  let(:connection) do
+    c = Bunny.new(:user => "bunny_gem", :password => "bunny_password", :vhost => "bunny_testbed")
+    c.start
+    c
+  end
+
+  after :each do
+    connection.close if connection.open?
+  end
+
+  context "with all default delivery and a 254 character long routing key" do
+    it "routes the messages" do
+      ch = connection.create_channel
+
+      q  = ch.queue("", :exclusive => true)
+      x  = ch.fanout("amq.fanout")
+      q.bind(x)
+
+      rk = "a" * 254
+      x.publish("xyzzy", :routing_key => rk, :persistent => true)
+
+      sleep(1)
+      q.message_count.should == 1
+
+      _, _, payload = q.pop
+
+      payload.should == "xyzzy"
+
+      ch.close
+    end
+  end
+
+  context "with all default delivery and a 255 character long routing key" do
+    it "routes the messages" do
+      ch = connection.create_channel
+
+      q  = ch.queue("", :exclusive => true)
+      x  = ch.fanout("amq.fanout")
+      q.bind(x)
+
+      rk = "a" * 255
+      x.publish("xyzzy", :routing_key => rk, :persistent => true)
+
+      sleep(1)
+      q.message_count.should == 1
+
+      _, _, payload = q.pop
+
+      payload.should == "xyzzy"
+
+      ch.close
+    end
+  end
+
+  context "with all default delivery and a 256 character long routing key" do
+    it "fails with a connection exception" do
+      ch = connection.create_channel
+
+      q  = ch.queue("", :exclusive => true)
+      x  = ch.fanout("amq.fanout")
+      q.bind(x)
+
+      rk = "a" * 256
+      expect do
+        x.publish("xyzzy", :routing_key => rk, :persistent => true)
+      end.to raise_error(ArgumentError)
+
+      ch.close
+    end
+  end
+end

data/spec/higher_level_api/integration/connection_stop_spec.rb

@@ -1,6 +1,20 @@
 require "spec_helper"
 
 describe Bunny::Session do
+  let(:http_client) { RabbitMQ::HTTP::Client.new("http://127.0.0.1:15672") }
+
+  def close_connection(client_port)
+    c = http_client.
+      list_connections.
+      find   { |conn_info| conn_info.peer_port.to_i == client_port }
+
+    http_client.close_connection(c.name)
+  end
+
+  def wait_for_recovery
+    sleep 0.5
+  end
+
   it "can be closed" do
     c  = Bunny.new(:automatically_recover => false)
     c.start
@@ -10,17 +24,48 @@ describe Bunny::Session do
     c.stop
     c.should be_closed
   end
-end
-
 
-describe Bunny::Session, "in a single threaded mode" do
-  it "can be closed" do
-    c  = Bunny.new(:automatically_recover => false, :threaded => false)
+  it "can be closed twice (Session#close is idempotent)" do
+    c  = Bunny.new(:automatically_recover => false)
     c.start
     ch = c.create_channel
 
     c.should be_connected
     c.stop
     c.should be_closed
+    c.stop
+    c.should be_closed
+  end
+
+  describe "in a single threaded mode" do
+    it "can be closed" do
+      c  = Bunny.new(:automatically_recover => false, :threaded => false)
+      c.start
+      ch = c.create_channel
+
+      c.should be_connected
+      c.stop
+      c.should be_closed
+    end
+  end
+
+
+  describe "that recovers from connection.close" do
+    it "can be closed" do
+      c  = Bunny.new(:automatically_recover => false, :recover_from_connection_close => true, :network_recovery_interval => 0.2)
+      c.start
+      ch = c.create_channel
+
+      c.should be_open
+      close_connection(c.local_port)
+      sleep 0.2
+      c.should_not be_open
+
+      wait_for_recovery
+      c.should be_open
+      ch.should be_open
+
+      c.close
+    end
   end
 end

data/spec/lower_level_api/integration/basic_cancel_spec.rb

@@ -66,4 +66,19 @@ describe Bunny::Channel, "#basic_cancel" do
       ch.close
     end
   end
+
+  context "when the given consumer tag belongs to a different channel" do
+    it "DOES NOT cause a channel error" do
+      ch1 = connection.create_channel
+      ch2 = connection.create_channel
+
+      q    = ch1.queue("", :exclusive => true)
+      cons = q.subscribe do |_, _, _|
+      end
+      ch2.basic_cancel(cons.consumer_tag)
+
+      ch1.close
+      ch2.close
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -8,6 +8,7 @@ Bundler.setup(:default, :test)
 
 require "effin_utf8"
 require "bunny"
+require "rabbitmq/http/client"
 
 
 require "amq/protocol/version"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bunny
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: 1.1.6
 platform: ruby
 authors:
 - Chris Duncan
@@ -75,6 +75,7 @@ files:
 - examples/connection/manually_reconnecting_consumer.rb
 - examples/connection/manually_reconnecting_publisher.rb
 - examples/connection/unknown_host.rb
+- examples/consumers/high_and_low_priority.rb
 - examples/guides/exchanges/direct_exchange_routing.rb
 - examples/guides/exchanges/fanout_exchange_routing.rb
 - examples/guides/exchanges/headers_exchange_routing.rb