fix: ensure worker graceful shutdown is tried in cluster pool
[poolifier.git] / CHANGELOG.md
CommitLineData
522eea03 1# Changelog
2
3All notable changes to this project will be documented in this file.
4
d4abc60a 5The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
522eea03 6and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
45a5a54c
JB
8## [Unreleased]
9
bc1b0765
JB
10## [2.6.3] - 2023-06-19
11
a6a2dc4c
JB
12### Fixed
13
14- Ensure no tasks are queued when trying to soft kill a dynamic worker.
f0d7f803 15- Update strategies internals after statistics computation.
a6a2dc4c 16
7b56f532
JB
17### Changed
18
19- Optimize O(1) queue implementation.
20
b628596c
JB
21## [2.6.2] - 2023-06-12
22
a9e89d00
JB
23### Fixed
24
25- Fix new worker use after creation in dynamic pool given the current worker choice strategy.
26
4368a898
JB
27## [2.6.1] - 2023-06-10
28
931d43e2
JB
29### Added
30
31- Add worker choice strategy documentation: [README.md](./src/pools/selection-strategies/README.md).
32
f1c06930
JB
33### Fixed
34
35- Fix average statistics computation: ensure failed tasks are not accounted.
36
16671b07
JB
37## [2.6.0] - 2023-06-09
38
a1347286
JB
39### Added
40
5af9c0f7 41- Add `LEAST_ELU` worker choice strategy (experimental).
9adcefab 42- Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
a1347286 43
1c6fe997
JB
44### Changed
45
46- Refactor pool worker node usage internals.
477f48e7 47- Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
f63a9dda 48- Breaking change: pool information `info` property object fields have been renamed.
1c6fe997
JB
49
50### Fixed
51
52- Fix wait time accounting.
53- Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
54- Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
55
aa07d6ee
JB
56## [2.5.4] - 2023-06-07
57
b6b32453
JB
58### Added
59
60- Add Event Loop Utilization (ELU) statistics to worker tasks usage.
61
62### Changed
63
64- Compute statistics at the worker level only if needed.
90082c8c 65- Add `worker-threads` options to thread pool options.
b6b32453 66
272d4d8f
JB
67### Fixed
68
69- Make the `LEAST_BUSY` strategy only relies on task runtime.
70
ed47fb3d
JB
71## [2.5.3] - 2023-06-04
72
89a4abfd
JB
73### Changed
74
75- Refine pool information content.
b4213b7f 76- Limit pool internals public exposure.
89a4abfd 77
8a9febf5
JB
78## [2.5.2] - 2023-06-02
79
91ee39ed
JB
80### Added
81
82- Add `taskError` pool event for task execution error.
6b27d407 83- Add pool information `info` property to pool.
91ee39ed
JB
84- Emit pool information on `busy` and `full` pool events.
85
8babb151
JB
86## [2.5.1] - 2023-06-01
87
0e05c4dc
JB
88### Added
89
1f68cede 90- Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
91ee39ed 91- Add `error` pool event for uncaught worker error.
0e05c4dc 92
a8766181
JB
93## [2.5.0] - 2023-05-31
94
e4543b14
JB
95### Added
96
97- Switch pool event emitter to `EventEmitterAsyncResource`.
6da80d38 98- Add tasks wait time accounting in per worker tasks usage.
5af9c0f7 99- Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
e4543b14
JB
100
101### Changed
102
103- Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
104
570efb11
JB
105## [2.4.14] - 2023-05-09
106
b0f28bad
JB
107### Fixed
108
109- Ensure no undefined task runtime can land in the tasks history.
110- Fix median computation implementation once again.
111
110b6d13
JB
112### Added
113
114- Unit tests for median and queue implementations.
115
72584880
JB
116## [2.4.13] - 2023-05-08
117
b0d6ed8f
JB
118### Fixed
119
e3058615 120- Fix worker choice strategy options validation.
b0d6ed8f
JB
121- Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
122
06140c32
JB
123## [2.4.12] - 2023-05-06
124
a86b6df1
JB
125### Added
126
127- Support multiple task functions per worker.
08f3f44c 128- Add custom worker weights support to worker choice strategies options.
a86b6df1 129
29ee7e9a
JB
130### Changed
131
132- Use O(1) queue implementation for tasks queueing.
133
0682ba15
JB
134### Fixed
135
136- Fix median computation implementation.
137- Fix fair share worker choice strategy internals update.
138
936d53ec
JB
139## [2.4.11] - 2023-04-23
140
cb70b19d
JB
141### Changed
142
143- Optimize free worker finding in worker choice strategies.
144
15bb637a
JB
145## [2.4.10] - 2023-04-15
146
ef41a6e6
JB
147### Fixed
148
149- Fix typescript type definition for worker function: ensure the input data is optional.
150- Fix typescript type definition for pool execute(): ensure the input data is optional.
151
181eb2b4
JB
152## [2.4.9] - 2023-04-15
153
a20f0ba5
JB
154### Added
155
156- Add tasks queue enablement runtime setter to pool.
157- Add tasks queue options runtime setter to pool.
158- Add worker choice strategy options runtime setter to pool.
159
160### Changed
161
162- Remove the tasks queuing experimental status.
163
d4aeae5a
JB
164### Fixed
165
166- Fix worker function type definition and validation.
2fc5cae3 167- Fix worker choice strategy options handling.
d4aeae5a 168
1d9e7023
JB
169## [2.4.8] - 2023-04-12
170
f9b4bbf8
JB
171### Fixed
172
173- Fix message between main worker and worker type definition for tasks.
174- Fix code documentation.
175
12ae3210
JB
176## [2.4.7] - 2023-04-11
177
7171d33f
JB
178### Added
179
180- Add worker tasks queue options to pool options.
181
e8bd29ce
JB
182### Fixed
183
184- Fix missing documentation.
185
42c7bc10
JB
186## [2.4.6] - 2023-04-10
187
681196cc
JB
188### Fixed
189
190- Ensure one task at a time is executed per worker with tasks queueing enabled.
1c6fe997 191- Properly count worker executing tasks with tasks queueing enabled.
681196cc 192
54d360e3
JB
193## [2.4.5] - 2023-04-09
194
3fafb1b2
JB
195### Added
196
9e775f96
JB
197- Use monotonic high resolution timer for worker tasks runtime.
198- Add worker tasks median runtime to statistics.
ff733df7 199- Add worker tasks queue (experimental).
3fafb1b2 200
92fa3eb6
JB
201## [2.4.4] - 2023-04-07
202
aee46736
JB
203### Added
204
205- Add `PoolEvents` enumeration and `PoolEvent` type.
206
36b5e78f
JB
207### Fixed
208
ff0c2b3e 209- Destroy worker only on alive check.
36b5e78f 210
9fb0f324
JB
211## [2.4.3] - 2023-04-07
212
28cf3617
JB
213### Fixed
214
215- Fix typedoc generation with inheritance.
216
848f0f27
JB
217## [2.4.2] - 2023-04-06
218
164d950a
JB
219### Added
220
221- Add `full` event to dynamic pool.
32417142 222- Keep worker choice strategy in memory for conditional reuse.
164d950a 223
78ab2555
JB
224### Fixed
225
226- Fix possible negative worker key at worker removal in worker choice strategies.
227
79aafe9f
JB
228## [2.4.1] - 2023-04-05
229
9cd39dd4
JB
230### Changed
231
232- Optimize worker choice strategy for dynamic pool.
233
965415bb
JB
234### Fixed
235
236- Ensure dynamic pool does not alter worker choice strategy expected behavior.
237
d8b60b1c
JB
238## [2.4.0] - 2023-04-04
239
c6bd2650
JB
240### Added
241
242- Add `LESS_BUSY` worker choice strategy.
243
244### Changed
245
246- Optimize worker storage in pool.
247- Optimize worker alive status check.
248- BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
249- Optimize `LESS_USED` worker choice strategy.
250- Update benchmarks versus external threads pools.
251- Optimize tasks usage statistics requirements for worker choice strategy.
252
253### Fixed
254
255- Ensure trimmable characters are checked at pool initialization.
256- Fix message id integer overflow.
257- Fix pool worker removal in worker choice strategy internals.
258- Fix package publication with pnpm.
259
d0a3f018
JB
260## [2.4.0-3] - 2023-04-04
261
b2ede285
JB
262### Added
263
264- Add `LESS_BUSY` worker choice strategy.
265
266### Changed
267
268- Optimize worker storage in pool.
269- Optimize worker alive status check.
270- BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
271- Optimize `LESS_USED` worker choice strategy.
272- Update benchmarks versus external threads pools.
273
274### Fixed
275
276- Ensure trimmable characters are checked at pool initialization.
277- Fix message id integer overflow.
278- Fix pool worker removal in worker choice strategy internals.
279- Fix package publication with pnpm.
280
a015ea40
JB
281## [2.4.0-2] - 2023-04-03
282
698f4bbc
JB
283### Added
284
285- Add `LESS_BUSY` worker choice strategy.
286
287### Changed
288
289- Optimize worker storage in pool.
290- Optimize worker alive status check.
291- BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
292- Optimize `LESS_USED` worker choice strategy.
293
294### Fixed
295
296- Ensure trimmable characters are checked at pool initialization.
297- Fix message id integer overflow.
298- Fix pool worker removal in worker choice strategy internals.
299- Fix package publication with pnpm.
300
8fe15920
JB
301## [2.4.0-1] - 2023-04-03
302
5b301c28
JB
303### Added
304
305- Add `LESS_BUSY` worker choice strategy.
306
307### Changed
308
309- Optimize worker storage in pool.
310- Optimize worker alive status check.
311- BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
312- Optimize `LESS_USED` worker choice strategy.
313
314### Fixed
315
316- Ensure trimmable characters are checked at pool initialization.
317- Fix message id integer overflow.
318- Fix pool worker removal in worker choice strategy internals.
319
2fb9ca9c
JB
320## [2.4.0-0] - 2023-04-03
321
168c526f
JB
322### Added
323
324- Add `LESS_BUSY` worker choice strategy.
325
1d71a908
JB
326### Changed
327
ffcbbad8 328- Optimize worker storage in pool.
1d71a908 329- Optimize worker alive status check.
65a60b3b 330- BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
737c6d97 331- Optimize `LESS_USED` worker choice strategy.
1d71a908 332
ffcbbad8
JB
333### Fixed
334
335- Ensure trimmable characters are checked at pool initialization.
b4e75778 336- Fix message id integer overflow.
97a2abc3 337- Fix pool worker removal in worker choice strategy internals.
ffcbbad8 338
08372738
JB
339## [2.3.10] - 2023-03-18
340
710826bc
JB
341### Fixed
342
343- Fix `exports` syntax for ESM and CommonJS.
344
345### Changed
346
347- Permit SemVer pre-release publication.
76e5ac6f 348
e4796ecd
JB
349## [2.3.10-2] - 2023-03-18
350
6abad580
JB
351### Fixed
352
353- Fix `exports` syntax for ESM and CommonJS.
354
a2ee98cc
JB
355## [2.3.10-1] - 2023-03-18
356
7e060cee
JB
357### Changed
358
90483887 359- Permit SemVer pre-release publication.
7e060cee 360
c81bfafb
JB
361## [2.3.10-0] - 2023-03-18
362
fe18768d
JB
363### Fixed
364
365- Fix `exports` syntax for ESM and CommonJS.
366
d7b78217
JB
367## [2.3.9] - 2023-03-18
368
ed6dd37f
JB
369### Changed
370
371- Introduce ESM module support along with CommonJS one.
372
373### Fixed
374
375- Fix brown paper bag bug referencing the same object literal.
376
68e2ad86
JB
377## [2.3.8] - 2023-03-18
378
ca6c7d70
JB
379### Changed
380
381- Switch internal benchmarking code to benny.
fbdedeb9
JB
382- Switch to TypeScript 5.x.x.
383- Switch rollup bundler plugins to core ones.
ed6dd37f 384- Switch to TSDoc syntax.
fbdedeb9 385- Enforce conventional commits.
ca6c7d70 386
d15211d4
JB
387### Fixed
388
389- Fix random integer generator.
fbdedeb9 390- Fix worker choice strategy pool type identification at initialization.
d15211d4 391
995705ea
JB
392## [2.3.7] - 2022-10-23
393
b953022b
JB
394### Changed
395
396- Switch to open collective FOSS project funding platform.
78cea37e
JB
397- Switch to ts-standard linter configuration on TypeScript code.
398
399### Fixed
400
401- Fixed missing async on pool execute method.
402- Fixed typing in TypeScript example.
403- Fixed types in unit tests.
b953022b 404
3b9f6953
JB
405## [2.3.6] - 2022-10-22
406
f80cead4
JB
407### Changed
408
409- Cleanup pool attributes and methods.
410- Refine error types thrown.
411
412### Fixed
413
414- Fix continuous integration build on windows.
415- Fix code coverage reporting by using c8 instead of nyc.
416
efc22107
JB
417## [2.3.5] - 2022-10-21
418
7a6a0a96
JB
419### Changed
420
a05c10de
JB
421- Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
422- Optimize tasks usage lookup implementation.
7a6a0a96 423
b4904890
JB
424### Fixed
425
426- Fix missed pool event emitter type export.
427- Fix typedoc documentation generation.
428
a875f8d1
JB
429## [2.3.4] - 2022-10-17
430
73cda448
JB
431### Added
432
433- Fully automate release process with release-it.
434
45a5a54c
JB
435### Changed
436
73cda448 437- Optimize fair share task scheduling algorithm implementation.
eb4a8a82 438- Update benchmarks versus external pools results with latest version.
45a5a54c 439
90ee1b18 440## [2.3.3] - 2022-10-15
1a76932b
JB
441
442### Added
443
444- Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
445
90ee1b18 446## [2.3.2] - 2022-10-14
11df3590
JB
447
448### Changed
449
450- Optimize fair share worker selection strategy implementation.
451
452### Fixed
453
454- Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
455
90ee1b18 456## [2.3.1] - 2022-10-13
23ff945a
JB
457
458### Added
459
460- Pool worker choice strategies:
461 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
462 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
463
90ee1b18 464## [2.2.2] - 2022-10-09
cb2b6c69
JB
465
466### Fixed
467
468- Fixed `README.md` file.
469
90ee1b18 470## [2.2.1] - 2022-10-08
bdacc2d2 471
bdaf31cd
JB
472### Added
473
474- Dynamic worker choice strategy change at runtime.
bdacc2d2 475
90ee1b18 476## [2.2.0] - 2022-01-05
7e0d447f
JB
477
478### Breaking Changes
479
480- Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
481
90ee1b18 482## [2.1.0] - 2021-08-29
35cf1c03
JB
483
484### Added
485
486- Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
e088a00c
JB
487
488### Breaking Changes
489
490- `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
491- `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
492- `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
c365b2d3 493- `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
e088a00c 494
90ee1b18 495## [2.0.2] - 2021-05-12
14916bf9
JB
496
497### Bug fixes
498
499- Fix `busy` event emission on fixed pool type
500
90ee1b18 501## [2.0.1] - 2021-03-16
7f685093
JB
502
503### Bug fixes
504
505- Check if pool options are properly set.
506- `busy` event is emitted on all pool types.
507
90ee1b18 508## [2.0.0] - 2021-03-01
fa0f5b28 509
f3f833ab 510### Bug fixes
d63d3be3 511
ddbeaffd 512- Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
d63d3be3 513
fa0f5b28
S
514### Breaking Changes
515
7f685093 516- `FullPool` event is now renamed to `busy`.
1927ee67 517- `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
1a81f8af 518 _Find more details on our JSDoc._
ddbeaffd 519
1927ee67
APA
520- `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
521
ddbeaffd 522- We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
fa0f5b28 523
ec2ccfc8
JB
524### Pool options types declaration merge
525
526`FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
527
fa0f5b28
S
528#### New `export` strategy
529
530```js
531// Before
777b7824 532const DynamicThreadPool = require('poolifier/lib/dynamic')
fa0f5b28 533// After
777b7824 534const { DynamicThreadPool } = require('poolifier/lib/dynamic')
fa0f5b28
S
535```
536
537But you should always prefer just using
538
539```js
777b7824 540const { DynamicThreadPool } = require('poolifier')
fa0f5b28
S
541```
542
d3c8a1a8
S
543#### New type definitions for input data and response
544
ec2ccfc8 545For cluster worker and worker-thread pools, you can now only send and receive serializable data.
d3c8a1a8
S
546_This is not a limitation by poolifier but NodeJS._
547
3a4b605f 548#### Public property replacements
5c5a1fb7 549
3a4b605f 550`numWorkers` property is now `numberOfWorkers`
5c5a1fb7 551
280c2a77 552#### Internal (protected) properties and methods renaming
fa0f5b28 553
280c2a77
S
554These properties are not intended for end users
555
556- `id` => `nextMessageId`
557
558These methods are not intended for end users
fa0f5b28
S
559
560- `_chooseWorker` => `chooseWorker`
280c2a77 561- `_newWorker` => `createWorker`
fa0f5b28
S
562- `_execute` => `internalExecute`
563- `_chooseWorker` => `chooseWorker`
564- `_checkAlive` => `checkAlive`
565- `_run` => `run`
566- `_runAsync` => `runAsync`
567
90ee1b18 568## [1.1.0] - 2020-05-21
0312f71a
APA
569
570### Added
571
572- ThreadWorker support async functions as option
cf9aa6c3 573- Various external library patches
0312f71a 574
90ee1b18 575## [1.0.0] - 2020-01-24
522eea03 576
577### Added
578
579- FixedThreadPool implementation
580- DynamicThreadPool implementation
0312f71a 581- WorkerThread implementation to improve developer experience