bunny 1.0.0.pre3 → 1.0.0.pre4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42830e201dcbd08b5367454288ce79c6924ea0d4
-  data.tar.gz: 04005efee192cb86d4e7af17776e53e13712525b
+  metadata.gz: c1668fc7a45c060f60a853a68eab96a4f3a18b56
+  data.tar.gz: 36139657c1d1333fbc97cf070d588e4fe8bd2927
 SHA512:
-  metadata.gz: 6d1841d225856610228745312a60ae7e86cd175a40528902f2834aa1c51c548be68a74a481717127f8d4d15463670a4a7a80577983b7766ff841bcb51822a37c
-  data.tar.gz: 44dbd529f0b0d16ae0f3c115040a9b6879f85ef7e4da6668dbe869a10e5e2b752232828eec30b70292b1fd582e0876a8f9eeb420c81e6d05eb1ac22f9d1c8198
+  metadata.gz: dde418ea8694ed3c7755552d8f8eb43ca3afe3d8063ecf05e1fc359b8705fa6ef8c148a463d65426bbfa1dafea14979a4b0e9439296b106684b33dd590bf0d02
+  data.tar.gz: b825a7c0f8e3e0cdf1a44f46a4d6eac297a6f356f9e4ec153b3dc4301a499923eccf22e26c9a4079502d428f9a32887378f86669cd33cd9091e0597c00d9a639

data/.travis.yml

@@ -1,6 +1,6 @@
 bundler_args: --without development
 before_script: "./bin/ci/before_build.sh"
-script: "bundle exec rspec -c spec"
+script: "bundle exec rspec -cfs spec"
 rvm:
   - "2.0"
   - "1.9.3"
@@ -15,3 +15,6 @@ branches:
   only:
     - master
     - 0.9.x-stable
+matrix:
+  allow_failures:
+    - rvm: rbx-19mode

data/ChangeLog.md

@@ -1,3 +1,57 @@
+## Changes between Bunny 1.0.0.pre3 and 1.0.0.pre4
+
+### Default Paths for TLS/SSL CA's on Linux
+
+Bunny now will use the following TLS/SSL CA's paths on Linux by default:
+
+ * `/etc/ssl/certs/ca-certificates.crt` on Ubuntu/Debian
+ * `/etc/ssl/certs/ca-bundle.crt` on Amazon Linux
+ * `/etc/ssl/ca-bundle.pem` on OpenSUSE
+ * `/etc/pki/tls/certs/ca-bundle.crt` on Fedora/RHEL
+
+and will log a warning if no CA files are available via default paths
+or `:tls_ca_certificates`.
+
+Contributed by Carl Hörberg.
+
+### Consumers Can Be Re-Registered From Bunny::Consumer#handle_cancellation
+
+It is now possible to re-register a consumer (and use any other synchronous methods)
+from `Bunny::Consumer#handle_cancellation`, which is now invoked in the channel's
+thread pool.
+
+
+### Bunny::Session#close Fixed for Single Threaded Connections
+
+`Bunny::Session#close` with single threaded connections no longer fails
+with a nil pointer exception.
+
+
+
+## Changes between Bunny 1.0.0.pre2 and 1.0.0.pre3
+
+This release has **breaking API changes**.
+
+### Safe[r] basic.ack, basic.nack and basic.reject implementation
+
+Previously if a channel was recovered (reopened) by automatic connection
+recovery before a message was acknowledged or rejected, it would cause
+any operation on the channel that uses delivery tags to fail and
+cause the channel to be closed.
+
+To avoid this issue, every channel keeps a counter of how many times
+it has been reopened and marks delivery tags with them. Using a stale
+tag to ack or reject a message will produce no method sent to RabbitMQ.
+Note that unacknowledged messages will be requeued by RabbitMQ when connection
+goes down anyway.
+
+This involves an API change: `Bunny::DeliveryMetadata#delivery_tag` is now
+and instance of a class that responds to `#tag` and `#to_i` and is accepted
+by `Bunny::Channel#ack` and related methods.
+
+Integers are still accepted by the same methods.
+
+
 ## Changes between Bunny 1.0.0.pre1 and 1.0.0.pre2
 
 ### Exclusivity Violation for Consumers Now Raises a Reasonable Exception

data/README.md

@@ -79,7 +79,7 @@ backwards compatible as possible but within reason.
 
 ### With Rubygems
 
-To install Bunny 0.9.x with RubyGems:
+To install Bunny with RubyGems:
 
 ```
 gem install bunny
@@ -87,17 +87,17 @@ gem install bunny
 
 ### Bundler Dependency
 
-To use Bunny 0.9.x in a project managed with Bundler:
+To use Bunny in a project managed with Bundler:
 
 ``` ruby
