bunny 1.0.7 → 2.24.0

data/lib/bunny/exchange.rb

@@ -1,4 +1,6 @@
-require "bunny/compatibility"
+# frozen_string_literal: true
+
+require 'amq/protocol'
 
 module Bunny
   # Represents AMQP 0.9.1 exchanges.
@@ -7,9 +9,6 @@ module Bunny
   # @see http://rubybunny.info/articles/extensions.html RabbitMQ Extensions guide
   class Exchange
 
-    include Bunny::Compatibility
-
-
     #
     # API
     #
@@ -33,12 +32,12 @@ module Bunny
     attr_accessor :opts
 
 
-    # The default exchange. Default exchange is a direct exchange that is predefined.
-    # It cannot be removed. Every queue is bind to this (direct) exchange by default with
-    # the following routing semantics: messages will be routed to the queue withe same
-    # same name as message's routing key. In other words, if a message is published with
-    # a routing key of "weather.usa.ca.sandiego" and there is a queue Q with this name,
-    # that message will be routed to Q.
+    # The default exchange. This exchange is a direct exchange that is predefined by the broker
+    # and that cannot be removed. Every queue is bound to this exchange by default with
+    # the following routing semantics: messages will be routed to the queue with the same
+    # name as the message's routing key. In other words, if a message is published with
+    # a routing key of "weather.usa.ca.sandiego" and there is a queue with this name,
+    # the message will be routed to the queue.
     #
     # @param [Bunny::Channel] channel_or_connection Channel to use. {Bunny::Session} instances
     #                                               are only supported for backwards compatibility.
@@ -46,23 +45,22 @@ module Bunny
     # @example Publishing a messages to the tasks queue
     #   channel     = Bunny::Channel.new(connection)
     #   tasks_queue = channel.queue("tasks")
-    #   Bunny::Exchange.default(channel).publish("make clean", routing_key => "tasks")
+    #   Bunny::Exchange.default(channel).publish("make clean", :routing_key => "tasks")
     #
     # @see http://rubybunny.info/articles/exchanges.html Exchanges and Publishing guide
     # @see http://www.rabbitmq.com/resources/specs/amqp0-9-1.pdf AMQP 0.9.1 specification (Section 2.1.2.4)
-    # @note Do not confuse default exchange with amq.direct: amq.direct is a pre-defined direct
+    # @note Do not confuse the default exchange with amq.direct: amq.direct is a pre-defined direct
     #       exchange that doesn't have any special routing semantics.
     # @return [Exchange] An instance that corresponds to the default exchange (of type direct).
     # @api public
     def self.default(channel_or_connection)
-      self.new(channel_from(channel_or_connection), :direct, AMQ::Protocol::EMPTY_STRING, :no_declare => true)
+      self.new(channel_or_connection, :direct, AMQ::Protocol::EMPTY_STRING, :no_declare => true)
     end
 
-    # @param [Bunny::Channel] channel_or_connection Channel this exchange will use. {Bunny::Session} instances are supported only for
-    #                                               backwards compatibility with 0.8.
-    # @param [Symbol,String] type                   Exchange type
-    # @param [String] name                          Exchange name
-    # @param [Hash] opts                            Exchange properties
+    # @param [Bunny::Channel] channel Channel this exchange will use.
+    # @param [Symbol,String] type     Exchange type
+    # @param [String] name            Exchange name
+    # @param [Hash] opts              Exchange properties
     #
     # @option opts [Boolean] :durable (false)      Should this exchange be durable?
     # @option opts [Boolean] :auto_delete (false)  Should this exchange be automatically deleted when it is no longer used?
@@ -75,18 +73,19 @@ module Bunny
     # @see http://rubybunny.info/articles/exchanges.html Exchanges and Publishing guide
     # @see http://rubybunny.info/articles/extensions.html RabbitMQ Extensions guide
     # @api public
-    def initialize(channel_or_connection, type, name, opts = {})
-      # old Bunny versions pass a connection here. In that case,
-      # we just use default channel from it. MK.
-      @channel          = channel_from(channel_or_connection)
+    def initialize(channel, type, name, opts = {})
+      @channel          = channel
       @name             = name
       @type             = type
       @options          = self.class.add_default_options(name, opts)
 
       @durable          = @options[:durable]
       @auto_delete      = @options[:auto_delete]
+      @internal         = @options[:internal]
       @arguments        = @options[:arguments]
 
+      @bindings         = Set.new
+
       declare! unless opts[:no_declare] || predeclared? || (@name == AMQ::Protocol::EMPTY_STRING)
 
       @channel.register_exchange(self)
@@ -104,6 +103,12 @@ module Bunny
       @auto_delete
     end # auto_delete?
 
