support h2 stream resets through user events #241
+52
−0
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
Resetting streams with specific error codes is required by some applications such as those implementing the CONNECT method (see https://datatracker.ietf.org/doc/html/rfc9113#section-8.5-8). Unfortunately, the HTTP2ToHTTP codecs don't expose this capability to applications. This change introduces an outbound user event applications can trigger when needing to reset a stream.
glbrntt
requested changes
Dec 19, 2024
| } | ||
|
|
||
| /// Events that can be sent by the application to be handled by the `HTTP2StreamChannel` | ||
| public struct HTTP2FramePayloadToHTTPEvent { |
There was a problem hiding this comment.
This will need a NIO prefix as it's new API (see https://github.com/apple/swift-nio/blob/main/docs/public-api.md#1-no-global-namespace-additions-that-arent-prefixed)
There was a problem hiding this comment.
It should also be Hashable and Sendable, it's generally useful to add these to value types.
| } | ||
|
|
||
| /// Returns reset code if the event is a reset | ||
| public func reset() -> HTTP2ErrorCode? { |
There was a problem hiding this comment.
A computed property would be more idiomatic here
Comment on lines
298
to
301
| if case let .reset(code) = self.kind { | ||
| return code | ||
| } | ||
| return nil |
There was a problem hiding this comment.
nit: convention is NIO is to exhaustively switch over enums
Comment on lines
285
to
289
| fileprivate enum Kind { | ||
| case reset(HTTP2ErrorCode) | ||
| } | ||
|
|
||
| fileprivate var kind: Kind |
There was a problem hiding this comment.
Can we make these private and use the public API in the handlers above?
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.
Allow applications to trigger HTTP/2 stream resets while using NIOHTTPTypesHTTP2's codecs
Motivation:
Resetting streams with specific error codes is required by some applications such as those implementing the CONNECT method
(see https://datatracker.ietf.org/doc/html/rfc9113#section-8.5-8). Unfortunately, the HTTP2ToHTTP codecs don't expose this capability to applications.
Modifications:
Introduce an outbound user event applications can trigger when needing to reset an HTTP/2 stream.
Result:
Now applications can trigger HTTP/2 stream resets while using the codecs provided by NIOHTTPTypesHTTP2