/
index.ts
294 lines (267 loc) · 8.86 KB
/
index.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
/**
* Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
import type {Config} from '@jest/types';
import type {SerializableError, TestResult} from '@jest/test-result';
import exit = require('exit');
import chalk = require('chalk');
import Emittery = require('emittery');
import throat from 'throat';
import Worker, {PromiseWithCustomMessage} from 'jest-worker';
import {deepCyclicCopy} from 'jest-util';
import runTest from './runTest';
import type {SerializableResolver, worker} from './testWorker';
import type {
OnTestFailure as JestOnTestFailure,
OnTestStart as JestOnTestStart,
OnTestSuccess as JestOnTestSuccess,
Test as JestTest,
TestEvents as JestTestEvents,
TestFileEvent as JestTestFileEvent,
TestRunnerContext as JestTestRunnerContext,
TestRunnerOptions as JestTestRunnerOptions,
TestWatcher as JestTestWatcher,
} from './types';
const TEST_WORKER_PATH = require.resolve('./testWorker');
interface WorkerInterface extends Worker {
worker: typeof worker;
}
namespace TestRunner {
export type Test = JestTest;
export type OnTestFailure = JestOnTestFailure;
export type OnTestStart = JestOnTestStart;
export type OnTestSuccess = JestOnTestSuccess;
export type TestWatcher = JestTestWatcher;
export type TestRunnerContext = JestTestRunnerContext;
export type TestRunnerOptions = JestTestRunnerOptions;
export type TestFileEvent = JestTestFileEvent;
}
/* eslint-disable-next-line no-redeclare */
class TestRunner {
private readonly _globalConfig: Config.GlobalConfig;
private readonly _context: JestTestRunnerContext;
private readonly eventEmitter = new Emittery.Typed<JestTestEvents>();
readonly __PRIVATE_UNSTABLE_API_supportsEventEmitters__: boolean = true;
readonly isSerial?: boolean;
constructor(
globalConfig: Config.GlobalConfig,
context?: JestTestRunnerContext,
) {
this._globalConfig = globalConfig;
this._context = context || {};
}
async runTests(
tests: Array<JestTest>,
watcher: JestTestWatcher,
onStart: JestOnTestStart | undefined,
onResult: JestOnTestSuccess | undefined,
onFailure: JestOnTestFailure | undefined,
options: JestTestRunnerOptions,
): Promise<void> {
return await (options.serial
? this._createInBandTestRun(tests, watcher, onStart, onResult, onFailure)
: this._createParallelTestRun(
tests,
watcher,
onStart,
onResult,
onFailure,
));
}
private async _createInBandTestRun(
tests: Array<JestTest>,
watcher: JestTestWatcher,
onStart?: JestOnTestStart,
onResult?: JestOnTestSuccess,
onFailure?: JestOnTestFailure,
) {
process.env.JEST_WORKER_ID = '1';
const mutex = throat(1);
return tests.reduce(
(promise, test) =>
mutex(() =>
promise
.then(async () => {
if (watcher.isInterrupted()) {
throw new CancelRun();
}
let sendMessageToJest: JestTestFileEvent;
// Remove `if(onStart)` in Jest 27
if (onStart) {
await onStart(test);
return runTest(
test.path,
this._globalConfig,
test.context.config,
test.context.resolver,
this._context,
undefined,
);
} else {
// `deepCyclicCopy` used here to avoid mem-leak
sendMessageToJest = (eventName, args) =>
this.eventEmitter.emit(
eventName,
deepCyclicCopy(args, {keepPrototype: false}),
);
await this.eventEmitter.emit('test-file-start', [test]);
return runTest(
test.path,
this._globalConfig,
test.context.config,
test.context.resolver,
this._context,
sendMessageToJest,
);
}
})
.then(result => {
if (onResult) {
return onResult(test, result);
} else {
return this.eventEmitter.emit('test-file-success', [
test,
result,
]);
}
})
.catch(err => {
if (onFailure) {
return onFailure(test, err);
} else {
return this.eventEmitter.emit('test-file-failure', [test, err]);
}
}),
),
Promise.resolve(),
);
}
private async _createParallelTestRun(
tests: Array<JestTest>,
watcher: JestTestWatcher,
onStart?: JestOnTestStart,
onResult?: JestOnTestSuccess,
onFailure?: JestOnTestFailure,
) {
const resolvers: Map<string, SerializableResolver> = new Map();
for (const test of tests) {
if (!resolvers.has(test.context.config.name)) {
resolvers.set(test.context.config.name, {
config: test.context.config,
serializableModuleMap: test.context.moduleMap.toJSON(),
});
}
}
const worker = new Worker(TEST_WORKER_PATH, {
exposedMethods: ['worker'],
forkOptions: {stdio: 'pipe'},
maxRetries: 3,
numWorkers: this._globalConfig.maxWorkers,
setupArgs: [
{
serializableResolvers: Array.from(resolvers.values()),
},
],
}) as WorkerInterface;
if (worker.getStdout()) worker.getStdout().pipe(process.stdout);
if (worker.getStderr()) worker.getStderr().pipe(process.stderr);
const mutex = throat(this._globalConfig.maxWorkers);
// Send test suites to workers continuously instead of all at once to track
// the start time of individual tests.
const runTestInWorker = (test: JestTest) =>
mutex(async () => {
if (watcher.isInterrupted()) {
return Promise.reject();
}
// Remove `if(onStart)` in Jest 27
if (onStart) {
await onStart(test);
} else {
await this.eventEmitter.emit('test-file-start', [test]);
}
const promise = worker.worker({
config: test.context.config,
context: {
...this._context,
changedFiles:
this._context.changedFiles &&
Array.from(this._context.changedFiles),
sourcesRelatedToTestsInChangedFiles:
this._context.sourcesRelatedToTestsInChangedFiles &&
Array.from(this._context.sourcesRelatedToTestsInChangedFiles),
},
globalConfig: this._globalConfig,
path: test.path,
}) as PromiseWithCustomMessage<TestResult>;
if (promise.UNSTABLE_onCustomMessage) {
// TODO: Get appropriate type for `onCustomMessage`
promise.UNSTABLE_onCustomMessage(([event, payload]: any) => {
this.eventEmitter.emit(event, payload);
});
}
return promise;
});
const onError = async (err: SerializableError, test: JestTest) => {
// Remove `if(onFailure)` in Jest 27
if (onFailure) {
await onFailure(test, err);
} else {
await this.eventEmitter.emit('test-file-failure', [test, err]);
}
if (err.type === 'ProcessTerminatedError') {
console.error(
'A worker process has quit unexpectedly! ' +
'Most likely this is an initialization error.',
);
exit(1);
}
};
const onInterrupt = new Promise((_, reject) => {
watcher.on('change', state => {
if (state.interrupted) {
reject(new CancelRun());
}
});
});
const runAllTests = Promise.all(
tests.map(test =>
runTestInWorker(test)
.then(result => {
if (onResult) {
return onResult(test, result);
} else {
return this.eventEmitter.emit('test-file-success', [
test,
result,
]);
}
})
.catch(error => onError(error, test)),
),
);
const cleanup = async () => {
const {forceExited} = await worker.end();
if (forceExited) {
console.error(
chalk.yellow(
'A worker process has failed to exit gracefully and has been force exited. ' +
'This is likely caused by tests leaking due to improper teardown. ' +
'Try running with --runInBand --detectOpenHandles to find leaks.',
),
);
}
};
return Promise.race([runAllTests, onInterrupt]).then(cleanup, cleanup);
}
on = this.eventEmitter.on.bind(this.eventEmitter);
}
class CancelRun extends Error {
constructor(message?: string) {
super(message);
this.name = 'CancelRun';
}
}
export = TestRunner;