bunny 2.9.2 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10f9758e67c181d0b2066f29dae89a4eec11ca8f
-  data.tar.gz: 2f515bc91583877f6a13fa33085ed0069260fcdb
+  metadata.gz: a1383ed91ffd30856f2d5a7581dcc0c4110c072b
+  data.tar.gz: d90f995da1275458c90e2659a005aaa555a53300
 SHA512:
-  metadata.gz: 5ef6792e9f0d3ee42eeee11cac8dd0d758dc43f126fcbc1c8989d185c714bdce35120d6422c340f389acc4441a7f07a1fe53aacabf2f3eba23ccd43afffb7156
-  data.tar.gz: 83ca932cf5981a08e6c1fe561f6762b95c61a07968a6b60770f88a6124184d58692f8a13bf66c422734471c49b5bd6c35ec021eda5b87620cf13fdf3190ab2f3
+  metadata.gz: 2de02f1c102d95da9137f4348f1e4897d2848cb2851f6fb51ebae28cf48b39c103c87b3faffc05b6b98db2482aab8c8a765204f9ce8d264ebe23feb34ba8913b
+  data.tar.gz: 3a1807d8219e9a006176ffeccba1120d5b3f6d237db750cfcd50ae7f5951d1481ffa90bec94dc700fc2f221aefe110da84910ab381a473ca7851ad127b6cacc3

data/.travis.yml

@@ -1,13 +1,16 @@
 language: ruby
 bundler_args: --without development
 cache: bundler
+before_install:
+  - gem install bundler
 before_script: "./bin/ci/before_build"
 script: "bundle exec rake integration_without_recovery"
 rvm:
   - ruby-head
-  - "2.4.1"
-  - "2.3.4"
-  - "2.2.7"
+  - "2.5.1"
+  - "2.4.2"
+  - "2.3.5"
+  - "2.2.8"
 notifications:
   email: michael@rabbitmq.com
 services:
@@ -15,6 +18,11 @@ services:
 branches:
   only:
     - master
-    - 2.6.x-stable
+    - 2.9.x-stable
+    - 2.8.x-stable
 env:
   - CI=true
+matrix:
+  allow_failures:
+    rvm:
+      - ruby-head

data/ChangeLog.md

@@ -1,13 +1,68 @@
-## Changes between Bunny 2.9.1 and 2.9.2 (unreleased)
+## Changes between Bunny 2.10.0 and 2.11.0 (unreleased)
 
 No changes yet.
 
 
-## Changes between Bunny 2.9.0 and 2.9.1 (Jan 11th, 2018)
+## Changes between Bunny 2.9.0 and 2.10.0 (Jun 5th, 2018)
 
-### Default CA Certificate Paths are Respected Again
+`2.10.0` is a maintenance release that introduces a couple of
+**minor potentially breaking changes**.
 
