http-2 1.2.1 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1db63e3235efa25ad18a270b128adc3955489766148712fd9405142d9cf1bd7
-  data.tar.gz: d3cfbb973cb9a3bc53466c106a6a33b6521f7ba8415d832a646ef96419c906cd
+  metadata.gz: aa40c026d7345ba9879c03ce22a9ca6c8ec981482381fd0f89c2da5f4d814214
+  data.tar.gz: 9cf43f76f7aed43428b636dca605c05bc8c882bfd2f56cabbadaeff71c42648b
 SHA512:
-  metadata.gz: 9a17f2bdcbc5fcd07ff0797994af22a0f170744f516702b5b5c2c8c032f60a15cf4c70869804c56f4e15e10829c2c51c8ea0fe5575751cf28b1fe0207389543a
-  data.tar.gz: e599eb9b1bfa7a4985b6a0f53fe1592e6d26ea780fc16d8471d23cc2abe5020a91e28fba80e1d227492525373dd117677e2c436bb289022875c3986f3733bb9e
+  metadata.gz: 56813420638e4b6b8e310d64fef3a284ae0c597ce77e8fc83ae316f6cf3070a216fe943c5fd8b0cb9741e8103cf64ec17317e6af45163d355489f55d8f17379b
+  data.tar.gz: c6af72766c395fb4ef21ba2c6de0ef86dc1432421b4c8b0cdc486e4f006891d8e8f104225f98b7950d2ca31d111f97a2a1f42ba6633aeb62845c712da0d139e5

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2013 Ilya Grigorik
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -85,6 +85,15 @@ Events emitted by the connection object:
   </tr>
 </table>
 
+Connection shutdown happens in two steps. Once a GOAWAY frame is sent or
+received, no new streams may be opened: `closed?` turns true and `new_stream`
+raises `ConnectionClosed` — new work belongs on a new connection. After a
+graceful GOAWAY (`:no_error`), streams the peer may still complete keep
+running: `closing?` distinguishes this draining state, in which the connection
+keeps processing frames — including connection-level flow control — until the
+last tracked stream closes. Streams the GOAWAY refused (id above its
+last-stream-id) are reported via the `:goaway` event, so their callers can
+retry them on a fresh connection.
 
 ### Stream lifecycle management
 

data/lib/http/2/base64.rb

@@ -30,16 +30,16 @@ elsif !defined?(Base64)
         str.tr!("+/", "-_")
         str
       end
-    end
 
-    def urlsafe_decode64(str)
-      if !str.end_with?("=") && str.length % 4 != 0
-        str = str.ljust((str.length + 3) & ~3, "=")
-        str.tr!("-_", "+/")
-      else
-        str = str.tr("-_", "+/")
+      def urlsafe_decode64(str)
+        if !str.end_with?("=") && str.length % 4 != 0
+          str = str.ljust((str.length + 3) & ~3, "=")
+          str.tr!("-_", "+/")
+        else
+          str = str.tr("-_", "+/")
+        end
+        strict_decode64(str)
       end
-      strict_decode64(str)
     end
   end
 end

data/lib/http/2/client.rb

@@ -64,7 +64,7 @@ module HTTP2
       @state = :connected
       emit(:frame, CONNECTION_PREFACE_MAGIC)
 
-      payload = @local_settings.reject { |k, v| v == SPEC_DEFAULT_CONNECTION_SETTINGS[k] }
+      payload = @local_settings.connection_settings.reject { |k, v| v == SPEC_DEFAULT_CONNECTION_SETTINGS[k] }
       settings(payload)
     end
 

data/lib/http/2/connection.rb

@@ -10,25 +10,6 @@ module HTTP2
   # Default stream_limit
   DEFAULT_MAX_CONCURRENT_STREAMS = 100
 
-  # Default values for SETTINGS frame, as defined by the spec.
-  SPEC_DEFAULT_CONNECTION_SETTINGS = {
-    settings_header_table_size: 4096,
-    settings_enable_push: 1, # enabled for servers
-    settings_max_concurrent_streams: Framer::MAX_STREAM_ID, # unlimited
-    settings_initial_window_size: 65_535,
-    settings_max_frame_size: 16_384,
-    settings_max_header_list_size: (2 << 30) - 1 # unlimited
-  }.freeze
-
-  DEFAULT_CONNECTION_SETTINGS = {
-    settings_header_table_size: 4096,
-    settings_enable_push: 1, # enabled for servers
-    settings_max_concurrent_streams: 100,
-    settings_initial_window_size: 65_535,
-    settings_max_frame_size: 16_384,
-    settings_max_header_list_size: (2 << 30) - 1 # unlimited
-  }.freeze
-
   # Default stream priority (lower values are higher priority).
   DEFAULT_WEIGHT = 16
 
@@ -56,7 +37,8 @@ module HTTP2
     include Error
     include BufferUtils
 
-    # Connection state (:new, :closed).
+    # Connection state (:waiting_magic, :waiting_connection_preface,
+    # :connected, :closing, :closed).
     attr_reader :state
 
     # Size of current connection flow control window (by default, set to
