Skip to content

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

chore: always plumb close reason through TargetClosedError (#38512)

Dmitry Gozman2ba58c9d51f5
diff --git a/packages/playwright-core/src/server/artifact.ts b/packages/playwright-core/src/server/artifact.ts
index c6f2b4bc9c..070d3bdedb 100644
--- a/packages/playwright-core/src/server/artifact.ts
+++ b/packages/playwright-core/src/server/artifact.ts
@@ -104,7 +104,7 @@ export class Artifact extends SdkObject {
this._deleted = true;
if (!this._unaccessibleErrorMessage)
await fs.promises.unlink(this._localPath).catch(e => {});
- await this.reportFinished(new TargetClosedError());
+ await this.reportFinished(new TargetClosedError(this.closeReason()));
}
async reportFinished(error?: Error) {
diff --git a/packages/playwright-core/src/server/chromium/crPage.ts b/packages/playwright-core/src/server/chromium/crPage.ts
index 08b98e9793..e11d040979 100644
--- a/packages/playwright-core/src/server/chromium/crPage.ts
+++ b/packages/playwright-core/src/server/chromium/crPage.ts
@@ -537,7 +537,7 @@ class FrameSession {
}
dispose() {
- this._firstNonInitialNavigationCommittedReject(new TargetClosedError());
+ this._firstNonInitialNavigationCommittedReject(new TargetClosedError(this._page.closeReason()));
for (const childSession of this._childSessions)
childSession.dispose();
if (this._parentSession)
diff --git a/packages/playwright-core/src/server/dispatchers/dispatcher.ts b/packages/playwright-core/src/server/dispatchers/dispatcher.ts
index 8f725a5b89..8fda388cae 100644
--- a/packages/playwright-core/src/server/dispatchers/dispatcher.ts
+++ b/packages/playwright-core/src/server/dispatchers/dispatcher.ts
@@ -125,7 +125,7 @@ export class Dispatcher<Type extends SdkObject, ChannelType, ParentScopeType ext
}
_dispose(reason?: 'gc') {
- this._disposeRecursively(new TargetClosedError());
+ this._disposeRecursively(new TargetClosedError(this._object.closeReason()));
this.connection.sendDispose(this, reason);
}
@@ -304,7 +304,7 @@ export class DispatcherConnection {
const { id, guid, method, params, metadata } = message as any;
const dispatcher = this._dispatcherByGuid.get(guid);
if (!dispatcher) {
- this.onmessage({ id, error: serializeError(new TargetClosedError()) });
+ this.onmessage({ id, error: serializeError(new TargetClosedError(undefined)) });
return;
}
@@ -379,19 +379,19 @@ export class DispatcherConnection {
try {
// If the dispatcher has been disposed while running the instrumentation call, error out.
if (this._dispatcherByGuid.get(guid) !== dispatcher)
- throw new TargetClosedError(closeReason(sdkObject));
+ throw new TargetClosedError(sdkObject.closeReason());
const result = await dispatcher._runCommand(callMetadata, method, validParams);
const validator = findValidator(dispatcher._type, method, 'Result');
response.result = validator(result, '', this._validatorToWireContext());
callMetadata.result = result;
} catch (e) {
if (isTargetClosedError(e)) {
- const reason = closeReason(sdkObject);
+ const reason = sdkObject.closeReason();
if (reason)
rewriteErrorMessage(e, reason);
} else if (isProtocolError(e)) {
if (e.type === 'closed')
- e = new TargetClosedError(closeReason(sdkObject), e.browserLogMessage());
+ e = new TargetClosedError(sdkObject.closeReason(), e.browserLogMessage());
else if (e.type === 'crashed')
rewriteErrorMessage(e, 'Target crashed ' + e.browserLogMessage());
}
@@ -416,9 +416,3 @@ export class DispatcherConnection {
await new Promise(f => setTimeout(f, slowMo));
}
}
-
-function closeReason(sdkObject: SdkObject): string | undefined {
- return sdkObject.attribution.page?.closeReason ||
- sdkObject.attribution.context?._closeReason ||
- sdkObject.attribution.browser?._closeReason;
-}
diff --git a/packages/playwright-core/src/server/errors.ts b/packages/playwright-core/src/server/errors.ts
index 88fe8b4403..fa4dc2ab16 100644
--- a/packages/playwright-core/src/server/errors.ts
+++ b/packages/playwright-core/src/server/errors.ts
@@ -29,7 +29,7 @@ class CustomError extends Error {
export class TimeoutError extends CustomError {}
export class TargetClosedError extends CustomError {
- constructor(cause?: string, logs?: string) {
+ constructor(cause: string | undefined, logs?: string) {
super((cause || 'Target page, context or browser has been closed') + (logs || ''));
}
}
diff --git a/packages/playwright-core/src/server/firefox/ffBrowser.ts b/packages/playwright-core/src/server/firefox/ffBrowser.ts
index b9ae8f2d36..1738295ce8 100644
--- a/packages/playwright-core/src/server/firefox/ffBrowser.ts
+++ b/packages/playwright-core/src/server/firefox/ffBrowser.ts
@@ -163,7 +163,7 @@ export class FFBrowser extends Browser {
_onDisconnect() {
for (const video of this._idToVideo.values())
- video.artifact.reportFinished(new TargetClosedError());
+ video.artifact.reportFinished(new TargetClosedError(this.closeReason()));
this._idToVideo.clear();
for (const ffPage of this._ffPages.values())
ffPage.didClose();
diff --git a/packages/playwright-core/src/server/firefox/ffPage.ts b/packages/playwright-core/src/server/firefox/ffPage.ts
index a1a2e52ab2..e4bd6a407f 100644
--- a/packages/playwright-core/src/server/firefox/ffPage.ts
+++ b/packages/playwright-core/src/server/firefox/ffPage.ts
@@ -316,7 +316,7 @@ export class FFPage implements PageDelegate {
}
didClose() {
- this._markAsError(new TargetClosedError());
+ this._markAsError(new TargetClosedError(this._page.closeReason()));
this._session.dispose();
eventsHelper.removeEventListeners(this._eventListeners);
this._networkManager.dispose();
diff --git a/packages/playwright-core/src/server/instrumentation.ts b/packages/playwright-core/src/server/instrumentation.ts
index a4e6c39a31..7633a5f52d 100644
--- a/packages/playwright-core/src/server/instrumentation.ts
+++ b/packages/playwright-core/src/server/instrumentation.ts
@@ -53,6 +53,12 @@ export class SdkObject extends EventEmitter {
this.attribution = { ...parent.attribution };
this.instrumentation = parent.instrumentation;
}
+
+ closeReason(): string | undefined {
+ return this.attribution.page?._closeReason ||
+ this.attribution.context?._closeReason ||
+ this.attribution.browser?._closeReason;
+ }
}
export function createRootSdkObject() {
diff --git a/packages/playwright-core/src/server/page.ts b/packages/playwright-core/src/server/page.ts
index d89b9a6ebe..8be5845b74 100644
--- a/packages/playwright-core/src/server/page.ts
+++ b/packages/playwright-core/src/server/page.ts
@@ -168,7 +168,7 @@ export class Page extends SdkObject {
private _networkRequests: network.Request[] = [];
readonly screencast: Screencast;
- closeReason: string | undefined;
+ _closeReason: string | undefined;
constructor(delegate: PageDelegate, browserContext: BrowserContext) {
super(browserContext, 'page');
@@ -263,7 +263,7 @@ export class Page extends SdkObject {
this.emit(Page.Events.Close);
this._closedPromise.resolve();
this.instrumentation.onPageClose(this);
- this.openScope.close(new TargetClosedError());
+ this.openScope.close(new TargetClosedError(this.closeReason()));
}
_didCrash() {
@@ -750,7 +750,7 @@ export class Page extends SdkObject {
if (this._closedState === 'closed')
return;
if (options.reason)
- this.closeReason = options.reason;
+ this._closeReason = options.reason;
const runBeforeUnload = !!options.runBeforeUnload;
if (this._closedState !== 'closing') {
// If runBeforeUnload is true, we don't know if we will close, so don't modify the state
diff --git a/packages/playwright-core/src/server/webkit/wkBrowser.ts b/packages/playwright-core/src/server/webkit/wkBrowser.ts
index c77c40abd9..33969eab33 100644
--- a/packages/playwright-core/src/server/webkit/wkBrowser.ts
+++ b/packages/playwright-core/src/server/webkit/wkBrowser.ts
@@ -78,7 +78,7 @@ export class WKBrowser extends Browser {
wkPage.didClose();
this._wkPages.clear();
for (const video of this._idToVideo.values())
- video.artifact.reportFinished(new TargetClosedError());
+ video.artifact.reportFinished(new TargetClosedError(this.closeReason()));
this._idToVideo.clear();
this._didClose();
}
diff --git a/packages/playwright-core/src/server/webkit/wkPage.ts b/packages/playwright-core/src/server/webkit/wkPage.ts
index ea8b6a5a6f..75b8faf693 100644
--- a/packages/playwright-core/src/server/webkit/wkPage.ts
+++ b/packages/playwright-core/src/server/webkit/wkPage.ts
@@ -259,7 +259,7 @@ export class WKPage implements PageDelegate {
this._provisionalPage.dispose();
this._provisionalPage = null;
}
- this._firstNonInitialNavigationCommittedReject(new TargetClosedError());
+ this._firstNonInitialNavigationCommittedReject(new TargetClosedError(this._page.closeReason()));
this._page._didClose();
}
@@ -494,7 +494,7 @@ export class WKPage implements PageDelegate {
async navigateFrame(frame: frames.Frame, url: string, referrer: string | undefined): Promise<frames.GotoResult> {
if (this._pageProxySession.isDisposed())
- throw new TargetClosedError();
+ throw new TargetClosedError(this._page.closeReason());
const pageProxyId = this._pageProxySession.sessionId;
const result = await this._pageProxySession.connection.browserSession.send('Playwright.navigate', { url, pageProxyId, frameId: frame._id, referrer });
return { newDocumentId: result.loaderId };
diff --git a/tests/library/page-close.spec.ts b/tests/library/page-close.spec.ts
index 92d9dda2ea..46832decb3 100644
--- a/tests/library/page-close.spec.ts
+++ b/tests/library/page-close.spec.ts
@@ -51,7 +51,7 @@ test('addLocatorHandler should throw when page closes', async ({ page, server })
await page.goto(server.PREFIX + '/input/handle-locator.html');
await page.addLocatorHandler(page.getByText('This interstitial covers the button'), async () => {
- await page.close();
+ await page.close({ reason: 'custom reason' });
});
await page.locator('#aside').hover();
@@ -60,7 +60,7 @@ test('addLocatorHandler should throw when page closes', async ({ page, server })
(window as any).setupAnnoyingInterstitial('mouseover', 1);
});
const error = await page.locator('#target').click().catch(e => e);
- expect(error.message).toContain(kTargetClosedErrorMessage);
+ expect(error.message).toContain('custom reason');
});
test('should reject all promises when page is closed', async ({ page }) => {