chore: extract SigIntWatcher (#11749)
This is to reduce the size of the long `_run` method in the `runner.ts`. It also might come handy around the codebase.
This commit is contained in:
parent
b58b004f0f
commit
3a4e506479
|
|
@ -577,3 +577,45 @@ export async function transformCommandsForRoot(commands: string[]): Promise<{ co
|
||||||
return { command: 'sudo', args: ['--', 'sh', '-c', `${commands.join('&& ')}`], elevatedPermissions: true };
|
return { command: 'sudo', args: ['--', 'sh', '-c', `${commands.join('&& ')}`], elevatedPermissions: true };
|
||||||
return { command: 'su', args: ['root', '-c', `${commands.join('&& ')}`], elevatedPermissions: true };
|
return { command: 'su', args: ['root', '-c', `${commands.join('&& ')}`], elevatedPermissions: true };
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export class SigIntWatcher {
|
||||||
|
private _hadSignal: boolean = false;
|
||||||
|
private _sigintPromise: Promise<void>;
|
||||||
|
private _sigintHandler: () => void;
|
||||||
|
constructor() {
|
||||||
|
let sigintCallback: () => void;
|
||||||
|
this._sigintPromise = new Promise<void>(f => sigintCallback = f);
|
||||||
|
this._sigintHandler = () => {
|
||||||
|
// We remove the handler so that second Ctrl+C immediately kills the runner
|
||||||
|
// via the default sigint handler. This is handy in the case where our shutdown
|
||||||
|
// takes a lot of time or is buggy.
|
||||||
|
//
|
||||||
|
// When running through NPM we might get multiple SIGINT signals
|
||||||
|
// for a single Ctrl+C - this is an NPM bug present since at least NPM v6.
|
||||||
|
// https://github.com/npm/cli/issues/1591
|
||||||
|
// https://github.com/npm/cli/issues/2124
|
||||||
|
//
|
||||||
|
// Therefore, removing the handler too soon will just kill the process
|
||||||
|
// with default handler without printing the results.
|
||||||
|
// We work around this by giving NPM 1000ms to send us duplicate signals.
|
||||||
|
// The side effect is that slow shutdown or bug in our runner will force
|
||||||
|
// the user to hit Ctrl+C again after at least a second.
|
||||||
|
setTimeout(() => process.off('SIGINT', this._sigintHandler), 1000);
|
||||||
|
this._hadSignal = true;
|
||||||
|
sigintCallback();
|
||||||
|
};
|
||||||
|
process.on('SIGINT', this._sigintHandler);
|
||||||
|
}
|
||||||
|
|
||||||
|
promise(): Promise<void> {
|
||||||
|
return this._sigintPromise;
|
||||||
|
}
|
||||||
|
|
||||||
|
hadSignal(): boolean {
|
||||||
|
return this._hadSignal;
|
||||||
|
}
|
||||||
|
|
||||||
|
disarm() {
|
||||||
|
process.off('SIGINT', this._sigintHandler);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
|
||||||
|
|
@ -38,6 +38,7 @@ import { Minimatch } from 'minimatch';
|
||||||
import { Config, FullConfig } from './types';
|
import { Config, FullConfig } from './types';
|
||||||
import { WebServer } from './webServer';
|
import { WebServer } from './webServer';
|
||||||
import { raceAgainstTimeout } from 'playwright-core/lib/utils/async';
|
import { raceAgainstTimeout } from 'playwright-core/lib/utils/async';
|
||||||
|
import { SigIntWatcher } from 'playwright-core/lib/utils/utils';
|
||||||
|
|
||||||
const removeFolderAsync = promisify(rimraf);
|
const removeFolderAsync = promisify(rimraf);
|
||||||
const readDirAsync = promisify(fs.readdir);
|
const readDirAsync = promisify(fs.readdir);
|
||||||
|
|
@ -345,46 +346,24 @@ export class Runner {
|
||||||
}
|
}
|
||||||
(config as any).__testGroupsCount = testGroups.length;
|
(config as any).__testGroupsCount = testGroups.length;
|
||||||
|
|
||||||
let sigint = false;
|
const sigintWatcher = new SigIntWatcher();
|
||||||
let sigintCallback: () => void;
|
|
||||||
const sigIntPromise = new Promise<void>(f => sigintCallback = f);
|
|
||||||
const sigintHandler = () => {
|
|
||||||
// We remove the handler so that second Ctrl+C immediately kills the runner
|
|
||||||
// via the default sigint handler. This is handy in the case where our shutdown
|
|
||||||
// takes a lot of time or is buggy.
|
|
||||||
//
|
|
||||||
// When running through NPM we might get multiple SIGINT signals
|
|
||||||
// for a single Ctrl+C - this is an NPM bug present since at least NPM v6.
|
|
||||||
// https://github.com/npm/cli/issues/1591
|
|
||||||
// https://github.com/npm/cli/issues/2124
|
|
||||||
//
|
|
||||||
// Therefore, removing the handler too soon will just kill the process
|
|
||||||
// with default handler without printing the results.
|
|
||||||
// We work around this by giving NPM 1000ms to send us duplicate signals.
|
|
||||||
// The side effect is that slow shutdown or bug in our runner will force
|
|
||||||
// the user to hit Ctrl+C again after at least a second.
|
|
||||||
setTimeout(() => process.off('SIGINT', sigintHandler), 1000);
|
|
||||||
sigint = true;
|
|
||||||
sigintCallback();
|
|
||||||
};
|
|
||||||
process.on('SIGINT', sigintHandler);
|
|
||||||
|
|
||||||
this._reporter.onBegin?.(config, rootSuite);
|
this._reporter.onBegin?.(config, rootSuite);
|
||||||
this._didBegin = true;
|
this._didBegin = true;
|
||||||
let hasWorkerErrors = false;
|
let hasWorkerErrors = false;
|
||||||
if (!list) {
|
if (!list) {
|
||||||
const dispatcher = new Dispatcher(this._loader, testGroups, this._reporter);
|
const dispatcher = new Dispatcher(this._loader, testGroups, this._reporter);
|
||||||
await Promise.race([dispatcher.run(), sigIntPromise]);
|
await Promise.race([dispatcher.run(), sigintWatcher.promise()]);
|
||||||
if (!sigint) {
|
if (!sigintWatcher.hadSignal()) {
|
||||||
// We know for sure there was no Ctrl+C, so we remove custom SIGINT handler
|
// We know for sure there was no Ctrl+C, so we remove custom SIGINT handler
|
||||||
// as soon as we can.
|
// as soon as we can.
|
||||||
process.off('SIGINT', sigintHandler);
|
sigintWatcher.disarm();
|
||||||
}
|
}
|
||||||
await dispatcher.stop();
|
await dispatcher.stop();
|
||||||
hasWorkerErrors = dispatcher.hasWorkerErrors();
|
hasWorkerErrors = dispatcher.hasWorkerErrors();
|
||||||
}
|
}
|
||||||
|
|
||||||
if (sigint) {
|
if (sigintWatcher.hadSignal()) {
|
||||||
const result: FullResult = { status: 'interrupted' };
|
const result: FullResult = { status: 'interrupted' };
|
||||||
return result;
|
return result;
|
||||||
}
|
}
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue