Add CloseableConnection capability#94
Draft
gjcairo wants to merge 1 commit into
Draft
Conversation
aryan-25
reviewed
Jul 6, 2026
| /// `true` when the request `.end` has been received on the inbound side, or no | ||
| /// request is currently in flight. `false` between receiving a request `.head` | ||
| /// and its `.end`. | ||
| private var requestEndReceived: Bool = true |
Collaborator
There was a problem hiding this comment.
Why is the default value true?
| if case .buffering = self.finalResponseState { | ||
| self.flushBuffer(context: context) | ||
| } | ||
| context.flush() |
Collaborator
There was a problem hiding this comment.
If self.flushBuffer() was called above, then context.flush() will be called twice (self.flushBuffer() also calls context.flush()).
| // The server requires a NIOAsyncChannel, so we create one from the test channel | ||
| let serverTestAsyncChannel = try await testChannel.eventLoop.submit { | ||
| try NIOAsyncChannel<NIOAsyncChannel<HTTPRequestPart, HTTPResponsePart>, Never>( | ||
| try NIOAsyncChannel<NIOHTTPServer.HTTP1ChildConnection, Never>( |
Collaborator
There was a problem hiding this comment.
nit:
Suggested change
| try NIOAsyncChannel<NIOHTTPServer.HTTP1ChildConnection, Never>( | |
| try NIOAsyncChannel<HTTP1ChildConnection, Never>( |
Comment on lines
+203
to
+209
| /// The context's ``ConnectionContext/signalConnectionClose()`` synchronously | ||
| /// flips the shared close flag the channel's ``HTTPKeepAliveHandler`` | ||
| /// observes when writing the next response head. The synchronous set | ||
| /// side-steps any race between firing a NIO event off-loop and writing the | ||
| /// response head off-loop. The handler reacts by amending the next response | ||
| /// head with `Connection: close` and closing the channel once the response | ||
| /// `.end` is written. |
Collaborator
There was a problem hiding this comment.
nit: I think this detail is unnecessary for this function.
Comment on lines
+387
to
+392
| /// If the request handler invokes | ||
| /// ``ConnectionContext/signalConnectionClose()`` while running, the | ||
| /// connection-context's `closeAction` fires `ChannelShouldQuiesceEvent` on | ||
| /// the connection-channel pipeline; NIO's HTTP/2 connection management | ||
| /// handler reacts by sending `GOAWAY`, letting other in-flight streams | ||
| /// complete normally, and finally closing the connection. |
Collaborator
There was a problem hiding this comment.
nit: I think this detail is unnecessary for this function.
Comment on lines
+355
to
+358
| request, | ||
| requestContext, | ||
| reader, | ||
| responseSender in |
Collaborator
There was a problem hiding this comment.
formatting nit: it should be possible to put all these arguments on the same line. request and reader can be replaced with _ if the line length becomes too long. The same applies for all the other test cases below.
Comment on lines
+448
to
+452
| #expect(response.headerFields[.connection] == "close") | ||
| // Look for any duplicate `Connection` headers; the field should | ||
| // appear exactly once with value "close". | ||
| let connectionValues = response.headerFields[values: .connection] | ||
| #expect(connectionValues == ["close"]) |
Collaborator
There was a problem hiding this comment.
Suggested change
| #expect(response.headerFields[.connection] == "close") | |
| // Look for any duplicate `Connection` headers; the field should | |
| // appear exactly once with value "close". | |
| let connectionValues = response.headerFields[values: .connection] | |
| #expect(connectionValues == ["close"]) | |
| // Look for any duplicate `Connection` headers; the field should | |
| // appear exactly once with value "close". | |
| let connectionValues = response.headerFields[values: .connection] | |
| #expect(connectionValues == ["close"]) |
Comment on lines
+457
to
+458
| let _trailing = try await iterator.next() | ||
| #expect(_trailing == nil) |
Collaborator
There was a problem hiding this comment.
nit: the leading underscore in the variable name seems unnecessary. The same applies for the test case below.
Comment on lines
+100
to
+101
| /// - On HTTP/1.1, the response carries `Connection: close` and the | ||
| /// channel is closed once the response has been written. |
Collaborator
There was a problem hiding this comment.
We should document that signalConnectionClose() must be called before sending the response for this to hold true.
Comment on lines
+500
to
+506
| // We deliberately don't assert anything about the `Connection` | ||
| // header here: `responseSender.send(_:)` returns once the head | ||
| // is yielded to the async-stream queue, which may be before the | ||
| // keep-alive handler has actually processed it on the event | ||
| // loop. So the flag set immediately after `send` is sometimes | ||
| // still observed in time to amend the head. The reliable | ||
| // observable is that the channel closes after the response. |
Collaborator
There was a problem hiding this comment.
We can bypass this by creating a promise that the client will fulfil after it receives the head. The server should await that promise before calling requestContext.signalConnectionClose().
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This is a follow-up of the connection lifecycle PR: #92
It adds support for signalling that the current connection should close after the in-flight response via a new
CloseableConnectionHTTPServerCapability.NIOHTTPServer.RequestContextconforms to it and exposes this capability viarequestContext.signalConnectionClose().