Fix bug where client ignores HEADERS frames on open stream when locally quiescing #445
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…m when locally quiescing
glbrntt
requested changes
Jul 4, 2024
Sources/NIOHTTP2/ConnectionStateMachine/FrameReceivingStates/ReceivingHeadersState.swift
Outdated
Show resolved
Hide resolved
Comment on lines
64
to
75
| extension HTTP2ConnectionStateMachine.ConnectionRole { | ||
| /// Obtain the inverse role to self | ||
| /// - Returns: The inverse role | ||
| fileprivate func inverse() -> Self { | ||
| switch self { | ||
| case .server: | ||
| return .client | ||
| case .client: | ||
| return .server | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
nit: can we move this to where ConnectionRole is defined?
|
@swift-server-bot add to allowlist |
Lukasa
reviewed
Jul 5, 2024
Sources/NIOHTTP2/ConnectionStateMachine/ConnectionStateMachine.swift
Outdated
Show resolved
Hide resolved
Sources/NIOHTTP2/ConnectionStateMachine/LocallyQuiescingState.swift
Outdated
Show resolved
Hide resolved
Lukasa
reviewed
Jul 17, 2024
| @@ -17,7 +17,7 @@ import NIOHPACK | |||
| /// can validly accept headers. | |||
| /// | |||
| /// This protocol should only be conformed to by states for the HTTP/2 connection state machine. | |||
| protocol ReceivingHeadersState: HasFlowControlWindows, HasLocalExtendedConnectSettings, HasRemoteExtendedConnectSettings { | |||
| protocol ReceivingHeadersState: HasFlowControlWindows, HasLocalExtendedConnectSettings, HasRemoteExtendedConnectSettings, ConnectionStateWithRole { | |||
There was a problem hiding this comment.
Do we need the protocol constraint here at all? We already have the role.
There was a problem hiding this comment.
Yes, ConnectionStateWithRole has a member peerRole which is being used as part of the fix:
Lukasa
approved these changes
Jul 18, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation:
Currently, HEADERS frames are ignored by the client on a client-initiated stream after the client sends a GOAWAY.
As per Section 6.8 (GOAWAY) in RFC 9113:
"Once the GOAWAY is sent, the sender will ignore frames sent on streams initiated by the receiver if the stream has an identifier higher than the included last stream identifier."
In this case, the client (sender) should not ignore the HEADERS frame as the stream is initiated by the client, not the receiver.
Modifications:
Fixed the condition in the
receiveHeadersfunction (givenLocallyQuiescingState) inReceivingHeadersState.swiftto work for both the client and server roles -- before this change, the condition is only correct whenself.role == ConnectionRole.server.Result:
HEADERS frames are not ignored by the client on a client-initiated stream when locally quiescing.