http-2 1.0.1 → 1.1.0

data/lib/http/2/flow_buffer.rb

@@ -7,6 +7,8 @@ module HTTP2
   module FlowBuffer
     include Error
 
+    attr_reader :send_buffer
+
     MAX_WINDOW_SIZE = (2 << 30) - 1
 
     # Amount of buffered data. Only DATA payloads are subject to flow stream
@@ -14,7 +16,7 @@ module HTTP2
     #
     # @return [Integer]
     def buffered_amount
-      send_buffer.bytesize
+      @send_buffer.bytesize
     end
 
     def flush
@@ -23,13 +25,9 @@ module HTTP2
 
     private
 
-    def send_buffer
-      @send_buffer ||= FrameBuffer.new
-    end
-
     def update_local_window(frame)
       frame_size = frame[:payload].bytesize
-      frame_size += frame[:padding] || 0
+      frame_size += frame.fetch(:padding, 0)
       @local_window -= frame_size
     end
 
@@ -69,31 +67,47 @@ module HTTP2
     # @param frame [Hash]
     # @param encode [Boolean] set to true by connection
     def send_data(frame = nil, encode = false)
-      send_buffer << frame unless frame.nil?
+      if frame
+        if @send_buffer.empty?
+          frame_size = frame[:payload].bytesize
+          end_stream = frame[:flags].include?(:end_stream)
+          # if buffer is empty, and frame is either end 0 length OR
+          # is within available window size, skip buffering and send immediately.
+          if @remote_window.positive?
+            return send_frame(frame, encode) if frame_size <= @remote_window
+          elsif frame_size.zero? && end_stream
+            return send_frame(frame, encode)
+          end
+        end
 
-      while (frame = send_buffer.retrieve(@remote_window))
+        @send_buffer << frame
+      end
 
-        # puts "#{self.class} -> #{@remote_window}"
-        sent = frame[:payload].bytesize
+      while (frame = @send_buffer.retrieve(@remote_window))
+        send_frame(frame, encode)
+      end
+    end
 
-        manage_state(frame) do
-          if encode
-            encode(frame).each { |f| emit(:frame, f) }
-          else
-            emit(:frame, frame)
-          end
-          @remote_window -= sent
+    def send_frame(frame, encode)
+      sent = frame[:payload].bytesize
+
+      manage_state(frame) do
+        if encode
+          encode(frame)
+        else
+          emit(:frame, frame)
         end
+        @remote_window -= sent
       end
     end
 
     def process_window_update(frame:, encode: false)
       return if frame[:ignore]
 
-      if frame[:increment]
-        raise ProtocolError, "increment MUST be higher than zero" if frame[:increment].zero?
+      if (increment = frame[:increment])
+        raise ProtocolError, "increment MUST be higher than zero" if increment.zero?
 
-        @remote_window += frame[:increment]
+        @remote_window += increment
         error(:flow_control_error, msg: "window size too large") if @remote_window > MAX_WINDOW_SIZE
       end
       send_data(nil, encode)
@@ -114,45 +128,41 @@ module HTTP2
     end
 
     def empty?
-      @bytesize.zero?
+      @buffer.empty?
     end
 
     def retrieve(window_size)
       frame = @buffer.first or return
 
       frame_size = frame[:payload].bytesize
-      end_stream = frame[:flags].include? :end_stream
+      end_stream = frame[:flags].include?(:end_stream)
 
       # Frames with zero length with the END_STREAM flag set (that
       # is, an empty DATA frame) MAY be sent if there is no available space
       # in either flow control window.
-      return if window_size <= 0 && !(frame_size == 0 && end_stream)
-
-      @buffer.shift
+      return if window_size <= 0 && !(frame_size.zero? && end_stream)
 
       if frame_size > window_size
-        payload = frame[:payload]
         chunk   = frame.dup
+        payload = frame[:payload]
 
         # Split frame so that it fits in the window
         # TODO: consider padding!
-        frame_bytes = payload.byteslice(0, window_size)
-        payload = payload.byteslice(window_size..-1)
 
-        frame[:payload] = frame_bytes
-        frame[:length] = frame_bytes.bytesize
-        chunk[:payload] = payload
-        chunk[:length]  = payload.bytesize
+        chunk[:payload] = payload.byteslice(0, window_size)
+        chunk[:length]  = window_size
+        frame[:payload] = payload.byteslice(window_size..-1)
+        frame[:length] = frame_size - window_size
 
         # if no longer last frame in sequence...
-        frame[:flags] -= [:end_stream] if end_stream
+        chunk[:flags] -= [:end_stream] if end_stream
 