-GitHub issue: [#539](https://github.com/ruby-amqp/bunny/issues/539).
+### Disabling Heartbeats Also Disables TCP Socket Read Timeouts
+
+Disabling heartbeats will now disable TCP socket read timeouts.
+
+They go hand in hand and users who prefer TCP keepalives via
+kernel configuration previously had to also explicitly configure
+a zero read timeout.
+
+GitHub issue: [#551](https://github.com/ruby-amqp/bunny/pull/551).
+
+Contributed by Carl Hörberg.
+
+
+### `verify_peer: false` Has the Expected Effect Again
+
+Make sure `verify_peer: false` has the expected effect again.
+
+Default value of connection's `:verify_peer` option to `true` only when
+all of `:verify_ssl`, `:verify_peer`, and `:verify` are `nil`.
+
+GitHub issue: [#541](https://github.com/ruby-amqp/bunny/issues/541).
+
+Contributed by Howard Ding.
+
+
+### Maximum Number of Channels Limited to 2K by Default
+
+Default maximum number of channels is limited to 2047 to reduce the probability
+of severe channel leaks. See [rabbitmq/rabbitmq-server#1593](https://github.com/rabbitmq/rabbitmq-server/issues/1593) for details.
+
+Applications that want to use more channels per connection can still configure a higher value
+using the `channel_max` setting (for both Bunny and RabbitMQ server).
+
+GitHub issue: [#553](https://github.com/ruby-amqp/bunny/pull/553).
+
+
+
+### Squashed Some Warnings
+
+GitHub issue: [#552](https://github.com/ruby-amqp/bunny/pull/552).
+
+Contributed by @utilum.
+
+
+
+### Disabling Heartbeats Disables TCP Socket Read Timeouts
+
+Disabling heartbeats will also disable TCP socket read timeouts,
+since the two are effectively interconnected. In this case a mechanism
+such as [TCP keepalives](http://www.rabbitmq.com/heartbeats.html#tcp-keepalives) is assumed to be used.
+
+See [RabbitMQ heartbeats guide](http://www.rabbitmq.com/heartbeats.html) for a more
+detailed overview of the options.
+
+GH issue: [#519](https://github.com/ruby-amqp/bunny/issues/519).
 
 Contributed by Carl Hörberg.
 
@@ -19,12 +74,23 @@ Contributed by Carl Hörberg.
 Bunny now requires Ruby 2.2.
 
 
-### Support for Additional URI Query Parameters
+### Connection Recovery Now Retries on Timeouts
+
+Connection recovery now will retry on TCP connection timeouts.
+
+GitHub issue: [#537](https://github.com/ruby-amqp/bunny/pull/537).
 
-GitHub issue: [#534](https://github.com/ruby-amqp/bunny/pull/534).
+
+### More URI Query Parameters
+
+Bunny now supports more URI query parameters plus aliases
+that are identical to those of the server.
 
 Contributed by Andrew Babichev.
 
+GitHub issue: [#534](https://github.com/ruby-amqp/bunny/pull/534)
+
+
 
 ## Changes between Bunny 2.7.0 and 2.8.0 (Dec 18th, 2018)
 

data/README.md

@@ -48,7 +48,7 @@ Specific examples:
 
 Modern Bunny versions support
 
- * CRuby 2.0 through 2.4
+ * CRuby 2.2 through 2.5 (inclusive)
 
 Bunny works sufficiently well on JRuby but there are known
 JRuby bugs in versions prior to JRuby 9000 that cause high CPU burn. JRuby users should
@@ -95,7 +95,7 @@ gem install bunny
 To use Bunny in a project managed with Bundler:
 
 ``` ruby
-gem "bunny", ">= 2.8.0"
+gem "bunny", ">= 2.9.2"
 ```
 
 

data/lib/bunny/channel.rb

@@ -169,6 +169,17 @@ module Bunny
       @connection = connection
       @logger     = connection.logger
       @id         = id || @connection.next_channel_id
+
+      # channel allocator is exhausted
+      if @id < 0
+        msg = "Cannot open a channel: max number of channels on connection reached. Connection channel_max value: #{@connection.channel_max}"
+        @logger.error(msg)
+
+        raise msg
+      else
+        @logger.debug { "Allocated channel id: #{@id}" }
+      end
+
       @status     = :opening
 
       @connection.register_channel(self)

data/lib/bunny/channel_id_allocator.rb

@@ -17,7 +17,9 @@ module Bunny
     #
 
     # @param [Integer] max_channel Max allowed channel id
-    def initialize(max_channel = ((1 << 16) - 1))
+    def initialize(max_channel = ((1 << 11) - 1))
+      # channel 0 has special meaning in the protocol, so start
+      # allocator at 1
       @allocator = AMQ::IntAllocator.new(1, max_channel)
       @mutex     = Monitor.new
     end

data/lib/bunny/cruby/ssl_socket.rb

@@ -107,7 +107,7 @@ module Bunny
       end
 
     end
-  rescue LoadError => le
+  rescue LoadError
     puts "Could not load OpenSSL"
   end
 end

data/lib/bunny/session.rb

@@ -36,10 +36,10 @@ module Bunny
     DEFAULT_HEARTBEAT = :server
     # @private
     DEFAULT_FRAME_MAX = 131072
-    # 2^16 - 1, maximum representable signed 16 bit integer.
+    # Hard limit the user cannot go over regardless of server configuration.
     # @private
     CHANNEL_MAX_LIMIT   = 65535
-    DEFAULT_CHANNEL_MAX = CHANNEL_MAX_LIMIT
+    DEFAULT_CHANNEL_MAX = 2047
 
     # backwards compatibility
     # @private
@@ -101,7 +101,7 @@ module Bunny
     # @option connection_string_or_opts [String] :username ("guest") Username
     # @option connection_string_or_opts [String] :password ("guest") Password
     # @option connection_string_or_opts [String] :vhost ("/") Virtual host to use
-    # @option connection_string_or_opts [Integer, Symbol] :heartbeat (:server) Heartbeat interval. :server means use the default suggested by RabbitMQ. 0 means no heartbeat (not recommended).
+    # @option connection_string_or_opts [Integer, Symbol] :heartbeat (:server) Heartbeat interval. :server means use the default suggested by RabbitMQ. 0 means heartbeats and socket read timeouts will be disabled (not recommended).
     # @option connection_string_or_opts [Integer] :network_recovery_interval (4) Recovery interval periodic network recovery will use. This includes initial pause after network failure.
     # @option connection_string_or_opts [Boolean] :tls (false) Should TLS/SSL be used?
     # @option connection_string_or_opts [String] :tls_cert (nil) Path to client TLS/SSL certificate file (.pem)
@@ -109,9 +109,10 @@ module Bunny
     # @option connection_string_or_opts [Array<String>] :tls_ca_certificates Array of paths to TLS/SSL CA files (.pem), by default detected from OpenSSL configuration
     # @option connection_string_or_opts [String] :verify_peer (true) Whether TLS peer verification should be performed
     # @option connection_string_or_opts [Symbol] :tls_version (negotiated) What TLS version should be used (:TLSv1, :TLSv1_1, or :TLSv1_2)
+    # @option connection_string_or_opts [Integer] :channel_max (2047) Maximum number of channels allowed on this connection, minus 1 to account for the special channel 0.
     # @option connection_string_or_opts [Integer] :continuation_timeout (15000) Timeout for client operations that expect a response (e.g. {Bunny::Queue#get}), in milliseconds.
     # @option connection_string_or_opts [Integer] :connection_timeout (30) Timeout in seconds for connecting to the server.
-    # @option connection_string_or_opts [Integer] :read_timeout (30) TCP socket read timeout in seconds.
+    # @option connection_string_or_opts [Integer] :read_timeout (30) TCP socket read timeout in seconds. If heartbeats are disabled this will be ignored.
     # @option connection_string_or_opts [Integer] :write_timeout (30) TCP socket write timeout in seconds.
     # @option connection_string_or_opts [Proc] :hosts_shuffle_strategy A Proc that reorders a list of host strings, defaults to Array#shuffle
     # @option connection_string_or_opts [Logger] :logger The logger.  If missing, one is created using :log_file and :log_level.
@@ -1068,7 +1069,9 @@ module Bunny
       # threads publish on the same channel aggressively, at some point frames will be
       # delivered out of order and broker will raise 505 UNEXPECTED_FRAME exception.
       # If we synchronize on the channel, however, this is both thread safe and pretty fine-grained
-      # locking. Note that "single frame" methods do not need this kind of synchronization. MK.
+      # locking. Note that "single frame" methods technically do not need this kind of synchronization
+      # (no incorrect frame interleaving of the same kind as with basic.publish isn't possible) but we
+      # still recommend not sharing channels between threads except for consumer-only cases in the docs. MK.
       channel.synchronize do
         # see rabbitmq/rabbitmq-server#156
         data = frames.reduce("") { |acc, frame| acc << frame.encode }
@@ -1087,7 +1090,7 @@ module Bunny
       # threads publish on the same channel aggressively, at some point frames will be
       # delivered out of order and broker will raise 505 UNEXPECTED_FRAME exception.
       # If we synchronize on the channel, however, this is both thread safe and pretty fine-grained
-      # locking. Note that "single frame" methods do not need this kind of synchronization. MK.
+      # locking. See a note about "single frame" methods in a comment in `send_frameset`. MK.
       channel.synchronize do
         frames.each { |frame| self.send_frame_without_timeout(frame, false) }
         signal_activity!
@@ -1177,26 +1180,18 @@ module Bunny
       @logger.debug { "Heartbeat interval negotiation: client = #{@client_heartbeat}, server = #{connection_tune.heartbeat}, result = #{@heartbeat}" }
       @logger.info "Heartbeat interval used (in seconds): #{@heartbeat}"
 
-      # We set the read_write_timeout to twice the heartbeat value
+      # We set the read_write_timeout to twice the heartbeat value,
+      # and then some padding for edge cases.
       # This allows us to miss a single heartbeat before we time out the socket.
-      #
-      # Since RabbitMQ can be configured to disable heartbeats (bad idea but technically
-      # possible nonetheless), we need to take both client and server values into
-      # consideration when deciding about using the heartbeat value for read timeouts.
-      @transport.read_timeout = if heartbeat_disabled?(@client_heartbeat) || heartbeat_disabled?(@heartbeat)
-                                  @logger.debug { "Will use default socket read timeout of #{Transport::DEFAULT_READ_TIMEOUT}" }
-                                  Transport::DEFAULT_READ_TIMEOUT
-                                else
-                                  # pad to account for edge cases. MK.
-                                  n = @heartbeat * 2.2
-                                  @logger.debug { "Will use socket read timeout of #{n}" }
-                                  n
-                                end
-
+      # If heartbeats are disabled, assume that TCP keepalives or a similar mechanism will be used
+      # and disable socket read timeouts. See ruby-amqp/bunny#551.
+      @transport.read_timeout = @heartbeat * 2.2
+      @logger.debug { "Will use socket read timeout of #{@transport.read_timeout}" }
 
       # if there are existing channels we've just recovered from
       # a network failure and need to fix the allocated set. See issue 205. MK.
       if @channels.empty?
+        @logger.debug { "Initializing channel ID allocator with channel_max = #{@channel_max}" }
         @channel_id_allocator = ChannelIdAllocator.new(@channel_max)
       end
 

data/lib/bunny/transport.rb

@@ -29,6 +29,10 @@ module Bunny
     attr_reader :tls_context, :verify_peer, :tls_ca_certificates, :tls_certificate_path, :tls_key_path
 
     attr_writer :read_timeout
+    def read_timeout=(v)
+      @read_timeout = v
+      @read_timeout = nil if @read_timeout == 0
+    end
 
     def initialize(session, host, port, opts)
       @session        = session

data/lib/bunny/version.rb

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

data/spec/higher_level_api/integration/tls_connection_spec.rb

@@ -1,6 +1,8 @@
 # -*- coding: utf-8 -*-
 require "spec_helper"
 
+require "socket"
+
 unless ENV["CI"]
   CERTIFICATE_DIR = ENV.fetch("BUNNY_CERTIFICATE_DIR", "./spec/tls")
   puts "Will use certificates from #{CERTIFICATE_DIR}"
@@ -35,7 +37,7 @@ unless ENV["CI"]
   end
 
   def local_hostname
-    ENV.fetch("BUNNY_RABBITMQ_HOSTNAME", "127.0.0.1")
+    ENV.fetch("BUNNY_RABBITMQ_HOSTNAME", "localhost")
   end
 
   context "initialized with :tls => true" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bunny
 version: !ruby/object:Gem::Version
-  version: 2.9.2
+  version: 2.10.0
 platform: ruby
 authors:
 - Chris Duncan
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-22 00:00:00.000000000 Z
+date: 2018-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amq-protocol
@@ -232,7 +232,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Popular easy to use Ruby client for RabbitMQ