Retain a ref to NIOAsyncWriter until channel active #2703
Merged
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
Motivation: NIOAsyncChannel requires users to explicitly close it, this is typically done by calling `executeThenClose`. If a `NIOAsyncChannel` isn't closed then its outbound writer will hit a precondition failure on `deinit`. Not calling `executeThenClose` is a programmer error. However there are some sharp edges: if NIO never returns the `NIOAsyncChannel` to the caller (e.g. if a connect attempt fails) then nothing will finish the writer and precondition will fail in the deinit. Working around this from a user perspective is non-obvious and requires keep tracking of all `NIOAsyncChannel`s created from a connect attempt and closing the unused ones. We still want to maintain the precondition when users don't close the channel, one way of achieving this is by defining a point in time at which NIO hands responsibility of the channel to the user. Modifications: - Retain the writer in the outbound writer handler until channel active - On successful connect attempts, the channel becomes active and the connected channel is returned to the caller. - On failed attempts channel active isn't called so the writer is retained until the handler is removed from the pipeline at which point it is finished. Result: Failed connect attempts don't result in precondition failures when using NIOAsyncChannel.
|
Hmm, CI is failing to install jemalloc |
|
@swift-server-bot test this please |
|
I'm happy with this, but would like JW to review. |
FranzBusch
approved these changes
Apr 19, 2024
|
Now we have a fun mixture of failures unrelated to the changes... Swift 5.9 and 5.10 are failing some datagram tests: and Swift 5.9 cxx interop is failing to establish connections to archive.ubuntu.com to install various dependencies: |
|
This likely explains why various dependencies couldn't be installed: https://status.canonical.com/#/incident/KNms6QK9ewuzz-7xUsPsNylV20jEt5kyKsd8A-3ptQHensLmCBVh6VphXOOE4t72EY4o3wVOetg9awfJ1hij3w== |
|
@swift-server-bot test this please |
|
@swift-server-bot test this please |
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:
NIOAsyncChannel requires users to explicitly close it, this is typically done by calling
executeThenClose. If aNIOAsyncChannelisn't closed then its outbound writer will hit a precondition failure ondeinit. Not callingexecuteThenCloseis a programmer error.However there are some sharp edges: if NIO never returns the
NIOAsyncChannelto the caller (e.g. if a connect attempt fails) then nothing will finish the writer and precondition will fail in the deinit. Working around this from a user perspective is non-obvious and requires keep tracking of allNIOAsyncChannels created from a connect attempt and closing the unused ones.We still want to maintain the precondition when users don't close the channel, one way of achieving this is by defining a point in time at which NIO hands responsibility of the channel to the user.
Modifications:
Result:
Failed connect attempts don't result in precondition failures when using NIOAsyncChannel.