yujunjun/playwright
1
0
Fork 0
mirror of https://github.com/microsoft/playwright.git synced 2025-06-26 21:40:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(reporters): separate onExit from onEnd (#15926)

Browse Source 
This is now used by html reporter to open UI.
This commit is contained in:
Dmitry Gozman 2022-07-25 13:20:33 -07:00 committed by GitHub
parent c4dae2a628
commit f88b1e9cde
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 24 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/src/test-reporter-api/class-reporter.md
View File

@ -140,6 +140,12 @@ Called on some global error, for example unhandled exception in the worker proce
The error.
## optional async method: Reporter.onExit
* since: v1.25
Called before the test runner will terminate. Useful to perform work after all reporters have finished, for example open some UI. Fore regular reporting, you should use [`method: Reporter.onEnd`] instead.
## optional method: Reporter.onStdErr
* since: v1.10

7
packages/playwright-test/src/reporters/html.ts
View File

@ -137,6 +137,7 @@ class HtmlReporter implements Reporter {
private _options: HtmlReporterOptions;
private _outputFolder!: string;
private _open: string | undefined;
private _buildResult: { ok: boolean, singleTestId: string | undefined } | undefined;
constructor(options: HtmlReporterOptions = {}) {
this._options = options;
@ -189,12 +190,14 @@ class HtmlReporter implements Reporter {
});
await removeFolders([this._outputFolder]);
const builder = new HtmlBuilder(this._outputFolder);
const { ok, singleTestId } = await builder.build(this.config.metadata, reports);
this._buildResult = await builder.build(this.config.metadata, reports);
}
async onExit() {
if (process.env.CI)
return;
const { ok, singleTestId } = this._buildResult!;
const shouldOpen = this._open === 'always' || (!ok && this._open === 'on-failure');
if (shouldOpen) {
await showHTMLReport(this._outputFolder, singleTestId);

5
packages/playwright-test/src/reporters/multiplexer.ts
View File

@ -57,6 +57,11 @@ export class Multiplexer implements Reporter {
await Promise.resolve().then(() => reporter.onEnd?.(result)).catch(e => console.error('Error in reporter', e));
}
async onExit() {
for (const reporter of this._reporters)
await Promise.resolve().then(() => reporter.onExit?.()).catch(e => console.error('Error in reporter', e));
}
onError(error: TestError) {
for (const reporter of this._reporters)
wrap(() => reporter.onError?.(error));

1
packages/playwright-test/src/runner.ts
View File

@ -190,6 +190,7 @@ export class Runner {
await new Promise<void>(resolve => process.stdout.write('', () => resolve()));
await new Promise<void>(resolve => process.stderr.write('', () => resolve()));
await this._reporter.onExit?.();
return fullResult;
}

7
packages/playwright-test/types/testReporter.d.ts vendored
View File

@ -379,6 +379,13 @@ export interface Reporter {
*/
onError?(error: TestError): void;
/**
* Called before the test runner will terminate. Useful to perform work after all reporters have finished, for example open
* some UI. Fore regular reporting, you should use
* [reporter.onEnd(result)](https://playwright.dev/docs/api/class-reporter#reporter-on-end) instead.
*/
onExit?(): Promise<void>;
/**
* Called when something has been written to the standard error in the worker process.
* @param chunk Output chunk.