Skip to content
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

Jump to bottom

[browser] WS cancelation fix #99522

Merged
merged 3 commits into from
Mar 12, 2024
Merged

[browser] WS cancelation fix #99522

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bb128a6
wip
pavelsavara Mar 11, 2024
be5e2c3
Update src/libraries/System.Net.WebSockets.Client/src/System/Net/WebS…
pavelsavara Mar 12, 2024
00524c8
Merge branch 'main' into browser_ws_cancelation
pavelsavara Mar 12, 2024
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
34 changes: 22 additions & 12 deletions ...tem.Net.WebSockets.Client/src/System/Net/WebSockets/BrowserWebSockets/BrowserWebSocket.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,9 +135,10 @@ public override string? SubProtocol

internal Task ConnectAsync(Uri uri, List<string>? requestedSubProtocols, CancellationToken cancellationToken)
{
AbortIfCancelationRequested(cancellationToken);
Copy link
Member

Choose a reason for hiding this comment

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

Why moving it out of the lock?

Copy link
Member Author

Choose a reason for hiding this comment

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

It probably doesn't matter


lock (_lockObject)
{
cancellationToken.ThrowIfCancellationRequested();
ThrowIfDisposed();

if (FastState != WebSocketState.None)
Expand Down Expand Up @@ -184,7 +185,6 @@ public override Task CloseOutputAsync(WebSocketCloseStatus closeStatus, string?
// this validation should be synchronous
WebSocketValidate.ValidateCloseStatus(closeStatus, statusDescription);

cancellationToken.ThrowIfCancellationRequested();
ThrowIfDisposed();

return CloseAsyncCore(closeStatus, statusDescription, false, cancellationToken);
Expand All @@ -195,7 +195,6 @@ public override Task CloseAsync(WebSocketCloseStatus closeStatus, string? status
// this validation should be synchronous
WebSocketValidate.ValidateCloseStatus(closeStatus, statusDescription);

cancellationToken.ThrowIfCancellationRequested();
ThrowIfDisposed();

return CloseAsyncCore(closeStatus, statusDescription, true, cancellationToken);
Expand Down Expand Up @@ -284,6 +283,17 @@ private void ThrowIfDisposed()
} // lock
}

private void AbortIfCancelationRequested(CancellationToken cancellationToken)
{
if (cancellationToken.IsCancellationRequested)
{
lock (_lockObject)
{
Abort();
} // lock
cancellationToken.ThrowIfCancellationRequested();
Copy link
Member

Choose a reason for hiding this comment

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

fyi: this internally checks for 'cancellationToken.IsCancellationRequested`.

runtime/src/libraries/System.Private.CoreLib/src/System/Threading/CancellationToken.cs

Line 359 in efa2b78

public void ThrowIfCancellationRequested()

}
}

private void CreateCore(Uri uri, List<string>? requestedSubProtocols)
{
Expand Down Expand Up @@ -366,14 +376,14 @@ private async Task SendAsyncCore(ArraySegment<byte> buffer, WebSocketMessageType
{
lock (_lockObject)
{
cancellationToken.ThrowIfCancellationRequested();
ThrowIfDisposed();

previousState = FastState;
if (previousState != WebSocketState.Open && previousState != WebSocketState.CloseReceived)
{
throw new InvalidOperationException(SR.net_WebSockets_NotConnected);
}
AbortIfCancelationRequested(cancellationToken);

if (buffer.Count == 0)
{
Expand Down Expand Up @@ -416,14 +426,14 @@ private async Task<WebSocketReceiveResult> ReceiveAsyncCore(ArraySegment<byte> b
{
lock (_lockObject)
{
cancellationToken.ThrowIfCancellationRequested();
ThrowIfDisposed();

previousState = FastState;
if (previousState != WebSocketState.Open && previousState != WebSocketState.CloseSent)
{
throw new WebSocketException(WebSocketError.InvalidState, SR.Format(SR.net_WebSockets_InvalidState, previousState, "Open, CloseSent"));
}
AbortIfCancelationRequested(cancellationToken);

Memory<byte> bufferMemory = buffer.AsMemory();
pinBuffer = bufferMemory.Pin();
Expand Down Expand Up @@ -502,22 +512,22 @@ private async Task CloseAsyncCore(WebSocketCloseStatus closeStatus, string? stat
WebSocketState previousState;
lock (_lockObject)
{
cancellationToken.ThrowIfCancellationRequested();

previousState = FastState;
if (_aborted)
{
return;
}
if (previousState == WebSocketState.None || previousState == WebSocketState.Closed)
{
throw new WebSocketException(WebSocketError.InvalidState, SR.Format(SR.net_WebSockets_InvalidState, previousState, "Connecting, Open, CloseSent, CloseReceived, Aborted"));
}
AbortIfCancelationRequested(cancellationToken);

if (!_closeReceived)
{
_closeStatus = closeStatus;
_closeStatusDescription = statusDescription;
}
if (previousState == WebSocketState.None || previousState == WebSocketState.Closed)
{
throw new WebSocketException(WebSocketError.InvalidState, SR.Format(SR.net_WebSockets_InvalidState, previousState, "Connecting, Open, CloseSent, Aborted"));
}

_closeSent = true;

Expand All @@ -544,7 +554,6 @@ private async Task CancellationHelper(Task promise, CancellationToken cancellati
{
try
{
cancellationToken.ThrowIfCancellationRequested();
if (promise.IsCompletedSuccessfully)
{
disposable?.Dispose();
Expand All @@ -556,6 +565,7 @@ private async Task CancellationHelper(Task promise, CancellationToken cancellati
await promise.ConfigureAwait(false);
return;
}
AbortIfCancelationRequested(cancellationToken);

using (var receiveRegistration = cancellationToken.Register(static s =>
{
Expand Down