+    # @return [Boolean] true if this exchange is internal (used solely for exchange-to-exchange
+    #                   bindings and cannot be published to by clients)
+    def internal?
+      @internal
+    end
+
     # @return [Hash] Additional optional arguments (typically used by RabbitMQ extensions and plugins)
     # @api public
     def arguments
@@ -170,6 +175,7 @@ module Bunny
     # @api public
     def bind(source, opts = {})
       @channel.exchange_bind(source, self, opts)
+      @bindings.add(source: source, opts: opts)
 
       self
     end
@@ -190,6 +196,7 @@ module Bunny
     # @api public
     def unbind(source, opts = {})
       @channel.exchange_unbind(source, self, opts)
+      @bindings.delete(source: source, opts: opts)
 
       self
     end
@@ -215,8 +222,11 @@ module Bunny
 
     # @private
     def recover_from_network_failure
-      # puts "Recovering exchange #{@name} from network failure"
-      declare! unless predefined?
+      declare! unless @options[:no_declare] ||predefined?
+
+      @bindings.each do |b|
+        bind(b[:source], b[:opts])
+      end
     end
 
 
@@ -246,11 +256,6 @@ module Bunny
       @channel.exchange_declare(@name, @type, @options)
     end
 
-    # @private
-    def self.add_default_options(name, opts, block)
-      { :exchange => name, :nowait => (block.nil? && !name.empty?) }.merge(opts)
-    end
-
     # @private
     def self.add_default_options(name, opts)
       # :nowait is always false for Bunny
@@ -261,6 +266,7 @@ module Bunny
           :passive     => false,
           :durable     => false,
           :auto_delete => false,
+          :internal    => false,
           :arguments   => nil
         }.merge(h)
       else

data/lib/bunny/framing.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bunny
   # @private
   module Framing

data/lib/bunny/get_response.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require "bunny/versioned_delivery_tag"
+
+module Bunny
+  # Wraps {AMQ::Protocol::Basic::GetOk} to
+  # provide access to the delivery properties as immutable hash as
+  # well as methods.
+  class GetResponse
+
+    #
+    # Behaviors
+    #
+
+    include Enumerable
+
+    #
+    # API
+    #
+
+    # @return [Bunny::Channel] Channel this basic.get-ok response is on
+    attr_reader :channel
+
+    # @private
+    def initialize(get_ok, channel)
+      @get_ok = get_ok
+      @hash          = {
+        :delivery_tag => @get_ok.delivery_tag,
+        :redelivered  => @get_ok.redelivered,
+        :exchange     => @get_ok.exchange,
+        :routing_key  => @get_ok.routing_key,
+        :channel      => channel
+      }
+      @channel       = channel
+    end
+
+    # Iterates over the delivery properties
+    # @see Enumerable#each
+    def each(*args, &block)
+      @hash.each(*args, &block)
+    end
+
+    # Accesses delivery properties by key
+    # @see Hash#[]
+    def [](k)
+      @hash[k]
+    end
+
+    # @return [Hash] Hash representation of this delivery info
+    def to_hash
+      @hash
+    end
+
+    # @private
+    def to_s
+      to_hash.to_s
+    end
+
+    # @private
+    def inspect
+      to_hash.inspect
+    end
+
+    # @return [String] Delivery identifier that is used to acknowledge, reject and nack deliveries
+    def delivery_tag
+      @get_ok.delivery_tag
+    end
+
+    # @return [Boolean] true if this delivery is a redelivery (the message was requeued at least once)
+    def redelivered
+      @get_ok.redelivered
+    end
+    alias redelivered? redelivered
+
+    # @return [String] Name of the exchange this message was published to
+    def exchange
+      @get_ok.exchange
+    end
+
+    # @return [String] Routing key this message was published with
+    def routing_key
+      @get_ok.routing_key
+    end
+  end
+end

data/lib/bunny/heartbeat_sender.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "thread"
 require "amq/protocol/client"
 require "amq/protocol/frame"
@@ -17,7 +19,7 @@ module Bunny
       @logger    = logger
       @mutex     = Monitor.new
 
-      @last_activity_time = Time.now
+      @last_activity_time = Bunny::Timestamp.monotonic
     end
 
     def start(period = 30)
@@ -29,6 +31,7 @@ module Bunny
         @interval = [(period / 2) - 1, 0.4].max
 
         @thread = Thread.new(&method(:run))
+        @thread.report_on_exception = false if @thread.respond_to?(:report_on_exception)
       end
     end
 
@@ -37,7 +40,7 @@ module Bunny
     end
 
     def signal_activity!
-      @last_activity_time = Time.now
+      @last_activity_time = Bunny::Timestamp.monotonic
     end
 
     protected
@@ -52,18 +55,18 @@ module Bunny
       rescue IOError => ioe
         @logger.error "I/O error in the hearbeat sender: #{ioe.message}"
         stop