@@ -77,13 +59,12 @@ module HTTP2
     attr_accessor :active_stream_count
 
     # Initializes new connection object.
-    #
     def initialize(settings = {})
-      @local_settings  = DEFAULT_CONNECTION_SETTINGS.merge(settings)
-      @remote_settings = SPEC_DEFAULT_CONNECTION_SETTINGS.dup
+      @local_settings  = Settings.new(**settings)
+      @remote_settings = Settings.new(settings_max_concurrent_streams: Framer::MAX_STREAM_ID)
 
-      @compressor   = Header::Compressor.new(settings)
-      @decompressor = Header::Decompressor.new(settings)
+      @compressor   = Header::Compressor.new(@local_settings)
+      @decompressor = Header::Decompressor.new(@local_settings)
 
       @active_stream_count = 0
       @last_stream_id = 0
@@ -92,11 +73,11 @@ module HTTP2
       @oldest_stream_recently_closed = nil
       @pending_settings = []
 
-      @framer = Framer.new(@local_settings[:settings_max_frame_size])
+      @framer = Framer.new(@local_settings.settings_max_frame_size)
 
-      @local_window_limit = @local_settings[:settings_initial_window_size]
+      @local_window_limit = @local_settings.settings_initial_window_size
       @local_window = @local_window_limit
-      @remote_window_limit = @remote_settings[:settings_initial_window_size]
+      @remote_window_limit = @remote_settings.settings_initial_window_size
       @remote_window = @remote_window_limit
 
       @recv_buffer = "".b
@@ -113,8 +94,15 @@ module HTTP2
       @send_buffer = FrameBuffer.new
     end
 
+    # No new streams may be opened (a GOAWAY was sent or received).
     def closed?
-      @state == :closed
+      @state == :closed || @state == :closing
+    end
+
+    # Graceful GOAWAY received: tracked streams may still complete,
+    # but no new ones can be opened.
+    def closing?
+      @state == :closing
     end
 
     # Allocates new stream for current connection.
@@ -123,12 +111,15 @@ module HTTP2
     # @param window [Integer]
     # @param parent [Stream]
     def new_stream(**args)
-      raise ConnectionClosed if @state == :closed
-      raise StreamLimitExceeded if @active_stream_count >= @remote_settings[:settings_max_concurrent_streams]
+      raise ConnectionClosed if closed?
 
       connection_error(:protocol_error, msg: "id is smaller than previous") if @stream_id < @last_stream_id
 
-      stream = activate_stream(id: @stream_id, **args)
+      stream = activate_stream(
+        id: @stream_id,
+        max_concurrent_streams: @remote_settings.settings_max_concurrent_streams,
+        **args
+      )
       @last_stream_id = stream.id
 
       @stream_id += 2
@@ -158,8 +149,7 @@ module HTTP2
     def goaway(error = :no_error, payload = nil)
       send(type: :goaway, stream: 0, last_stream: @last_stream_id,
            error: error, payload: payload)
-      @state = :closed
-      @closed_since = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      close!
     end
 
     # Sends a WINDOW_UPDATE frame to the peer.
@@ -203,7 +193,7 @@ module HTTP2
         elsif read_str(@recv_buffer, 24) == CONNECTION_PREFACE_MAGIC
           # MAGIC is OK.  Send our settings
           @state = :waiting_connection_preface
-          payload = @local_settings.reject { |k, v| v == SPEC_DEFAULT_CONNECTION_SETTINGS[k] }
+          payload = @local_settings.connection_settings.reject { |k, v| v == SPEC_DEFAULT_CONNECTION_SETTINGS[k] }
           settings(payload)
         else
           raise HandshakeError
@@ -244,7 +234,7 @@ module HTTP2
             # prevent HTTP/2 CONTINUATION FLOOD
             # same heuristic as the one from HAProxy: https://www.haproxy.com/blog/haproxy-is-resilient-to-the-http-2-continuation-flood
             # different mitigation (connection closed, instead of 400 response)
-            unless @continuation_size < @local_settings[:settings_max_frame_size]
+            unless @continuation_size < @local_settings.settings_max_frame_size
               connection_error(:protocol_error,
                                msg: "too many continuations received")
             end
@@ -295,7 +285,11 @@ module HTTP2
             # PUSH_PROMISE and CONTINUATION frames MUST be minimally
             # processed to ensure a consistent compression state
             decode_headers(frame)
-            return if @state == :closed
+            # After a GOAWAY, HEADERS may only complete a tracked stream at
+            # or below the highest id seen (Section 6.8); anything else is
+            # discarded - decoded above, so the compression state is intact.
+            # Skip only this frame: later ones may serve completing streams.
+            next if closed? && (stream_id > @last_stream_id || !@streams.key?(stream_id))
 
             stream = @streams[stream_id]
             if stream.nil?
@@ -323,7 +317,7 @@ module HTTP2
             end
 
             decode_headers(frame)
