bunny 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c95090be1c7c3802f91e9bbde8a65145be46036
-  data.tar.gz: dba06fb978dcbdc3613e25dd6dc6d2ae6520e114
+  metadata.gz: 4513453ba83efb33a882a0360116c2d652deaeca
+  data.tar.gz: a5b1deb516b9a0798f02b394d78eabc3022e96ba
 SHA512:
-  metadata.gz: 33990cab5ebb80edd6c95b33da3e1c1c572830acc8fa9a2d177340ca88fd9a40907c68507505736096eb8595d64ffa23fd560633d9f50edc3068e7ec55806035
-  data.tar.gz: 209a580762f599be1a69ba24c6aab533891a54f5e55f82920e258bb886205c0e96849ad165b2a4a86f9bd3aed6be71f21b9aa4ecc5e6201edfb310396bf1380e
+  metadata.gz: 71f26786c44ac4580a48cacb604dbeed272bab27005bbb3d4dc0816e10d02679e23adcd671898a8a8f12727c0a63fec16a15dddf1764f16cd13bec8d8a867cd8
+  data.tar.gz: 3ac225508d9a2bc13b1e24f98bb879e8a4ce500340abff9362e28c1fe9e106eff44a5d6b818df65a432eb3f0d48db9ff6db4760c91041b16e9558ffc092dd6fe

data/ChangeLog.md

@@ -1,3 +1,18 @@
+## Changes between Bunny 2.1.0 and 2.2.0
+
+### Add :addresses to connect options
+
+Before this the connection options only allowed multiple hosts, an
+address is a combination of a host and a port. This makes it possible to
+specify different hosts with different ports.
+
+### Recover from connection.close by default
+
+Bunny will now try to reconnect also when server sent connection.close is
+received, e.g. when a server is restarting (but also when the connection is
+force closed by the server). This is in-line with how many other clients behave.
+The old default was `recover_from_connection_close: false`.
+
 ## Changes between Bunny 2.0.0 and 2.1.0
 
 Bunny 2.1.0 has an **important breaking change**. It is highly

data/README.md

@@ -68,14 +68,6 @@ Bunny `1.4.x` and earlier supports RabbitMQ 2.x and 3.x.
 Bunny is a mature library (started in early 2009) with
 a stable public API.
 
-Before version 0.9, **a lot** of functionality was missing.  Version
-0.9 can be considered to be a "second birthday" for Bunny as it was
-rewritten from scratch with over a dozen of preview releases over the
-course of about a year.
-
-We (the maintainers) made our best effort to keep the new version as
-backwards compatible as possible but within reason.
-
 
 ## Installation & Bundler Dependency
 
@@ -96,7 +88,7 @@ gem install bunny
 To use Bunny in a project managed with Bundler:
 
 ``` ruby
-gem "bunny", ">= 2.0.1"
+gem "bunny", ">= 2.1.0"
 ```
 
 

data/bunny.gemspec

@@ -21,13 +21,7 @@ Gem::Specification.new do |s|
     "Michael S. Klishin",
     "Stefan Kaes"]
 
-  s.email = [
-    "Y2VsbGRlZUBnbWFpbC5jb20=\n",
-    "ZXJpY0A1c3RvcHMuY29t\n",
-    "c3Rhc3RueUAxMDFpZGVhcy5jeg==\n",
-    "bWljaGFlbEBub3ZlbWJlcmFpbi5jb20=\n",
-    "c2thZXNAcmFpbHNleHByZXNzLmRl\n"].
-    map { |mail| Base64.decode64(mail) }
+  s.email = ["michael.s.klishin@gmail.com"]
 
   # Dependencies
   s.add_dependency "amq-protocol", ">= 2.0.0"

data/lib/bunny/consumer_work_pool.rb

@@ -19,6 +19,7 @@ module Bunny
     def initialize(size = 1)
       @size  = size
       @queue = ::Queue.new
+      @paused = false
     end
 
 
@@ -41,6 +42,14 @@ module Bunny
       @running
     end
 
+    def backlog
+      @queue.length
+    end
+
+    def busy?
+      !@queue.empty?
+    end
+
     def shutdown
       @running = false
 
@@ -57,12 +66,12 @@ module Bunny
 
     def pause
       @running = false
-
-      @threads.each { |t| t.stop }
+      @paused = true
     end
 
     def resume
       @running = true
+      @paused = false
 
       @threads.each { |t| t.run }
     end
@@ -78,6 +87,7 @@ module Bunny
     def run_loop
       catch(:terminate) do
         loop do
