Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.
TypeScript automationchromechromiume2e-testingelectronend-to-end-testingfirefoxjavascriptplaywrighttesttest-automationtestingtesting-toolswebwebkit
fix(expect): report target close reason instead of internal protocol error (#42861)
Pavel Feldman091e4b9376e0
diff --git a/packages/playwright-core/src/server/dispatchers/dispatcher.ts b/packages/playwright-core/src/server/dispatchers/dispatcher.tsindex bb2e18e418..879cd2e176 100644--- a/packages/playwright-core/src/server/dispatchers/dispatcher.ts+++ b/packages/playwright-core/src/server/dispatchers/dispatcher.ts@@ -21,11 +21,9 @@ import { eventsHelper } from '@utils/eventsHelper';import { isUnderTest } from '@utils/debug';import { assert } from '@isomorphic/assert';import { monotonicTime } from '@isomorphic/time';-import { rewriteErrorMessage } from '@utils/stackTrace';import { ValidationError, createMetadataValidator, createWaitInfoValidator, findValidator, maybeFindValidator } from '@protocol/validator';-import { AbortError, TargetClosedError, isTargetClosedError, serializeError } from '../errors';+import { AbortError, TargetClosedError, rewriteErrorForClosedTarget, serializeError } from '../errors';import { createRootSdkObject, SdkObject } from '../instrumentation';-import { isProtocolError } from '../protocolError';import { compressCallLog } from '../callLog';import { Progress, ProgressController } from '../progress';@@ -379,16 +377,7 @@ export class DispatcherConnection {response.result = validator(result, '', this._validatorToWireContext());callMetadata.result = result;} catch (e) {- if (isTargetClosedError(e)) {- const reason = sdkObject.closeReason();- if (reason)- rewriteErrorMessage(e, reason);- } else if (isProtocolError(e)) {- if (e.type === 'closed')- e = new TargetClosedError(sdkObject.closeReason(), e.browserLogMessage());- else if (e.type === 'crashed')- rewriteErrorMessage(e, 'Target crashed ' + e.browserLogMessage());- }+ e = rewriteErrorForClosedTarget(e, sdkObject.closeReason());response.error = serializeError(e);const detailsValidator = maybeFindValidator(dispatcher._type, method, 'ErrorDetails');if (detailsValidator)diff --git a/packages/playwright-core/src/server/errors.ts b/packages/playwright-core/src/server/errors.tsindex d749aba7cd..d250a5cfac 100644--- a/packages/playwright-core/src/server/errors.ts+++ b/packages/playwright-core/src/server/errors.ts@@ -16,6 +16,9 @@import { isError } from '@isomorphic/rtti';import { parseSerializedValue, parseSystemErrorFields, serializeSystemErrorFields, serializeValue, systemErrorMessage } from '@protocol/serializers';+import { rewriteErrorMessage } from '@utils/stackTrace';++import { isProtocolError } from './protocolError';import type { SerializedError } from './channels';@@ -48,6 +51,19 @@ export function isTargetClosedError(error: Error) {return error instanceof TargetClosedError || error.name === 'TargetClosedError';}+export function rewriteErrorForClosedTarget(error: Error, closeReason: string | undefined): Error {+ if (isTargetClosedError(error)) {+ if (closeReason)+ rewriteErrorMessage(error, closeReason);+ } else if (isProtocolError(error)) {+ if (error.type === 'closed')+ return new TargetClosedError(closeReason, error.browserLogMessage());+ if (error.type === 'crashed')+ rewriteErrorMessage(error, 'Target crashed ' + error.browserLogMessage());+ }+ return error;+}+export function serializeError(e: any): SerializedError {if (isError(e))return { error: { message: systemErrorMessage(e), stack: e.stack, name: e.name, ...serializeSystemErrorFields(e) } };diff --git a/packages/playwright-core/src/server/frames.ts b/packages/playwright-core/src/server/frames.tsindex c68329b610..823515a0f4 100644--- a/packages/playwright-core/src/server/frames.ts+++ b/packages/playwright-core/src/server/frames.ts@@ -28,7 +28,7 @@ import { constructURLBasedOnBaseURL } from '@isomorphic/urlMatch';import { createGuid } from '@utils/crypto';import { BrowserContext } from './browserContext';import * as dom from './dom';-import { EvaluationStalledError, TimeoutError, isTargetClosedError } from './errors';+import { EvaluationStalledError, TimeoutError, isTargetClosedError, rewriteErrorForClosedTarget } from './errors';import { prepareFilesForUpload } from './fileUploadUtils';import { FrameSelectors } from './frameSelectors';import { helper } from './helper';@@ -1509,6 +1509,9 @@ export class Frame extends SdkObject<FrameEventMap> {return { matches, received };});} catch (e) {+ const closedError = isTargetClosedError(e) || isSessionClosedError(e) ? rewriteErrorForClosedTarget(e, this.closeReason()) : undefined;+ if (closedError)+ progress.log(closedError.message);const details: ExpectErrorDetails = {};if (isInvalidSelectorError(e) || dom.isNonRecoverableDOMError(e)) {details.customErrorMessage = e.message;@@ -1517,9 +1520,9 @@ export class Frame extends SdkObject<FrameEventMap> {} else if (lastIntermediateResult.isSet) {details.received = lastIntermediateResult.received;details.customErrorMessage = lastIntermediateResult.errorMessage;+ } else if (closedError) {+ details.customErrorMessage = closedError.message;}- if (isTargetClosedError(e) || isSessionClosedError(e))- progress.log(e.message);if (e instanceof TimeoutError)details.timedOut = true;throw new ExpectError(details);diff --git a/tests/page/expect-misc.spec.ts b/tests/page/expect-misc.spec.tsindex 76d66d5287..d0b12b8c8d 100644--- a/tests/page/expect-misc.spec.ts+++ b/tests/page/expect-misc.spec.ts@@ -675,3 +675,13 @@ test('should report expect error details when page closes during expect', asyncexpect(stripAnsi(error.message)).toContain('Expected: "world"');expect(stripAnsi(error.message)).toContain('Received: "hello"');});++test('should report page close reason when page closes during expect', async ({ page }) => {+ await page.setContent(`<div>hello</div>`);+ const promise = expect(page.locator('non-existent')).toHaveText('world', { timeout: 10000 }).catch((e: Error) => e);+ await page.close({ reason: 'Bye bye.' });+ const error = await promise as Error;+ expect(stripAnsi(error.message)).toContain('expect(locator).toHaveText(expected) failed');+ expect(stripAnsi(error.message)).toContain('Bye bye.');+ expect(stripAnsi(error.message)).not.toContain('Internal server error');+});