amqp-client 1.0.1 → 1.1.2

data/lib/amqp/client/connection.rb

@@ -3,7 +3,7 @@
 require "socket"
 require "uri"
 require "openssl"
-require_relative "./frames"
+require_relative "./frame_bytes"
 require_relative "./channel"
 require_relative "./errors"
 
@@ -13,58 +13,50 @@ module AMQP
     class Connection
       # Establish a connection to an AMQP broker
       # @param uri [String] URL on the format amqp://username:password@hostname/vhost, use amqps:// for encrypted connection
-      # @param read_loop_thread [Boolean] Set to false if you manually want to run the {#read_loop}
+      # @param read_loop_thread [Boolean] If true run {#read_loop} in a background thread,
+      #   otherwise the user have to run it explicitly, without {#read_loop} the connection won't function
       # @option options [Boolean] connection_name (PROGRAM_NAME) Set a name for the connection to be able to identify
       #   the client from the broker
       # @option options [Boolean] verify_peer (true) Verify broker's TLS certificate, set to false for self-signed certs
+      # @option options [Integer] connect_timeout (30) TCP connection timeout
       # @option options [Integer] heartbeat (0) Heartbeat timeout, defaults to 0 and relies on TCP keepalive instead
       # @option options [Integer] frame_max (131_072) Maximum frame size,
       #    the smallest of the client's and the broker's values will be used
       # @option options [Integer] channel_max (2048) Maxium number of channels the client will be allowed to have open.
       #   Maxium allowed is 65_536.  The smallest of the client's and the broker's value will be used.
       # @return [Connection]
-      def self.connect(uri, read_loop_thread: true, **options)
+      def initialize(uri = "", read_loop_thread: true, **options)
         uri = URI.parse(uri)
         tls = uri.scheme == "amqps"
         port = port_from_env || uri.port || (tls ? 5671 : 5672)
         host = uri.host || "localhost"
         user = uri.user || "guest"
         password = uri.password || "guest"
-        vhost = URI.decode_www_form_component(uri.path[1..-1] || "/")
+        vhost = URI.decode_www_form_component(uri.path[1..] || "/")
         options = URI.decode_www_form(uri.query || "").map! { |k, v| [k.to_sym, v] }.to_h.merge(options)
 
-        socket = Socket.tcp host, port, connect_timeout: 20, resolv_timeout: 5
-        enable_tcp_keepalive(socket)
-        if tls
-          cert_store = OpenSSL::X509::Store.new
-          cert_store.set_default_paths
-          context = OpenSSL::SSL::SSLContext.new
-          context.cert_store = cert_store
-          context.verify_mode = OpenSSL::SSL::VERIFY_PEER unless [false, "false", "none"].include? options[:verify_peer]
-          socket = OpenSSL::SSL::SSLSocket.new(socket, context)
-          socket.sync_close = true # closing the TLS socket also closes the TCP socket
-          socket.hostname = host # SNI host
-          socket.connect
-          socket.post_connection_check(host) || raise(Error, "TLS certificate hostname doesn't match requested")
-        end
+        socket = open_socket(host, port, tls, options)
         channel_max, frame_max, heartbeat = establish(socket, user, password, vhost, options)
-        Connection.new(socket, channel_max, frame_max, heartbeat, read_loop_thread: read_loop_thread)
-      end
 
-      # Requires an already established TCP/TLS socket
-      # @api private
-      def initialize(socket, channel_max, frame_max, heartbeat, read_loop_thread: true)
         @socket = socket
         @channel_max = channel_max.zero? ? 65_536 : channel_max
         @frame_max = frame_max
         @heartbeat = heartbeat
         @channels = {}
-        @closed = false
+        @closed = nil
         @replies = ::Queue.new
         @write_lock = Mutex.new
+        @blocked = nil
         Thread.new { read_loop } if read_loop_thread
       end
 
+      # Alias for {#initialize}
+      # @see #initialize
+      # @deprecated
+      def self.connect(uri, read_loop_thread: true, **options)
+        new(uri, read_loop_thread: read_loop_thread, **options)
+      end
+
       # The max frame size negotiated between the client and the broker
       # @return [Integer]
       attr_reader :frame_max
@@ -115,17 +107,21 @@ module AMQP
       def close(reason: "", code: 200)
         return if @closed
 
-        @closed = true
-        write_bytes FrameBytes.connection_close(code, reason)
-        @channels.each_value { |ch| ch.closed!(code, reason, 0, 0) }
-        expect(:close_ok)
+        @closed = [code, reason]
+        @channels.each_value { |ch| ch.closed!(:connection, code, reason, 0, 0) }
+        if @blocked
+          @socket.close
+        else
+          write_bytes FrameBytes.connection_close(code, reason)
+          expect(:close_ok)
+        end
         nil
       end
 
       # True if the connection is closed
       # @return [Boolean]
       def closed?
