bunny 1.3.0 → 2.17.0

data/lib/bunny/exchange.rb

@@ -1,4 +1,4 @@
-require "bunny/compatibility"
+require 'amq/protocol'
 
 module Bunny
   # Represents AMQP 0.9.1 exchanges.
@@ -7,9 +7,6 @@ module Bunny
   # @see http://rubybunny.info/articles/extensions.html RabbitMQ Extensions guide
   class Exchange
 
-    include Bunny::Compatibility
-
-
     #
     # API
     #
@@ -33,12 +30,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,11 +43,11 @@ 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
@@ -58,11 +55,10 @@ module Bunny
       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,10 +71,8 @@ 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)
@@ -88,6 +82,8 @@ module Bunny
       @internal         = @options[:internal]
       @arguments        = @options[:arguments]
 
+      @bindings         = Set.new
+
       declare! unless opts[:no_declare] || predeclared? || (@name == AMQ::Protocol::EMPTY_STRING)
 
       @channel.register_exchange(self)
@@ -177,6 +173,7 @@ module Bunny
     # @api public
     def bind(source, opts = {})
       @channel.exchange_bind(source, self, opts)
+      @bindings.add(source: source, opts: opts)
 
       self
     end
@@ -197,6 +194,7 @@ module Bunny
     # @api public
     def unbind(source, opts = {})
       @channel.exchange_unbind(source, self, opts)
+      @bindings.delete(source: source, opts: opts)
 
       self
     end
@@ -222,8 +220,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
 
 
@@ -253,11 +254,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

data/lib/bunny/get_response.rb

@@ -20,7 +20,7 @@ module Bunny
     attr_reader :channel
 
     # @private
-    def initialize(get_ok, consumer, channel)
+    def initialize(get_ok, channel)
       @get_ok = get_ok
       @hash          = {
         :delivery_tag => @get_ok.delivery_tag,

data/lib/bunny/heartbeat_sender.rb

@@ -29,6 +29,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
 
@@ -62,8 +63,8 @@ module Bunny
       now = Time.now
 
       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/jruby/socket.rb

@@ -5,7 +5,22 @@ module Bunny
     # TCP socket extension that uses Socket#readpartial to avoid excessive CPU
     # burn after some time. See issue #165.
     # @private
-    class Socket < Bunny::Socket
+    module Socket
+      include Bunny::Socket
+
+      def self.open(host, port, options = {})
+        socket = ::Socket.tcp(host, port, nil, nil,
+                              connect_timeout: options[:connect_timeout])
+        if ::Socket.constants.include?('TCP_NODELAY') || ::Socket.constants.include?(:TCP_NODELAY)
+          socket.setsockopt(::Socket::IPPROTO_TCP, ::Socket::TCP_NODELAY, true)
+        end
+        socket.setsockopt(::Socket::SOL_SOCKET, ::Socket::SO_KEEPALIVE, true) if options.fetch(:keepalive, true)
+        socket.extend self
+        socket.options = { :host => host, :port => port }.merge(options)
+        socket
+      rescue Errno::ETIMEDOUT
+        raise ClientTimeout
+      end
 
       # Reads given number of bytes with an optional timeout
       #
@@ -15,17 +30,17 @@ module Bunny
       # @return [String] Data read from the socket
       # @api public
       def read_fully(count, timeout = nil)
-        return nil if @__bunny_socket_eof_flag__
-
         value = ''
+
         begin
           loop do
-            value << readpartial(count - value.bytesize)
+            value << read_nonblock(count - value.bytesize)
             break if value.bytesize >= count
           end
         rescue EOFError
-          # @eof will break Rubinius' TCPSocket implementation. MK.
-          @__bunny_socket_eof_flag__ = true
+          # JRuby specific fix via https://github.com/jruby/jruby/issues/1694#issuecomment-54873532
+          IO.select([self], nil, nil, timeout)
+          retry
         rescue *READ_RETRY_EXCEPTION_CLASSES
           if IO.select([self], nil, nil, timeout)
             retry
@@ -33,8 +48,10 @@ module Bunny
             raise Timeout::Error, "IO timeout when reading #{count} bytes"
           end
         end
+
         value
       end # read_fully
+
     end
   end
 end

data/lib/bunny/jruby/ssl_socket.rb

@@ -8,6 +8,11 @@ module Bunny
       # methods found in Bunny::Socket.
       class SSLSocket < Bunny::SSLSocket
 
+        def initialize(*args)
+          super
+          @__bunny_socket_eof_flag__ = false
+        end
+
         # Reads given number of bytes with an optional timeout
         #
         # @param [Integer] count How many bytes to read

data/lib/bunny/queue.rb

@@ -1,4 +1,3 @@
-require "bunny/compatibility"
 require "bunny/get_response"
 
 module Bunny
@@ -8,9 +7,6 @@ module Bunny
   # @see http://rubybunny.info/articles/extensions.html RabbitMQ Extensions guide
   class Queue
 
-    include Bunny::Compatibility
-
-
     #
     # API
     #
@@ -22,8 +18,7 @@ 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
     #
@@ -36,13 +31,12 @@ module Bunny
     # @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]
@@ -93,6 +87,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
@@ -152,9 +155,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
@@ -163,17 +166,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])
 