-            return if @state == :closed
+            next if closed?
 
             # PUSH_PROMISE frames MUST be associated with an existing, peer-
             # initiated stream... A receiver MUST treat the receipt of a
@@ -375,11 +369,16 @@ module HTTP2
               end
             else
               case frame_type
-              # The PRIORITY frame can be sent for a stream in the "idle" or
-              # "closed" state. This allows for the reprioritization of a
-              # group of dependent streams by altering the priority of an
-              # unused or closed parent stream.
+              # Priority signaling is deprecated (RFC 9113 Section 5.3.2), but
+              # a PRIORITY frame may still name a stream id not opened yet:
+              # activate it, so the priority sticks if the stream opens.
               when :priority
+                # After a GOAWAY, a PRIORITY for a stream already used and
+                # closed must not resurrect it: reprioritizing a closed
+                # parent is a no-op here, and a phantom stream would hold
+                # the draining connection open.
+                next if closed? && stream_id <= @last_stream_id
+
                 stream = activate_stream(
                   id: stream_id,
                   weight: frame[:weight] || DEFAULT_WEIGHT,
@@ -495,7 +494,7 @@ module HTTP2
         @state = :connected
         connection_settings(frame)
 
-      when :connected
+      when :connected, :closing
         case frame_type
         when :settings
           # @type var frame: settings_frame
@@ -510,8 +509,13 @@ module HTTP2
           # Receivers of a GOAWAY frame MUST NOT open additional streams on
           # the connection, although a new connection can be established
           # for new streams.
-          @state = :closed
-          @closed_since = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+          if frame[:error] == :no_error && !@streams.empty?
+            # A graceful GOAWAY lets tracked streams complete before the
+            # connection closes (Section 6.8).
+            @state = :closing
+          else
+            close!
+          end
           emit(:goaway, frame[:last_stream], frame[:error], frame[:payload])
         when :altsvc
           # @type var frame: altsvc_frame
@@ -728,7 +732,7 @@ module HTTP2
       #: @type var payload: String
       headers_frame[:payload] = payload
 
-      max_frame_size = @remote_settings[:settings_max_frame_size]
+      max_frame_size = @remote_settings.settings_max_frame_size
 
       # if single frame, return immediately
       if payload.bytesize <= max_frame_size
@@ -768,19 +772,28 @@ module HTTP2
     # connection managemet callbacks.
     #
     # @param id [Integer]
+    # @param max_concurrent_streams [Symbol] threshold to cap the number of active streams with.
     # @param priority [Integer]
     # @param window [Integer]
     # @param parent [Stream]
-    def activate_stream(id:, **args)
+    def activate_stream(id:, max_concurrent_streams: @local_settings.settings_max_concurrent_streams, **args)
       connection_error(msg: "Stream ID already exists") if @streams.key?(id)
 
-      raise StreamLimitExceeded if @active_stream_count >= @local_settings[:settings_max_concurrent_streams]
+      # SETTINGS_MAX_CONCURRENT_STREAMS limits the number of concurrent streams that the sender
+      # of the setting permits the receiver to create (RFC 9113, section 5.1.2), so the bounding
+      # limit is the one advertised by the endpoint that did *not* open the stream.
+      raise StreamLimitExceeded if @active_stream_count >= max_concurrent_streams
 
       stream = Stream.new(connection: self, id: id, **args)
 
       stream.once(:close) do
         @streams.delete(id)
 
+        # A graceful GOAWAY leaves the connection :closing until the
+        # tracked streams complete (Section 6.8); the last one to close
+        # moves it to its terminal state.
+        close! if @state == :closing && @streams.empty?
+
         # Store a reference to the closed stream, such that we can respond
         # to any in-flight frames while close is registered on both sides.
         # References to such streams will be purged whenever another stream
@@ -802,6 +815,8 @@ module HTTP2
             true
           end
           @oldest_stream_recently_closed = new_oldest
+        else
+          @oldest_stream_recently_closed ||= now
         end
 
         @streams_recently_closed[id] = now
@@ -811,6 +826,11 @@ module HTTP2
       @streams[id] = stream
     end
 
+    def close!
+      @state = :closed
+      @closed_since = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    end
+
     def verify_stream_order(id)
       return unless id.odd?
 

data/lib/http/2/error.rb

@@ -53,7 +53,7 @@ module HTTP2
     # Raised if stream has been closed and new frames cannot be sent.
     class StreamClosed < Error; end
 
-    # Raised if connection has been closed (or draining) and new stream
+    # Raised if connection has been closed (or closing) and new stream
     # cannot be opened.
     class ConnectionClosed < Error; end
 

data/lib/http/2/framer.rb

@@ -130,10 +130,10 @@ module HTTP2
 
       stream_id = frame.fetch(:stream, 0)
 
-      raise CompressionError, "Stream ID (#{stream_id}) is too large" if stream_id > MAX_STREAM_ID
+      raise CompressionError, "Stream ID (#{stream_id}) is outside the valid range" unless stream_id.between?(0, MAX_STREAM_ID)
 
-      if type == :window_update && frame[:increment] > MAX_WINDOWINC
-        raise CompressionError, "Window increment (#{frame[:increment]}) is too large"
+      if type == :window_update && !frame[:increment].between?(1, MAX_WINDOWINC)
+        raise CompressionError, "Window increment (#{frame[:increment]}) is outside the valid range"
       end
 
       flags = frame[:flags]

data/lib/http/2/header/compressor.rb

@@ -7,18 +7,16 @@ module HTTP2
       include PackingExtensions
       include BufferUtils
 
-      # @param options [Hash] encoding options
-      def initialize(options = {})
-        @cc = EncodingContext.new(options)
+      def initialize(settings = Settings.new)
+        @cc = EncodingContext.new(settings)
       end
 
-      # Set dynamic table size in EncodingContext
-      # @param size [Integer] new dynamic table size
+      # Set dynamic table +size+ in EncodingContext
       def table_size=(size)
         @cc.table_size = size
       end
 
-      # Encodes provided value via integer representation.
+      # Encodes +i+ via integer representation into +buffer+ at the offset set by +offset+.
       # - http://tools.ietf.org/html/draft-ietf-httpbis-header-compression-10#section-5.1
       #
       #  If I < 2^N - 1, encode I on N bits
@@ -30,11 +28,6 @@ module HTTP2
       #           I = I / 128
       #      encode (I) on 8 bits
       #
-      # @param i [Integer] value to encode
-      # @param n [Integer] number of available bits
-      # @param buffer [String] buffer to pack bytes into
-      # @param offset [Integer] offset to insert packed bytes in buffer
-      # @return [String] binary string
       def integer(i, n, buffer:, offset: buffer.size)
         limit = (1 << n) - 1
         return pack([i], "C", buffer: buffer, offset: offset) if i < limit
@@ -65,16 +58,8 @@ module HTTP2
       # * If the bit 7 of the first byte is 0, the string value is
       #   represented as a list of UTF-8 encoded octets.
       #
-      # +@options [:huffman]+ controls whether to use Huffman encoding:
-      #  :never   Do not use Huffman encoding
-      #  :always  Always use Huffman encoding
-      #  :shorter Use Huffman when the result is strictly shorter
-      #
-      # @param str [String]
-      # @param buffer [String]
-      # @return [String] binary string
       def string(str, buffer = "".b)
-        case @cc.options[:huffman]
+        case @cc.settings.huffman
         when :always
           huffman_string(str, buffer)
         when :never
@@ -93,11 +78,7 @@ module HTTP2
         end
       end
 
-      # Encodes header command with appropriate header representation.
-      #
-      # @param h [Hash] header command
-      # @param buffer [String]
-      # @return [Buffer]
+      # Encodes +h+ header command with appropriate header representation into +buffer+.
       def header(h, buffer = "".b)
         type = h[:type]
         rep = HEADREP[type]
@@ -128,9 +109,6 @@ module HTTP2
       end
 
       # Encodes provided list of HTTP headers.
-      #
-      # @param headers [Array] +[[name, value], ...]+
-      # @return [Buffer]
       def encode(headers)
         buffer = "".b
         headers.partition { |f, _| f.start_with? ":" }.each do |hs|
@@ -144,9 +122,7 @@ module HTTP2
 
       private
 
-      # @param str [String]
-      # @param buffer [String]
-      # @return [String] binary string
+      # encodes +str+ into +buffer+ using Huffman encoding.
       def huffman_string(str, buffer = "".b)
         huffman_offset = buffer.bytesize
         buffer << "\x00".b
@@ -162,18 +138,14 @@ module HTTP2
         buffer
       end
 
-      # @param str [String]
-      # @param buffer [String]
-      # @return [String] binary string
+      # encodes +str+ into +buffer+.
       def plain_string(str, plain = "".b)
         integer(str.bytesize, 7, buffer: plain)
         append_str(plain, str)
         plain
       end
 
-      # @param buffer [String]
-      # @param huffman_offset [Integer] buffer offset where huffman string was introduced
-      # @return [String] binary string
+      # encodes the huffman string size from +buffer+ into the string at the offset indicated by +huffman_offset+
       def set_huffman_size(buffer, huffman_offset)
         integer(buffer.bytesize - huffman_offset, 7, buffer: buffer, offset: huffman_offset)
         buffer.setbyte(huffman_offset, buffer.getbyte(huffman_offset) | 0x80)

data/lib/http/2/header/decompressor.rb

@@ -5,32 +5,22 @@ module HTTP2
     # Responsible for decoding received headers and maintaining compression
     # context of the opposing peer. Decompressor must be initialized with
     # appropriate starting context based on local role: client or server.
-    #
-    # @example
-    #   server_role = Decompressor.new(:request)
-    #   client_role = Decompressor.new(:response)
     class Decompressor
       include Error
       include BufferUtils
 
       FORBIDDEN_HEADERS = %w[connection te].freeze
 
-      # @param options [Hash] decoding options.  Only :table_size is effective.
-      def initialize(options = {})
-        @cc = EncodingContext.new(options)
+      def initialize(settings = Settings.new)
+        @cc = EncodingContext.new(settings)
       end
 
-      # Set dynamic table size in EncodingContext
-      # @param size [Integer] new dynamic table size
+      # Set dynamic table +size+ in EncodingContext
       def table_size=(size)
         @cc.table_size = size
       end
 
-      # Decodes integer value from provided buffer.
-      #
-      # @param buf [String]
-      # @param n [Integer] number of available bits
-      # @return [Integer]
+      # Decodes integer value from provided +buffer+.
       def integer(buf, n)
         limit = (1 << n) - 1
         if n.zero?
@@ -55,11 +45,9 @@ module HTTP2
         i
       end
 
-      # Decodes string value from provided buffer.
+      # Decodes string value from provided +buf+.
       #
-      # @param buf [String]
-      # @return [String] UTF-8 encoded string
-      # @raise [CompressionError] when input is malformed
+      # raises CompressionError when input is malformed
       def string(buf)
         raise CompressionError, "invalid header block fragment" if buf.empty?
 
@@ -72,10 +60,7 @@ module HTTP2
         str.force_encoding(Encoding::UTF_8)
       end
 
-      # Decodes header command from provided buffer.
-      #
-      # @param buf [Buffer]
-      # @return [Hash] command
+      # Decodes header command from provided +buf+.
       def header(buf)
         peek = buf.getbyte(0)
 
@@ -109,13 +94,9 @@ module HTTP2
         end
       end
 
-      # Decodes and processes header commands within provided buffer.
-      #
-      # @param buf [Buffer]
-      # @param frame [HTTP2::Frame, nil]
-      # @return [Array] +[[name, value], ...]
+      # Decodes and processes header commands within provided +buf+.
       def decode(buf, frame = nil)
-        list = []
+        list = [] #: Array[header_pair]
         decoding_pseudo_headers = true
         @cc.listen_on_table do
           until buf.empty?

data/lib/http/2/header/encoding_context.rb

@@ -86,12 +86,6 @@ module HTTP2
 
       STATIC_TABLE_SIZE = STATIC_TABLE.size
 
-      DEFAULT_OPTIONS = {
-        huffman: :shorter,
-        index: :all,
-        table_size: 4096
-      }.freeze
-
       STATIC_ALL = %i[all static].freeze
 
       STATIC_NEVER = %i[never static].freeze
@@ -99,37 +93,27 @@ module HTTP2
       # Current table of header key-value pairs.
       attr_reader :table
 
-      # Current encoding options
-      #
-      #   :table_size  Integer  maximum dynamic table size in bytes
-      #   :huffman     Symbol   :always, :never, :shorter
-      #   :index       Symbol   :all, :static, :never
-      attr_reader :options
+      # Current encoding settings
+      attr_reader :settings
 
       # Current table size in octets
       attr_reader :current_table_size
 
       # Initializes compression context with appropriate client/server
-      # defaults and maximum size of the dynamic table.
-      #
-      # @param options [Hash] encoding options
-      #   :table_size  Integer  maximum dynamic table size in bytes
-      #   :huffman     Symbol   :always, :never, :shorter
-      #   :index       Symbol   :all, :static, :never
-      def initialize(options = {})
+      # +settings+ and maximum size of the dynamic table.
+      def initialize(settings = Settings.new)
         @table = []
         @table_by_field = Hash.new { |hs, k| hs[k] = [] }
         @unshifts = 0
-        @options = DEFAULT_OPTIONS.merge(options)
-        @limit = @options[:table_size]
+        @settings = settings
+        @limit = settings.table_size
         @_table_updated = false
         @current_table_size = 0
       end
 
       # Duplicates current compression context
-      # @return [EncodingContext]
       def dup
-        other = EncodingContext.new(@options)
+        other = EncodingContext.new(@settings)
         t = @table
         tbf = @table_by_field.transform_values(&:dup)
         unshifts = @unshifts
@@ -143,16 +127,13 @@ module HTTP2
         other
       end
 
-      # Finds an entry in current dynamic table by index.
-      # Note that index is zero-based in this module.
+      # Finds an entry in current dynamic table by +index+.
+      # Note that +index+ is zero-based in this module.
       #
-      # If the index is greater than the last index in the static table,
+      # If the +index+ is greater than the last index in the static table,
       # an entry in the dynamic table is dereferenced.
       #
-      # If the index is greater than the last header index, an error is raised.
-      #
-      # @param index [Integer] zero-based index in the dynamic table.
-      # @return [Array] +[key, value]+
+      # If the +index+ is greater than the last header index, an error is raised.
       def dereference(index)
         # NOTE: index is zero-based in this module.
         return STATIC_TABLE[index] if index < STATIC_TABLE_SIZE
@@ -166,10 +147,6 @@ module HTTP2
 
       # Header Block Processing
       # - http://tools.ietf.org/html/draft-ietf-httpbis-header-compression-10#section-4.1
-      #
-      # @param cmd [Hash] { type:, name:, value:, index: }
-      # @return [Array, nil] +[name, value]+ header field that is added to the decoded header list,
-      #                                      or nil if +cmd[:type]+ is +:changetablesize+
       def process(cmd)
         type = cmd[:type]
         name = cmd[:name]
@@ -181,7 +158,7 @@ module HTTP2
 
           # we can receive multiple table size change commands inside a header frame. However,
           # we should blow up if we receive another frame where the new table size is bigger.
-          table_size_updated = @limit != @options[:table_size]
+          table_size_updated = @limit != @settings.table_size
 
           raise CompressionError, "dynamic table size update exceed limit" if !table_size_updated && value > @limit
 
@@ -217,11 +194,12 @@ module HTTP2
           emit = [name, value]
 
           # add to table
-          if type == :incremental && size_check?(name.bytesize + value.bytesize + 32)
+          cmdsize = name.bytesize + value.bytesize + 32
+          if type == :incremental && size_check?(cmdsize)
             @table.unshift(emit)
             @unshifts += 1
             @table_by_field[name].unshift([value, @unshifts])
-            @current_table_size += name.bytesize + value.bytesize + 32
+            @current_table_size += cmdsize
             @_table_updated = true
           end
 
@@ -231,16 +209,10 @@ module HTTP2
         end
       end
 
-      # Plan header compression according to +@options [:index]+
-      #  :never   Do not use dynamic table or static table reference at all.
-      #  :static  Use static table only.
-      #  :all     Use all of them.
-      #
-      # @param headers [Array] +[[name, value], ...]+
-      # @return [Array] array of commands
+      # Plan +headers+ compression.
       def encode(headers)
         # Literals commands are marked with :noindex when index is not used
-        noindex = STATIC_NEVER.include?(@options[:index])
+        noindex = STATIC_NEVER.include?(@settings.index)
 
         headers.each do |field, value|
           # Literal header names MUST be translated to lowercase before
@@ -254,26 +226,17 @@ module HTTP2
         end
       end
 
-      # Emits command for a header.
+      # Emits command for a +field+/+value+ header.
       # Prefer static table over dynamic table.
       # Prefer exact match over name-only match.
       #
-      # +@options [:index]+ controls whether to use the dynamic table,
-      # static table, or both.
-      #  :never   Do not use dynamic table or static table reference at all.
-      #  :static  Use static table only.
-      #  :all     Use all of them.
-      #
-      # @param field [String] the header field
-      # @param value [String] the header value
-      # @return [Hash] command
       def addcmd(field, value)
         # @type var exact: Integer?
         exact = nil
         # @type var name_only: Integer?
         name_only = nil
 
-        index_type = @options[:index]
+        index_type = @settings.index
 
         if STATIC_ALL.include?(index_type) &&
            STATIC_TABLE_BY_FIELD.key?(field)
@@ -337,11 +300,10 @@ module HTTP2
         end
       end
 
+      # whether +cmd+ fits in the dynamic table.
+      #
       # To keep the dynamic table size lower than or equal to @limit,
       # remove one or more entries at the end of the dynamic table.
-      #
-      # @param cmdsize [Integer]
-      # @return [Boolean] whether +cmd+ fits in the dynamic table.
       def size_check?(cmdsize)
         resize_table(cmdsize)
         cmdsize <= @limit

data/lib/http/2/header/huffman.rb

@@ -22,12 +22,7 @@ module HTTP2
 
       EOS_PADDING = (0..7).map { |n| ("1" * n).b.freeze }.freeze
 
-      # Encodes provided value via huffman encoding.
-      # Length is not encoded in this method.
-      #
-      # @param str [String]
-      # @param buffer [String]
-      # @return [String] binary string
+      # Encodes provided +str+ via huffman encoding into +buffer+ .
       def encode(str, buffer = "".b)
         bitstring = String.new("", encoding: Encoding::BINARY, capacity: (str.bytesize * 30) + ((8 - str.size) % 8))
         str.each_byte { |chr| append_str(bitstring, ENCODE_TABLE[chr]) }
@@ -35,11 +30,9 @@ module HTTP2
         pack([bitstring], "B*", buffer: buffer)
       end
 
-      # Decodes provided Huffman coded string.
+      # Decodes provided Huffman coded string in +buf+.
       #
-      # @param buf [Buffer]
-      # @return [String] binary string
-      # @raise [CompressionError] when Huffman coded string is malformed
+      # raises CompressionError when Huffman coded string is malformed
       def decode(buf)
         emit = "".b
         state = 0 # start state

data/lib/http/2/server.rb

@@ -97,10 +97,10 @@ module HTTP2
         dependency: 0,
         exclusive: false,
         payload: headers
-      }
+      } #: headers_frame
 
       if body.empty?