-        @buffer.unshift(chunk)
         @bytesize -= window_size
+        chunk
       else
         @bytesize -= frame_size
+        @buffer.shift
       end
-      frame
     end
   end
 end

data/lib/http/2/framer.rb

@@ -4,10 +4,9 @@ module HTTP2
   # Performs encoding, decoding, and validation of binary HTTP/2 frames.
   #
   class Framer
-    using StringExtensions
-
     include Error
     include PackingExtensions
+    include BufferUtils
 
     # Default value of max frame size (16384 bytes)
     DEFAULT_MAX_FRAME_SIZE = 2 << 13
@@ -37,6 +36,8 @@ module HTTP2
       origin: 0xc
     }.freeze
 
+    FRAME_TYPES_BY_NAME = FRAME_TYPES.invert.freeze
+
     FRAME_TYPES_WITH_PADDING = %i[data headers push_promise].freeze
 
     # Per frame flags as defined by the spec
@@ -127,30 +128,43 @@ module HTTP2
     # @param buffer [String] buffer to pack bytes into
     # @return [String]
     def common_header(frame, buffer:)
-      raise CompressionError, "Invalid frame type (#{frame[:type]})" unless FRAME_TYPES[frame[:type]]
+      type = frame[:type]
+
+      raise CompressionError, "Invalid frame type (#{type})" unless FRAME_TYPES[type]
+
+      length = frame[:length]
 
-      raise CompressionError, "Frame size is too large: #{frame[:length]}" if frame[:length] > @remote_max_frame_size
+      raise CompressionError, "Frame size is too large: #{length}" if length > @remote_max_frame_size
 
-      raise CompressionError, "Frame size is invalid: #{frame[:length]}" if frame[:length] < 0
+      raise CompressionError, "Frame size is invalid: #{length}" if length < 0
 
-      raise CompressionError, "Stream ID (#{frame[:stream]}) is too large" if frame[:stream] > MAX_STREAM_ID
+      stream_id = frame.fetch(:stream, 0)
 
-      if frame[:type] == :window_update && frame[:increment] > MAX_WINDOWINC
+      raise CompressionError, "Stream ID (#{stream_id}) is too large" if stream_id > MAX_STREAM_ID
+
+      if type == :window_update && frame[:increment] > MAX_WINDOWINC
         raise CompressionError, "Window increment (#{frame[:increment]}) is too large"
       end
 
+      header = buffer
+
+      if buffer.frozen?
+        header = String.new("", encoding: Encoding::BINARY, capacity: buffer.bytesize + 9) # header length
+        header << buffer
+      end
+
       pack([
-             (frame[:length] >> FRAME_LENGTH_HISHIFT),
-             (frame[:length] & FRAME_LENGTH_LOMASK),
-             FRAME_TYPES[frame[:type]],
+             (length >> FRAME_LENGTH_HISHIFT),
+             (length & FRAME_LENGTH_LOMASK),
+             FRAME_TYPES[type],
              frame[:flags].reduce(0) do |acc, f|
-               position = FRAME_FLAGS[frame[:type]][f]
-               raise CompressionError, "Invalid frame flag (#{f}) for #{frame[:type]}" unless position
+               position = FRAME_FLAGS[type][f]
+               raise CompressionError, "Invalid frame flag (#{f}) for #{type}" unless position
 
                acc | (1 << position)
              end,
-             frame[:stream]
-           ], HEADERPACK, buffer: buffer, offset: 0) # 8+16,8,8,32
+             stream_id
+           ], HEADERPACK, buffer: header, offset: 0) # 8+16,8,8,32
     end
 
     # Decodes common 9-byte header.
@@ -158,19 +172,21 @@ module HTTP2
     # @param buf [Buffer]
     # @return [Hash] the corresponding frame
     def read_common_header(buf)
-      frame = {}
       len_hi, len_lo, type, flags, stream = buf.byteslice(0, 9).unpack(HEADERPACK)
 
-      frame[:length] = (len_hi << FRAME_LENGTH_HISHIFT) | len_lo
-      frame[:type], = FRAME_TYPES.find { |_t, pos| type == pos }
-      if frame[:type]
-        frame[:flags] = FRAME_FLAGS[frame[:type]].each_with_object([]) do |(name, pos), acc|
-          acc << name if (flags & (1 << pos)) > 0
-        end
-      end
+      type = FRAME_TYPES_BY_NAME[type]
+      length = (len_hi << FRAME_LENGTH_HISHIFT) | len_lo
 