-        @closed
+        !@closed.nil?
       end
 
       # Write byte array(s) directly to the socket (thread-safe)
@@ -133,10 +129,19 @@ module AMQP
       # @return [Integer] number of bytes written
       # @api private
       def write_bytes(*bytes)
+        blocked = @blocked
+        warn "AMQP-Client blocked by broker: #{blocked}" if blocked
         @write_lock.synchronize do
-          @socket.write(*bytes)
+          warn "AMQP-Client unblocked by broker" if blocked
+          if RUBY_ENGINE == "truffleruby"
+            bytes.each { |b| @socket.write b }
+          else
+            @socket.write(*bytes)
+          end
         end
-      rescue IOError, OpenSSL::OpenSSLError, SystemCallError => e
+      rescue *READ_EXCEPTIONS => e
+        raise Error::ConnectionClosed.new(*@closed) if @closed
+
         raise Error, "Could not write to socket, #{e.message}"
       end
 
@@ -151,12 +156,12 @@ module AMQP
         frame_start = String.new(capacity: 7)
         frame_buffer = String.new(capacity: frame_max)
         loop do
-          socket.read(7, frame_start)
+          socket.read(7, frame_start) || raise(IOError)
           type, channel_id, frame_size = frame_start.unpack("C S> L>")
           frame_max >= frame_size || raise(Error, "Frame size #{frame_size} larger than negotiated max frame size #{frame_max}")
 
           # read the frame content
-          socket.read(frame_size, frame_buffer)
+          socket.read(frame_size, frame_buffer) || raise(IOError)
 
           # make sure that the frame end is correct
           frame_end = socket.readchar.ord
@@ -166,21 +171,26 @@ module AMQP
           parse_frame(type, channel_id, frame_buffer) || return
         end
         nil
-      rescue IOError, OpenSSL::OpenSSLError, SystemCallError => e
-        warn "AMQP-Client read error: #{e.inspect}"
+      rescue *READ_EXCEPTIONS => e
+        @closed ||= [400, "read error: #{e.message}"]
         nil # ignore read errors
       ensure
-        @closed = true
+        @closed ||= [400, "unknown"]
         @replies.close
         begin
-          @socket.close
-        rescue IOError, OpenSSL::OpenSSLError, SystemCallError
+          @write_lock.synchronize do
+            @socket.close
+          end
+        rescue *READ_EXCEPTIONS
           nil
         end
       end
 
       private
 
+      READ_EXCEPTIONS = [IOError, OpenSSL::OpenSSLError, SystemCallError,
+                         RUBY_ENGINE == "jruby" ? java.lang.NullPointerException : nil].compact.freeze
+
       def parse_frame(type, channel_id, buf)
         case type
         when 1 # method frame
@@ -191,11 +201,11 @@ module AMQP
 
             case method_id
             when 50 # connection#close
-              @closed = true
               code, text_len = buf.unpack("@4 S> C")
               text = buf.byteslice(7, text_len).force_encoding("utf-8")
               error_class_id, error_method_id = buf.byteslice(7 + text_len, 4).unpack("S> S>")
-              @channels.each_value { |ch| ch.closed!(code, text, error_class_id, error_method_id) }
+              @closed = [code, text, error_class_id, error_method_id]
+              @channels.each_value { |ch| ch.closed!(:connection, code, text, error_class_id, error_method_id) }
               begin
                 write_bytes FrameBytes.connection_close_ok
               rescue Error
@@ -203,9 +213,16 @@ module AMQP
               end
               return false
             when 51 # connection#close-ok
-              @closed = true
               @replies.push [:close_ok]
               return false
+            when 60 # connection#blocked
+              reason_len = buf.getbyte(4)
+              reason = buf.byteslice(5, reason_len).force_encoding("utf-8")
+              @blocked = reason
+              @write_lock.lock
+            when 61 # connection#unblocked
+              @blocked = nil
+              @write_lock.unlock
             else raise Error::UnsupportedMethodFrame, class_id, method_id
             end
           when 20 # channel
@@ -217,7 +234,7 @@ module AMQP
               reply_text = buf.byteslice(7, reply_text_len).force_encoding("utf-8")
               classid, methodid = buf.byteslice(7 + reply_text_len, 4).unpack("S> S>")
               channel = @channels.delete(channel_id)
