protocol-http2 0.26.2 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71a2305405458d3561894bf24c86be5ea1173afcac8b7b4a9ef428d7456a8d71
-  data.tar.gz: 33ab8df1d8cf05915b30dd0f7097e58c5ac0e9f4d41adf9fda9f404099efc66d
+  metadata.gz: e218c8562a926b98f24ad707341e1ee24d26ed6ce94b9f6550049000f415cd2b
+  data.tar.gz: 8ed236e94626982bd750d03a5c568c7b438e233b09256b671e5373db0881617c
 SHA512:
-  metadata.gz: e839c86778149cea55719b358e8e145332c14fac5a8ef383f089d939d70dd4bdc654453e8e4ed71a6c0514c01bcbddc19382925e70a1c66fbc2ade195abbbc0c
-  data.tar.gz: d92e068cc07e8222795c9faa3242a72d8cdabbcefb4a42e11177fe59c01c654e9df0f56adf9e65471bf26f1310cfe3b2fcb2f49e5d4ab03e471d9d077a9af554
+  metadata.gz: 31dfad736c2d3807ba103ccd70dea68d95375fe53f290582f805691c7b51cc43512494e2aae439c90082b0fbf518568c78e574bf9a3bb19dc4312127eb6378db
+  data.tar.gz: 2ee408ca054cd3ae3eb205489ea0b7095fe896af11bcb810e377a627d824cd2b6440d013ace9ebba79886ac71c067a541209007c9ee169dcd78803c2be531172

data/context/index.yaml

@@ -3,6 +3,8 @@
 ---
 description: A low level implementation of the HTTP/2 protocol.
 metadata:
+  bug_tracker_uri: https://github.com/socketry/protocol-http2/issues
+  changelog_uri: https://github.com/socketry/protocol-http2/blob/main/releases.md
   documentation_uri: https://socketry.github.io/protocol-http2/
   source_code_uri: https://github.com/socketry/protocol-http2.git
 files:

data/lib/protocol/http2/connection.rb

@@ -3,6 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2019-2026, by Samuel Williams.
 # Copyright, 2023, by Marco Concetto Rudilosso.
+# Copyright, 2026, by Denis Talakevich.
 
 require_relative "framer"
 require_relative "flow_controlled"
@@ -44,6 +45,9 @@ module Protocol
 				
 				@local_window = LocalWindow.new
 				@remote_window = Window.new
+				
+				# The lowest Last-Stream-ID received in a GOAWAY frame, or nil if no GOAWAY frame has been received:
+				@goaway_stream_id = nil
 			end
 			
 			# The connection stream ID (always 0 for connection-level operations).
@@ -94,16 +98,41 @@ module Protocol
 			# The highest stream_id that has been successfully accepted by this connection.
 			attr :remote_stream_id
 			
+			# The lowest Last-Stream-ID received in a GOAWAY frame.
+			attr :goaway_stream_id
+			
 			# Whether the connection is effectively or actually closed.
 			def closed?
 				@state == :closed || @framer.nil?
 			end
 			
+			# Whether the remote peer has sent us a GOAWAY frame. We must not initiate any new streams on this connection, but existing streams may still be in progress.
+			# @returns [Boolean] True if a GOAWAY frame has been received.
+			def goaway_received?
+				!@goaway_stream_id.nil?
+			end
+			
+			# Transition the connection into the closed state if a graceful GOAWAY was received and there is nothing left to drain.
+			#
+			# As with {close!}, this is a state transition only: the owner of the connection is responsible for closing the underlying framer.
+			def close_if_drained!
+				if self.goaway_received? && @streams.empty?
+					self.close!
+				end
+			end
+			
 			# Remove a stream from the active streams collection.
+			#
+			# If the remote peer has sent a graceful GOAWAY frame, the connection is only kept open in order to drain the streams it accepted, so when the last one completes there is nothing left to read.
+			#
 			# @parameter id [Integer] The stream ID to remove.
 			# @returns [Stream | Nil] The removed stream, or nil if not found.
 			def delete(id)
-				@streams.delete(id)
+				stream = @streams.delete(id)
+				
+				self.close_if_drained!
+				
+				return stream
 			end
 			
 			# Close the underlying framer and all streams.