-        headers_frame[:flags] |= END_HEADERS
+        headers_frame[:flags] |= END_STREAM
         stream << headers_frame
       else
         stream << headers_frame

data/lib/http/2/settings.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module HTTP2
+  MAX_HEADER_LIST_SIZE = (2 << 30) - 1
+
   # Default values for SETTINGS frame, as defined by the spec.
   SPEC_DEFAULT_CONNECTION_SETTINGS = {
     settings_header_table_size: 4096,
@@ -8,32 +10,46 @@ module HTTP2
     settings_max_concurrent_streams: Framer::MAX_STREAM_ID, # unlimited
     settings_initial_window_size: 65_535,
     settings_max_frame_size: 16_384,
-    settings_max_header_list_size: (2 << 30) - 1 # unlimited
+    settings_max_header_list_size: MAX_HEADER_LIST_SIZE # unlimited
   }.freeze
 
+  ENCODING_CONTEXT_SETTINGS = %i[huffman index table_size].freeze
+
   Settings = Struct.new(
+    # connection settings
     :settings_header_table_size,
     :settings_enable_push,
     :settings_max_concurrent_streams,
     :settings_initial_window_size,
     :settings_max_frame_size,
     :settings_max_header_list_size,
+    # encoding context settings
+    :huffman,
+    :index,
+    :table_size,
     keyword_init: true
   ) do
     def initialize(
+      # connection settings
       settings_header_table_size: 4096,
       settings_enable_push: 1,
       settings_max_concurrent_streams: 100,
       settings_initial_window_size: 65_535,
       settings_max_frame_size: 16_384,
-      settings_max_header_list_size: (2 << 30) - 1
+      settings_max_header_list_size: MAX_HEADER_LIST_SIZE,
+      # encoding context settings
+      huffman: :shorter,
+      index: :all,
+      table_size: 4096
     )
       super
     end
 
