123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333 |
- 'use strict';
- Object.defineProperty(exports, '__esModule', {
- value: true
- });
- exports.default = void 0;
- function _child_process() {
- const data = require('child_process');
- _child_process = function () {
- return data;
- };
- return data;
- }
- function _stream() {
- const data = require('stream');
- _stream = function () {
- return data;
- };
- return data;
- }
- function _mergeStream() {
- const data = _interopRequireDefault(require('merge-stream'));
- _mergeStream = function () {
- return data;
- };
- return data;
- }
- function _supportsColor() {
- const data = require('supports-color');
- _supportsColor = function () {
- return data;
- };
- return data;
- }
- var _types = require('../types');
- function _interopRequireDefault(obj) {
- return obj && obj.__esModule ? obj : {default: obj};
- }
- function _defineProperty(obj, key, value) {
- if (key in obj) {
- Object.defineProperty(obj, key, {
- value: value,
- enumerable: true,
- configurable: true,
- writable: true
- });
- } else {
- obj[key] = value;
- }
- return obj;
- }
- const SIGNAL_BASE_EXIT_CODE = 128;
- const SIGKILL_EXIT_CODE = SIGNAL_BASE_EXIT_CODE + 9;
- const SIGTERM_EXIT_CODE = SIGNAL_BASE_EXIT_CODE + 15; // How long to wait after SIGTERM before sending SIGKILL
- const SIGKILL_DELAY = 500;
- /**
- * This class wraps the child process and provides a nice interface to
- * communicate with. It takes care of:
- *
- * - Re-spawning the process if it dies.
- * - Queues calls while the worker is busy.
- * - Re-sends the requests if the worker blew up.
- *
- * The reason for queueing them here (since childProcess.send also has an
- * internal queue) is because the worker could be doing asynchronous work, and
- * this would lead to the child process to read its receiving buffer and start a
- * second call. By queueing calls here, we don't send the next call to the
- * children until we receive the result of the previous one.
- *
- * As soon as a request starts to be processed by a worker, its "processed"
- * field is changed to "true", so that other workers which might encounter the
- * same call skip it.
- */
- class ChildProcessWorker {
- constructor(options) {
- _defineProperty(this, '_child', void 0);
- _defineProperty(this, '_options', void 0);
- _defineProperty(this, '_request', void 0);
- _defineProperty(this, '_retries', void 0);
- _defineProperty(this, '_onProcessEnd', void 0);
- _defineProperty(this, '_onCustomMessage', void 0);
- _defineProperty(this, '_fakeStream', void 0);
- _defineProperty(this, '_stdout', void 0);
- _defineProperty(this, '_stderr', void 0);
- _defineProperty(this, '_exitPromise', void 0);
- _defineProperty(this, '_resolveExitPromise', void 0);
- this._options = options;
- this._request = null;
- this._fakeStream = null;
- this._stdout = null;
- this._stderr = null;
- this._exitPromise = new Promise(resolve => {
- this._resolveExitPromise = resolve;
- });
- this.initialize();
- }
- initialize() {
- const forceColor = _supportsColor().stdout
- ? {
- FORCE_COLOR: '1'
- }
- : {};
- const child = (0, _child_process().fork)(
- require.resolve('./processChild'),
- [],
- {
- cwd: process.cwd(),
- env: {
- ...process.env,
- JEST_WORKER_ID: String(this._options.workerId + 1),
- // 0-indexed workerId, 1-indexed JEST_WORKER_ID
- ...forceColor
- },
- // Suppress --debug / --inspect flags while preserving others (like --harmony).
- execArgv: process.execArgv.filter(v => !/^--(debug|inspect)/.test(v)),
- silent: true,
- ...this._options.forkOptions
- }
- );
- if (child.stdout) {
- if (!this._stdout) {
- // We need to add a permanent stream to the merged stream to prevent it
- // from ending when the subprocess stream ends
- this._stdout = (0, _mergeStream().default)(this._getFakeStream());
- }
- this._stdout.add(child.stdout);
- }
- if (child.stderr) {
- if (!this._stderr) {
- // We need to add a permanent stream to the merged stream to prevent it
- // from ending when the subprocess stream ends
- this._stderr = (0, _mergeStream().default)(this._getFakeStream());
- }
- this._stderr.add(child.stderr);
- }
- child.on('message', this._onMessage.bind(this));
- child.on('exit', this._onExit.bind(this));
- child.send([
- _types.CHILD_MESSAGE_INITIALIZE,
- false,
- this._options.workerPath,
- this._options.setupArgs
- ]);
- this._child = child;
- this._retries++; // If we exceeded the amount of retries, we will emulate an error reply
- // coming from the child. This avoids code duplication related with cleaning
- // the queue, and scheduling the next call.
- if (this._retries > this._options.maxRetries) {
- const error = new Error(
- `Jest worker encountered ${this._retries} child process exceptions, exceeding retry limit`
- );
- this._onMessage([
- _types.PARENT_MESSAGE_CLIENT_ERROR,
- error.name,
- error.message,
- error.stack,
- {
- type: 'WorkerError'
- }
- ]);
- }
- }
- _shutdown() {
- // End the temporary streams so the merged streams end too
- if (this._fakeStream) {
- this._fakeStream.end();
- this._fakeStream = null;
- }
- this._resolveExitPromise();
- }
- _onMessage(response) {
- // TODO: Add appropriate type check
- let error;
- switch (response[0]) {
- case _types.PARENT_MESSAGE_OK:
- this._onProcessEnd(null, response[1]);
- break;
- case _types.PARENT_MESSAGE_CLIENT_ERROR:
- error = response[4];
- if (error != null && typeof error === 'object') {
- const extra = error; // @ts-expect-error: no index
- const NativeCtor = global[response[1]];
- const Ctor = typeof NativeCtor === 'function' ? NativeCtor : Error;
- error = new Ctor(response[2]);
- error.type = response[1];
- error.stack = response[3];
- for (const key in extra) {
- error[key] = extra[key];
- }
- }
- this._onProcessEnd(error, null);
- break;
- case _types.PARENT_MESSAGE_SETUP_ERROR:
- error = new Error('Error when calling setup: ' + response[2]);
- error.type = response[1];
- error.stack = response[3];
- this._onProcessEnd(error, null);
- break;
- case _types.PARENT_MESSAGE_CUSTOM:
- this._onCustomMessage(response[1]);
- break;
- default:
- throw new TypeError('Unexpected response from worker: ' + response[0]);
- }
- }
- _onExit(exitCode) {
- if (
- exitCode !== 0 &&
- exitCode !== null &&
- exitCode !== SIGTERM_EXIT_CODE &&
- exitCode !== SIGKILL_EXIT_CODE
- ) {
- this.initialize();
- if (this._request) {
- this._child.send(this._request);
- }
- } else {
- this._shutdown();
- }
- }
- send(request, onProcessStart, onProcessEnd, onCustomMessage) {
- onProcessStart(this);
- this._onProcessEnd = (...args) => {
- // Clean the request to avoid sending past requests to workers that fail
- // while waiting for a new request (timers, unhandled rejections...)
- this._request = null;
- return onProcessEnd(...args);
- };
- this._onCustomMessage = (...arg) => onCustomMessage(...arg);
- this._request = request;
- this._retries = 0;
- this._child.send(request, () => {});
- }
- waitForExit() {
- return this._exitPromise;
- }
- forceExit() {
- this._child.kill('SIGTERM');
- const sigkillTimeout = setTimeout(
- () => this._child.kill('SIGKILL'),
- SIGKILL_DELAY
- );
- this._exitPromise.then(() => clearTimeout(sigkillTimeout));
- }
- getWorkerId() {
- return this._options.workerId;
- }
- getStdout() {
- return this._stdout;
- }
- getStderr() {
- return this._stderr;
- }
- _getFakeStream() {
- if (!this._fakeStream) {
- this._fakeStream = new (_stream().PassThrough)();
- }
- return this._fakeStream;
- }
- }
- exports.default = ChildProcessWorker;
|