kyfx
/
playwright
mirror of https://github.com/microsoft/playwright.git
4
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

chore: always use TestInfoErrorImpl (impl) in @playwright/test (#33255)

This commit is contained in:
Pavel Feldman 2024-10-23 17:36:05 -07:00 committed by GitHub
parent 9a0a6cec10
commit 6ae6b4865c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
9 changed files with 54 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
packages/playwright/src/common/ipc.ts
View File

@ -15,9 +15,11 @@
*/ */
import util from 'util'; import util from 'util';
import { type SerializedCompilationCache, serializeCompilationCache } from '../transform/compilationCache'; import { serializeCompilationCache } from '../transform/compilationCache';
import type { SerializedCompilationCache } from '../transform/compilationCache';
import type { ConfigLocation, FullConfigInternal } from './config'; import type { ConfigLocation, FullConfigInternal } from './config';
import type { ReporterDescription, TestInfoError, TestStatus } from '../../types/test'; import type { ReporterDescription, TestInfoError, TestStatus } from '../../types/test';
import type { MatcherResultProperty } from '../matchers/matcherHint';
export type ConfigCLIOverrides = { export type ConfigCLIOverrides = {
debug?: boolean; debug?: boolean;
@ -74,11 +76,15 @@ export type AttachmentPayload = {
contentType: string; contentType: string;
}; };
export type TestInfoErrorImpl = TestInfoError & {
matcherResult?: MatcherResultProperty;
};
export type TestEndPayload = { export type TestEndPayload = {
testId: string; testId: string;
duration: number; duration: number;
status: TestStatus; status: TestStatus;
errors: TestInfoError[]; errors: TestInfoErrorImpl[];
hasNonRetriableError: boolean; hasNonRetriableError: boolean;
expectedStatus: TestStatus; expectedStatus: TestStatus;
annotations: { type: string, description?: string }[]; annotations: { type: string, description?: string }[];
@ -99,7 +105,7 @@ export type StepEndPayload = {
testId: string; testId: string;
stepId: string; stepId: string;
wallTime: number; // milliseconds since unix epoch wallTime: number; // milliseconds since unix epoch
error?: TestInfoError; error?: TestInfoErrorImpl;
}; };
export type TestEntry = { export type TestEntry = {
@ -113,7 +119,7 @@ export type RunPayload = {
}; };
export type DonePayload = { export type DonePayload = {
fatalErrors: TestInfoError[]; fatalErrors: TestInfoErrorImpl[];
skipTestsDueToSetupFailure: string[]; // test ids skipTestsDueToSetupFailure: string[]; // test ids
fatalUnknownTestIds?: string[]; fatalUnknownTestIds?: string[];
}; };
@ -124,7 +130,7 @@ export type TestOutputPayload = {
}; };
export type TeardownErrorsPayload = { export type TeardownErrorsPayload = {
fatalErrors: TestInfoError[]; fatalErrors: TestInfoErrorImpl[];
}; };
export type EnvProducedPayload = [string, string | null][]; export type EnvProducedPayload = [string, string | null][];

5
packages/playwright/src/common/process.ts
View File

@ -14,9 +14,8 @@
* limitations under the License. * limitations under the License.
*/ */
import type { EnvProducedPayload, ProcessInitParams } from './ipc'; import type { EnvProducedPayload, ProcessInitParams, TestInfoErrorImpl } from './ipc';
import { startProfiling, stopProfiling } from 'playwright-core/lib/utils'; import { startProfiling, stopProfiling } from 'playwright-core/lib/utils';
import type { TestInfoError } from '../../types/test';
import { serializeError } from '../util'; import { serializeError } from '../util';
import { registerESMLoader } from './esmLoaderHost'; import { registerESMLoader } from './esmLoaderHost';
import { execArgvWithoutExperimentalLoaderOptions } from '../transform/esmUtils'; import { execArgvWithoutExperimentalLoaderOptions } from '../transform/esmUtils';
@ -29,7 +28,7 @@ export type ProtocolRequest = {
export type ProtocolResponse = { export type ProtocolResponse = {
id?: number; id?: number;
error?: TestInfoError; error?: TestInfoErrorImpl;
method?: string; method?: string;
params?: any; params?: any;
result?: any; result?: any;

22
packages/playwright/src/matchers/matcherHint.ts
View File

@ -45,18 +45,18 @@ export type MatcherResult<E, A> = {
printedDiff?: string; printedDiff?: string;
}; };
export class ExpectError extends Error { export type MatcherResultProperty = Omit<MatcherResult<unknown, unknown>, 'message'> & {
matcherResult: { message: string;
message: string; };
pass: boolean;
name?: string;
expected?: any;
actual?: any;
log?: string[];
timeout?: number;
};
constructor(jestError: ExpectError, customMessage: string, stackFrames: StackFrame[]) { type JestError = Error & {
matcherResult: MatcherResultProperty;
};
export class ExpectError extends Error {
matcherResult: MatcherResultProperty;
constructor(jestError: JestError, customMessage: string, stackFrames: StackFrame[]) {
super(''); super('');
// Copy to erase the JestMatcherError constructor name from the console.log(error). // Copy to erase the JestMatcherError constructor name from the console.log(error).
this.name = jestError.name; this.name = jestError.name;

4
packages/playwright/src/util.ts
View File

@ -21,10 +21,10 @@ import path from 'path';
import url from 'url'; import url from 'url';
import { debug, mime, minimatch, parseStackTraceLine } from 'playwright-core/lib/utilsBundle'; import { debug, mime, minimatch, parseStackTraceLine } from 'playwright-core/lib/utilsBundle';
import { formatCallLog } from 'playwright-core/lib/utils'; import { formatCallLog } from 'playwright-core/lib/utils';
import type { TestInfoError } from './../types/test';
import type { Location } from './../types/testReporter'; import type { Location } from './../types/testReporter';
import { calculateSha1, isRegExp, isString, sanitizeForFilePath, stringifyStackFrames } from 'playwright-core/lib/utils'; import { calculateSha1, isRegExp, isString, sanitizeForFilePath, stringifyStackFrames } from 'playwright-core/lib/utils';
import type { RawStack } from 'playwright-core/lib/utils'; import type { RawStack } from 'playwright-core/lib/utils';
import type { TestInfoErrorImpl } from './common/ipc';
const PLAYWRIGHT_TEST_PATH = path.join(__dirname, '..'); const PLAYWRIGHT_TEST_PATH = path.join(__dirname, '..');
const PLAYWRIGHT_CORE_PATH = path.dirname(require.resolve('playwright-core/package.json')); const PLAYWRIGHT_CORE_PATH = path.dirname(require.resolve('playwright-core/package.json'));
@ -62,7 +62,7 @@ export function filteredStackTrace(rawStack: RawStack): StackFrame[] {
return frames; return frames;
} }
export function serializeError(error: Error | any): TestInfoError { export function serializeError(error: Error | any): TestInfoErrorImpl {
if (error instanceof Error) if (error instanceof Error)
return filterStackTrace(error); return filterStackTrace(error);
return { return {

1
packages/playwright/src/worker/DEPS.list
View File

@ -3,3 +3,4 @@
../transform/ ../transform/
../util.ts ../util.ts
../utilBundle.ts ../utilBundle.ts
../matchers/**

18
packages/playwright/src/worker/testInfo.ts
View File

@ -17,8 +17,8 @@
import fs from 'fs'; import fs from 'fs';
import path from 'path'; import path from 'path';
import { captureRawStack, monotonicTime, zones, sanitizeForFilePath, stringifyStackFrames } from 'playwright-core/lib/utils'; import { captureRawStack, monotonicTime, zones, sanitizeForFilePath, stringifyStackFrames } from 'playwright-core/lib/utils';
import type { TestInfoError, TestInfo, TestStatus, FullProject } from '../../types/test'; import type { TestInfo, TestStatus, FullProject } from '../../types/test';
import type { AttachmentPayload, StepBeginPayload, StepEndPayload, WorkerInitParams } from '../common/ipc'; import type { AttachmentPayload, StepBeginPayload, StepEndPayload, TestInfoErrorImpl, WorkerInitParams } from '../common/ipc';
import type { TestCase } from '../common/test'; import type { TestCase } from '../common/test';
import { TimeoutManager, TimeoutManagerError, kMaxDeadline } from './timeoutManager'; import { TimeoutManager, TimeoutManagerError, kMaxDeadline } from './timeoutManager';
import type { RunnableDescription } from './timeoutManager'; import type { RunnableDescription } from './timeoutManager';
@ -28,7 +28,7 @@ import { debugTest, filteredStackTrace, formatLocation, getContainedPath, normal
import { TestTracing } from './testTracing'; import { TestTracing } from './testTracing';
import type { Attachment } from './testTracing'; import type { Attachment } from './testTracing';
import type { StackFrame } from '@protocol/channels'; import type { StackFrame } from '@protocol/channels';
import { serializeWorkerError } from './util'; import { testInfoError } from './util';
export interface TestStepInternal { export interface TestStepInternal {
complete(result: { error?: Error | unknown, attachments?: Attachment[] }): void; complete(result: { error?: Error | unknown, attachments?: Attachment[] }): void;
@ -41,7 +41,7 @@ export interface TestStepInternal {
endWallTime?: number; endWallTime?: number;
apiName?: string; apiName?: string;
params?: Record<string, any>; params?: Record<string, any>;
error?: TestInfoError; error?: TestInfoErrorImpl;
infectParentStepsWithError?: boolean; infectParentStepsWithError?: boolean;
box?: boolean; box?: boolean;
isStage?: boolean; isStage?: boolean;
@ -97,14 +97,14 @@ export class TestInfoImpl implements TestInfo {
snapshotSuffix: string = ''; snapshotSuffix: string = '';
readonly outputDir: string; readonly outputDir: string;
readonly snapshotDir: string; readonly snapshotDir: string;
errors: TestInfoError[] = []; errors: TestInfoErrorImpl[] = [];
readonly _attachmentsPush: (...items: TestInfo['attachments']) => number; readonly _attachmentsPush: (...items: TestInfo['attachments']) => number;
get error(): TestInfoError | undefined { get error(): TestInfoErrorImpl | undefined {
return this.errors[0]; return this.errors[0];
} }
set error(e: TestInfoError | undefined) { set error(e: TestInfoErrorImpl | undefined) {
if (e === undefined) if (e === undefined)
throw new Error('Cannot assign testInfo.error undefined value!'); throw new Error('Cannot assign testInfo.error undefined value!');
this.errors[0] = e; this.errors[0] = e;
@ -273,7 +273,7 @@ export class TestInfoImpl implements TestInfo {
if (result.error) { if (result.error) {
if (typeof result.error === 'object' && !(result.error as any)?.[stepSymbol]) if (typeof result.error === 'object' && !(result.error as any)?.[stepSymbol])
(result.error as any)[stepSymbol] = step; (result.error as any)[stepSymbol] = step;
const error = serializeWorkerError(result.error); const error = testInfoError(result.error);
if (data.boxedStack) if (data.boxedStack)
error.stack = `${error.message}\n${stringifyStackFrames(data.boxedStack).join('\n')}`; error.stack = `${error.message}\n${stringifyStackFrames(data.boxedStack).join('\n')}`;
step.error = error; step.error = error;
@ -331,7 +331,7 @@ export class TestInfoImpl implements TestInfo {
_failWithError(error: Error | unknown) { _failWithError(error: Error | unknown) {
if (this.status === 'passed' || this.status === 'skipped') if (this.status === 'passed' || this.status === 'skipped')
this.status = error instanceof TimeoutManagerError ? 'timedOut' : 'failed'; this.status = error instanceof TimeoutManagerError ? 'timedOut' : 'failed';
const serialized = serializeWorkerError(error); const serialized = testInfoError(error);
const step: TestStepInternal | undefined = typeof error === 'object' ? (error as any)?.[stepSymbol] : undefined; const step: TestStepInternal | undefined = typeof error === 'object' ? (error as any)?.[stepSymbol] : undefined;
if (step && step.boxedStack) if (step && step.boxedStack)
serialized.stack = `${(error as Error).name}: ${(error as Error).message}\n${stringifyStackFrames(step.boxedStack).join('\n')}`; serialized.stack = `${(error as Error).name}: ${(error as Error).message}\n${stringifyStackFrames(step.boxedStack).join('\n')}`;

6
packages/playwright/src/worker/testTracing.ts
View File

@ -21,10 +21,10 @@ import fs from 'fs';
import path from 'path'; import path from 'path';
import { ManualPromise, calculateSha1, monotonicTime, createGuid, SerializedFS } from 'playwright-core/lib/utils'; import { ManualPromise, calculateSha1, monotonicTime, createGuid, SerializedFS } from 'playwright-core/lib/utils';
import { yauzl, yazl } from 'playwright-core/lib/zipBundle'; import { yauzl, yazl } from 'playwright-core/lib/zipBundle';
import type { TestInfo, TestInfoError } from '../../types/test';
import { filteredStackTrace } from '../util'; import { filteredStackTrace } from '../util';
import type { TraceMode, PlaywrightWorkerOptions } from '../../types/test'; import type { TestInfo, TraceMode, PlaywrightWorkerOptions } from '../../types/test';
import type { TestInfoImpl } from './testInfo'; import type { TestInfoImpl } from './testInfo';
import type { TestInfoErrorImpl } from '../common/ipc';
export type Attachment = TestInfo['attachments'][0]; export type Attachment = TestInfo['attachments'][0];
export const testTraceEntryName = 'test.trace'; export const testTraceEntryName = 'test.trace';
@ -219,7 +219,7 @@ export class TestTracing {
this._testInfo.attachments.push({ name: 'trace', path: tracePath, contentType: 'application/zip' }); this._testInfo.attachments.push({ name: 'trace', path: tracePath, contentType: 'application/zip' });
} }
appendForError(error: TestInfoError) { appendForError(error: TestInfoErrorImpl) {
const rawStack = error.stack?.split('\n') || []; const rawStack = error.stack?.split('\n') || [];
const stack = rawStack ? filteredStackTrace(rawStack) : []; const stack = rawStack ? filteredStackTrace(rawStack) : [];
this._appendTraceEvent({ this._appendTraceEvent({

33
packages/playwright/src/worker/util.ts
View File

@ -14,32 +14,13 @@
* limitations under the License. * limitations under the License.
*/ */
import type { TestError } from '../../types/testReporter'; import type { TestInfoErrorImpl } from '../common/ipc';
import type { TestInfoError } from '../../types/test'; import { ExpectError } from '../matchers/matcherHint';
import type { MatcherResult } from '../matchers/matcherHint';
import { serializeError } from '../util'; import { serializeError } from '../util';
export function testInfoError(error: Error | any): TestInfoErrorImpl {
type MatcherResultDetails = Pick<TestError, 'timeout'|'matcherName'|'locator'|'expected'|'received'|'log'>; const result = serializeError(error);
if (error instanceof ExpectError)
export function serializeWorkerError(error: Error | any): TestInfoError & MatcherResultDetails { result.matcherResult = error.matcherResult;
return { return result;
...serializeError(error),
...serializeExpectDetails(error),
};
} }
function serializeExpectDetails(e: Error): MatcherResultDetails {
const matcherResult = (e as any).matcherResult as MatcherResult<unknown, unknown>;
if (!matcherResult)
return {};
return {
timeout: matcherResult.timeout,
matcherName: matcherResult.name,
locator: matcherResult.locator,
expected: matcherResult.printedExpected,
received: matcherResult.printedReceived,
log: matcherResult.log,
};
}

16
packages/playwright/src/worker/workerMain.ts
View File

@ -16,7 +16,8 @@
import { colors } from 'playwright-core/lib/utilsBundle'; import { colors } from 'playwright-core/lib/utilsBundle';
import { debugTest, relativeFilePath } from '../util'; import { debugTest, relativeFilePath } from '../util';
import { type TestBeginPayload, type TestEndPayload, type RunPayload, type DonePayload, type WorkerInitParams, type TeardownErrorsPayload, stdioChunkToParams } from '../common/ipc'; import type { TestBeginPayload, TestEndPayload, RunPayload, DonePayload, WorkerInitParams, TeardownErrorsPayload, TestInfoErrorImpl } from '../common/ipc';
import { stdioChunkToParams } from '../common/ipc';
import { setCurrentTestInfo, setIsWorkerProcess } from '../common/globals'; import { setCurrentTestInfo, setIsWorkerProcess } from '../common/globals';
import { deserializeConfig } from '../common/configLoader'; import { deserializeConfig } from '../common/configLoader';
import type { Suite, TestCase } from '../common/test'; import type { Suite, TestCase } from '../common/test';
@ -28,11 +29,10 @@ import { ProcessRunner } from '../common/process';
import { loadTestFile } from '../common/testLoader'; import { loadTestFile } from '../common/testLoader';
import { applyRepeatEachIndex, bindFileSuiteToProject, filterTestsRemoveEmptySuites } from '../common/suiteUtils'; import { applyRepeatEachIndex, bindFileSuiteToProject, filterTestsRemoveEmptySuites } from '../common/suiteUtils';
import { PoolBuilder } from '../common/poolBuilder'; import { PoolBuilder } from '../common/poolBuilder';
import type { TestInfoError } from '../../types/test';
import type { Location } from '../../types/testReporter'; import type { Location } from '../../types/testReporter';
import { inheritFixtureNames } from '../common/fixtures'; import { inheritFixtureNames } from '../common/fixtures';
import { type TimeSlot } from './timeoutManager'; import { type TimeSlot } from './timeoutManager';
import { serializeWorkerError } from './util'; import { testInfoError } from './util';
export class WorkerMain extends ProcessRunner { export class WorkerMain extends ProcessRunner {
private _params: WorkerInitParams; private _params: WorkerInitParams;
@ -42,7 +42,7 @@ export class WorkerMain extends ProcessRunner {
private _fixtureRunner: FixtureRunner; private _fixtureRunner: FixtureRunner;
// Accumulated fatal errors that cannot be attributed to a test. // Accumulated fatal errors that cannot be attributed to a test.
private _fatalErrors: TestInfoError[] = []; private _fatalErrors: TestInfoErrorImpl[] = [];
// Whether we should skip running remaining tests in this suite because // Whether we should skip running remaining tests in this suite because
// of a setup error, usually beforeAll hook. // of a setup error, usually beforeAll hook.
private _skipRemainingTestsInSuite: Suite | undefined; private _skipRemainingTestsInSuite: Suite | undefined;
@ -113,7 +113,7 @@ export class WorkerMain extends ProcessRunner {
await fakeTestInfo._runAsStage({ title: 'worker cleanup', runnable }, () => gracefullyCloseAll()).catch(() => {}); await fakeTestInfo._runAsStage({ title: 'worker cleanup', runnable }, () => gracefullyCloseAll()).catch(() => {});
this._fatalErrors.push(...fakeTestInfo.errors); this._fatalErrors.push(...fakeTestInfo.errors);
} catch (e) { } catch (e) {
this._fatalErrors.push(serializeWorkerError(e)); this._fatalErrors.push(testInfoError(e));
} }
if (this._fatalErrors.length) { if (this._fatalErrors.length) {
@ -123,7 +123,7 @@ export class WorkerMain extends ProcessRunner {
} }
} }
private _appendProcessTeardownDiagnostics(error: TestInfoError) { private _appendProcessTeardownDiagnostics(error: TestInfoErrorImpl) {
if (!this._lastRunningTests.length) if (!this._lastRunningTests.length)
return; return;
const count = this._totalRunningTests === 1 ? '1 test' : `${this._totalRunningTests} tests`; const count = this._totalRunningTests === 1 ? '1 test' : `${this._totalRunningTests} tests`;
@ -154,7 +154,7 @@ export class WorkerMain extends ProcessRunner {
// No current test - fatal error. // No current test - fatal error.
if (!this._currentTest) { if (!this._currentTest) {
if (!this._fatalErrors.length) if (!this._fatalErrors.length)
this._fatalErrors.push(serializeWorkerError(error)); this._fatalErrors.push(testInfoError(error));
void this._stop(); void this._stop();
return; return;
} }
@ -225,7 +225,7 @@ export class WorkerMain extends ProcessRunner {
// In theory, we should run above code without any errors. // In theory, we should run above code without any errors.
// However, in the case we screwed up, or loadTestFile failed in the worker // However, in the case we screwed up, or loadTestFile failed in the worker
// but not in the runner, let's do a fatal error. // but not in the runner, let's do a fatal error.
this._fatalErrors.push(serializeWorkerError(e)); this._fatalErrors.push(testInfoError(e));
void this._stop(); void this._stop();
} finally { } finally {
const donePayload: DonePayload = { const donePayload: DonePayload = {