-    def each_setting
+    def connection_settings
+      return enum_for(__method__) unless block_given?
+
       each_pair do |k, v|
-        next if v == SPEC_DEFAULT_CONNECTION_SETTINGS[k]
+        next if ENCODING_CONTEXT_SETTINGS.include?(k)
 
         yield k, v
       end

data/lib/http/2/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HTTP2
-  VERSION = "1.2.1"
+  VERSION = "1.2.3"
 end

data/lib/http/2.rb

@@ -13,6 +13,7 @@ require "http/2/emitter"
 require "http/2/flow_buffer"
 require "http/2/header"
 require "http/2/framer"
+require "http/2/settings"
 require "http/2/connection"
 require "http/2/client"
 require "http/2/server"

data/sig/2.rbs

@@ -11,23 +11,10 @@ module HTTP2
 
   type connection_opts = Hash[Symbol, untyped]
 
-  type settings_hash = {
-    settings_header_table_size: Integer,
-    settings_enable_push: Integer,
-    settings_max_concurrent_streams:  Integer,
-    settings_initial_window_size: Integer,
-    settings_max_frame_size: Integer,
-    settings_max_header_list_size: Integer
-  }
-
   type settings_ary = Array[settings_enum]
 
   type settings_enum = Enumerable[[Symbol, Integer]]
 