-              channel.closed!(reply_code, reply_text, classid, methodid)
+              channel.closed!(:channel, reply_code, reply_text, classid, methodid)
               write_bytes FrameBytes.channel_close_ok(channel_id)
             when 41 # channel#close-ok
               channel = @channels.delete(channel_id)
@@ -239,7 +256,7 @@ module AMQP
           when 50 # queue
             case method_id
             when 11 # declare-ok
-              queue_name_len = buf.unpack1("@4 C")
+              queue_name_len = buf.getbyte(4)
               queue_name = buf.byteslice(5, queue_name_len).force_encoding("utf-8")
               message_count, consumer_count = buf.byteslice(5 + queue_name_len, 8).unpack("L> L>")
               @channels[channel_id].reply [:queue_declare_ok, queue_name, message_count, consumer_count]
@@ -259,17 +276,17 @@ module AMQP
             when 11 # qos-ok
               @channels[channel_id].reply [:basic_qos_ok]
             when 21 # consume-ok
-              tag_len = buf.unpack1("@4 C")
+              tag_len = buf.getbyte(4)
               tag = buf.byteslice(5, tag_len).force_encoding("utf-8")
               @channels[channel_id].reply [:basic_consume_ok, tag]
             when 30 # cancel
-              tag_len = buf.unpack1("@4 C")
+              tag_len = buf.getbyte(4)
               tag = buf.byteslice(5, tag_len).force_encoding("utf-8")
-              no_wait = buf[5 + tag_len].ord == 1
+              no_wait = buf.getbyte(5 + tag_len) == 1
               @channels[channel_id].close_consumer(tag)
               write_bytes FrameBytes.basic_cancel_ok(@id, tag) unless no_wait
             when 31 # cancel-ok
-              tag_len = buf.unpack1("@4 C")
+              tag_len = buf.getbyte(4)
               tag = buf.byteslice(5, tag_len).force_encoding("utf-8")
               @channels[channel_id].reply [:basic_cancel_ok, tag]
             when 50 # return
@@ -277,23 +294,23 @@ module AMQP
               pos = 7
               reply_text = buf.byteslice(pos, reply_text_len).force_encoding("utf-8")
               pos += reply_text_len
-              exchange_len = buf[pos].ord
+              exchange_len = buf.getbyte(pos)
               pos += 1
               exchange = buf.byteslice(pos, exchange_len).force_encoding("utf-8")
               pos += exchange_len
-              routing_key_len = buf[pos].ord
+              routing_key_len = buf.getbyte(pos)
               pos += 1
               routing_key = buf.byteslice(pos, routing_key_len).force_encoding("utf-8")
               @channels[channel_id].message_returned(reply_code, reply_text, exchange, routing_key)
             when 60 # deliver
-              ctag_len = buf[4].ord
+              ctag_len = buf.getbyte(4)
               consumer_tag = buf.byteslice(5, ctag_len).force_encoding("utf-8")
               pos = 5 + ctag_len
               delivery_tag, redelivered, exchange_len = buf.byteslice(pos, 10).unpack("Q> C C")
               pos += 8 + 1 + 1
               exchange = buf.byteslice(pos, exchange_len).force_encoding("utf-8")
               pos += exchange_len
-              rk_len = buf[pos].ord
+              rk_len = buf.getbyte(pos)
               pos += 1
               routing_key = buf.byteslice(pos, rk_len).force_encoding("utf-8")
               @channels[channel_id].message_delivered(consumer_tag, delivery_tag, redelivered == 1, exchange, routing_key)
@@ -302,11 +319,11 @@ module AMQP
               pos = 14
               exchange = buf.byteslice(pos, exchange_len).force_encoding("utf-8")
               pos += exchange_len
-              routing_key_len = buf[pos].ord
+              routing_key_len = buf.getbyte(pos)
               pos += 1
               routing_key = buf.byteslice(pos, routing_key_len).force_encoding("utf-8")
-              pos += routing_key_len
-              _message_count = buf.byteslice(pos, 4).unpack1("L>")
+              # pos += routing_key_len
+              # message_count = buf.byteslice(pos, 4).unpack1("L>")
               @channels[channel_id].message_delivered(nil, delivery_tag, redelivered == 1, exchange, routing_key)
             when 72 # get-empty
               @channels[channel_id].basic_get_empty
@@ -340,7 +357,7 @@ module AMQP
           end
         when 2 # header
           body_size = buf.unpack1("@4 Q>")
-          properties = Properties.decode(buf.byteslice(12, buf.bytesize - 12))
+          properties = Properties.decode(buf, 12)
           @channels[channel_id].header_delivered body_size, properties
         when 3 # body
           @channels[channel_id].body_delivered buf
