forked from jestjs/jest
-
Notifications
You must be signed in to change notification settings - Fork 0
/
WorkerEdgeCases.test.ts
453 lines (376 loc) Β· 12.3 KB
/
WorkerEdgeCases.test.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
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
/**
* 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 {access, mkdir, rm, writeFile} from 'fs/promises';
import {dirname, join} from 'path';
import {transformFileAsync} from '@babel/core';
import {
CHILD_MESSAGE_CALL,
WorkerEvents,
WorkerOptions,
WorkerStates,
} from '../../types';
import ChildProcessWorker, {SIGKILL_DELAY} from '../ChildProcessWorker';
import ThreadsWorker from '../NodeThreadsWorker';
jest.setTimeout(10000);
const root = join('../../');
const filesToBuild = ['workers/processChild', 'workers/threadChild', 'types'];
const writeDestination = join(__dirname, '__temp__');
const processChildWorkerPath = join(
writeDestination,
'workers/processChild.js',
);
const threadChildWorkerPath = join(writeDestination, 'workers/threadChild.js');
beforeAll(async () => {
await mkdir(writeDestination, {recursive: true});
for (const file of filesToBuild) {
const sourcePath = join(__dirname, root, `${file}.ts`);
const writePath = join(writeDestination, `${file}.js`);
await mkdir(dirname(writePath), {recursive: true});
const result = await transformFileAsync(sourcePath);
await writeFile(writePath, result!.code!, {
encoding: 'utf-8',
});
}
});
afterAll(async () => {
await rm(writeDestination, {force: true, recursive: true});
});
test.each(filesToBuild)('%s.js should exist', file => {
const path = join(writeDestination, `${file}.js`);
expect(async () => await access(path)).not.toThrow();
});
async function closeWorkerAfter(
worker: ChildProcessWorker | ThreadsWorker,
testBody: (worker: ChildProcessWorker | ThreadsWorker) => Promise<void>,
) {
try {
await testBody(worker);
} finally {
worker.forceExit();
await worker.waitForExit();
}
}
describe.each([
{
name: 'ProcessWorker',
workerClass: ChildProcessWorker,
workerPath: processChildWorkerPath,
},
{
name: 'ThreadWorker',
workerClass: ThreadsWorker,
workerPath: threadChildWorkerPath,
},
])('$name', ({workerClass, workerPath}) => {
let int: NodeJS.Timeout;
afterEach(async () => {
clearInterval(int);
});
function waitForChange(fn: () => unknown) {
const initial = fn();
return new Promise((resolve, reject) => {
let count = 0;
int = setInterval(() => {
const updated = fn();
if (initial !== updated) {
resolve(updated);
clearInterval(int);
}
if (count > 100000) {
reject(new Error('Timeout waiting for change'));
}
count++;
}, 1);
});
}
test('should get memory usage', async () => {
await closeWorkerAfter(
new workerClass({
childWorkerPath: workerPath,
maxRetries: 0,
workerPath: join(__dirname, '__fixtures__', 'EdgeCasesWorker'),
} as WorkerOptions),
async (worker: ChildProcessWorker | ThreadsWorker) => {
const memoryUsagePromise = worker.getMemoryUsage();
expect(memoryUsagePromise).toBeInstanceOf(Promise);
expect(await memoryUsagePromise).toBeGreaterThan(0);
},
);
});
test('should recycle on idle limit breach', async () => {
await closeWorkerAfter(
new workerClass({
childWorkerPath: workerPath,
// There is no way this is fitting into 1000 bytes, so it should restart
// after requesting a memory usage update
idleMemoryLimit: 1000,
maxRetries: 0,
workerPath: join(__dirname, '__fixtures__', 'EdgeCasesWorker'),
} as WorkerOptions),
async (worker: ChildProcessWorker | ThreadsWorker) => {
const startSystemId = worker.getWorkerSystemId();
expect(startSystemId).toBeGreaterThanOrEqual(0);
worker.checkMemoryUsage();
await waitForChange(() => worker.getWorkerSystemId());
const systemId = worker.getWorkerSystemId();
expect(systemId).toBeGreaterThanOrEqual(0);
expect(systemId).not.toEqual(startSystemId);
await new Promise(resolve => {
setTimeout(resolve, SIGKILL_DELAY + 100);
});
expect(worker.isWorkerRunning()).toBeTruthy();
},
);
});
describe('should automatically recycle on idle limit breach', () => {
let startPid: number;
let worker: ChildProcessWorker | ThreadsWorker;
const orderOfEvents: Array<WorkerStates> = [];
beforeAll(() => {
worker = new workerClass({
childWorkerPath: workerPath,
// There is no way this is fitting into 1000 bytes, so it should restart
// after requesting a memory usage update
idleMemoryLimit: 1000,
maxRetries: 0,
on: {
[WorkerEvents.STATE_CHANGE]: (state: WorkerStates) => {
orderOfEvents.push(state);
},
},
silent: true,
workerPath: join(__dirname, '__fixtures__', 'EdgeCasesWorker'),
} as unknown as WorkerOptions);
});
afterAll(async () => {
if (worker) {
worker.forceExit();
await worker.waitForExit();
}
});
test('initial state', async () => {
startPid = worker.getWorkerSystemId();
expect(startPid).toBeGreaterThanOrEqual(0);
expect(worker.state).toEqual(WorkerStates.OK);
expect(orderOfEvents).toEqual(['ok']);
});
test('new worker starts', async () => {
const onStart = jest.fn();
const onEnd = jest.fn();
const onCustom = jest.fn();
worker.send(
[CHILD_MESSAGE_CALL, true, 'safeFunction', []],
onStart,
onEnd,
onCustom,
);
await waitForChange(() => worker.getWorkerSystemId());
const endPid = worker.getWorkerSystemId();
expect(endPid).toBeGreaterThanOrEqual(0);
expect(endPid).not.toEqual(startPid);
expect(worker.isWorkerRunning()).toBeTruthy();
expect(worker.state).toEqual(WorkerStates.OK);
});
test(
'worker continues to run after kill delay',
async () => {
await new Promise(resolve => {
setTimeout(resolve, SIGKILL_DELAY + 100);
});
expect(worker.state).toEqual(WorkerStates.OK);
expect(worker.isWorkerRunning()).toBeTruthy();
},
SIGKILL_DELAY * 3,
);
test('expected state order', () => {
expect(orderOfEvents).toEqual(['ok', 'restarting', 'starting', 'ok']);
});
});
describe('should cleanly exit on out of memory crash', () => {
const workerHeapLimit = 50;
let worker: ChildProcessWorker | ThreadsWorker;
let orderOfEvents: Array<WorkerStates> = [];
beforeAll(() => {
orderOfEvents = [];
const options = {
childWorkerPath: workerPath,
maxRetries: 0,
on: {
[WorkerEvents.STATE_CHANGE]: (state: WorkerStates) => {
orderOfEvents.push(state);
},
},
silent: true,
workerPath: join(__dirname, '__fixtures__', 'EdgeCasesWorker'),
} as unknown as WorkerOptions;
if (workerClass === ThreadsWorker) {
options.resourceLimits = {
codeRangeSizeMb: workerHeapLimit * 2,
maxOldGenerationSizeMb: workerHeapLimit,
maxYoungGenerationSizeMb: workerHeapLimit * 2,
stackSizeMb: workerHeapLimit * 2,
};
} else if (workerClass === ChildProcessWorker) {
options.forkOptions = {
// Forcibly set the heap limit so we can crash the process easily.
execArgv: [`--max-old-space-size=${workerHeapLimit}`],
};
}
worker = new workerClass(options);
});
afterAll(async () => {
await new Promise<void>(resolve => {
setTimeout(async () => {
if (worker) {
worker.forceExit();
await worker.waitForExit();
}
resolve();
}, 500);
});
});
test('starting state', async () => {
const startPid = worker.getWorkerSystemId();
expect(startPid).toBeGreaterThanOrEqual(0);
});
test('worker ready', async () => {
await worker.waitForWorkerReady();
expect(worker.state).toEqual(WorkerStates.OK);
});
test('worker crashes and exits', async () => {
const onStart = jest.fn();
const onEnd = jest.fn();
const onCustom = jest.fn();
worker.send(
[CHILD_MESSAGE_CALL, true, 'leakMemory', []],
onStart,
onEnd,
onCustom,
);
await worker.waitForExit();
expect(worker.state).not.toEqual(WorkerStates.OK);
});
test('worker stays dead', async () => {
await expect(
async () => await worker.waitForWorkerReady(),
).rejects.toThrow('Worker state means it will never be ready: shut-down');
expect(worker.isWorkerRunning()).toBeFalsy();
});
test('expected state order', () => {
expect(orderOfEvents).toEqual([
WorkerStates.OK,
WorkerStates.OUT_OF_MEMORY,
WorkerStates.SHUT_DOWN,
]);
});
});
describe('should handle regular fatal crashes', () => {
let worker: ChildProcessWorker | ThreadsWorker;
let startedWorkers = 0;
beforeAll(() => {
worker = new workerClass({
childWorkerPath: workerPath,
maxRetries: 4,
on: {
[WorkerEvents.STATE_CHANGE]: (state: WorkerStates) => {
if (state === WorkerStates.OK) {
startedWorkers++;
}
},
},
workerPath: join(__dirname, '__fixtures__', 'EdgeCasesWorker'),
} as unknown as WorkerOptions);
});
afterAll(async () => {
if (worker) {
worker.forceExit();
await worker.waitForExit();
}
});
test('starting state', async () => {
const startPid = worker.getWorkerSystemId();
expect(startPid).toBeGreaterThanOrEqual(0);
});
test('processes restart', async () => {
const onStart = jest.fn();
const onEnd = jest.fn();
const onCustom = jest.fn();
worker.send(
[CHILD_MESSAGE_CALL, true, 'fatalExitCode', []],
onStart,
onEnd,
onCustom,
);
// Give it some time to restart some workers
await new Promise(resolve => setTimeout(resolve, 4000));
expect(startedWorkers).toBe(6);
expect(worker.isWorkerRunning()).toBeTruthy();
expect(worker.state).toEqual(WorkerStates.OK);
});
test('processes exits', async () => {
worker.forceExit();
await expect(() => worker.waitForWorkerReady()).rejects.toThrow(
'Worker state means it will never be ready: shutting-down',
);
});
});
});
// This describe block only applies to the child process worker since it's
// generally not possible for external processes to abruptly kill a thread of
// another process.
describe('should not hang on external process kill', () => {
let worker: ChildProcessWorker;
beforeEach(() => {
const options = {
childWorkerPath: processChildWorkerPath,
maxRetries: 0,
silent: true,
workerPath: join(__dirname, '__fixtures__', 'SelfKillWorker'),
} as unknown as WorkerOptions;
worker = new ChildProcessWorker(options);
});
afterEach(async () => {
await new Promise<void>(resolve => {
setTimeout(async () => {
if (worker) {
worker.forceExit();
await worker.waitForExit();
}
resolve();
}, 500);
});
});
// Regression test for https://github.com/facebook/jest/issues/13183
test('onEnd callback is called', async () => {
let onEndPromiseResolve: () => void;
let onEndPromiseReject: (err: Error) => void;
const onEndPromise = new Promise<void>((resolve, reject) => {
onEndPromiseResolve = resolve;
onEndPromiseReject = reject;
});
const onStart = jest.fn();
const onEnd = jest.fn((err: Error | null) => {
if (err) {
return onEndPromiseReject(err);
}
onEndPromiseResolve();
});
const onCustom = jest.fn();
await worker.waitForWorkerReady();
// The SelfKillWorker simulates an external process calling SIGTERM on it,
// but just SIGTERMs itself underneath the hood to make this test easier.
worker.send(
[CHILD_MESSAGE_CALL, true, 'selfKill', []],
onStart,
onEnd,
onCustom,
);
// The onEnd callback should be called when the child process exits.
await expect(onEndPromise).rejects.toBeInstanceOf(Error);
expect(onEnd).toHaveBeenCalled();
});
});