-gem "bunny", ">= 0.9.3"
+gem "bunny", ">= 0.10.0"
 ```
 
 
-## Quick Start for Bunny 0.9.x
+## Quick Start
 
 Below is a small snippet that demonstrates how to publish
-and synchronously consume ("pull API") messages with Bunny 0.9.
+and synchronously consume ("pull API") messages with Bunny.
 
 For a 15 minute tutorial using more practical examples, see [Getting Started with RabbitMQ and Ruby using Bunny](http://rubybunny.info/articles/getting_started.html).
 

data/benchmarks/mutex_and_monitor.rb

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require "rubygems"
+require "set"
+require "thread"
+require "benchmark"
+require "monitor"
+
+puts
+puts "-" * 80
+puts "Benchmarking on #{RUBY_DESCRIPTION}"
+
+n  = 2_000_000
+mx = Mutex.new
+mt = Monitor.new
+
+# warm up the JIT, etc
+puts "Doing a warmup run..."
+n.times do |i|
+  mx.synchronize { 1 }
+  mt.synchronize { 1 }
+end
+
+t1  = Benchmark.realtime do
+  n.times do |i|
+    mx.synchronize { 1 }
+  end
+end
+r1  = (n.to_f/t1.to_f)
+
+t2  = Benchmark.realtime do
+  n.times do |i|
+    mt.synchronize { 1 }
+  end
+end
+r2  = (n.to_f/t2.to_f)
+
+puts "Mutex#synchronize, rate: #{(r1 / 1000).round(2)} KGHz"
+puts "Monitor#synchronize, rate: #{(r2 / 1000).round(2)} KGHz"
+puts
+puts "-" * 80

data/bunny.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.version = Bunny::VERSION.dup
   s.homepage = "http://rubybunny.info"
   s.summary = "Popular easy to use Ruby client for RabbitMQ"
-  s.description = "Easy to use, feature complete Ruby client for RabbitMQ 2.0."
+  s.description = "Easy to use, feature complete Ruby client for RabbitMQ 2.0 and later versions."
   s.license = "MIT"
 
   # Sorted alphabetically.
@@ -29,7 +29,7 @@ Gem::Specification.new do |s|
     map { |mail| Base64.decode64(mail) }
 
   # Dependencies
-  s.add_dependency "amq-protocol", ">= 1.6.0"
+  s.add_dependency "amq-protocol", ">= 1.7.0"
 
   # Files.
   s.has_rdoc = true

data/examples/guides/extensions/connection_blocked.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require "rubygems"
+require "bunny"
+
+puts "=> Demonstrating connection.blocked"
+puts
+
+conn = Bunny.new
+conn.start
+
+ch   = conn.create_channel
+x    = ch.fanout("amq.fanout")
+
+# This example requires high memory watermark to be set
+# really low to demonstrate blocking.
+#
+# rabbitmqctl set_vm_memory_high_watermark 0.00000001
+#
+# should do it.
+
+conn.on_blocked do |connection_blocked|
+  puts "Connection is blocked. Reason: #{connection_blocked.reason}"
+end
+
+conn.on_unblocked do |connection_unblocked|
+  puts "Connection is unblocked."
+end
+
+x.publish("z" * 1024 * 1024 * 16)
+
+sleep 120.0
+puts "Disconnecting..."
+conn.close

data/lib/bunny/channel.rb

@@ -843,6 +843,7 @@ module Bunny
 
       @last_basic_consume_ok
     end
+    alias consume basic_consume
 
     # Registers a consumer for queue as {Bunny::Consumer} instance.
     #
@@ -894,6 +895,7 @@ module Bunny
 
       @last_basic_consume_ok
     end
+    alias consume_with basic_consume_with
 
     # Removes a consumer. Messages for this consumer will no longer be delivered. If the queue
     # it was on is auto-deleted and this consumer was the last one, the queue will be deleted.
@@ -1538,10 +1540,17 @@ module Bunny
         @continuations.push(method)
       when AMQ::Protocol::Basic::Cancel then
         if consumer = @consumers[method.consumer_tag]
-          consumer.handle_cancellation(method)
+          @work_pool.submit do
+            begin
+              @consumers.delete(method.consumer_tag)
+              consumer.handle_cancellation(method)
+            rescue Exception => e
+              @logger.error "Got excepton when notifying consumer #{method.consumer_tag} about cancellation!"
+            end
+          end
+        else
+          @logger.warn "No consumer for tag #{method.consumer_tag} on channel #{@id}!"
         end
-
-        @consumers.delete(method.consumer_tag)
       when AMQ::Protocol::Basic::CancelOk then
         @continuations.push(method)
         unregister_consumer(method.consumer_tag)
@@ -1847,12 +1856,12 @@ module Bunny
     # @private
     def guarding_against_stale_delivery_tags(tag, &block)
       case tag
-      # if a fixnum was passed, execute unconditionally. MK.
+        # if a fixnum was passed, execute unconditionally. MK.
       when Fixnum then
         block.call
-      # versioned delivery tags should be checked to avoid
-      # sending out stale (invalid) tags after channel was reopened
-      # during network failure recovery. MK.
+        # versioned delivery tags should be checked to avoid
+        # sending out stale (invalid) tags after channel was reopened
+        # during network failure recovery. MK.
       when VersionedDeliveryTag then
         if !tag.stale?(@recoveries_counter.get)
           block.call

data/lib/bunny/exceptions.rb

@@ -55,7 +55,7 @@ module Bunny
           when Exception then
             e.message
           end
-      super("Could not estabilish TCP connection to #{hostname}:#{port}: #{m}")
+      super("Could not establish TCP connection to #{hostname}:#{port}: #{m}")
     end
   end
 
@@ -70,6 +70,9 @@ module Bunny
     end
   end
 
+  class ShutdownSignal < Exception
+  end
+
   # Raised when RabbitMQ closes TCP connection before finishing connection
   # sequence properly. This typically indicates an authentication issue.
   class PossibleAuthenticationFailureError < Exception

data/lib/bunny/reader_loop.rb

@@ -19,7 +19,6 @@ module Bunny
 
     def start
       @thread    = Thread.new(&method(:run_loop))
-      @thread.abort_on_exception = true
     end
 
     def resume
@@ -33,8 +32,10 @@ module Bunny
           break if @stopping || @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)
 
           @network_is_down = true
@@ -44,7 +45,10 @@ module Bunny
           else
             @session_thread.raise(Bunny::NetworkFailure.new("detected a network failure: #{e.message}", e))
           end
+        rescue ShutdownSignal => _
+          break
         rescue Exception => e
+          break if @stopping
           log_exception(e)
 
           @network_is_down = true
@@ -86,9 +90,19 @@ module Bunny
       @stopped
     end
 
+    def raise(e)
+      @thread.raise(e) if @thread
+    end
+
+    def join
+      @thread.join if @thread
+    end
+
     def kill
-      @thread.kill
-      @thread.join
+      if @thread
+        @thread.kill
+        @thread.join
+      end
     end
 
     def log_exception(e)

data/lib/bunny/session.rb

@@ -54,7 +54,8 @@ module Bunny
         :publisher_confirms         => true,
         :consumer_cancel_notify     => true,
         :exchange_exchange_bindings => true,
-        :"basic.nack"               => true
+        :"basic.nack"               => true,
+        :"connection.blocked"       => true
       },
       :product      => "Bunny",
       :platform     => ::RUBY_DESCRIPTION,
@@ -135,6 +136,7 @@ module Bunny
       @continuation_timeout      = opts.fetch(:continuation_timeout, DEFAULT_CONTINUATION_TIMEOUT)
 
       @status             = :not_connected
+      @blocked            = false
 
       # these are negotiated with the broker during the connection tuning phase
       @client_frame_max   = opts.fetch(:frame_max, DEFAULT_FRAME_MAX)
@@ -208,6 +210,9 @@ module Bunny
       return self if connected?
 
       @status        = :connecting
+      # reset here for cases when automatic network recovery kicks in
+      # when we were blocked. MK.
+      @blocked       = false
       self.reset_continuations
 
       begin
@@ -226,7 +231,7 @@ module Bunny
         self.open_connection
 
         @reader_loop = nil
-        self.start_reader_loop if @threaded
+        self.start_reader_loop if threaded?
 
         @default_channel = self.create_channel
       rescue Exception => e
@@ -342,6 +347,34 @@ module Bunny
       @default_channel.exchange(*args)
     end
 
+    # Defines a callback that will be executed when RabbitMQ blocks the connection
+    # because it is running low on memory or disk space (as configured via config file
+    # and/or rabbitmqctl).
+    #
+    # @yield [AMQ::Protocol::Connection::Blocked] connection.blocked method which provides a reason for blocking
+    #
+    # @api public
+    def on_blocked(&block)
+      @block_callback = block
+    end
+
+    # Defines a callback that will be executed when RabbitMQ unblocks the connection
+    # that was previously blocked, e.g. because the memory or disk space alarm has cleared.
+    #
+    # @see #on_blocked
+    # @api public
+    def on_unblocked(&block)
+      @unblock_callback = block
+    end
+
+    # @return [Boolean] true if the connection is currently blocked by RabbitMQ because it's running low on
+    #                   RAM, disk space, or other resource; false otherwise
+    # @see #on_blocked
+    # @see #on_unblocked
+    def blocked?
+      @blocked
+    end
+
 
     #
     # Implementation
@@ -418,6 +451,12 @@ module Bunny
         ensure
           @continuations.push(:__unblock__)
         end
+      when AMQ::Protocol::Connection::Blocked then
+        @blocked = true
+        @block_callback.call(method) if @block_callback
+      when AMQ::Protocol::Connection::Unblocked then
+        @blocked = false
+        @unblock_callback.call(method) if @unblock_callback
       when AMQ::Protocol::Channel::Close then
         begin
           ch = @channels[ch_number]
@@ -626,10 +665,23 @@ module Bunny
     def maybe_shutdown_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
+        if threaded?
+          # this is the easiest way to wait until the loop
+          # is guaranteed to have terminated
+          @reader_loop.raise(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.
+          # So we use this ugly hack or else our test suite takes forever
+          # to run on JRuby (a new connection is opened/closed per example). MK.
+          if RUBY_ENGINE == "jruby"
+            sleep 0.075
+          else
+            @reader_loop.join
+          end
+        else
+          # single threaded mode, nothing to do. MK.
+        end
       end
 
       @reader_loop = nil