-  SPEC_DEFAULT_CONNECTION_SETTINGS: settings_hash
-
-  DEFAULT_CONNECTION_SETTINGS: settings_hash
-
   DEFAULT_WEIGHT: Integer
 
   CONNECTION_PREFACE_MAGIC: String
@@ -36,6 +23,12 @@ module HTTP2
 
   RESPONSE_MANDATORY_HEADERS: Array[String]
 
+  CONNECTION_FRAME_TYPES: Array[Symbol]
+
+  STREAM_OPEN_STATES: Array[Symbol]
+
+  HEADERS_FRAME_TYPES: Array[Symbol]
+
   # Frame flags
   END_STREAM: Integer
   ACK: Integer

data/sig/connection.rbs

@@ -4,16 +4,6 @@ module HTTP2
     include Emitter
     include BufferUtils
 
-    REQUEST_MANDATORY_HEADERS: Array[String]
-
-    RESPONSE_MANDATORY_HEADERS: Array[String]
-
-    CONNECTION_FRAME_TYPES: Array[Symbol]
-
-    HEADERS_FRAME_TYPES: Array[Symbol]
-
-    STREAM_OPEN_STATES: Array[Symbol]
-
     attr_reader state: Symbol
 
     attr_reader local_window: Integer
@@ -21,8 +11,8 @@ module HTTP2
 
     alias window local_window
 