@@ -229,25 +258,39 @@ module Protocol
 			end
 			
 			# Process a GOAWAY frame from the remote peer.
+			#
+			# A GOAWAY frame with a zero error code is a graceful shutdown: the remote peer will not accept any new streams, but it is still processing the streams at or below `last_stream_id` and will send their responses (RFC 9113 §6.8). We must keep reading until those streams complete, otherwise requests which the remote peer has already processed - and whose side effects have already happened - fail locally. The connection is closed once the last of those streams completes, or the remote peer closes it.
+			#
+			# A GOAWAY frame with a non-zero error code is a connection error: the connection transitions into the closed state and {GoawayError} is raised.
+			#
 			# @parameter frame [GoawayFrame] The GOAWAY frame to process.
 			# @raises [GoawayError] If the frame indicates a connection error.
 			def receive_goaway(frame)
-				# We capture the last stream that was processed.
-				@remote_stream_id, error_code, message = frame.unpack
+				# We capture the last locally-initiated stream that may have been processed by the peer.
+				goaway_stream_id, error_code, message = frame.unpack
 				
-				self.close!
+				# A peer can send an initial GOAWAY with a high stream ID, followed by another GOAWAY with a lower stream ID. The effective cutoff can only decrease (RFC 9113 §6.8).
+				if @goaway_stream_id.nil? || goaway_stream_id < @goaway_stream_id
+					@goaway_stream_id = goaway_stream_id
+				end
 				
-				# Streams above the last stream ID were not processed by the remote peer and are safe to retry (RFC 9113 §6.8).
-				error = ::Protocol::HTTP::RefusedError.new("GOAWAY: request not processed.")
+				# Locally-initiated streams above the last stream ID were not processed by the remote peer and are safe to retry (RFC 9113 §6.8). They are removed from the connection before being closed, both so that what remains is exactly the set of streams we are waiting on, and so that closing them cannot mutate the collection while we are traversing it.
+				refused_streams = @streams.select{|id, stream| local_stream_id?(id) && id > @goaway_stream_id}
+				refused_streams.each_key{|id| @streams.delete(id)}
 				
-				@streams.each_value do |stream|
-					if stream.id > @remote_stream_id
-						stream.close(error)
-					end
+				# The state of the connection is decided before any stream is closed, so that it cannot be left undecided by a `closed` hook which raises, and cannot be influenced by one which creates a stream.
+				if error_code != 0
+					self.close!
+				else
+					self.close_if_drained!
+				end
+				
+				unless refused_streams.empty?
+					error = ::Protocol::HTTP::RefusedError.new("GOAWAY: request not processed.")
+					refused_streams.each_value{|stream| stream.close(error)}
 				end
 				
 				if error_code != 0
-					# Shut down immediately.
 					raise GoawayError.new(message, error_code)
 				end
 			end
@@ -404,6 +447,14 @@ module Protocol
 				false
 			end
 			
+			# Check if the given stream ID represents a locally-initiated stream.
+			# This method should be overridden by client/server implementations.
+			# @parameter id [Integer] The stream ID to check.
+			# @returns [Boolean] True if the stream ID is locally-initiated.
+			def local_stream_id?(id)
+				false
+			end
+			
 			# Accept an incoming stream from the other side of the connnection.
 			# On the server side, we accept requests.
 			def accept_stream(stream_id, &block)
@@ -425,6 +476,11 @@ module Protocol
 			# On the client side, we create requests.
 			# @return [Stream] the created stream.
 			def create_stream(id = next_stream_id, &block)
+				if self.goaway_received? and local_stream_id?(id)
+					# Receivers of a GOAWAY frame MUST NOT open additional streams on the connection (RFC 9113 §6.8). A new connection has to be established for new streams.
+					raise ProtocolError, "Cannot create stream #{id} after GOAWAY!"
+				end
+				
 				if @streams.key?(id)
 					raise ProtocolError, "Cannot create stream with id #{id}, already exists!"
 				end

data/lib/protocol/http2/goaway_frame.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2025, by Samuel Williams.
+# Copyright, 2019-2026, by Samuel Williams.
 
 require_relative "frame"
 

data/lib/protocol/http2/version.rb

@@ -7,6 +7,6 @@
 module Protocol
 	# @namespace
 	module HTTP2
