bunny 3.5.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c409adf026a09b52061cdbca1d1ea72e6312f11085712f3ba586111fc62fd91
-  data.tar.gz: c90db5d9e534fb527899221f0a13fb91e13ef18cc178f064f077a7984da692d5
+  metadata.gz: d0192b4541ec169e249317d397768bf5e945b43c08b797559a47adb5aa16d553
+  data.tar.gz: 6a460e9bdbb8ee073c28f6aa7c9bdcc4ab017929d6a6e298eb49ba01db1059df
 SHA512:
-  metadata.gz: 9fadf7743831aef18668dc5394c3a888b89f39f2afeb71c73f99a0553722ed365ed26fa571cd1a0d0ed27240c5b35b2c0fa4b330b9b2acfe25339bebf5e49fca
-  data.tar.gz: 465c8430c93d6895c510f4fc8d66493f0c2a17493ce1685175305f8ed6a704017e85098972c074c8bca67fb12611c01e9820d33da21120b3cbdfa37a226a17d9
+  metadata.gz: a01fbb4c9cbfe312b803026b86dca339b1ba306aa1ad3f44cb77abaf26f28ec823a57bee2231ca1b29de03e5b31355a70e2a6b8eb066be465f9fb85f052fa616
+  data.tar.gz: 3b752e1f17c5d40a155c49fbdf53f437ad450a4c31a74ffc791b8dfd5079029b0f5242dc0d573b349ce7248d7474ae15211e214a8797b0487759d7a69a0aadfe

data/ChangeLog.md

@@ -1,6 +1,33 @@
-## Changes between Bunny 3.5.0 and 3.6.0
+## Changes between Bunny 3.5.0 and 3.6.0 (Nov 9, 2026)
 
