bunny 2.14.4 → 2.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf0bcb6bc92f6092788f0eeffed76f438be49f1341857a6e5a94254544cf44e3
-  data.tar.gz: 317240a20f888087e959999b7cbe10d57fe423316032bc6fa6f2a6733e8dd50c
+  metadata.gz: d6de535f1d386dbf46fd89a733c1c44915280af55c3cc3cc56467abe0ead9c24
+  data.tar.gz: 6048aea84078fb8995718ed774d9a3956dc91645b24c09382cd54283b444aabe
 SHA512:
-  metadata.gz: d0c159c08871fdf203a322543489d9c563d45c855f407f9e069adc6f3f0d97f7b0fb8d7ac90a5280dfdc2cea81dbef53e0c2b217be2064373432d0ca0d889626
-  data.tar.gz: 4d8a071b4d8494ad3976d842a705cf3d8323d8c14c61a0c147c309cc07ebc77bf6420243a597c68a3cde9b4b7a6cb5f17e25bab7972cf607f1d1d55b8bd88cdb
+  metadata.gz: b3575710f81dabf6c116c92c4ac1807a29f0c0bcd1bd5fb35ae1fd9dd468df193efac49d0ad5e77ef04ecc53e97b9b4e13e70f4207972ba0c2335c28afcd6c9b
+  data.tar.gz: 8b90dd4da7dab28b529e78cf1282656ca1904432b1017ee5574545c1972315f975d175c718481372604b61796e9ae56b293a342dcba800fa0929e4b80cd7a3c4

data/README.md

@@ -43,12 +43,11 @@ Specific examples:
    Web applications that display that information in the real time.
 
 
-
 ## Supported Ruby Versions
 
 Modern Bunny versions support
 
