Skip to content

Changed NIOAsyncChannel.executeThenClose to accept actor-isolated par… #3121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rafaelcepeda merged 18 commits into from
Mar 25, 2025
Merged

Changed NIOAsyncChannel.executeThenClose to accept actor-isolated par… #3121

Changes from 4 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
d87d115
Changed NIOAsyncChannel.executeThenClose to accept actor-isolated par…
rafaelcepeda Feb 25, 2025
5aed567
Reintroduced old executeThenClose API to prevent breaking clients. Ad…
rafaelcepeda Feb 25, 2025
255ae79
Fixed formatting issues
rafaelcepeda Feb 25, 2025
d29dfd6
Merge branch 'main' into ahc_actor_isolation
rafaelcepeda Feb 25, 2025
3797119
Added compiler test to include new executeTheClose implementation.
rafaelcepeda Feb 28, 2025
5ac616b
Merge branch 'main' into ahc_actor_isolation
rafaelcepeda Feb 28, 2025
07d9dd2
Fixed method documentation.
rafaelcepeda Feb 28, 2025
601a89d
Constrained Result to be Sendable from the new executeThenClose.
rafaelcepeda Feb 28, 2025
5136e34
Fixed empty line in method doc.
rafaelcepeda Feb 28, 2025
0ce2eb7
Update Sources/NIOCore/AsyncChannel/AsyncChannel.swift
rafaelcepeda Mar 3, 2025
c6b44a4
Update Sources/NIOCore/AsyncChannel/AsyncChannel.swift
rafaelcepeda Mar 3, 2025
1c391f0
Changed return Result to be sending.
rafaelcepeda Mar 14, 2025
d75febb
Merge branch 'main' into ahc_actor_isolation
rafaelcepeda Mar 14, 2025
e4e9521
Added tests to verify new executeThenClose methods.
rafaelcepeda Mar 19, 2025
19fdada
Guarded new tests with compiler directive.
rafaelcepeda Mar 19, 2025
e5ccc5f
Added extra test that references self.
rafaelcepeda Mar 19, 2025
9bbc12b
Merge branch 'main' into ahc_actor_isolation
rafaelcepeda Mar 19, 2025
b358601
Merge branch 'main' into ahc_actor_isolation
rafaelcepeda Mar 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion Sources/NIOCore/AsyncChannel/AsyncChannel.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,10 +283,25 @@ public struct NIOAsyncChannel<Inbound: Sendable, Outbound: Sendable>: Sendable {
///
/// - Important: After this method returned the underlying ``Channel`` will be closed.
///
/// - Parameter body: A closure that gets scoped access to the inbound and outbound.
/// - Parameter: body: A closure that gets scoped access to the inbound and outbound.
public func executeThenClose<Result>(
_ body: (_ inbound: NIOAsyncChannelInboundStream<Inbound>, _ outbound: NIOAsyncChannelOutboundWriter<Outbound>)
async throws -> Result
) async throws -> Result {
try await executeThenClose(isolatedTo: nil, body)
}

/// Provides scoped access to the inbound and outbound side of the underlying ``Channel``.
///
/// - Important: After this method returned the underlying ``Channel`` will be closed.
///
/// - Parameter:
/// - actor: actor where this function should be isolated to
/// - body: A closure that gets scoped access to the inbound and outbound.
public func executeThenClose<Result>(
isolatedTo actor: isolated (any Actor)?,
Copy link
Contributor

@rnro rnro Feb 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We seem to have dropped the defaulted parameter here which I think we want.

Copy link
Contributor

@gjcairo gjcairo Feb 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The problem is the compiler picking the right func if we default this parameter (i.e. if you call executeThenClose { ... } are we calling the old version, or the one defaulting isolation?).
We could use @_disfavoredOverload, but have we agreed that is the route we generally want to take?

Specifically in this case, if what we want is to enable adopters to use executeThenClose from actors, I don't think it's particularly bad to have to explicitly pass self as isolation, as it makes it clear you want to run this on the actor, even though you're awaiting and would otherwise be hopping off the isolation domain.

Copy link
Contributor Author

@rafaelcepeda rafaelcepeda Feb 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As spoken offline, we decided to favour the use of @_disfavoredOverload with this API. I'll change the code.

_ body: (_ inbound: NIOAsyncChannelInboundStream<Inbound>, _ outbound: NIOAsyncChannelOutboundWriter<Outbound>)
async throws -> Result
) async throws -> Result {
let result: Result
do {
Expand Down
Loading