-
Notifications
You must be signed in to change notification settings - Fork 549
/
autoscaled_pool.test.ts
543 lines (460 loc) · 18.1 KB
/
autoscaled_pool.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
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
import log from '@apify/log';
import { AutoscaledPool } from '@crawlee/core';
import { sleep } from '@crawlee/utils';
describe('AutoscaledPool', () => {
let logLevel: number;
beforeAll(() => {
logLevel = log.getLevel();
log.setLevel(log.LEVELS.ERROR);
});
afterAll(() => {
log.setLevel(logLevel);
});
test('should work with concurrency 1', async () => {
const range = [...Array(10).keys()];
const result: number[] = [];
let isFinished = false;
const runTaskFunction = () => {
if (range.length === 1) {
isFinished = true;
}
return new Promise((resolve) => {
const item = range.shift();
result.push(item);
setTimeout(resolve, 5);
});
};
const pool = new AutoscaledPool({
minConcurrency: 1,
maxConcurrency: 1,
runTaskFunction,
isFinishedFunction: () => Promise.resolve(isFinished),
isTaskReadyFunction: () => Promise.resolve(!isFinished),
});
await pool.run();
expect(result).toEqual([...Array(10).keys()]);
});
test('should work with concurrency 10', async () => {
const range = [...Array(100).keys()];
const result: number[] = [];
let isFinished = false;
const runTaskFunction = () => {
if (range.length === 1) {
isFinished = true;
}
return new Promise((resolve) => {
const item = range.shift();
result.push(item);
setTimeout(resolve, 5);
});
};
const pool = new AutoscaledPool({
minConcurrency: 10,
maxConcurrency: 10,
runTaskFunction,
isFinishedFunction: () => Promise.resolve(isFinished),
isTaskReadyFunction: () => Promise.resolve(!isFinished),
});
await pool.run();
expect(result).toEqual([...Array(100).keys()]);
});
test('enables setting concurrency', async () => {
const range = [...Array(100).keys()];
const result: number[] = [];
let isFinished = false;
const runTaskFunction = () => {
if (range.length === 1) {
isFinished = true;
}
return new Promise((resolve) => {
const item = range.shift();
result.push(item);
setTimeout(resolve, 5);
});
};
const pool = new AutoscaledPool({
// Test initial concurrency setting
minConcurrency: 3,
maxConcurrency: 13,
desiredConcurrency: 9,
runTaskFunction,
isFinishedFunction: () => Promise.resolve(isFinished),
isTaskReadyFunction: () => Promise.resolve(!isFinished),
});
expect(pool.minConcurrency).toBe(3);
expect(pool.maxConcurrency).toBe(13);
expect(pool.desiredConcurrency).toBe(9);
const promise = await pool.run();
// Test setting concurrency
pool.minConcurrency = 4;
pool.maxConcurrency = 14;
pool.desiredConcurrency = 7;
expect(pool.minConcurrency).toBe(4);
expect(pool.maxConcurrency).toBe(14);
expect(pool.desiredConcurrency).toBe(7);
await promise;
expect(result).toEqual([...Array(100).keys()]);
});
describe('should scale correctly', () => {
class MockSystemStatus {
okNow: boolean;
okLately: boolean;
getCurrentStatus: () => { isSystemIdle: boolean };
getHistoricalStatus: () => { isSystemIdle: boolean };
constructor(okNow: boolean, okLately: boolean) {
this.okNow = okNow;
this.okLately = okLately;
this.getCurrentStatus = () => ({ isSystemIdle: this.okNow });
this.getHistoricalStatus = () => ({ isSystemIdle: this.okLately });
}
}
let pool: AutoscaledPool;
let systemStatus: MockSystemStatus;
const cb = () => {};
beforeEach(() => {
systemStatus = new MockSystemStatus(true, true);
pool = new AutoscaledPool({
minConcurrency: 1,
maxConcurrency: 100,
runTaskFunction: async () => {},
isFinishedFunction: async () => false,
isTaskReadyFunction: async () => true,
});
// @ts-expect-error Mock
pool.systemStatus = systemStatus;
});
test('works with low values', () => {
// @ts-expect-error Calling private method
pool._autoscale(cb);
expect(pool.desiredConcurrency).toBe(2);
// @ts-expect-error Calling private method
pool._autoscale(cb);
expect(pool.desiredConcurrency).toBe(2); // because currentConcurrency is not high enough;
// @ts-expect-error Overwriting readonly private prop
pool._currentConcurrency = 2;
// @ts-expect-error Calling private method
pool._autoscale(cb);
expect(pool.desiredConcurrency).toBe(3);
systemStatus.okNow = false; // this should have no effect
// @ts-expect-error Overwriting readonly private prop
pool._currentConcurrency = 3;
// @ts-expect-error Calling private method
pool._autoscale(cb);
expect(pool.desiredConcurrency).toBe(4);
systemStatus.okLately = false;
// @ts-expect-error Calling private method
pool._autoscale(cb);
expect(pool.desiredConcurrency).toBe(3);
});
test('works with high values', () => {
// Should not scale because current concurrency is too low.
pool.desiredConcurrency = 50;
// @ts-expect-error Overwriting readonly private prop
pool._currentConcurrency = Math.floor(pool.desiredConcurrency * pool.desiredConcurrencyRatio) - 1;
systemStatus.okLately = true;
// @ts-expect-error Calling private method
pool._autoscale(cb);
expect(pool.desiredConcurrency).toBe(50);
// Should scale because we bumped up current concurrency.
// @ts-expect-error Overwriting readonly private prop
pool._currentConcurrency = Math.floor(pool.desiredConcurrency * pool.desiredConcurrencyRatio);
// @ts-expect-error Accessing private prop
let newConcurrency = pool.desiredConcurrency + Math.ceil(pool.desiredConcurrency * pool.scaleUpStepRatio);
// @ts-expect-error Calling private method
pool._autoscale(cb);
expect(pool.desiredConcurrency).toEqual(newConcurrency);
// Should scale down.
systemStatus.okLately = false;
// @ts-expect-error Accessing private prop
newConcurrency = pool.desiredConcurrency - Math.ceil(pool.desiredConcurrency * pool.scaleDownStepRatio);
// @ts-expect-error Calling private method
pool._autoscale(cb);
expect(pool.desiredConcurrency).toEqual(newConcurrency);
});
test('works at minConcurrency when currently overloaded', async () => {
let limit = 5;
let concurrencyLog: number[] = [];
let count = 0;
// @ts-expect-error Overwriting readonly private prop
pool.systemStatus.okNow = false;
// @ts-expect-error Overwriting readonly private prop
pool.runTaskFunction = async () => {
await sleep(10);
count++;
};
// @ts-expect-error Overwriting readonly private prop
pool.isFinishedFunction = async () => count >= limit;
// @ts-expect-error Overwriting readonly private prop
pool.isTaskReadyFunction = async () => count < limit;
pool.desiredConcurrency = 10;
// @ts-expect-error Overwriting readonly private prop
pool._currentConcurrency = pool.currentConcurrency;
Object.defineProperty(pool, 'currentConcurrency', {
get() {
return this._currentConcurrency;
},
set(v) {
concurrencyLog.push(v);
this._currentConcurrency = v;
},
});
expect(pool.currentConcurrency).toBe(0);
await pool.run();
expect(concurrencyLog.some((n) => n > 1)).toBe(false);
limit = 50;
concurrencyLog = [];
count = 0;
pool.minConcurrency = 5;
await pool.run();
expect(concurrencyLog.some((n) => n > 5)).toBe(false);
});
});
describe('should throw', () => {
// Turn off unnecessary error logging.
let originalLevel: number;
beforeAll(() => {
originalLevel = log.getLevel();
log.setLevel(log.LEVELS.OFF);
});
afterAll(() => {
log.setLevel(originalLevel);
});
test('when some of the promises throws', async () => {
let counter = 0;
const runTaskFunction = async () => {
counter++;
await sleep(1);
if (counter > 20) throw new Error('some-promise-error');
};
const pool = new AutoscaledPool({
maxConcurrency: 5,
minConcurrency: 5,
runTaskFunction,
isFinishedFunction: async () => counter > 200,
isTaskReadyFunction: async () => true,
});
await expect(pool.run()).rejects.toThrow('some-promise-error');
});
test('when runTaskFunction throws', async () => {
const runTaskFunction = async () => {
await sleep(3);
throw new Error('some-runtask-error');
};
const pool = new AutoscaledPool({
maxConcurrency: 1,
runTaskFunction,
isFinishedFunction: async () => false,
isTaskReadyFunction: async () => true,
});
await expect(pool.run()).rejects.toThrow('some-runtask-error');
});
test('when isFinishedFunction throws', async () => {
let count = 0;
const pool = new AutoscaledPool({
maxConcurrency: 1,
runTaskFunction: async () => {
count++;
},
isFinishedFunction: async () => {
throw new Error('some-finished-error');
},
isTaskReadyFunction: async () => {
return count < 1;
},
});
await expect(pool.run()).rejects.toThrow('some-finished-error');
});
test('when isTaskReadyFunction throws', async () => {
let count = 0;
const pool = new AutoscaledPool({
maxConcurrency: 1,
runTaskFunction: async () => { count++; },
isFinishedFunction: async () => false,
isTaskReadyFunction: async () => {
if (count > 1) throw new Error('some-ready-error');
else return true;
},
});
await expect(pool.run()).rejects.toThrow('some-ready-error');
});
});
test('should not handle tasks added after isFinishedFunction returned true', async () => {
const isFinished = async () => count > 10;
let count = 0;
// Run the pool and close it after 3s.
const pool = new AutoscaledPool({
minConcurrency: 3,
runTaskFunction: async () => sleep(1).then(() => { count++; }),
isFinishedFunction: isFinished,
isTaskReadyFunction: async () => !await isFinished(),
});
// @ts-expect-error Overwriting readonly private prop
pool.maybeRunIntervalMillis = 5;
await pool.run();
await sleep(10);
expect(count).toBeGreaterThanOrEqual(11);
// Check finished tasks.
expect(count).toBeLessThanOrEqual(13);
});
test('should break and resume when the task queue is empty for a while', async () => {
const finished: number[] = [];
let isFinished = false;
let isTaskReady = true;
let counter = 0;
const pool = new AutoscaledPool({
maxConcurrency: 1,
runTaskFunction: async () => {
await sleep(1);
if (counter === 10) { isTaskReady = false; setTimeout(() => { isTaskReady = true; }, 10); }
if (counter === 19) { isTaskReady = false; isFinished = true; }
counter++;
finished.push(Date.now());
},
isFinishedFunction: async () => isFinished,
isTaskReadyFunction: async () => !isFinished && isTaskReady,
});
// @ts-expect-error Overwriting readonly private prop
pool.maybeRunIntervalMillis = 1;
await pool.run();
// Check finished tasks.
expect(finished).toHaveLength(20);
expect(finished[11] - finished[10]).toBeGreaterThan(9);
});
test('should work with loggingIntervalSecs = null', async () => {
const pool = new AutoscaledPool({
minConcurrency: 1,
maxConcurrency: 100,
runTaskFunction: () => Promise.resolve(),
isFinishedFunction: () => Promise.resolve(false),
isTaskReadyFunction: () => Promise.resolve(true),
loggingIntervalSecs: null,
});
// @ts-expect-error Calling private method
pool._autoscale(() => {});
expect(pool.desiredConcurrency).toBe(2);
});
test('should abort', async () => {
let finished = false;
let aborted = false;
const pool = new AutoscaledPool({
runTaskFunction: async () => {
if (!aborted) {
await pool.abort();
aborted = true;
} else {
return null;
}
},
isFinishedFunction: async () => { finished = true; return true; },
isTaskReadyFunction: async () => !aborted,
});
await pool.run();
expect(finished).toBe(false);
});
test('should only finish after tasks complete', async () => {
let started = false;
let completed = false;
const pool = new AutoscaledPool({
runTaskFunction: async () => {
started = true;
await sleep(100);
completed = true;
},
isFinishedFunction: async () => {
return started;
},
isTaskReadyFunction: async () => {
return !started;
},
});
await pool.run();
expect(started).toBe(true);
expect(completed).toBe(true);
});
test('should pause and resume', async () => {
let count = 0;
const results: number[] = [];
let pauseResolve: (value: unknown) => void;
const pausePromise = new Promise((res) => { pauseResolve = res; });
const pool = new AutoscaledPool({
maybeRunIntervalSecs: 0.01,
minConcurrency: 10,
runTaskFunction: async () => {
results.push(count++);
if (count === 20) {
void pool.pause().then(pauseResolve);
}
},
isFinishedFunction: async () => !(count < 50),
isTaskReadyFunction: async () => count < 50,
});
let finished = false;
const runPromise = pool.run();
void runPromise.then(() => { finished = true; });
await pausePromise;
expect(count).toBe(20);
expect(finished).toBe(false);
expect(results).toHaveLength(count);
results.forEach((r, i) => expect(r).toEqual(i));
pool.resume();
await runPromise;
expect(count).toBe(50);
expect(finished).toBe(true);
expect(results).toHaveLength(count);
results.forEach((r, i) => expect(r).toEqual(i));
});
test('should timeout after taskTimeoutSecs', async () => {
const runTaskFunction = async () => {
await sleep(1e3);
return 1;
};
const pool = new AutoscaledPool({
minConcurrency: 1,
maxConcurrency: 1,
runTaskFunction,
taskTimeoutSecs: 0.1,
isFinishedFunction: async () => false,
isTaskReadyFunction: async () => true,
});
const now = Date.now();
await expect(pool.run()).rejects.toThrow('runTaskFunction timed out after 0.1 seconds.');
expect(Date.now() - now).toBeGreaterThanOrEqual(100);
});
test('should not timeout if taskTimeoutSecs === 0', async () => {
let finished = false;
const runTaskFunction = async () => {
await sleep(1e3);
finished = true;
return 1;
};
const pool = new AutoscaledPool({
minConcurrency: 1,
maxConcurrency: 1,
runTaskFunction,
taskTimeoutSecs: 0,
isFinishedFunction: async () => finished,
isTaskReadyFunction: async () => !finished,
});
const now = Date.now();
await expect(pool.run()).resolves.toBeUndefined();
expect(Date.now() - now).toBeGreaterThanOrEqual(1e3);
}, 10e3);
test('should not timeout if taskTimeoutSecs not explicitly set', async () => {
let finished = false;
const runTaskFunction = async () => {
await sleep(1e3);
finished = true;
return 1;
};
const pool = new AutoscaledPool({
minConcurrency: 1,
maxConcurrency: 1,
runTaskFunction,
isFinishedFunction: async () => finished,
isTaskReadyFunction: async () => !finished,
});
const now = Date.now();
await expect(pool.run()).resolves.toBeUndefined();
expect(Date.now() - now).toBeGreaterThanOrEqual(1e3);
}, 10e3);
});