- * CRuby 2.3 through 2.6 (inclusive)
+ * CRuby 2.5 through 3.0 (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
@@ -71,10 +70,8 @@ a stable public API.
 Change logs per release series:
 
  * [master](https://github.com/ruby-amqp/bunny/blob/master/ChangeLog.md)
- * [2.13.x](https://github.com/ruby-amqp/bunny/blob/2.13.x-stable/ChangeLog.md)
- * [2.12.x](https://github.com/ruby-amqp/bunny/blob/2.12.x-stable/ChangeLog.md)
- * [2.11.x](https://github.com/ruby-amqp/bunny/blob/2.11.x-stable/ChangeLog.md)
- * [2.10.x](https://github.com/ruby-amqp/bunny/blob/2.10.x-stable/ChangeLog.md)
+ * [2.18.x](https://github.com/ruby-amqp/bunny/blob/2.18.x-stable/ChangeLog.md)
+ * [2.17.x](https://github.com/ruby-amqp/bunny/blob/2.17.x-stable/ChangeLog.md)
 
 
 
@@ -97,7 +94,7 @@ gem install bunny
 To use Bunny in a project managed with Bundler:
 
 ``` ruby
-gem "bunny", ">= 2.13.0"
+gem "bunny", ">= 2.18.0"
 ```
 
 
@@ -117,20 +114,31 @@ conn.start
 
 # open a channel
 ch = conn.create_channel
+ch.confirm_select
 
 # declare a queue
 q  = ch.queue("test1")
+q.subscribe(manual_ack: true) do |delivery_info, metadata, payload|
+  puts "This is the message: #{payload}"
+  # acknowledge the delivery so that RabbitMQ can mark it for deletion
+  ch.ack(delivery_info.delivery_tag)
+end
 
 # publish a message to the default exchange which then gets routed to this queue
 q.publish("Hello, everybody!")
 
-# fetch a message from the queue
-delivery_info, metadata, payload = q.pop
+# await confirmations from RabbitMQ, see
+# https://www.rabbitmq.com/publishers.html#data-safety for details
+ch.wait_for_confirms
+
+# give the above consumer some time consume the delivery and print out the message
+sleep 1
 
-puts "This is the message: #{payload}"
+puts "Done"
 
+ch.close
 # close the connection
-conn.stop
+conn.close
 ```
 
 
@@ -142,7 +150,7 @@ For a 15 minute tutorial using more practical examples, see [Getting Started wit
 
 ### Guides
 
-Other documentation guides are available at [rubybunny.info](http://rubybunny.info):
+Bunny documentation guides are available at [rubybunny.info](http://rubybunny.info):
 
  * [Queues and Consumers](http://rubybunny.info/articles/queues.html)
  * [Exchanges and Publishers](http://rubybunny.info/articles/exchanges.html)
@@ -154,6 +162,16 @@ Other documentation guides are available at [rubybunny.info](http://rubybunny.in
  * [Using RabbitMQ Extensions with Bunny](http://rubybunny.info/articles/extensions.html)
  * [Durability and Related Matters](http://rubybunny.info/articles/durability.html)
 
+Some highly relevant RabbitMQ documentation guides:
+
+ * [Connections](https://www.rabbitmq.com/connections.html)
+ * [Channels](https://www.rabbitmq.com/channels.html)
+ * [Queues](https://www.rabbitmq.com/queues.html)
+ * [Publishers](https://www.rabbitmq.com/publishers.html)
+ * [Consumers](https://www.rabbitmq.com/consumers.html)
+ * Data safety: publisher and consumer [Confirmations](https://www.rabbitmq.com/confirms.html)
+ * [Production Checklist](https://www.rabbitmq.com/production-checklist.html)
+
 ### API Reference
 
 [Bunny API Reference](http://reference.rubybunny.info/).

data/lib/bunny/channel.rb

@@ -1156,7 +1156,7 @@ module Bunny
 
     # @group Exchange operations (exchange.*)
 
-    # Declares a exchange using echange.declare AMQP 0.9.1 method.
+    # Declares a exchange using exchange.declare AMQP 0.9.1 method.
     #
     # @param [String] name The name of the exchange. Note that LF and CR characters
     #                       will be stripped from the value.
@@ -1789,7 +1789,7 @@ module Bunny
     # @private
     def handle_ack_or_nack(delivery_tag_before_offset, multiple, nack)
       delivery_tag          = delivery_tag_before_offset + @delivery_tag_offset
-      confirmed_range_start = multiple ? @delivery_tag_offset + 1 : delivery_tag
+      confirmed_range_start = multiple ? @delivery_tag_offset + @unconfirmed_set.min : delivery_tag
       confirmed_range_end   = delivery_tag
       confirmed_range       = (confirmed_range_start..confirmed_range_end)
 

data/lib/bunny/queue.rb

@@ -158,9 +158,6 @@ module Bunny
     # @option opts [Boolean] :ack (false) [DEPRECATED] Use :manual_ack instead
     # @option opts [Boolean] :manual_ack (false) Will this consumer use manual acknowledgements?
     # @option opts [Boolean] :exclusive (false) Should this consumer be exclusive for this queue?
-    # @option opts [Boolean] :block (false) Should the call block the calling thread? This option can be useful for keeping the main thread of
-    #                                       a script alive. It is incompatible with automatic connection recovery
-    #                                       and is not generally recommended.
     # @option opts [#call] :on_cancellation Block to execute when this consumer is cancelled remotely (e.g. via the RabbitMQ Management plugin)
     # @option opts [String] :consumer_tag Unique consumer identifier. It is usually recommended to let Bunny generate it for you.
     # @option opts [Hash] :arguments ({}) Additional (optional) arguments, typically used by RabbitMQ extensions

data/lib/bunny/reader_loop.rb

@@ -9,17 +9,17 @@ module Bunny
   # @private
   class ReaderLoop
 
-    def initialize(transport, session, session_thread)
-      @transport      = transport
-      @session        = session
-      @session_thread = session_thread
-      @logger         = @session.logger
+    def initialize(transport, session, session_error_handler)
+      @transport             = transport
+      @session               = session
+      @session_error_handler = session_error_handler
+      @logger                = @session.logger
 
-      @mutex          = Mutex.new
+      @mutex                 = Mutex.new
 
-      @stopping        = false
-      @stopped         = false
-      @network_is_down = false
+      @stopping              = false
+      @stopped               = false
+      @network_is_down       = false
     end
 
 
@@ -47,7 +47,7 @@ module Bunny
             @session.handle_network_failure(e)
           else
             log_exception(e)
-            @session_thread.raise(Bunny::NetworkFailure.new("detected a network failure: #{e.message}", e))
+            @session_error_handler.raise(Bunny::NetworkFailure.new("detected a network failure: #{e.message}", e))
           end
         rescue ShutdownSignal => _
           @mutex.synchronize { @stopping = true }
@@ -58,7 +58,7 @@ module Bunny
             log_exception(e)
 
             @network_is_down = true
-            @session_thread.raise(Bunny::NetworkFailure.new("caught an unexpected exception in the network loop: #{e.message}", e))
+            @session_error_handler.raise(Bunny::NetworkFailure.new("caught an unexpected exception in the network loop: #{e.message}", e))
           end
         rescue Errno::EBADF => _ebadf
           break if terminate?

data/lib/bunny/session.rb

@@ -89,6 +89,7 @@ module Bunny
     # @return [Integer] Timeout for blocking protocol operations (queue.declare, queue.bind, etc), in milliseconds. Default is 15000.
     attr_reader :continuation_timeout
     attr_reader :network_recovery_interval
+    attr_reader :connection_name
     attr_accessor :socket_configurator
 
     # @param [String, Hash] connection_string_or_opts Connection string or a hash of connection options
@@ -123,10 +124,14 @@ module Bunny
     # @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
     # @option connection_string_or_opts [Integer] :reset_recovery_attempts_after_reconnection (true) Should recovery attempt counter be reset after successful reconnection? When set to false, the attempt counter will last through the entire lifetime of the connection object.
+    # @option connection_string_or_opts [Proc] :recovery_attempt_started (nil) Will be called before every connection recovery attempt
+    # @option connection_string_or_opts [Proc] :recovery_completed (nil) Will be called after successful connection recovery
     # @option connection_string_or_opts [Boolean] :recover_from_connection_close (true) Should this connection recover after receiving a server-sent connection.close (e.g. connection was force closed)?
+    # @option connection_string_or_opts [Object] :session_error_handler (Thread.current) Object which responds to #raise that will act as a session error handler. Defaults to Thread.current, which will raise asynchronous exceptions in the thread that created the session.
     #
     # @option optz [String] :auth_mechanism ("PLAIN") Authentication mechanism, PLAIN or EXTERNAL
     # @option optz [String] :locale ("PLAIN") Locale RabbitMQ should use
+    # @option optz [String] :connection_name (nil) Client-provided connection name, if any. Note that the value returned does not uniquely identify a connection and cannot be used as a connection identifier in HTTP API requests.
     #
     # @see http://rubybunny.info/articles/connecting.html Connecting to RabbitMQ guide
     # @see http://rubybunny.info/articles/tls.html TLS/SSL guide
@@ -169,7 +174,7 @@ module Bunny
       @automatically_recover = if opts[:automatically_recover].nil? && opts[:automatic_recovery].nil?
                                  true
                                else
-                                 opts[:automatically_recover] || opts[:automatic_recovery]
+                                 opts[:automatically_recover] | opts[:automatic_recovery]
                                end
       @recovering_from_network_failure = false
       @max_recovery_attempts = opts[:recovery_attempts]
@@ -197,7 +202,9 @@ module Bunny
       @client_heartbeat   = self.heartbeat_from(opts)
 
       client_props         = opts[:properties] || opts[:client_properties] || {}
+      @connection_name     = client_props[:connection_name] || opts[:connection_name]
       @client_properties   = DEFAULT_CLIENT_PROPERTIES.merge(client_props)
+                                                      .merge(connection_name: connection_name)
       @mechanism           = normalize_auth_mechanism(opts.fetch(:auth_mechanism, "PLAIN"))
       @credentials_encoder = credentials_encoder_for(@mechanism)
       @locale              = @opts.fetch(:locale, DEFAULT_LOCALE)
@@ -213,9 +220,11 @@ module Bunny
       @address_index_mutex = @mutex_impl.new
 
       @channels            = Hash.new
-      @recovery_completed = opts[:recovery_completed]
 
-      @origin_thread       = Thread.current
+      @recovery_attempt_started = opts[:recovery_attempt_started]
+      @recovery_completed       = opts[:recovery_completed]
+
+      @session_error_handler = opts.fetch(:session_error_handler, Thread.current)
 
       self.reset_continuations
       self.initialize_transport
@@ -342,6 +351,14 @@ module Bunny
       self
     end
 
+    def update_secret(value, reason)
+      @transport.send_frame(AMQ::Protocol::Connection::UpdateSecret.encode(value, reason))
+      @last_update_secret_ok = wait_on_continuations
+      raise_if_continuation_resulted_in_a_connection_error!
+
+      @last_update_secret_ok
+    end
+
     # Socket operation write timeout used by this connection
     # @return [Integer]
     # @private
@@ -520,6 +537,18 @@ module Bunny
       end
     end
 
+    # Defines a callable (e.g. a block) that will be called
+    # before every connection recovery attempt.
+    def before_recovery_attempt_starts(&block)
+      @recovery_attempt_started = block
+    end
+
+    # Defines a callable (e.g. a block) that will be called
+    # after successful connection recovery.
+    def after_recovery_completed(&block)
+      @recovery_completed = block
+    end
+
 
     #
     # Implementation
@@ -632,6 +661,8 @@ module Bunny
       when AMQ::Protocol::Connection::Unblocked then
         @blocked = false
         @unblock_callback.call(method) if @unblock_callback
+      when AMQ::Protocol::Connection::UpdateSecretOk then
+        @continuations.push(method)
       when AMQ::Protocol::Channel::Close then
         begin
           ch = synchronised_find_channel(ch_number)
@@ -735,6 +766,7 @@ module Bunny
     def recover_from_network_failure
       sleep @network_recovery_interval
       @logger.debug "Will attempt connection recovery..."
+      notify_of_recovery_attempt_start
 
       self.initialize_transport
 
@@ -808,8 +840,9 @@ module Bunny
       end
     end
 
-    def after_recovery_completed(&block)
-      @recovery_completed = block
+    # @private
+    def notify_of_recovery_attempt_start
+      @recovery_attempt_started.call if @recovery_attempt_started
     end
 
     # @private
@@ -852,7 +885,7 @@ module Bunny
 
       clean_up_on_shutdown
       if threaded?
-        @origin_thread.raise(@last_connection_error)
+        @session_error_handler.raise(@last_connection_error)
       else
         raise @last_connection_error
       end
@@ -1009,7 +1042,7 @@ module Bunny
 
     # @private
     def reader_loop
-      @reader_loop ||= ReaderLoop.new(@transport, self, Thread.current)
+      @reader_loop ||= ReaderLoop.new(@transport, self, @session_error_handler)
     end
 
     # @private
@@ -1272,7 +1305,7 @@ module Bunny
           end
 
           if threaded?
-            @origin_thread.raise(e)
+            @session_error_handler.raise(e)
           else
             raise e
           end
@@ -1318,7 +1351,7 @@ module Bunny
         @transport = Transport.new(self,
                                    host_from_address(address),
                                    port_from_address(address),
-                                   @opts.merge(:session_thread => @origin_thread)
+                                   @opts.merge(:session_error_handler => @session_error_handler)
                                   )
 
         # Reset the cached progname for the logger only when no logger was provided

data/lib/bunny/transport.rb

@@ -35,7 +35,7 @@ module Bunny
 
     def initialize(session, host, port, opts)
       @session        = session
-      @session_thread = opts[:session_thread]
+      @session_error_handler = opts[:session_error_handler]
       @host    = host
       @port    = port
       @opts    = opts
@@ -146,7 +146,7 @@ module Bunny
           if @session.automatically_recover?
             @session.handle_network_failure(e)
           else
-            @session_thread.raise(Bunny::NetworkFailure.new("detected a network failure: #{e.message}", e))
+            @session_error_handler.raise(Bunny::NetworkFailure.new("detected a network failure: #{e.message}", e))
           end
         end
       end
@@ -170,7 +170,7 @@ module Bunny
           if @session.automatically_recover?
             @session.handle_network_failure(e)
           else
-            @session_thread.raise(Bunny::NetworkFailure.new("detected a network failure: #{e.message}", e))
+            @session_error_handler.raise(Bunny::NetworkFailure.new("detected a network failure: #{e.message}", e))
           end
         end
       end
@@ -188,7 +188,7 @@ module Bunny
         if @session.automatically_recover?
           @session.handle_network_failure(e)
         else
-          @session_thread.raise(Bunny::NetworkFailure.new("detected a network failure: #{e.message}", e))
+          @session_error_handler.raise(Bunny::NetworkFailure.new("detected a network failure: #{e.message}", e))
         end
       end
     end
@@ -245,7 +245,7 @@ module Bunny
         if @session.automatically_recover?
           raise
         else
-          @session_thread.raise(Bunny::NetworkFailure.new("detected a network failure: #{e.message}", e))
+          @session_error_handler.raise(Bunny::NetworkFailure.new("detected a network failure: #{e.message}", e))
         end
       end
     end
@@ -453,9 +453,9 @@ module Bunny
       end
     end
 
-    def initialize_tls_context(ctx, opts={})
+    def initialize_tls_context(ctx, opts = {})
       ctx.cert       = OpenSSL::X509::Certificate.new(@tls_certificate) if @tls_certificate
-      ctx.key        = OpenSSL::PKey::RSA.new(@tls_key) if @tls_key
+      ctx.key        = OpenSSL::PKey.read(@tls_key) if @tls_key
       ctx.cert_store = if @tls_certificate_store
                          @tls_certificate_store
                        else
@@ -463,8 +463,9 @@ module Bunny
                          @tls_ca_certificates = tls_ca_certificates_paths_from(opts)
                          initialize_tls_certificate_store(@tls_ca_certificates)
                        end
+      should_silence_warnings = opts.fetch(:tls_silence_warnings, false)
 
-      if !@tls_certificate
+      if !@tls_certificate && !should_silence_warnings
         @logger.warn <<-MSG
 Using TLS but no client certificate is provided. If RabbitMQ is configured to require & verify peer
 certificate, connection will be rejected. Learn more at https://www.rabbitmq.com/ssl.html
@@ -482,14 +483,14 @@ certificate, connection will be rejected. Learn more at https://www.rabbitmq.com
       @logger.debug { "Will use peer verification mode #{verify_mode}" }
       ctx.verify_mode = verify_mode
 
-      if !@verify_peer
+      if !@verify_peer && !should_silence_warnings
         @logger.warn <<-MSG
 Using TLS but peer hostname verification is disabled. This is convenient for local development
 but prone to man-in-the-middle attacks. Please set verify_peer: true in production. Learn more at https://www.rabbitmq.com/ssl.html
         MSG
       end
 
-      ssl_version = opts[:tls_protocol] || opts[:ssl_version]
+      ssl_version = opts[:tls_protocol] || opts[:ssl_version] || :TLSv1_2
       ctx.ssl_version = ssl_version if ssl_version
 
       ctx
@@ -501,7 +502,7 @@ but prone to man-in-the-middle attacks. Please set verify_peer: true in producti
       certs.each do |cert|
         # if it starts with / or C:/ then it's a file path that may or may not
         # exist (e.g. a default OpenSSL path). MK.
-        if File.readable?(cert) || cert =~ /^([a-z]:?)?\//i
+        if File.readable?(cert) || cert =~ /\A([a-z]:?)?\//i
           cert_files.push(cert)
         else
           cert_inlines.push(cert)

data/lib/bunny/version.rb

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

data/spec/higher_level_api/integration/basic_cancel_spec.rb

@@ -20,7 +20,7 @@ describe Bunny::Consumer, "#cancel" do
       t = Thread.new do
         ch         = connection.create_channel
         q          = ch.queue(queue_name, auto_delete: true, durable: false)
-        consumer = q.subscribe(block: false) do |_, _, payload|
+        consumer = q.subscribe do |_, _, payload|
           delivered_data << payload
         end
 
@@ -58,7 +58,7 @@ describe Bunny::Consumer, "#cancel" do
           delivered_data << payload
         end
 
-        q.subscribe_with(consumer, block: false)
+        q.subscribe_with(consumer)
       end
       t.abort_on_exception = true
       sleep 1.0
@@ -91,7 +91,7 @@ describe Bunny::Consumer, "#cancel" do
           delivered_data << payload
         end
 
-        q.subscribe_with(consumer, block: false)
+        q.subscribe_with(consumer)
       end
       t.abort_on_exception = true
       sleep 1.0
@@ -122,7 +122,7 @@ describe Bunny::Consumer, "#cancel" do
           delivered_data << payload
         end
 
-        q.subscribe_with(consumer, block: false)
+        q.subscribe_with(consumer)
       end
       t.abort_on_exception = true
       sleep 1.0