Skip to content

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

fix(networkidle): do not wait for open EventSource (SSE) connections (#41514)

Max Schmittc370acfe5ab1
diff --git a/packages/playwright-core/src/server/frames.ts b/packages/playwright-core/src/server/frames.ts
index ca307ec5d8..924b3f3e2d 100644
--- a/packages/playwright-core/src/server/frames.ts
+++ b/packages/playwright-core/src/server/frames.ts
@@ -384,7 +384,7 @@ export class FrameManager {
private _inflightRequestFinished(request: network.Request) {
const frame = request.frame();
- if (request._isFavicon || !frame)
+ if (this._isExcludedFromNetworkIdle(request) || !frame)
return;
if (!frame._inflightRequests.has(request))
return;
@@ -395,13 +395,21 @@ export class FrameManager {
private _inflightRequestStarted(request: network.Request) {
const frame = request.frame();
- if (request._isFavicon || !frame)
+ if (this._isExcludedFromNetworkIdle(request) || !frame)
return;
frame._inflightRequests.add(request);
if (frame._inflightRequests.size === 1)
frame._stopNetworkIdleTimer();
}
+ private _isExcludedFromNetworkIdle(request: network.Request): boolean {
+ if (request._isFavicon)
+ return true;
+ if (request.resourceType() === 'eventsource')
+ return true;
+ return false;
+ }
+
interceptConsoleMessage(message: ConsoleMessage): boolean {
if (message.type() !== 'debug')
return false;
diff --git a/tests/page/page-network-idle.spec.ts b/tests/page/page-network-idle.spec.ts
index dda4f96c3a..d0a818dc49 100644
--- a/tests/page/page-network-idle.spec.ts
+++ b/tests/page/page-network-idle.spec.ts
@@ -207,3 +207,45 @@ it('should work after repeated navigations in the same page', async ({ page, ser
await page.goto(server.EMPTY_PAGE, { waitUntil: 'networkidle' });
expect(requestCount).toBe(2);
});
+
+it('should not wait for an open EventSource connection', async ({ page, server }) => {
+ it.info().annotations.push({ type: 'issue', description: 'https://github.com/microsoft/playwright/issues/37226' });
+
+ server.setRoute('/sse', (req, res) => {
+ res.writeHead(200, {
+ 'Content-Type': 'text/event-stream',
+ 'Connection': 'keep-alive',
+ 'Cache-Control': 'no-cache',
+ });
+ res.write('data: hello\n\n');
+ });
+ server.setRoute('/sse-page.html', (req, res) => {
+ res.writeHead(200, { 'Content-Type': 'text/html' });
+ res.end(`<script>new EventSource('/sse');</script>`);
+ });
+
+ const response = await page.goto(server.PREFIX + '/sse-page.html', { waitUntil: 'networkidle' });
+ expect(response.status()).toBe(200);
+});
+
+it('should not wait for an open EventSource connection in setContent', async ({ page, server }) => {
+ it.info().annotations.push({ type: 'issue', description: 'https://github.com/microsoft/playwright/issues/37226' });
+
+ server.setRoute('/sse', (req, res) => {
+ res.writeHead(200, {
+ 'Content-Type': 'text/event-stream',
+ 'Connection': 'keep-alive',
+ 'Cache-Control': 'no-cache',
+ });
+ res.write('data: hello\n\n');
+ });
+
+ await page.goto(server.EMPTY_PAGE);
+ await page.setContent(`<script>
+ window.__sseOpened = new Promise(resolve => {
+ const es = new EventSource('/sse');
+ es.onmessage = () => resolve();
+ });
+ </script>`, { waitUntil: 'networkidle' });
+ await page.evaluate(() => window['__sseOpened']);
+});