Skip to content

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

fix(chromium): dispose child session upon Target.detachedFromTarget (#43017)

Dmitry Gozman7c283fddba6e
diff --git a/packages/playwright-core/src/server/chromium/crBrowser.ts b/packages/playwright-core/src/server/chromium/crBrowser.ts
index b234d7396e..5cf1363bf5 100644
--- a/packages/playwright-core/src/server/chromium/crBrowser.ts
+++ b/packages/playwright-core/src/server/chromium/crBrowser.ts
@@ -230,6 +230,7 @@ export class CRBrowser extends Browser {
serviceWorker.didClose();
return;
}
+ this._session.disposeChildSession(payload.sessionId);
}
private _didDisconnect() {
diff --git a/packages/playwright-core/src/server/chromium/crConnection.ts b/packages/playwright-core/src/server/chromium/crConnection.ts
index ebf4e0e5a5..bdf9ab80d5 100644
--- a/packages/playwright-core/src/server/chromium/crConnection.ts
+++ b/packages/playwright-core/src/server/chromium/crConnection.ts
@@ -135,6 +135,13 @@ export class CRSession extends SdkObject<Protocol.EventMap & ConnectionEventMap>
return session;
}
+ disposeChildSession(sessionId: string) {
+ const session = this._connection._sessions.get(sessionId);
+ if (session && session._parentSession !== this)
+ debugLogger.log('error', `Session ${sessionId} should be a child of ${this._sessionId}, but it has ${session._parentSession?._sessionId} as a parent`);
+ session?.dispose();
+ }
+
async send<T extends keyof Protocol.CommandParameters>(
method: T,
params?: Protocol.CommandParameters[T]
diff --git a/packages/playwright-core/src/server/chromium/crPage.ts b/packages/playwright-core/src/server/chromium/crPage.ts
index 27f5be2864..3ba35b2104 100644
--- a/packages/playwright-core/src/server/chromium/crPage.ts
+++ b/packages/playwright-core/src/server/chromium/crPage.ts
@@ -497,8 +497,8 @@ class FrameSession {
private _addBrowserListeners() {
this._eventListeners.push(...[
- eventsHelper.addEventListener(this._client, 'Target.attachedToTarget', event => this._onAttachedToTarget(event)),
- eventsHelper.addEventListener(this._client, 'Target.detachedFromTarget', event => this._onDetachedFromTarget(event)),
+ eventsHelper.addEventListener(this._client, 'Target.attachedToTarget', event => this._onAttachedToTarget(this._client, event)),
+ eventsHelper.addEventListener(this._client, 'Target.detachedFromTarget', event => this._onDetachedFromTarget(this._client, event)),
eventsHelper.addEventListener(this._client, 'Inspector.targetCrashed', event => this._onTargetCrashed()),
eventsHelper.addEventListener(this._client, 'Page.screencastFrame', event => this._onScreencastFrame(event)),
eventsHelper.addEventListener(this._client, 'Page.windowOpen', event => this._onWindowOpen(event)),
@@ -557,7 +557,7 @@ class FrameSession {
const attachedToTargetEvents = this._bufferedAttachedToTargetEvents || [];
this._bufferedAttachedToTargetEvents = undefined;
for (const event of attachedToTargetEvents)
- this._onAttachedToTarget(event);
+ this._onAttachedToTarget(this._client, event);
const localFrames = this._isMainFrame() ? this._page.frames() : [this._page.frameManager.frame(this._targetId)!];
for (const frame of localFrames) {
@@ -795,13 +795,13 @@ class FrameSession {
this._onExecutionContextDestroyed(contextId);
}
- _onAttachedToTarget(event: Protocol.Target.attachedToTargetPayload) {
+ _onAttachedToTarget(parentSession: CRSession, event: Protocol.Target.attachedToTargetPayload) {
if (this._bufferedAttachedToTargetEvents) {
this._bufferedAttachedToTargetEvents.push(event);
return;
}
- const session = this._client.createChildSession(event.sessionId);
+ const session = parentSession.createChildSession(event.sessionId);
if (event.targetInfo.type === 'iframe') {
// Frame id equals target id.
@@ -846,8 +846,8 @@ class FrameSession {
this._crPage._networkManager.addSession(session, this._page.frameManager.frame(event.targetInfo.parentFrameId ?? this._targetId) ?? undefined).catch(() => {});
session._sendMayFail('Runtime.runIfWaitingForDebugger');
session._sendMayFail('Target.setAutoAttach', { autoAttach: true, waitForDebuggerOnStart: true, flatten: true });
- session.on('Target.attachedToTarget', event => this._onAttachedToTarget(event));
- session.on('Target.detachedFromTarget', event => this._onDetachedFromTarget(event));
+ session.on('Target.attachedToTarget', event => this._onAttachedToTarget(session, event));
+ session.on('Target.detachedFromTarget', event => this._onDetachedFromTarget(session, event));
session.on('Runtime.consoleAPICalled', event => {
const args = event.args.map(o => createHandle(worker.existingExecutionContext!, o));
this._page.addConsoleMessage(worker, event.type, args, stackTraceToLocation(event.stackTrace), undefined, event.timestamp);
@@ -866,15 +866,18 @@ class FrameSession {
return true;
}
- _onDetachedFromTarget(event: Protocol.Target.detachedFromTargetPayload) {
+ _onDetachedFromTarget(parentSession: CRSession, event: Protocol.Target.detachedFromTargetPayload) {
// This might be a worker...
if (this._removeWorkerSession(event.sessionId))
return;
// ... or an oopif.
const childFrameSession = this._crPage._sessions.get(event.targetId!);
- if (!childFrameSession)
+ if (!childFrameSession) {
+ // Something else - perhaps a stalled service worker? Just dispose of it to reject all the callbacks.
+ parentSession.disposeChildSession(event.sessionId);
return;
+ }
// Usually, we get frameAttached in this session first and mark child as swappedIn.
if (childFrameSession._swappedIn) {
diff --git a/tests/library/chromium/chromium.spec.ts b/tests/library/chromium/chromium.spec.ts
index 3eccc7fc29..123b42eca5 100644
--- a/tests/library/chromium/chromium.spec.ts
+++ b/tests/library/chromium/chromium.spec.ts
@@ -16,7 +16,7 @@
*/
import { contextTest as test, expect } from '../../config/browserTest';
-import { playwrightTest } from '../../config/browserTest';
+import { browserTest, playwrightTest } from '../../config/browserTest';
import type { Page } from 'playwright-core';
@@ -811,3 +811,17 @@ test('should fire dialogclosed event when dialog is closed out of band', async (
expect(await closedPromise).toBe(dialog);
await evaluatePromise;
});
+
+browserTest('should not leak service worker session after context close', async ({ browser, server, toImpl }) => {
+ browserTest.info().annotations.push({ type: 'issue', description: 'https://github.com/microsoft/playwright/issues/43009' });
+ const sessions: Map<string, unknown> = toImpl(browser)._connection._sessions;
+ const sessionCount = sessions.size;
+ const context = await browser.newContext();
+ const page = await context.newPage();
+ await Promise.all([
+ context.waitForEvent('serviceworker'),
+ page.goto(server.PREFIX + '/serviceworkers/empty/sw.html'),
+ ]);
+ await context.close();
+ await expect.poll(() => sessions.size).toBe(sessionCount);
+});