+          Thread.stop if @paused
           callable = @queue.pop
 
           begin

data/lib/bunny/session.rb

@@ -95,6 +95,7 @@ module Bunny
     #
     # @option connection_string_or_opts [String] :host ("127.0.0.1") Hostname or IP address to connect to
     # @option connection_string_or_opts [Array<String>] :hosts (["127.0.0.1"]) list of hostname or IP addresses to select hostname from when connecting
+    # @option connection_string_or_opts [Array<String>] :addresses (["127.0.0.1:5672"]) list of addresses to select hostname and port from when connecting
     # @option connection_string_or_opts [Integer] :port (5672) Port RabbitMQ listens on
     # @option connection_string_or_opts [String] :username ("guest") Username
     # @option connection_string_or_opts [String] :password ("guest") Password
@@ -113,8 +114,9 @@ module Bunny
     # @option connection_string_or_opts [IO, String] :log_file The file or path to use when creating a logger.  Defaults to STDOUT.
     # @option connection_string_or_opts [IO, String] :logfile DEPRECATED: use :log_file instead.  The file or path to use when creating a logger.  Defaults to STDOUT.
     # @option connection_string_or_opts [Integer] :log_level The log level to use when creating a logger.  Defaults to LOGGER::WARN
-    # @option connection_string_or_opts [Boolean] :automatically_recover Should automatically recover from network failures?
-    # @option connection_string_or_opts [Integer] :recovery_attempts Max number of recovery attempts
+    # @option connection_string_or_opts [Boolean] :automatically_recover (true) Should automatically recover from network failures?
+    # @option connection_string_or_opts [Integer] :recovery_attempts (nil) Max number of recovery attempts, nil means forever, 0 means never
+    # @option connection_string_or_opts [Boolean] :recover_from_connection_close (true) Recover from server-sent connection.close
     #
     # @option optz [String] :auth_mechanism ("PLAIN") Authentication mechanism, PLAIN or EXTERNAL
     # @option optz [String] :locale ("PLAIN") Locale RabbitMQ should use
@@ -135,10 +137,9 @@ module Bunny
       @default_hosts_shuffle_strategy = Proc.new { |hosts| hosts.shuffle }
 
       @opts            = opts
-      @hosts           = self.hostnames_from(opts)
-      @host_index      = 0
+      @addresses       = self.addresses_from(opts)
+      @address_index   = 0
 
-      @port            = self.port_from(opts)
       @user            = self.username_from(opts)
       @pass            = self.password_from(opts)
       @vhost           = self.vhost_from(opts)
@@ -148,6 +149,8 @@ module Bunny
       log_level        = opts[:log_level] || ENV["BUNNY_LOG_LEVEL"] || Logger::WARN
       @logger          = opts.fetch(:logger, init_default_logger(log_file, log_level))
 
+      validate_connection_options(opts)
+
       # should automatic recovery from network failures be used?
       @automatically_recover = if opts[:automatically_recover].nil? && opts[:automatic_recovery].nil?
                                  true
@@ -156,7 +159,7 @@ module Bunny
                                end
       @recovery_attempts     = opts[:recovery_attempts]
       @network_recovery_interval = opts.fetch(:network_recovery_interval, DEFAULT_NETWORK_RECOVERY_INTERVAL)
-      @recover_from_connection_close = opts.fetch(:recover_from_connection_close, false)
+      @recover_from_connection_close = opts.fetch(:recover_from_connection_close, true)
       # in ms
       @continuation_timeout   = opts.fetch(:continuation_timeout, DEFAULT_CONTINUATION_TIMEOUT)
 
@@ -183,7 +186,7 @@ module Bunny
       # the non-reentrant Ruby mutexes. MK.
       @transport_mutex     = @mutex_impl.new
       @status_mutex        = @mutex_impl.new
-      @host_index_mutex    = @mutex_impl.new
+      @address_index_mutex = @mutex_impl.new
 
       @channels            = Hash.new
 
@@ -193,6 +196,16 @@ module Bunny
       self.initialize_transport
     end
 
+    def validate_connection_options(options)
+      if options[:hosts] && options[:addresses]
+        raise ArgumentError, "Connection options can't contain hosts and addresses at the same time"
+      end
+
+      if (options[:host] || options[:hostname]) && (options[:hosts] || options[:addresses])
+        @logger.warn "The connection options contain both a host and an array of hosts, the single host is ignored."
+      end
+    end
+
     # @return [String] RabbitMQ hostname (or IP address) used
     def hostname;     self.host;  end
     # @return [String] Username used