-    attr_reader remote_settings: settings_hash
-    attr_reader local_settings: settings_hash
+    attr_reader remote_settings: Settings
+    attr_reader local_settings: Settings
     attr_reader pending_settings: settings_ary
 
     attr_accessor active_stream_count: Integer
@@ -59,6 +49,10 @@ module HTTP2
 
     def closed?: () -> bool
 
+    def closing?: () -> bool
+
+    def close!: () -> void
+
     def new_stream: (**untyped) -> Stream
 
     def ping: (String) -> void
@@ -83,7 +77,7 @@ module HTTP2
 
     def connection_frame?: (frame) -> bool
 
-    def connection_management: (connection_frame frame) -> void
+    def connection_management: (frame frame) -> void
 
     def ping_management: (frame) -> void
 
@@ -95,7 +89,7 @@ module HTTP2
 
     def encode_headers: (headers_frame | push_promise_frame) -> void
 
-    def activate_stream: (id: Integer, **untyped) -> Stream
+    def activate_stream: (id: Integer, ?max_concurrent_streams: Integer, **untyped) -> Stream
 
     def verify_stream_order: (Integer id) -> void
 

data/sig/header/compressor.rbs

@@ -18,7 +18,7 @@ module HTTP2
 
       private
 
-      def initialize: (?connection_opts options) -> void
+      def initialize: (?Settings settings) -> void
 
       def huffman_string: (String str, ?String buffer) -> String
 

data/sig/header/decompressor.rbs

@@ -19,7 +19,7 @@ module HTTP2
                 | (String) -> Array[header_pair]
       private
 
-      def initialize: (?connection_opts options) -> void
+      def initialize: (?Settings settings) -> void
     end
   end
 end

data/sig/header/encoding_context.rbs

@@ -11,14 +11,12 @@ module HTTP2
 
       STATIC_NEVER: Array[Symbol]
 
-      DEFAULT_OPTIONS: context_hash
-
       UPPER: Regexp
 
 
       attr_reader table: Array[header_pair]
 
-      attr_reader options: context_hash
+      attr_reader settings: Settings
 
       attr_reader current_table_size: Integer
 
@@ -46,7 +44,7 @@ module HTTP2
 
       private
 
-      def initialize: (?connection_opts options) -> void
+      def initialize: (?Settings settings) -> void
 
       def add_to_table: (string name, string value) -> void
 

data/sig/server.rbs

@@ -1,5 +1,7 @@
 module HTTP2
   class Server < Connection
+    @origin_set: Array[String]
+    @origins_sent: bool
 
     def upgrade: (String settings, Enumerable[header_pair] headers, String body) -> void
 

data/sig/settings.rbs

@@ -0,0 +1,71 @@
+module HTTP2
+  MAX_HEADER_LIST_SIZE: Integer
+
+  SPEC_DEFAULT_CONNECTION_SETTINGS: Hash[Symbol, Integer]
+
+  ENCODING_CONTEXT_SETTINGS: Array[Symbol]
+
+  type huffman_type = :always | :never | :shorter
+
+  type index_type = :all | :static | :never
+
+  # Container for all settings required for the management of an HTTP/2 connection. This
+  # includes the managemenet of the settings negotiated via the SETTINGS frame, as well as
+  # user-level configuration related with header compression.
+  class Settings # this is actually a Struct, but RBS does not support it yet
+    # connection settings (send and received in the SETTINGS frame)
+
+    # maximum size of the header compression table used to decode header blocks, in bytes.
+    attr_reader settings_header_table_size: Integer
+
+    # can be used to disable server push (set to 0)
+    attr_reader settings_enable_push: Integer
+
+    # maximum number of concurrent streams that the sender will allow.
+    attr_reader settings_max_concurrent_streams: Integer
+
+    # initial window size (in bytes) for stream-level flow control.
+    attr_reader settings_initial_window_size: Integer
+
+    # max size of for payload that the sender is willing to receive, in bytes.
+    attr_reader settings_max_frame_size: Integer
+    attr_reader settings_max_header_list_size: Integer
+
+    # encoding context settings
+
+    # controls how to use huffman encoding to encode strings. can be one of the following values:
+    #
+    # * `:always` - Always use Huffman encoding
+    # * `:never` - Do not use Huffman encoding
+    # * `:shorter` - Use Huffman when the result is strictly shorter
+    attr_reader huffman: huffman_type
+
+    # controls the configuration of the HPACK indexing tables:
+    #
+    # * `:static` - use the static table only
+    # * `:all` - use the static table and the dynamic table
+    # * `:never` - do not use any of the tables.
+    attr_reader index: index_type
+
+    # maximum dynamic table size in bytes
+    attr_reader table_size: Integer
+
+    def initialize: (
+      # connection settings
+      ?settings_header_table_size: Integer,
+      ?settings_enable_push: Integer,
+      ?settings_max_concurrent_streams: Integer,
+      ?settings_initial_window_size: Integer,
+      ?settings_max_frame_size: Integer,
+      ?settings_max_header_list_size: Integer,
+      # encoding context settings
+      ?huffman: huffman_type,
+      ?index: index_type,
+      ?table_size: Integer
+    ) -> void
+
+    # yields connection-level settings only.
+    def connection_settings: () { (Symbol, Integer) -> void } -> self
+                           | () -> Enumerable[[Symbol, Integer]]
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: http-2
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.3
 platform: ruby
 authors:
 - Tiago Cardoso
@@ -19,6 +19,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
 - README.md
 - lib/http/2.rb
 - lib/http/2/base64.rb
@@ -54,6 +55,7 @@ files:
 - sig/header/encoding_context.rbs
 - sig/header/huffman.rbs
 - sig/server.rbs
+- sig/settings.rbs
 - sig/stream.rbs
 homepage: https://github.com/igrigorik/http-2
 licenses:
@@ -78,7 +80,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: Pure-ruby HTTP 2.0 protocol implementation
 test_files: []