-      frame[:stream] = stream & RBIT
-      frame
+      return { length: length } unless type
+
+      {
+        type: type,
+        flags: FRAME_FLAGS[type].filter_map do |name, pos|
+          name if flags.anybits?((1 << pos))
+        end,
+        length: length,
+        stream: stream & RBIT
+      }
     end
 
     # Generates encoded HTTP/2 frame.
@@ -178,53 +194,60 @@ module HTTP2
     #
     # @param frame [Hash]
     def generate(frame)
-      bytes  = "".b
       length = 0
-
-      frame[:flags] ||= []
-      frame[:stream] ||= 0
+      frame[:flags] ||= EMPTY
 
       case frame[:type]
-      when :data
-        bytes << frame[:payload]
-        bytes.force_encoding(Encoding::BINARY)
-        length += frame[:payload].bytesize
+      when :data, :continuation
+        bytes = frame[:payload]
+        length = bytes.bytesize
 
       when :headers
+        headers = frame[:payload]
+
         if frame[:weight] || frame[:dependency] || !frame[:exclusive].nil?
           unless frame[:weight] && frame[:dependency] && !frame[:exclusive].nil?
             raise CompressionError, "Must specify all of priority parameters for #{frame[:type]}"
           end
 
-          frame[:flags] += [:priority] unless frame[:flags].include? :priority
+          frame[:flags] += [:priority] unless frame[:flags].include?(:priority)
         end
 
-        if frame[:flags].include? :priority
+        if frame[:flags].include?(:priority)
+          length = 5 + headers.bytesize
+          bytes = String.new("", encoding: Encoding::BINARY, capacity: length)
           pack([(frame[:exclusive] ? EBIT : 0) | (frame[:dependency] & RBIT)], UINT32, buffer: bytes)
           pack([frame[:weight] - 1], UINT8, buffer: bytes)
-          length += 5
+          append_str(bytes, headers)
+        else
+          length = headers.bytesize
+          bytes = headers
         end
 
-        bytes << frame[:payload]
-        length += frame[:payload].bytesize
-
       when :priority
         unless frame[:weight] && frame[:dependency] && !frame[:exclusive].nil?
           raise CompressionError, "Must specify all of priority parameters for #{frame[:type]}"
         end
 
+        length = 5
+        bytes = String.new("", encoding: Encoding::BINARY, capacity: length)
         pack([(frame[:exclusive] ? EBIT : 0) | (frame[:dependency] & RBIT)], UINT32, buffer: bytes)
         pack([frame[:weight] - 1], UINT8, buffer: bytes)
-        length += 5
 
       when :rst_stream
+        length = 4
+        bytes = String.new("", encoding: Encoding::BINARY, capacity: length)
         pack_error(frame[:error], buffer: bytes)
-        length += 4
 
       when :settings
-        raise CompressionError, "Invalid stream ID (#{frame[:stream]})" if (frame[:stream]).nonzero?
+        if (stream_id = frame[:stream]) && stream_id.nonzero?
+          raise CompressionError, "Invalid stream ID (#{stream_id})"
+        end
 
-        frame[:payload].each do |(k, v)|
+        settings = frame[:payload]
+        bytes = String.new("", encoding: Encoding::BINARY, capacity: length)
+
+        settings.each do |(k, v)|
           if k.is_a? Integer # rubocop:disable Style/GuardClause
             DEFINED_SETTINGS.value?(k) || next
           else
@@ -239,42 +262,42 @@ module HTTP2
         end
 
       when :push_promise
+        length = 4 + frame[:payload].bytesize
+        bytes = String.new("", encoding: Encoding::BINARY, capacity: length)
         pack([frame[:promise_stream] & RBIT], UINT32, buffer: bytes)
-        bytes << frame[:payload]
-        length += 4 + frame[:payload].bytesize
+        append_str(bytes, frame[:payload])
 
       when :ping
-        raise CompressionError, "Invalid payload size (#{frame[:payload].size} != 8 bytes)" if frame[:payload].bytesize != 8
+        bytes = frame[:payload]
+        raise CompressionError, "Invalid payload size (#{bytes.size} != 8 bytes)" if bytes.bytesize != 8
 
-        bytes << frame[:payload]
-        length += 8
+        length = 8
 
       when :goaway
+        data = frame[:payload]
+        length = 8
+        length += data.bytesize if data
+        bytes = String.new("", encoding: Encoding::BINARY, capacity: length)
+
         pack([frame[:last_stream] & RBIT], UINT32, buffer: bytes)
         pack_error(frame[:error], buffer: bytes)
-        length += 8
 
-        if frame[:payload]
-          bytes << frame[:payload]
-          length += frame[:payload].bytesize
-        end
+        append_str(bytes, data) if data
 
       when :window_update
