http-2 1.2.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37f0171472c53a3f13cb8f8259302aed5f07c9dbc90f27893ddf8b868c78e41a
-  data.tar.gz: 52b05bc6ebc9d08d2a761ba465f39315e32ad3738a4c22d1d9a3ab58e7357867
+  metadata.gz: 1b41c25d0512d4056a38265801e7eef05df3cab5720ecbe11ff088c906752019
+  data.tar.gz: 0b7322ff7f49e8dd892a9804a1a710be23f3c7105f76f7c67f62b281843616fc
 SHA512:
-  metadata.gz: 9f9c98e6f3d031388f451d22b142764d221967bcf72252689652182ffcd9e47bb60b90003491b7a7056eea51a7faaaece880c942ef4d02d223579924587ab103
-  data.tar.gz: 1bbe211ac07f751a5381b2c8d633392bb5460b5324af0f717f7ad06f4ff8695c7a3a8122bcca8ceb01b7b5063cd3f95c4e8fdff14a1bbcc3ce640e5609d90da9
+  metadata.gz: 32b4191d53effc33d5186da7093af95698809f2fec89fe37ce01898628d598e7a1215704875ec06ebd9fcaf84b11517310ee46631fb7a2c6b4a2a17fb3ad8b94
+  data.tar.gz: 5ce7ec0abedca471a25e45883ba4b8d315eb1e78879ed5a8c563dc6a58a7e128bbe9f78f878a8d9956dd90254718634bc67323b57039cb33e87d6e1552cac392

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/connection.rb

@@ -56,7 +56,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
@@ -113,8 +114,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 +131,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 +169,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.
@@ -295,7 +305,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 +337,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 +389,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,
@@ -399,7 +418,6 @@ module HTTP2
                 unless @streams_recently_closed.key?(stream_id)
                   connection_error(:protocol_error, msg: "sent window update on idle stream")
                 end
-                stream = @streams_recently_closed[stream_id]
                 process_window_update(frame: frame, encode: true)
               # Endpoints MUST ignore
               # WINDOW_UPDATE or RST_STREAM frames received in this state (closed), though
@@ -496,7 +514,7 @@ module HTTP2
         @state = :connected
         connection_settings(frame)
 
-      when :connected
+      when :connected, :closing
         case frame_type
         when :settings
           # @type var frame: settings_frame
@@ -511,8 +529,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
@@ -769,19 +792,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
@@ -812,6 +844,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/extensions.rb

@@ -26,9 +26,16 @@ module HTTP2
       def read_str(str, n)
         return "".b if n == 0
 
+        enc = str.encoding
+
+        if enc != Encoding::BINARY
+          str = str.dup if str.frozen?
+          str.force_encoding(Encoding::BINARY)
+        end
+
         chunk = str.byteslice(0, n)
         str.bytesplice(0, chunk.length, "")
-        chunk
+        chunk.force_encoding(Encoding::BINARY)
       end
     else
       def read_str(str, n)
@@ -37,7 +44,7 @@ module HTTP2
         chunk = str.byteslice(0, n)
         remaining = str.byteslice(n, str.size - n)
         remaining ? str.replace(remaining) : str.clear
-        chunk
+        chunk.force_encoding(Encoding::BINARY)
       end
     end
 

data/lib/http/2/version.rb

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

data/sig/connection.rbs

@@ -59,6 +59,10 @@ module HTTP2
 
     def closed?: () -> bool
 
+    def closing?: () -> bool
+
+    def close!: () -> void
+
     def new_stream: (**untyped) -> Stream
 
     def ping: (String) -> void
@@ -95,7 +99,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
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: http-2
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.2
 platform: ruby
 authors:
 - Tiago Cardoso
@@ -78,7 +78,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: []