-		VERSION = "0.26.2"
+		VERSION = "0.27.0"
 	end
 end

data/license.md

@@ -5,6 +5,7 @@ Copyright, 2019, by Yuta Iwama.
 Copyright, 2020, by Olle Jonsson.  
 Copyright, 2023, by Marco Concetto Rudilosso.  
 Copyright, 2024, by Adam Petro.  
+Copyright, 2026, by Denis Talakevich.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/readme.md

@@ -14,6 +14,11 @@ Please see the [project documentation](https://socketry.github.io/protocol-http2
 
 Please see the [project releases](https://socketry.github.io/protocol-http2/releases/index) for all releases.
 
+### v0.27.0
+
+  - On a graceful `GOAWAY` (error code `0`), keep the connection open until the streams the remote peer accepted have completed, instead of closing it immediately and failing those requests with `EOFError`.
+  - `Connection#create_stream` refuses to open a locally-initiated stream once a `GOAWAY` has been received, as required by RFC 9113 §6.8.
+
 ### v0.26.2
 
   - Ignore the reserved high bit when decoding GOAWAY last stream IDs.
@@ -52,13 +57,6 @@ Please see the [project releases](https://socketry.github.io/protocol-http2/rele
 
   - **Breaking**: Removed support for priority frame and stream dependencies. The `Protocol::HTTP2::Stream` class no longer tracks dependencies, and `Stream#send_headers` no longer takes `priority` as the first argument. This change simplifies the internal implementation significantly as HTTP/2 priority frames have been deprecated in the protocol specification.
 
-### v0.20.0
-
-  - Improved performance of dependency management by avoiding linear search operations.
-  - Removed `traces` as a required dependency - it's now optional and only used when explicitly needed.
-  - Added better documentation for `maximum_concurrent_streams` setting.
-  - Restored 100% test coverage and exposed trace provider for optional tracing support.
-
 ## See Also
 
   - [Async::HTTP](https://github.com/socketry/async-http) - A high-level HTTP client and server implementation.
@@ -67,26 +65,26 @@ Please see the [project releases](https://socketry.github.io/protocol-http2/rele
 
 We welcome contributions to this project.
 
-1.  Fork it.
+1.  Fork the repository.
 2.  Create your feature branch (`git checkout -b my-new-feature`).
-3.  Commit your changes (`git commit -am 'Add some feature'`).
+3.  Commit your changes (`git commit -am 'Add some feature.'`).
 4.  Push to the branch (`git push origin my-new-feature`).
-5.  Create new Pull Request.
+5.  Create a new pull request.
 
 ### Running Tests
 
 To run the test suite:
 
-``` shell
-bundle exec sus
+``` bash
+$ bundle exec sus
 ```
 
 ### Making Releases
 
 To make a new release:
 
-``` shell
-bundle exec bake gem:release:patch # or minor or major
+``` bash
+$ bundle exec bake gem:release:patch # or minor or major
 ```
 
 ### Developer Certificate of Origin

data/releases.md

@@ -1,5 +1,10 @@
 # Releases
 
+## v0.27.0
+
+  - On a graceful `GOAWAY` (error code `0`), keep the connection open until the streams the remote peer accepted have completed, instead of closing it immediately and failing those requests with `EOFError`.
+  - `Connection#create_stream` refuses to open a locally-initiated stream once a `GOAWAY` has been received, as required by RFC 9113 §6.8.
+
 ## v0.26.2
 
   - Ignore the reserved high bit when decoding GOAWAY last stream IDs.

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: protocol-http2
 version: !ruby/object:Gem::Version
-  version: 0.26.2
+  version: 0.27.0
 platform: ruby
 authors:
 - Samuel Williams
 - Yuta Iwama
 - Adam Petro
+- Denis Talakevich
 - Marco Concetto Rudilosso
 - Olle Jonsson
 bindir: bin
@@ -107,6 +108,8 @@ homepage: https://github.com/socketry/protocol-http2
 licenses:
 - MIT
 metadata:
+  bug_tracker_uri: https://github.com/socketry/protocol-http2/issues
+  changelog_uri: https://github.com/socketry/protocol-http2/blob/main/releases.md
   documentation_uri: https://socketry.github.io/protocol-http2/
   source_code_uri: https://github.com/socketry/protocol-http2.git
 rdoc_options: []