@@ -223,11 +236,15 @@ module Bunny
     end
 
     def host
-      @transport ? @transport.host : @hosts[@host_index]
+      @transport ? @transport.host : host_from_address(@addresses[@address_index])
     end
 
-    def reset_host_index
-      @host_index_mutex.synchronize { @host_index = 0 }
+    def port
+      @transport ? @transport.port : port_from_address(@addresses[@address_index])
+    end
+
+    def reset_address_index
+      @address_index_mutex.synchronize { @address_index = 0 }
     end
 
     # @private
@@ -293,7 +310,7 @@ module Bunny
           raise
         end
       rescue HostListDepleted
-        self.reset_host_index
+        self.reset_address_index
         @status_mutex.synchronize { @status = :not_connected }
         raise TCPConnectionFailedForAllHosts
       end
@@ -659,7 +676,7 @@ module Bunny
           recover_channels
         end
       rescue HostListDepleted
-        reset_host_index
+        reset_address_index
         retry
       rescue TCPConnectionFailedForAllHosts, TCPConnectionFailed, AMQ::Protocol::EmptyResponseError => e
         @logger.warn "TCP connection failed, reconnecting in #{@network_recovery_interval} seconds"
@@ -744,10 +761,23 @@ module Bunny
     end
 
     # @private
-    def hostnames_from(options)
-      options.fetch(:hosts_shuffle_strategy, @default_hosts_shuffle_strategy).call(
-        [ options[:hosts] || options[:host] || options[:hostname] || DEFAULT_HOST ].flatten
-      )
+    def addresses_from(options)
+      shuffle_strategy = options.fetch(:hosts_shuffle_strategy, @default_hosts_shuffle_strategy)
+
+      addresses = options[:host] || options[:hostname] || options[:addresses] ||
+        options[:hosts] || ["#{DEFAULT_HOST}:#{port_from(options)}"]
+      addresses = [addresses] unless addresses.is_a? Array
+
+      addresses.map! do |address|
+        host_with_port?(address) ? address : "#{address}:#{port_from(@opts)}"
+      end
+
+      shuffle_strategy.call addresses
+    end
+
+    # @private
+    def host_with_port?(address)
+      address.include? ':'
     end
 
     # @private
@@ -761,6 +791,16 @@ module Bunny
       options.fetch(:port, fallback)
     end
 
+    # @private
+    def host_from_address(address)
+      address.split(":")[0]
+    end
+
+    # @private
+    def port_from_address(address)
+      address.split(":")[1].to_i
+    end
+
     # @private
     def vhost_from(options)
       options[:virtual_host] || options[:vhost] || DEFAULT_VHOST
@@ -946,7 +986,7 @@ module Bunny
     # @api public
     def to_s
       oid = ("0x%x" % (self.object_id << 1))
-      "#<#{self.class.name}:#{oid} #{@user}@#{host}:#{@port}, vhost=#{@vhost}, hosts=[#{@hosts.join(',')}]>"
+      "#<#{self.class.name}:#{oid} #{@user}@#{host}:#{port}, vhost=#{@vhost}, addresses=[#{@addresses.join(',')}]>"
     end
 
     def inspect
@@ -1109,10 +1149,14 @@ module Bunny
 
     # @private
     def initialize_transport
-      if host = @hosts[ @host_index ]
-        @host_index_mutex.synchronize { @host_index += 1 }
+      if address = @addresses[ @address_index ]
+        @address_index_mutex.synchronize { @address_index += 1 }
         @transport.close rescue nil # Let's make sure the previous transport socket is closed
-        @transport = Transport.new(self, host, @port, @opts.merge(:session_thread => @origin_thread))
+        @transport = Transport.new(self,
+                                   host_from_address(address),
+                                   port_from_address(address),
+                                   @opts.merge(:session_thread => @origin_thread)
+                                  )
 
         # Reset the cached progname for the logger only when no logger was provided
         @default_logger.progname = self.to_s

data/lib/bunny/version.rb

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

data/spec/higher_level_api/integration/connection_spec.rb

@@ -19,7 +19,6 @@ describe Bunny::Session do
       end
     end
 
-
     it "handles amqp:// URIs w/o path part" do
       session = described_class.new("amqp://127.0.0.1")
       session.start
@@ -32,7 +31,6 @@ describe Bunny::Session do
       session.close
     end
 
