Skip to content

[SignalR] Pass cancellation token to FlushAsync #41180

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
BrennanConroy merged 2 commits into from
Apr 14, 2022
Merged

[SignalR] Pass cancellation token to FlushAsync #41180

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6b0adbb
[SignalR] Pass cancellation token to FlushAsync
BrennanConroy Apr 13, 2022
1c9e4bc
update
BrennanConroy Apr 13, 2022
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
7 changes: 1 addition & 6 deletions src/SignalR/clients/csharp/Client.Core/src/HubConnection.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -869,19 +869,14 @@ private async Task InvokeStreamCore(ConnectionState connectionState, string meth
}
}

#pragma warning disable IDE0060 // Remove unused parameter. Resolving tracked via https://github.com/dotnet/aspnetcore/issues/40475
private async Task SendHubMessage(ConnectionState connectionState, HubMessage hubMessage, CancellationToken cancellationToken = default)
#pragma warning restore IDE0060 // Remove unused parameter
{
_state.AssertConnectionValid();
_protocol.WriteMessage(hubMessage, connectionState.Connection.Transport.Output);

Log.SendingMessage(_logger, hubMessage);

#pragma warning disable CA2016 // Forward the 'CancellationToken' parameter to methods
// REVIEW: If a token is passed in and is canceled during FlushAsync it seems to break .Complete()...
await connectionState.Connection.Transport.Output.FlushAsync().ConfigureAwait(false);
#pragma warning restore CA2016 // Forward the 'CancellationToken' parameter to methods
await connectionState.Connection.Transport.Output.FlushAsync(cancellationToken).ConfigureAwait(false);
Log.MessageSent(_logger, hubMessage);

// We've sent a message, so don't ping for a while
Expand Down
24 changes: 24 additions & 0 deletions src/SignalR/clients/csharp/Client/test/UnitTests/HubConnectionTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
using System;
using System.Buffers;
using System.IO;
using System.IO.Pipelines;
using System.Net;
using System.Net.WebSockets;
using System.Threading;
Expand Down Expand Up @@ -220,6 +221,29 @@ await Assert.ThrowsAsync<TaskCanceledException>(() =>
}
}

[Fact]
public async Task SendAsyncCanceledWhenTokenCanceledDuringSend()
{
using (StartVerifiableLog())
{
// Use pause threshold to block FlushAsync when writing 100+ bytes
var connection = new TestConnection(pipeOptions: new PipeOptions(readerScheduler: PipeScheduler.Inline, writerScheduler: PipeScheduler.Inline, pauseWriterThreshold: 100, useSynchronizationContext: false));
var hubConnection = CreateHubConnection(connection, loggerFactory: LoggerFactory);

await hubConnection.StartAsync().DefaultTimeout();

var cts = new CancellationTokenSource();
// Send 100+ bytes to trigger pauseWriterThreshold
var sendTask = hubConnection.SendAsync("testMethod", new byte[100], cts.Token);

cts.Cancel();

await Assert.ThrowsAsync<OperationCanceledException>(() => sendTask.DefaultTimeout());

await hubConnection.StopAsync().DefaultTimeout();
}
}

[Fact]
public async Task StreamAsChannelAsyncCanceledWhenPassedCanceledToken()
{
Expand Down
4 changes: 2 additions & 2 deletions src/SignalR/clients/csharp/Client/test/UnitTests/TestConnection.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,14 @@ internal class TestConnection : ConnectionContext, IConnectionInherentKeepAliveF

bool IConnectionInherentKeepAliveFeature.HasInherentKeepAlive => _hasInherentKeepAlive;

public TestConnection(Func<Task> onStart = null, Func<Task> onDispose = null, bool autoHandshake = true, bool hasInherentKeepAlive = false)
public TestConnection(Func<Task> onStart = null, Func<Task> onDispose = null, bool autoHandshake = true, bool hasInherentKeepAlive = false, PipeOptions pipeOptions = null)
{
_autoHandshake = autoHandshake;
_onStart = onStart ?? (() => Task.CompletedTask);
_onDispose = onDispose ?? (() => Task.CompletedTask);
_hasInherentKeepAlive = hasInherentKeepAlive;

var options = new PipeOptions(readerScheduler: PipeScheduler.Inline, writerScheduler: PipeScheduler.Inline, useSynchronizationContext: false);
var options = pipeOptions ?? new PipeOptions(readerScheduler: PipeScheduler.Inline, writerScheduler: PipeScheduler.Inline, useSynchronizationContext: false);

var pair = DuplexPipe.CreateConnectionPair(options, options);
Application = pair.Application;
Expand Down