-      rescue Exception => e
+      rescue ::Exception => e
         @logger.error "Error in the hearbeat sender: #{e.message}"
         stop
       end
     end
 
     def beat
-      now = Time.now
+      now = Bunny::Timestamp.monotonic
 
       if now > (@last_activity_time + @interval)
-        @logger.debug "Sending a heartbeat, last activity time: #{@last_activity_time}, interval (s): #{@interval}"
-        @transport.write_without_timeout(AMQ::Protocol::HeartbeatFrame.encode)
+        @logger.debug { "Sending a heartbeat, last activity time: #{@last_activity_time}, interval (s): #{@interval}" }
+        @transport.write_without_timeout(AMQ::Protocol::HeartbeatFrame.encode, true)
       end
     end
   end

data/lib/bunny/message_properties.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bunny
   # Wraps basic properties hash as returned by amq-protocol to
   # provide access to the delivery properties as immutable hash as

data/lib/bunny/queue.rb

@@ -1,4 +1,6 @@
-require "bunny/compatibility"
+# frozen_string_literal: true
+
+require "bunny/get_response"
 
 module Bunny
   # Represents AMQP 0.9.1 queue.
@@ -7,13 +9,27 @@ module Bunny
   # @see http://rubybunny.info/articles/extensions.html RabbitMQ Extensions guide
   class Queue
 
-    include Bunny::Compatibility
-
-
     #
     # API
     #
 
+    module Types
+      QUORUM  = "quorum"
+      CLASSIC = "classic"
+      STREAM  = "stream"
+
+      KNOWN = [CLASSIC, QUORUM, STREAM]
+
+      def self.known?(q_type)
+        KNOWN.include?(q_type)
+      end
+    end
+
+    module XArgs
+      MAX_LENGTH = "x-max-length",
+      QUEUE_TYPE = "x-queue-type"
+    end
+
     # @return [Bunny::Channel] Channel this queue uses
     attr_reader :channel
     # @return [String] Queue name
@@ -21,33 +37,42 @@ module Bunny
     # @return [Hash] Options this queue was created with
     attr_reader :options
 
-    # @param [Bunny::Channel] channel_or_connection Channel this queue will use. {Bunny::Session} instances are supported only for
-    #                                               backwards compatibility with 0.8.
+    # @param [Bunny::Channel] channel Channel this queue will use.
     # @param [String] name                          Queue name. Pass an empty string to make RabbitMQ generate a unique one.
     # @param [Hash] opts                            Queue properties
     #
     # @option opts [Boolean] :durable (false)      Should this queue be durable?
     # @option opts [Boolean] :auto_delete (false)  Should this queue be automatically deleted when the last consumer disconnects?
     # @option opts [Boolean] :exclusive (false)    Should this queue be exclusive (only can be used by this connection, removed when the connection is closed)?
-    # @option opts [Boolean] :arguments ({})       Additional optional arguments (typically used by RabbitMQ extensions and plugins)
+    # @option opts [String] :type (nil)            Type of the declared queue (classic, quorum or stream)
+    # @option opts [Hash] :arguments (nil)         Additional optional arguments (typically used by RabbitMQ extensions and plugins)
     #
     # @see Bunny::Channel#queue
     # @see http://rubybunny.info/articles/queues.html Queues and Consumers guide
     # @see http://rubybunny.info/articles/extensions.html RabbitMQ Extensions guide
     # @api public
-    def initialize(channel_or_connection, name = AMQ::Protocol::EMPTY_STRING, opts = {})
+    def initialize(channel, name = AMQ::Protocol::EMPTY_STRING, opts = {})
       # old Bunny versions pass a connection here. In that case,
       # we just use default channel from it. MK.
-      @channel          = channel_from(channel_or_connection)
+      @channel          = channel
       @name             = name
       @options          = self.class.add_default_options(name, opts)
-      @consumers        = Hash.new
 
       @durable          = @options[:durable]
       @exclusive        = @options[:exclusive]
       @server_named     = @name.empty?
       @auto_delete      = @options[:auto_delete]
-      @arguments        = @options[:arguments]
+      @type             = @options[:type]
+
+      @arguments        = if @type and !@type.empty? then
+        (@options[:arguments] || {}).merge({XArgs::QUEUE_TYPE => @type})
+      else
+        @options[:arguments]
+      end
+      verify_type!(@arguments)
+      # reassigns updated and verified arguments because Bunny::Channel#declare_queue
+      # accepts a map of options
+      @options[:arguments] = @arguments
 
       @bindings         = Array.new
 
@@ -92,6 +117,15 @@ module Bunny
       @arguments
     end
 