-
     context "when URI ends in a slash" do
       it "parses vhost as an empty string" do
         session = described_class.new("amqp://127.0.0.1/")
@@ -50,9 +48,6 @@ describe Bunny::Session do
     end
   end
 
-
-
-
   context "initialized with all defaults" do
     it "provides a way to fine tune socket options" do
       conn = Bunny.new
@@ -156,7 +151,7 @@ describe Bunny::Session do
       let(:hosts)   { [host] }
       let(:subject) { described_class.new(:hosts => hosts) }
 
-      it "uses hostname = localhost" do
+      it "uses hostname = 192.168.1.10" do
         expect(subject.host).to eq host
         expect(subject.hostname).to eq host
       end
@@ -171,6 +166,58 @@ describe Bunny::Session do
       end
     end
 
+    context "initialized with :addresses => [...]" do
+      after :each do
+        subject.close if subject.open?
+      end
+
+      let(:host)      { "192.168.1.10" }
+      let(:port)      { 5673 }
+      let(:address)   { "#{host}:#{port}" }
+      let(:addresses) { [address] }
+      let(:subject)   { described_class.new(:addresses => addresses) }
+
+      it "uses hostname = 192.168.1.10" do
+        expect(subject.host).to eq host
+        expect(subject.hostname).to eq host
+      end
+
+      it "uses port 5673" do
+        expect(subject.port).to eq port
+      end
+
+      it "uses username = guest" do
+        expect(subject.username).to eq username
+        expect(subject.user).to eq username
+      end
+    end
+
+    context "initialized with conflicting hosts and addresses" do
+      let(:host)      { "192.168.1.10" }
+      let(:port)      { 5673 }
+      let(:address)   { "#{host}:#{port}" }
+      let(:io)        { StringIO.new }
+      let(:logger)    { ::Logger.new(io) }
+
+      it "raises an argument error when there is are hosts and an address" do
+        expect { described_class.new(addresses: [address], hosts: [host]) }.to raise_error(ArgumentError)
+      end
+
+      it "logs a warning when there is a single host and an array" do
+        described_class.new(addresses: [address], host: host, logger: logger)
+        expect(io.string).to include 'WARN -- : The connection options contain '\
+          'both a host and an array of hosts, the single host is ignored.'
+      end
+
+      it "converts hosts in addresses to addresses" do
+        strategy = Proc.new { |addresses| addresses }
+        session = described_class.new(addresses: [address,host ], hosts_shuffle_strategy: strategy)
+        strategy = Proc.new { |addresses| addresses }
+
+        expect(session.to_s).to include 'addresses=[192.168.1.10:5673,192.168.1.10:5672]'
+      end
+    end
+
     context "initialized with :channel_max => 4096" do
       after :each do
         subject.close if subject.open?
@@ -223,7 +270,6 @@ describe Bunny::Session do
     end
   end
 
-
   context "initialized with :host => 127.0.0.1 and non-default credentials" do
     after :each do
       subject.close if subject.open?
@@ -276,7 +322,6 @@ describe Bunny::Session do
     end
   end
 
-
   context "initialized with :host => 127.0.0.1 and non-default credentials (take 2)" do
     after :each do
       subject.close if subject.open?
@@ -324,8 +369,6 @@ describe Bunny::Session do
     end
   end
 
-
-
   context "initialized with :host => 127.0.0.1 and non-default credentials (take 2)" do
     after :each do
       subject.close if subject.open?
@@ -362,8 +405,6 @@ describe Bunny::Session do
     end
   end
 
-
-
   context "initialized with :host => 127.0.0.1 and INVALID credentials" do
     let(:host)     { "127.0.0.1" }
     # see ./bin/ci/before_build
@@ -390,7 +431,6 @@ describe Bunny::Session do
     end
   end
 
-
   context "initialized with unreachable host or port" do
     it "fails to connect" do
       expect do
@@ -422,7 +462,6 @@ describe Bunny::Session do
     end
   end
 
-
   context "initialized with a custom logger object" do
     let(:io)      { StringIO.new }
     let(:logger)  { ::Logger.new(io) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bunny
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Chris Duncan
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-16 00:00:00.000000000 Z
+date: 2015-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amq-protocol
@@ -31,11 +31,7 @@ dependencies:
 description: Easy to use, feature complete Ruby client for RabbitMQ 3.3 and later
   versions.
 email:
-- celldee@gmail.com
-- eric@5stops.com
-- stastny@101ideas.cz
-- michael@novemberain.com
-- skaes@railsexpress.de
+- michael.s.klishin@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: