ed99ac7395
In the following scenario, we were adding SIGINT handler twice, but removing it just once: - Task runner starts testing, creates SigIntWatcher, installs SIGINT handler. - Press Ctrl+C, task runner interrupts, disarms SigIntWatcher, SIGINT handler is not removed due to 1000ms cooldown. - Task runner starts cleanup, creates SigIntWatcher, installs another SIGINT handler. - Cleanup finishes, SigIntWatcher disarms, could remove or not remove SIGINT handler based on timing (same 1000ms cooldown). In any case, we have one or two SIGINT handlers still on. - HTML reporter hangs in onExit, while we still have SIGINT handler up, so Ctrl+C does not exit. Regressed in #24265.
106 lines
3.3 KiB
TypeScript
106 lines
3.3 KiB
TypeScript
/**
|
|
* Copyright (c) Microsoft Corporation.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
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 = () => {
|
|
FixedNodeSIGINTHandler.off(this._sigintHandler);
|
|
this._hadSignal = true;
|
|
sigintCallback();
|
|
};
|
|
FixedNodeSIGINTHandler.on(this._sigintHandler);
|
|
}
|
|
|
|
promise(): Promise<void> {
|
|
return this._sigintPromise;
|
|
}
|
|
|
|
hadSignal(): boolean {
|
|
return this._hadSignal;
|
|
}
|
|
|
|
disarm() {
|
|
FixedNodeSIGINTHandler.off(this._sigintHandler);
|
|
}
|
|
}
|
|
|
|
// NPM/NPX will send us duplicate SIGINT signals, so we need to ignore them.
|
|
class FixedNodeSIGINTHandler {
|
|
private static _handlers: (() => void)[] = [];
|
|
private static _ignoreNextSIGINTs = false;
|
|
private static _handlerInstalled = false;
|
|
|
|
static _dispatch = () => {
|
|
if (this._ignoreNextSIGINTs)
|
|
return;
|
|
|
|
this._ignoreNextSIGINTs = true;
|
|
setTimeout(() => {
|
|
this._ignoreNextSIGINTs = false;
|
|
// We remove the handler so that second Ctrl+C immediately kills the process
|
|
// 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 NPM v6+.
|
|
// https://github.com/npm/cli/issues/1591
|
|
// https://github.com/npm/cli/issues/2124
|
|
// https://github.com/npm/cli/issues/5021
|
|
//
|
|
// 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 process will force
|
|
// the user to hit Ctrl+C again after at least a second.
|
|
if (!this._handlers.length)
|
|
this._uninstall();
|
|
}, 1000);
|
|
for (const handler of this._handlers)
|
|
handler();
|
|
};
|
|
|
|
static _install() {
|
|
if (!this._handlerInstalled) {
|
|
this._handlerInstalled = true;
|
|
process.on('SIGINT', this._dispatch);
|
|
}
|
|
}
|
|
|
|
static _uninstall() {
|
|
if (this._handlerInstalled) {
|
|
this._handlerInstalled = false;
|
|
process.off('SIGINT', this._dispatch);
|
|
}
|
|
}
|
|
|
|
static on(handler: () => void) {
|
|
this._handlers.push(handler);
|
|
if (this._handlers.length === 1)
|
|
this._install();
|
|
}
|
|
|
|
static off(handler: () => void) {
|
|
this._handlers = this._handlers.filter(h => h !== handler);
|
|
if (!this._ignoreNextSIGINTs && !this._handlers.length)
|
|
this._uninstall();
|
|
}
|
|
}
|