+        length = 4
+        bytes = String.new("", encoding: Encoding::BINARY, capacity: length)
         pack([frame[:increment] & RBIT], UINT32, buffer: bytes)
-        length += 4
-
-      when :continuation
-        bytes << frame[:payload]
-        length += frame[:payload].bytesize
 
       when :altsvc
+        length = 6
+        bytes = String.new("", encoding: Encoding::BINARY, capacity: length)
         pack([frame[:max_age], frame[:port]], UINT32 + UINT16, buffer: bytes)
-        length += 6
         if frame[:proto]
           raise CompressionError, "Proto too long" if frame[:proto].bytesize > 255
 
           pack([frame[:proto].bytesize], UINT8, buffer: bytes)
-          bytes << frame[:proto]
+          append_str(bytes, frame[:proto])
           length += 1 + frame[:proto].bytesize
         else
           pack([0], UINT8, buffer: bytes)
@@ -284,24 +307,25 @@ module HTTP2
           raise CompressionError, "Host too long" if frame[:host].bytesize > 255
 
           pack([frame[:host].bytesize], UINT8, buffer: bytes)
-          bytes << frame[:host]
+          append_str(bytes, frame[:host])
           length += 1 + frame[:host].bytesize
         else
           pack([0], UINT8, buffer: bytes)
           length += 1
         end
         if frame[:origin]
-          bytes << frame[:origin]
+          append_str(bytes, frame[:origin])
           length += frame[:origin].bytesize
         end
 
       when :origin
-        frame[:payload].each do |origin|
+        origins = frame[:payload]
+        length = origins.sum(&:bytesize) + (2 * origins.size)
+        bytes = String.new("", encoding: Encoding::BINARY, capacity: length)
+        origins.each do |origin|
           pack([origin.bytesize], UINT16, buffer: bytes)
-          bytes << origin
-          length += 2 + origin.bytesize
+          append_str(bytes, origin)
         end
-
       end
 
       # Process padding.
@@ -320,12 +344,12 @@ module HTTP2
 
         length += padlen
         pack([padlen -= 1], UINT8, buffer: bytes, offset: 0)
-        frame[:flags] << :padded
+        frame[:flags] += [:padded]
 
         # Padding:  Padding octets that contain no application semantic value.
         # Padding octets MUST be set to zero when sending and ignored when
         # receiving.
-        bytes << ("\0" * padlen)
+        append_str(bytes, ("\0" * padlen))
       end
 
       frame[:length] = length
@@ -340,71 +364,76 @@ module HTTP2
       return if buf.size < 9
 
       frame = read_common_header(buf)
-      return if buf.size < 9 + frame[:length]
 
-      raise ProtocolError, "payload too large" if frame[:length] > @local_max_frame_size
+      type = frame[:type]
+      length = frame[:length]
+      flags = frame[:flags]
+
+      return if buf.size < 9 + length
 
-      buf.read(9)
-      payload = buf.read(frame[:length])
+      raise ProtocolError, "payload too large" if length > @local_max_frame_size
+
+      read_str(buf, 9)
+      payload = read_str(buf, length)
 
       # Implementations MUST discard frames
       # that have unknown or unsupported types.
       # - http://tools.ietf.org/html/draft-ietf-httpbis-http2-16#section-5.5
-      return frame if frame[:type].nil?
+      return frame unless type
 
       # Process padding
       padlen = 0
-      if FRAME_TYPES_WITH_PADDING.include?(frame[:type])
-        padded = frame[:flags].include?(:padded)
+      if FRAME_TYPES_WITH_PADDING.include?(type)
+        padded = flags.include?(:padded)
         if padded
-          padlen = payload.read(1).unpack1(UINT8)
+          padlen = read_str(payload, 1).unpack1(UINT8)
           frame[:padding] = padlen + 1
           raise ProtocolError, "padding too long" if padlen > payload.bytesize
 
           payload = payload.byteslice(0, payload.bytesize - padlen) if padlen > 0
           frame[:length] -= frame[:padding]
-          frame[:flags].delete(:padded)
+          flags.delete(:padded)
         end
       end
 
-      case frame[:type]
+      case type
       when :data, :ping, :continuation
-        frame[:payload] = payload.read(frame[:length])
+        frame[:payload] = read_str(payload, length)
       when :headers
-        if frame[:flags].include? :priority
-          e_sd = payload.read_uint32
+        if flags.include?(:priority)
+          e_sd = read_uint32(payload)
           frame[:dependency] = e_sd & RBIT
-          frame[:exclusive] = (e_sd & EBIT) != 0
+          frame[:exclusive] = e_sd.anybits?(EBIT)
           weight = payload.byteslice(0, 1).ord + 1
           frame[:weight] = weight
           payload = payload.byteslice(1..-1)
         end
-        frame[:payload] = payload.read(frame[:length])
+        frame[:payload] = read_str(payload, length)
       when :priority
-        raise FrameSizeError, "Invalid length for PRIORITY_STREAM (#{frame[:length]} != 5)" if frame[:length] != 5
+        raise FrameSizeError, "Invalid length for PRIORITY_STREAM (#{length} != 5)" if length != 5
 
-        e_sd = payload.read_uint32
+        e_sd = read_uint32(payload)
         frame[:dependency] = e_sd & RBIT
-        frame[:exclusive] = (e_sd & EBIT) != 0
+        frame[:exclusive] = e_sd.anybits?(EBIT)
         weight = payload.byteslice(0, 1).ord + 1
         frame[:weight] = weight
         payload = payload.byteslice(1..-1)
       when :rst_stream
-        raise FrameSizeError, "Invalid length for RST_STREAM (#{frame[:length]} != 4)" if frame[:length] != 4
+        raise FrameSizeError, "Invalid length for RST_STREAM (#{length} != 4)" if length != 4
 
-        frame[:error] = unpack_error payload.read_uint32
+        frame[:error] = unpack_error read_uint32(payload)
 
       when :settings
         # NOTE: frame[:length] might not match the number of frame[:payload]
         # because unknown extensions are ignored.
         frame[:payload] = []
-        raise ProtocolError, "Invalid settings payload length" unless (frame[:length] % 6).zero?
+        raise ProtocolError, "Invalid settings payload length" unless (length % 6).zero?
 
-        raise ProtocolError, "Invalid stream ID (#{frame[:stream]})" if (frame[:stream]).nonzero?
+        raise ProtocolError, "Invalid stream ID (#{frame[:stream]})" if frame[:stream].nonzero?
 
         (frame[:length] / 6).times do
-          id  = payload.read(2).unpack1(UINT16)
-          val = payload.read_uint32
+          id  = read_str(payload, 2).unpack1(UINT16)
+          val = read_uint32(payload)
 
           # Unsupported or unrecognized settings MUST be ignored.
           # Here we send it along.
@@ -412,39 +441,37 @@ module HTTP2
           frame[:payload] << [name, val] if name
         end
       when :push_promise
-        frame[:promise_stream] = payload.read_uint32 & RBIT
-        frame[:payload] = payload.read(frame[:length])
+        frame[:promise_stream] = read_uint32(payload) & RBIT
+        frame[:payload] = read_str(payload, length)
       when :goaway
-        frame[:last_stream] = payload.read_uint32 & RBIT
-        frame[:error] = unpack_error payload.read_uint32
+        frame[:last_stream] = read_uint32(payload) & RBIT
+        frame[:error] = unpack_error read_uint32(payload)
 
-        size = frame[:length] - 8 # for last_stream and error
-        frame[:payload] = payload.read(size) if size > 0
+        size = length - 8 # for last_stream and error
+        frame[:payload] = read_str(payload, size) if size > 0
       when :window_update
-        if frame[:length] % 4 != 0
-          raise FrameSizeError, "Invalid length for WINDOW_UPDATE (#{frame[:length]} not multiple of 4)"
-        end
+        raise FrameSizeError, "Invalid length for WINDOW_UPDATE (#{length} not multiple of 4)" if length % 4 != 0
 
-        frame[:increment] = payload.read_uint32 & RBIT
+        frame[:increment] = read_uint32(payload) & RBIT
       when :altsvc
-        frame[:max_age], frame[:port] = payload.read(6).unpack(UINT32 + UINT16)
+        frame[:max_age], frame[:port] = read_str(payload, 6).unpack(UINT32 + UINT16)
 
         len = payload.byteslice(0, 1).ord
         payload = payload.byteslice(1..-1)
-        frame[:proto] = payload.read(len) if len > 0
+        frame[:proto] = read_str(payload, len) if len > 0
 
         len = payload.byteslice(0, 1).ord
         payload = payload.byteslice(1..-1)
-        frame[:host] = payload.read(len) if len > 0
+        frame[:host] = read_str(payload, len) if len > 0
 
-        frame[:origin] = payload.read(payload.size) unless payload.empty?
+        frame[:origin] = read_str(payload, payload.size) unless payload.empty?
 
       when :origin
         origins = []
 
         until payload.empty?
-          len = payload.read(2).unpack1(UINT16)
-          origins << payload.read(len)
+          len = read_str(payload, 2).unpack1(UINT16)
+          origins << read_str(payload, len)
         end
 
         frame[:payload] = origins