Skip to content

Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.

fix(routeWebSocket): route WebSockets in already loaded documents (#43130)

Pavel Feldman6b1c4254626a
diff --git a/packages/playwright-core/src/server/dispatchers/webSocketRouteDispatcher.ts b/packages/playwright-core/src/server/dispatchers/webSocketRouteDispatcher.ts
index 6400947ac0..c02f825f3c 100644
--- a/packages/playwright-core/src/server/dispatchers/webSocketRouteDispatcher.ts
+++ b/packages/playwright-core/src/server/dispatchers/webSocketRouteDispatcher.ts
@@ -97,13 +97,16 @@ export class WebSocketRouteDispatcher extends Dispatcher<SdkObject, channels.Web
}
++data.counter;
- return await target.addInitScript(progress, `
+ const initScript = await target.addInitScript(progress, `
(() => {
const module = {};
${rawWebSocketMockSource.source}
(module.exports.inject())(globalThis);
})();
`);
+ // Also inject into already loaded documents, so that WebSockets created there are routed.
+ await progress.race(target.safeNonStallingEvaluateInAllFrames(initScript.source, 'main'));
+ return initScript;
}
static async uninstall(connection: DispatcherConnection, target: Page | BrowserContext, initScript: InitScript) {
diff --git a/tests/library/route-web-socket.spec.ts b/tests/library/route-web-socket.spec.ts
index 21b1b7efc1..f43a31e798 100644
--- a/tests/library/route-web-socket.spec.ts
+++ b/tests/library/route-web-socket.spec.ts
@@ -475,6 +475,27 @@ test('should work without server', async ({ page, server }) => {
]);
});
+test('should route WebSockets in already loaded documents', {
+ annotation: { type: 'issue', description: 'https://github.com/microsoft/playwright/issues/43105' },
+}, async ({ page, server }) => {
+ await page.goto(server.EMPTY_PAGE);
+ const frame = await attachFrame(page, 'frame1', server.EMPTY_PAGE);
+ await page.routeWebSocket(/.*/, ws => {
+ ws.onMessage(message => ws.send('mock-' + message));
+ });
+
+ for (const target of [page.mainFrame(), frame]) {
+ await target.evaluate(({ host }) => {
+ window.log = [];
+ window.ws = new WebSocket('ws://' + host + '/ws');
+ window.ws.addEventListener('message', event => window.log.push(event.data));
+ window.ws.addEventListener('close', () => window.log.push('close'));
+ window.ws.addEventListener('open', () => window.ws.send('hi'));
+ }, { host: server.HOST });
+ await expect.poll(() => target.evaluate(() => window.log)).toEqual(['mock-hi']);
+ }
+});
+
test('should emit close upon frame navigation', async ({ page, server }) => {
const { promise, resolve } = withResolvers<WebSocketRoute>();
await page.routeWebSocket(/.*/, async ws => {