Skip to content

fix(webSocketRoute): handle close events without code/reason #3345

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
Dmitry Gozman (dgozman) merged 1 commit into from
Aug 12, 2026
Merged

fix(webSocketRoute): handle close events without code/reason #3345

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
45 changes: 45 additions & 0 deletions src/Playwright.Tests/PageRouteWebSocketTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,51 @@ await AssertAreEqualWithRetriesAsync(() => Page.EvaluateAsync<string[]>("() => w
]);
}

[PlaywrightTest("route-web-socket.spec.ts", "should emit close upon frame navigation")]
public async Task ShouldEmitCloseUponFrameNavigation()
{
var tcs = new TaskCompletionSource<IWebSocketRoute>();
await Page.RouteWebSocketAsync(new Regex(".*"), ws =>
{
ws.ConnectToServer();
tcs.SetResult(ws);
});

await SetupWS(Page, Server.Port, "blob");

var route = await tcs.Task;
route.Send("hello");

await AssertAreEqualWithRetriesAsync(() => Page.EvaluateAsync<string[]>("() => window.log"), new[]
{
"open",
$"message: data=hello origin=ws://localhost:{Server.Port} lastEventId=",
});

var closedTcs = new TaskCompletionSource();
route.OnClose((code, reason) => closedTcs.TrySetResult());
await Page.GotoAsync(Server.EmptyPage);
await closedTcs.Task;
}

[PlaywrightTest("route-web-socket.spec.ts", "should not throw after page closure")]
public async Task ShouldNotThrowAfterPageClosure()
{
var tcs = new TaskCompletionSource<IWebSocketRoute>();
await Page.RouteWebSocketAsync(new Regex(".*"), ws =>
{
ws.ConnectToServer();
tcs.SetResult(ws);
});

await SetupWS(Page, Server.Port, "blob");

var route = await tcs.Task;
var closeTask = Page.CloseAsync();
route.Send("hello");
await closeTask;
}

[PlaywrightTest("page-route-web-socket.spec.ts", "should work with baseURL")]
public async Task ShouldWorkWithBaseURL()
{
Expand Down
52 changes: 30 additions & 22 deletions src/Playwright/Core/WebSocketRoute.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,35 +90,43 @@ internal override void OnMessage(string method, JsonElement serverParams)
}
break;
case "closePage":
if (_onPageClose != null)
{
_onPageClose(serverParams.GetProperty("code").GetInt32(), serverParams.GetProperty("reason").GetString());
}
else
{
SendMessageToServerAsync("closeServer", new Dictionary<string, object?>
int? code = serverParams.TryGetProperty("code", out var codeElement) && codeElement.ValueKind == JsonValueKind.Number ? codeElement.GetInt32() : null;
string? reason = serverParams.TryGetProperty("reason", out var reasonElement) && reasonElement.ValueKind == JsonValueKind.String ? reasonElement.GetString() : null;
if (_onPageClose != null)
{
["code"] = serverParams.GetProperty("code").GetInt32(),
["reason"] = serverParams.GetProperty("reason").GetString(),
["wasClean"] = serverParams.GetProperty("wasClean").GetBoolean(),
}).IgnoreException();
_onPageClose(code, reason);
}
else
{
SendMessageToServerAsync("closeServer", new Dictionary<string, object?>
{
["code"] = code,
["reason"] = reason,
["wasClean"] = serverParams.GetProperty("wasClean").GetBoolean(),
}).IgnoreException();
}
break;
}
break;
case "closeServer":
if (_onServerClose != null)
{
_onServerClose(serverParams.GetProperty("code").GetInt32(), serverParams.GetProperty("reason").GetString());
}
else
{
SendMessageToServerAsync("closePage", new Dictionary<string, object?>
int? code = serverParams.TryGetProperty("code", out var codeElement) && codeElement.ValueKind == JsonValueKind.Number ? codeElement.GetInt32() : null;
string? reason = serverParams.TryGetProperty("reason", out var reasonElement) && reasonElement.ValueKind == JsonValueKind.String ? reasonElement.GetString() : null;
if (_onServerClose != null)
{
["code"] = serverParams.GetProperty("code").GetInt32(),
["reason"] = serverParams.GetProperty("reason").GetString(),
["wasClean"] = serverParams.GetProperty("wasClean").GetBoolean(),
}).IgnoreException();
_onServerClose(code, reason);
}
else
{
SendMessageToServerAsync("closePage", new Dictionary<string, object?>
{
["code"] = code,
["reason"] = reason,
["wasClean"] = serverParams.GetProperty("wasClean").GetBoolean(),
}).IgnoreException();
}
break;
}
break;
}
}

Expand Down
Loading