@@ -360,21 +377,44 @@ module AMQP
         args
       end
 
+      # Connect to the host/port, optionally establish a TLS connection
+      # @return [Socket]
+      # @return [OpenSSL::SSL::SSLSocket]
+      def open_socket(host, port, tls, options)
+        connect_timeout = options.fetch(:connect_timeout, 30).to_i
+        socket = Socket.tcp host, port, connect_timeout: connect_timeout
+        enable_tcp_keepalive(socket)
+        if tls
+          cert_store = OpenSSL::X509::Store.new
+          cert_store.set_default_paths
+          context = OpenSSL::SSL::SSLContext.new
+          context.cert_store = cert_store
+          verify_peer = [false, "false", "none"].include? options[:verify_peer]
+          context.verify_mode = OpenSSL::SSL::VERIFY_PEER unless verify_peer
+          socket = OpenSSL::SSL::SSLSocket.new(socket, context)
+          socket.sync_close = true # closing the TLS socket also closes the TCP socket
+          socket.hostname = host # SNI host
+          socket.connect
+          socket.post_connection_check(host) || raise(Error, "TLS certificate hostname doesn't match requested")
+        end
+        socket
+      end
+
       # Negotiate a connection
       # @return [Array<Integer, Integer, Integer>] channel_max, frame_max, heartbeat
-      def self.establish(socket, user, password, vhost, options)
+      def establish(socket, user, password, vhost, options)
         channel_max, frame_max, heartbeat = nil
         socket.write "AMQP\x00\x00\x09\x01"
         buf = String.new(capacity: 4096)
         loop do
           begin
             socket.readpartial(4096, buf)
-          rescue IOError, OpenSSL::OpenSSLError, SystemCallError => e
+          rescue *READ_EXCEPTIONS => e
             raise Error, "Could not establish AMQP connection: #{e.message}"
           end
 
           type, channel_id, frame_size = buf.unpack("C S> L>")
-          frame_end = buf[frame_size + 7].ord
+          frame_end = buf.getbyte(frame_size + 7)
           raise UnexpectedFrameEndError, frame_end if frame_end != 206
 
           case type
@@ -411,16 +451,18 @@ module AMQP
           else raise Error, "Unexpected frame type: #{type}"
           end
         end
-      rescue StandardError => e
+      rescue Exception => e
         begin
           socket.close
-        rescue IOError, OpenSSL::OpenSSLError, SystemCallError
+        rescue *READ_EXCEPTIONS
           nil
         end
         raise e
       end
 
-      def self.enable_tcp_keepalive(socket)
+      # Enable TCP keepalive, which is prefered to heartbeats
+      # @return [void]
+      def enable_tcp_keepalive(socket)
         socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, true)
         socket.setsockopt(Socket::SOL_TCP, Socket::TCP_KEEPIDLE, 60)
         socket.setsockopt(Socket::SOL_TCP, Socket::TCP_KEEPINTVL, 10)
@@ -429,14 +471,15 @@ module AMQP
         warn "AMQP-Client could not enable TCP keepalive on socket. #{e.inspect}"
       end
 
-      def self.port_from_env
+      # Fetch the AMQP port number from ENV
+      # @return [Integer] A port number
+      # @return [nil] When the environment variable AMQP_PORT isn't set
+      def port_from_env
         return unless (port = ENV["AMQP_PORT"])
 
         port.to_i
       end
 
-      private_class_method :establish, :enable_tcp_keepalive, :port_from_env
-
       CLIENT_PROPERTIES = {
         capabilities: {
           authentication_failure_close: true,

data/lib/amqp/client/errors.rb

@@ -32,6 +32,19 @@ module AMQP
         end
       end
 
+      # Depending on close level a ConnectionClosed or ChannelClosed error is returned
+      class Closed < Error
+        def self.new(id, level, code, reason, classid = 0, methodid = 0)
+          case level
+          when :connection
+            ConnectionClosed.new(code, reason, classid, methodid)
+          when :channel
+            ChannelClosed.new(id, code, reason, classid, methodid)
+          else raise ArgumentError, "invalid level '#{level}'"
+          end
+        end
+      end
+
       # Raised if channel is already closed
       class ChannelClosed < Error
         def initialize(id, code, reason, classid = 0, methodid = 0)
@@ -40,7 +53,11 @@ module AMQP
       end
 
       # Raised if connection is unexpectedly closed
-      class ConnectionClosed < Error; end
+      class ConnectionClosed < Error
+        def initialize(code, reason, classid = 0, methodid = 0)
+          super "Connection closed (#{code}) #{reason} (#{classid}/#{methodid})"
+        end
+      end
     end
   end
 end