@@ -208,7 +216,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.
@@ -229,12 +238,17 @@ module Bunny
     #
     #   puts "This is the message: " + payload + "\n\n"
     #   conn.close
-    def pop(opts = {:ack => false}, &block)
+    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
+
       get_response, properties, content = @channel.basic_get(@name, opts)
 
       if block
         if properties
-          di = GetResponse.new(get_response, properties, @channel)
+          di = GetResponse.new(get_response, @channel)
           mp = MessageProperties.new(properties)
 
           block.call(di, mp, content)
@@ -243,7 +257,7 @@ module Bunny
         end
       else
         if properties
-          di = GetResponse.new(get_response, properties, @channel)
+          di = GetResponse.new(get_response, @channel)
           mp = MessageProperties.new(properties)
           [di, mp, content]
         else
@@ -326,7 +340,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
@@ -358,11 +372,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

data/lib/bunny/reader_loop.rb

@@ -9,13 +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
     end
 
 
@@ -33,15 +37,17 @@ module Bunny
         begin
           break if @mutex.synchronize { @stopping || @stopped || @network_is_down }
           run_once
-        rescue AMQ::Protocol::EmptyResponseError, IOError, SystemCallError => e
+        rescue AMQ::Protocol::EmptyResponseError, IOError, SystemCallError, Timeout::Error,
+               OpenSSL::OpenSSLError => e
           break if terminate? || @session.closing? || @session.closed?
 
-          log_exception(e)
           @network_is_down = true
           if @session.automatically_recover?
+            log_exception(e, level: :warn)
             @session.handle_network_failure(e)
           else
-            @session_thread.raise(Bunny::NetworkFailure.new("detected a network failure: #{e.message}", e))
+            log_exception(e)
+            @session_error_handler.raise(Bunny::NetworkFailure.new("detected a network failure: #{e.message}", e))
           end
         rescue ShutdownSignal => _
           @mutex.synchronize { @stopping = true }
@@ -52,9 +58,9 @@ 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
+        rescue Errno::EBADF => _ebadf
           break if terminate?
           # ignored, happens when we loop after the transport has already been closed
           @mutex.synchronize { @stopping = true }
@@ -92,11 +98,11 @@ module Bunny
     end
 
     def stopped?
-      @mutex.synchronize { @stopped = true }
+      @mutex.synchronize { @stopped }
     end
 
     def stopping?
-      @mutex.synchronize { @stopping = true }
+      @mutex.synchronize { @stopping }
     end
 
     def terminate_with(e)
@@ -110,7 +116,14 @@ module Bunny
     end
 
     def join
-      @thread.join if @thread
+      # Thread#join can/would trigger a re-raise of an unhandled exception in this thread.
+      # In addition, Thread.handle_interrupt can be used by other libraries or application code
+      # that would make this join operation fail with an obscure exception.
+      # So we try to save everyone some really unpleasant debugging time by introducing
+      # this condition which typically would not evaluate to true anyway.
+      #
+      # See ruby-amqp/bunny#589 and ruby-amqp/bunny#590 for background.
+      @thread.join if @thread && @thread != Thread.current
     end
 
     def kill
@@ -122,12 +135,12 @@ module Bunny
 
     protected
 
-    def log_exception(e)
+    def log_exception(e, level: :error)
       if !(io_error?(e) && (@session.closing? || @session.closed?))
-        @logger.error "Exception in the reader loop: #{e.class.name}: #{e.message}"
-        @logger.error "Backtrace: "
+        @logger.send level, "Exception in the reader loop: #{e.class.name}: #{e.message}"
+        @logger.send level, "Backtrace: "
         e.backtrace.each do |line|
-          @logger.error "\t#{line}"
+          @logger.send level, "\t#{line}"
         end
       end
     end