-No changes yet.
+### `amq-protocol` Bump to `2.10.0`
+
+[`2.10.0` release notes](https://github.com/ruby-amqp/amq-protocol/releases/tag/v2.10.0).
+
+`amqps://` URIs without `?verify=` no longer disable peer verification.
+
+### TLSv1.2 Is Now a Minimum, Not a Pinned Version
+
+Without an explicit `tls_protocol`, TLS 1.3 is no longer ruled out.
+
+GitHub issue: [#760](https://github.com/ruby-amqp/bunny/issues/760)
+
+### New `tls_min_version` and `tls_max_version` Options
+
+They set the range of TLS versions to negotiate and accept strings as well as symbols.
+`tls_protocol`, which pins a single version, is deprecated in their favor and now emits a warning.
+
+### Stale Delivery Tags Are Not Acknowledged After `Channel#reopen` or Connection Recovery
+
+Delivery tags now keep increasing across a reopen or recovery instead of restarting at 1.
+Acknowledgements for tags from before it are dropped instead of closing the channel or
+acknowledging a different delivery.
+
+GitHub issue: [#710](https://github.com/ruby-amqp/bunny/issues/710)
+
+### `Channel#reopen` No Longer Leaks a Consumer Work Pool Thread
+
+Topology recovery replaced the consumer work pool `Channel#reopen` had just started, leaking its thread.
 
 
 ## Changes between Bunny 3.4.0 and 3.5.0 (Oct 25, 2026)

data/README.md

@@ -95,7 +95,7 @@ may introduce, e.g. the idempotency of `queue.delete` operations.
 To use Bunny in a project managed with Bundler:
 
 ``` ruby
-gem "bunny", ">= 3.0"
+gem "bunny", ">= 3.5"
 ```
 
 ### With Rubygems
@@ -218,7 +218,7 @@ and steps to reproduce (or failing test cases).
 ## Other Ruby RabbitMQ Clients
 
 The other widely used Ruby RabbitMQ client is [March Hare](http://rubymarchhare.info) (JRuby-only).
-It's a mature library that requires RabbitMQ 3.3.x or later.
+It's a mature library that requires RabbitMQ 3.13.x or later.
 
 
 ## Contributing

data/lib/bunny/channel.rb

@@ -196,6 +196,7 @@ module Bunny
       end
 
       @status     = :opening
+      @status_mutex = Mutex.new
       @connection.register_channel(self)
 
       @queues     = Hash.new
@@ -233,6 +234,11 @@ module Bunny
       @next_publish_seq_no = 0
       @delivery_tag_offset = 0
 
+      # Delivery tags restart at 1 on a reopened or recovered channel. Shifting them
+      # by the highest tag seen so far keeps them unique, see #guarding_against_stale_delivery_tags.
+      @consumer_delivery_tag_offset = 0
+      @last_consumer_delivery_tag   = 0
+
       @uncaught_exception_handler = Proc.new do |e, consumer|
         @logger.error "Uncaught exception from consumer #{consumer.to_s}: #{e.inspect} @ #{e.backtrace[0]}"
       end
@@ -255,6 +261,8 @@ module Bunny
       @threads_waiting_on_continuations           = Set.new
       @threads_waiting_on_confirms_continuations  = Set.new
       @threads_waiting_on_basic_get_continuations = Set.new
+      # Set before the channel is open again, so that no stale tag slips through
+      @consumer_delivery_tag_offset = @last_consumer_delivery_tag
 
       @connection.open_channel(self)
       # clear last channel error
@@ -290,6 +298,8 @@ module Bunny
         end
       end
 
+      # once channel.close is on the wire, the server rejects any other frame on this channel
+      @status_mutex.synchronize { @status = :closing }
       @connection.close_channel(self)
       @status = :closed
       @work_pool.shutdown
@@ -1041,10 +1051,12 @@ module Bunny
     # @see http://rubybunny.info/articles/queues.html Queues and Consumers guide
     # @api public
     def basic_reject(delivery_tag, requeue = false)
-      raise_if_no_longer_open!
-      @connection.send_frame(AMQ::Protocol::Basic::Reject.encode(@id, delivery_tag, requeue))
+      guarding_against_stale_delivery_tags(delivery_tag) do |tag|
+        raise_if_no_longer_open!
+        @connection.send_frame(AMQ::Protocol::Basic::Reject.encode(@id, tag, requeue))
 
-      nil
+        nil
+      end
     end
 
     # Acknowledges a delivery (message).
@@ -1087,9 +1099,9 @@ module Bunny
     # @see http://rubybunny.info/articles/queues.html Queues and Consumers guide
     # @api public
     def basic_ack(delivery_tag, multiple = false)
-      guarding_against_stale_delivery_tags(delivery_tag) do
+      guarding_against_stale_delivery_tags(delivery_tag) do |tag|
         raise_if_no_longer_open!
-        @connection.send_frame(AMQ::Protocol::Basic::Ack.encode(@id, delivery_tag, multiple))
+        @connection.send_frame(AMQ::Protocol::Basic::Ack.encode(@id, tag, multiple))
 
         nil
       end
@@ -1149,10 +1161,10 @@ module Bunny
     # @see http://rubybunny.info/articles/extensions.html RabbitMQ Extensions guide
     # @api public
     def basic_nack(delivery_tag, multiple = false, requeue = false)
-      guarding_against_stale_delivery_tags(delivery_tag) do
+      guarding_against_stale_delivery_tags(delivery_tag) do |tag|
         raise_if_no_longer_open!
         @connection.send_frame(AMQ::Protocol::Basic::Nack.encode(@id,
-                                                                 delivery_tag,
+                                                                 tag,
                                                                  multiple,
                                                                  requeue))
 
@@ -2034,7 +2046,8 @@ module Bunny
     #
     # @api private
     def maybe_reinitialize_consumer_pool!
-      unless @consumers.empty?
+      # keep a pool that is already running, e.g. the one #reopen has just started
+      unless @consumers.empty? || @work_pool.running?
         @work_pool = ConsumerWorkPool.new(@work_pool.size, @work_pool.abort_on_exception)
         @work_pool.start
       end
@@ -2132,7 +2145,9 @@ module Bunny
     def send_basic_cancel_ok(consumer_tag)
       tag = consumer_tag.to_s
       payload = [AMQ::Protocol::Basic::CancelOk.index, tag.bytesize, tag].pack("NCa*")
-      @connection.send_frame(AMQ::Protocol::MethodFrame.new(payload, @id))
+      @status_mutex.synchronize do
+        @connection.send_frame(AMQ::Protocol::MethodFrame.new(payload, @id)) if open?
+      end
     end
 
     # @private
@@ -2244,7 +2259,7 @@ module Bunny
 
     # @private
     def handle_basic_get_ok(basic_get_ok, properties, content)
-      basic_get_ok.delivery_tag = basic_get_ok.delivery_tag
+      basic_get_ok.delivery_tag = next_consumer_delivery_tag(basic_get_ok.delivery_tag)
       @basic_get_continuations.push([basic_get_ok, properties, content])
     end
 
@@ -2264,9 +2279,11 @@ module Bunny
         @last_consumer = consumer
       end
 
+      # the server counts deliveries for unknown consumers as well
+      delivery_tag = next_consumer_delivery_tag(basic_deliver.delivery_tag)
       if consumer
         @work_pool.submit do
-          deliver_to_consumer(consumer, basic_deliver, properties, content)
+          deliver_to_consumer(consumer, basic_deliver, properties, content, delivery_tag)
         end
       else
         @logger.warn "No consumer for tag #{basic_deliver.consumer_tag} on channel #{@id}!"
@@ -2274,9 +2291,9 @@ module Bunny
     end
 
     # @private
-    def deliver_to_consumer(consumer, basic_deliver, properties, content)
+    def deliver_to_consumer(consumer, basic_deliver, properties, content, delivery_tag = basic_deliver.delivery_tag)
       begin
-        consumer.call(DeliveryInfo.new(basic_deliver, consumer, self), MessageProperties.new(properties), content)
+        consumer.call(DeliveryInfo.new(basic_deliver, consumer, self, delivery_tag), MessageProperties.new(properties), content)
       rescue StandardError => e
         @uncaught_exception_handler.call(e, consumer) if @uncaught_exception_handler
       end
@@ -2724,11 +2741,24 @@ module Bunny
       Concurrent::ContinuationQueue.new
     end
 
+    # @private
+    def next_consumer_delivery_tag(tag)
+      @last_consumer_delivery_tag = tag + @consumer_delivery_tag_offset
+    end
+
+    # A tag at or below the offset was delivered before the channel was reopened or recovered.
+    # RabbitMQ has requeued that delivery already, and acknowledging it here would close the channel
+    # with an unknown delivery tag, or acknowledge a different delivery.
     # @private
     def guarding_against_stale_delivery_tags(tag, &block)
-      case tag
-      when Integer then block.call
-      end
+      return unless tag.is_a?(Integer)
+      # 0 with multiple set covers all outstanding deliveries
+      return block.call(tag) if tag.zero?
+      # read once, a concurrent #open may change it
+      offset = @consumer_delivery_tag_offset
+      return if tag <= offset
+
+      block.call(tag - offset)
     end
   end # Channel
 end # Bunny

data/lib/bunny/delivery_info.rb

@@ -22,10 +22,11 @@ module Bunny
     attr_reader :channel
 
     # @private
-    def initialize(basic_deliver, consumer, channel)
+    def initialize(basic_deliver, consumer, channel, delivery_tag = basic_deliver.delivery_tag)
       @basic_deliver = basic_deliver
       @consumer      = consumer
       @channel       = channel
+      @delivery_tag  = delivery_tag
     end
 
     # Iterates over delivery properties
@@ -39,7 +40,7 @@ module Bunny
     def [](k)
       case k
       when :consumer_tag then @basic_deliver.consumer_tag
-      when :delivery_tag then @basic_deliver.delivery_tag
+      when :delivery_tag then @delivery_tag
       when :redelivered  then @basic_deliver.redelivered
       when :exchange     then @basic_deliver.exchange
       when :routing_key  then @basic_deliver.routing_key
@@ -53,7 +54,7 @@ module Bunny
     def to_hash
       @hash ||= {
         consumer_tag: @basic_deliver.consumer_tag,
-        delivery_tag: @basic_deliver.delivery_tag,
+        delivery_tag: @delivery_tag,
         redelivered:  @basic_deliver.redelivered,
         exchange:     @basic_deliver.exchange,
         routing_key:  @basic_deliver.routing_key,
@@ -79,7 +80,7 @@ module Bunny
 
     # @return [String] Delivery identifier that is used to acknowledge, reject and nack deliveries
     def delivery_tag
-      @basic_deliver.delivery_tag
+      @delivery_tag
     end
 
     # @return [Boolean] true if this delivery is a redelivery (the message was requeued at least once)

data/lib/bunny/session.rb

@@ -112,7 +112,9 @@ module Bunny
     # @option connection_string_or_opts [String] :tls_key (nil) Path to client TLS/SSL private key file (.pem)
     # @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_protocol (negotiated) What TLS version should be used (:TLSv1, :TLSv1_1, or :TLSv1_2)
+    # @option connection_string_or_opts [Symbol] :tls_protocol (nil) [DEPRECATED] Use :tls_min_version and :tls_max_version instead. Pins the TLS version (:TLSv1, :TLSv1_1, :TLSv1_2 or :TLSv1_3)
+    # @option connection_string_or_opts [Symbol, String] :tls_min_version (:TLSv1_2) Lowest TLS version to negotiate, ignored when :tls_protocol is set
+    # @option connection_string_or_opts [Symbol, String] :tls_max_version (nil) Highest TLS version to negotiate, ignored when :tls_protocol is set
     # @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.
@@ -251,6 +253,10 @@ module Bunny
       if (options[:host] || options[:hostname]) && (options[:hosts] || options[:addresses])
         @logger.warn "Connection options contain both a host and an array of hosts (addresses), please pick one."
       end
+
+      if options[:tls_protocol] || options[:ssl_version]
+        warn "[DEPRECATION] `:tls_protocol` is deprecated.  Please use `:tls_min_version` and `:tls_max_version` instead."
+      end
     end
 
     # @return [String] RabbitMQ hostname (or IP address) used

data/lib/bunny/transport.rb

@@ -42,7 +42,7 @@ module Bunny
     # older OpenSSL versions won't support for TLS 1.3 and won't
     # have this constant defined.
     if defined?(OpenSSL::SSL::TLS1_3_VERSION)
-      TLS_VERSION_ALIASES["1.3"]                        = OpenSSL::SSL::TLS1_3_VERSION
+      TLS_VERSION_ALIASES[:"1.3"]                       = OpenSSL::SSL::TLS1_3_VERSION
       TLS_VERSION_ALIASES[:TLSv1_3]                     = OpenSSL::SSL::TLS1_3_VERSION
       TLS_VERSION_ALIASES[OpenSSL::SSL::TLS1_3_VERSION] = OpenSSL::SSL::TLS1_3_VERSION
     end
@@ -538,12 +538,11 @@ but prone to man-in-the-middle attacks. Please set verify_peer: true in producti
         MSG
       end
 
-      ssl_version = opts[:tls_protocol] || opts[:ssl_version] || :TLSv1_2
-      if ssl_version
-        v = tls_version_constant(ssl_version)
-        ctx.min_version = v
-        ctx.max_version = v
-      end
+      pinned = opts[:tls_protocol] || opts[:ssl_version]
+      min = pinned || opts[:tls_min_version] || :TLSv1_2
+      max = pinned || opts[:tls_max_version]
+      ctx.min_version = tls_version_constant(min)
+      ctx.max_version = tls_version_constant(max) if max
 
       ctx
     end
@@ -576,6 +575,7 @@ but prone to man-in-the-middle attacks. Please set verify_peer: true in producti
       # OpenSSL::SSL::TLS1_3_VERSION and similar constants
       # are just integers, so use the value itself as fallback since
       # there is no class to case switch on
+      value = value.to_sym if value.is_a?(String)
       TLS_VERSION_ALIASES[value] || value
     end
 

data/lib/bunny/version.rb

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

data/lib/bunny.rb

@@ -71,7 +71,9 @@ module Bunny
   # @option connection_string_or_opts [String] :tls_key (nil) Path to client TLS/SSL private key file (.pem)
   # @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_protocol (negotiated) What TLS version should be used (:TLSv1, :TLSv1_1, or :TLSv1_2)
+  # @option connection_string_or_opts [Symbol] :tls_protocol (nil) [DEPRECATED] Use :tls_min_version and :tls_max_version instead. Pins the TLS version (:TLSv1, :TLSv1_1, :TLSv1_2 or :TLSv1_3)
+  # @option connection_string_or_opts [Symbol, String] :tls_min_version (:TLSv1_2) Lowest TLS version to negotiate, ignored when :tls_protocol is set
+  # @option connection_string_or_opts [Symbol, String] :tls_max_version (nil) Highest TLS version to negotiate, ignored when :tls_protocol is set
   # @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.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bunny
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.6.0
 platform: ruby
 authors:
 - Chris Duncan
@@ -19,14 +19,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '2.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '2.10'
 - !ruby/object:Gem::Dependency
   name: logger
   requirement: !ruby/object:Gem::Requirement
@@ -150,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Popular easy to use Ruby client for RabbitMQ
 test_files: []