+    def to_s
+      oid = ("0x%x" % (self.object_id << 1))
+      "<#{self.class.name}:#{oid} @name=\"#{name}\" channel=#{@channel.to_s} @durable=#{@durable} @auto_delete=#{@auto_delete} @exclusive=#{@exclusive} @arguments=#{@arguments}>"
+    end
+
+    def inspect
+      to_s
+    end
+
     # Binds queue to an exchange
     #
     # @param [Bunny::Exchange,String] exchange Exchange to bind to
@@ -151,9 +185,9 @@ module Bunny
     #
     # @param [Hash] opts Options
     #
+    # @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 calling thread?
     # @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
@@ -162,17 +196,22 @@ module Bunny
     # @api public
     def subscribe(opts = {
                     :consumer_tag    => @channel.generate_consumer_tag,
-                    :ack             => false,
+                    :manual_ack      => false,
                     :exclusive       => false,
                     :block           => false,
                     :on_cancellation => nil
                   }, &block)
 
+      unless opts[:ack].nil?
+        warn "[DEPRECATION] `:ack` is deprecated.  Please use `:manual_ack` instead."
+        opts[:manual_ack] = opts[:ack]
+      end
+
       ctag       = opts.fetch(:consumer_tag, @channel.generate_consumer_tag)
       consumer   = Consumer.new(@channel,
                                 self,
                                 ctag,
-                                !(opts[:ack] || opts[:manual_ack]),
+                                !opts[:manual_ack],
                                 opts[:exclusive],
                                 opts[:arguments])
 
@@ -207,7 +246,8 @@ module Bunny
 
     # @param [Hash] opts Options
     #
-    # @option opts [Boolean] :ack (false) Will the message be acknowledged manually?
+    # @option opts [Boolean] :ack (false) [DEPRECATED] Use :manual_ack instead
+    # @option opts [Boolean] :manual_ack (false) Will the message be acknowledged manually?
     #
     # @return [Array] Triple of delivery info, message properties and message content.
     #                 If the queue is empty, all three will be nils.
@@ -228,33 +268,34 @@ module Bunny
     #
     #   puts "This is the message: " + payload + "\n\n"
     #   conn.close
-    def pop(opts = {:ack => false}, &block)
-      delivery_info, properties, content = @channel.basic_get(@name, opts)
-
-      if block
-        block.call(delivery_info, properties, content)
-      else
-        [delivery_info, properties, content]
+    def pop(opts = {:manual_ack => false}, &block)
+      unless opts[:ack].nil?
+        warn "[DEPRECATION] `:ack` is deprecated.  Please use `:manual_ack` instead."
+        opts[:manual_ack] = opts[:ack]
       end
-    end
-    alias get pop
 
-    # Version of {Bunny::Queue#pop} that returns data in legacy format
-    # (as a hash).
-    # @return [Hash]
-    # @deprecated
-    def pop_as_hash(opts = {:ack => false}, &block)
-      delivery_info, properties, content = @channel.basic_get(@name, opts)
-
-      result = {:header => properties, :payload => content, :delivery_details => delivery_info}
+      get_response, properties, content = @channel.basic_get(@name, opts)
 
       if block
-        block.call(result)
+        if properties
+          di = GetResponse.new(get_response, @channel)
+          mp = MessageProperties.new(properties)
+
+          block.call(di, mp, content)
+        else
+          block.call(nil, nil, nil)
+        end
       else
-        result
+        if properties
+          di = GetResponse.new(get_response, @channel)
+          mp = MessageProperties.new(properties)
+          [di, mp, content]
+        else
+          [nil, nil, nil]
+        end
       end
     end
-
+    alias get pop
 
     # Publishes a message to the queue via default exchange. Takes the same arguments
     # as {Bunny::Exchange#publish}
@@ -313,6 +354,14 @@ module Bunny
       s[:consumer_count]
     end
 
+    def self.verify_type!(args0 = {})
+      # be extra defensive
+      args = args0 || {}
+      q_type = args["x-queue-type"] || args[:"x-queue-type"]
+      throw ArgumentError.new(
+        "unsupported queue type #{q_type.inspect}, supported ones: #{Types::KNOWN.join(', ')}") if (q_type and !Types.known?(q_type))
+    end
+
     #
     # Recovery
     #
@@ -329,7 +378,7 @@ module Bunny
       # TODO: inject and use logger
       # puts "Recovering queue #{@name}"
       begin
-        declare!
+        declare! unless @options[:no_declare]
 
         @channel.register_queue(self)
       rescue Exception => e
@@ -361,11 +410,6 @@ module Bunny
 
     protected
 
-    # @private
-    def self.add_default_options(name, opts, block)
-      { :queue => name, :nowait => (block.nil? && !name.empty?) }.merge(opts)
-    end
-
     # @private
     def self.add_default_options(name, opts)
       # :nowait is always false for Bunny
@@ -383,5 +427,9 @@ module Bunny
         h
       end
     end
+
+    def verify_type!(args)
+      self.class.verify_type!(args)
+    end
   end
 end