fix: fix worker node event emitter memory leak
[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
78f60f82
JB
10### Fixed
11
12- Remove all pool events listener at pool destroying.
13- Remove all worker node events listener at worker node destroying.
9f99eb9b 14- Fix worker node event emitter listeners handling memory leak at pool options runtime change.
78f60f82 15
0c08a681
JB
16## [3.0.8] - 2023-11-25
17
463226a4
JB
18### Fixed
19
20- Ensure continuous tasks stealing on idle start at worker node idling
21
14dad1fd
JB
22## [3.0.7] - 2023-11-24
23
65542a35
JB
24### Changed
25
26- Make continuous tasks stealing start at worker node idling.
27
82c5db63
JB
28## [3.0.6] - 2023-11-24
29
711623b8
JB
30### Fixed
31
b51d8596 32- Ensure pool statuses are checked at initialization, `start()` or `destroy()`.
55082af9 33- Ensure pool `ready` event can be emitted after several `start()/destroy()` cycles.
711623b8 34
5aa31a74
JB
35## [3.0.5] - 2023-10-27
36
d91689fd
JB
37### Fixed
38
55082af9 39- Ensure pool `ready` event can be emitted only once.
d91689fd 40
597775b2
JB
41## [3.0.4] - 2023-10-20
42
03fb313b
JB
43### Changed
44
49d60f11 45- Switch to Bencher for benchmarking: [https://bencher.dev/perf/poolifier](https://bencher.dev/perf/poolifier).
03fb313b
JB
46- Use builtin retry mechanism in worker choice strategies instead of custom one.
47
6c285176
JB
48## [3.0.3] - 2023-10-19
49
9761e404
JB
50### Fixed
51
52- Avoid null exception at sending message to worker.
535fd8d5 53- Avoid null exception at checking worker node readiness.
9761e404 54
358dc40f
JB
55## [3.0.2] - 2023-10-17
56
97256a85
JB
57### Fixed
58
c3c2b35e 59- Fix race condition at dynamic worker node task assignment and scheduled removal. See issue [#1468](https://github.com/poolifier/poolifier/issues/1468) and [#1496](https://github.com/poolifier/poolifier/issues/1496).
97256a85 60
7a570743
JB
61## [3.0.1] - 2023-10-16
62
dbfa7948
JB
63### Fixed
64
fc84edac 65- Workaround possible race condition at work nodes array element removal and querying. See issue [#1468](https://github.com/poolifier/poolifier/issues/1468).
dbfa7948 66
365f13e4
JB
67### Changed
68
c3c2b35e 69- Switch the worker node eventing code to `EventTarget` API.
365f13e4 70
003b3275
JB
71## [3.0.0] - 2023-10-08
72
277c49bf
JB
73### Changed
74
75- Remove Node.js 16.x.x (EOL) support.
76
3c9e911a
JB
77## [2.7.5] - 2023-10-03
78
f80125ca
JB
79### Changed
80
81- Use `EventEmitterAsyncResource` type from `@types/node` for pool event emitter. TypeScript users will need to update to latest `@types/node` version.
82
3466e757
JB
83## [2.7.4] - 2023-09-25
84
67b26ae2
JB
85### Fixed
86
87- Fix source maps (bundler issue).
88
eeb1f961
JB
89## [2.7.3] - 2023-09-24
90
b5604034
JB
91### Changed
92
93- Convert pool event emitter to event emitter async resource.
94
f2df6dc8
JB
95## [2.7.2] - 2023-09-23
96
116ca64b
JB
97### Changed
98
99- Add source maps to npm package to ease debugging.
100
1e319a70
JB
101### Added
102
103- Continuous benchmarking versus other worker pools: [https://poolifier.github.io/benchmark](https://poolifier.github.io/benchmark).
104
aab2819b
JB
105## [2.7.1] - 2023-09-20
106
ae036c3e
JB
107### Fixed
108
109- Ensure worker message listener used one time are removed after usage.
110
15d7c489
JB
111## [2.7.0] - 2023-09-19
112
160557ff
JB
113### Fixed
114
115- Fix task stealing related tasks queue options handling at runtime.
116
c3284191
JB
117### Changed
118
119- Rename `listTaskFunctions()` to `listTaskFunctionNames()` in pool and worker API.
120
121### Added
122
35808931 123- Add `hasTaskFunction()`, `addTaskFunction()`, `removeTaskFunction()`, `setDefaultTaskFunction()` methods to pool API: [PR #1148](https://github.com/poolifier/poolifier/pull/1148).
c20084b6 124- Stricter worker constructor arguments validation.
c3284191 125
04054352
JB
126## [2.6.45] - 2023-09-17
127
093af25b
JB
128### Changed
129
130- Disable publication on GitHub packages registry on release until authentication issue is fixed.
09d9af02
JB
131
132### Added
133
ce0ab2d7 134- Add `startWorkers` to pool options to whether start the minimum number of workers at pool initialization or not.
cde5b54e 135- Add `start()` method to pool API to start the minimum number of workers.
af98b972 136- Add `taskStealing` and `tasksStealingOnPressure` to tasks queue options to whether enable task stealing or not and whether enable tasks stealing under back pressure or not.
1e319a70 137- Continuous internal benchmarking: [https://poolifier.github.io/benchmark-results/dev/bench](https://poolifier.github.io/benchmark-results/dev/bench).
f1c674cd 138
bce9ffdf
JB
139## [2.6.44] - 2023-09-08
140
4cb259d3
JB
141### Fixed
142
143- Use a dedicated PAT to publish on GitHub packages registry.
144
145### Added
146
147- Publish on GitHub packages registry on release.
148
149### Changed
150
151- Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
152
fbda1e26
JB
153## [2.6.43] - 2023-09-08
154
15fc82ba
JB
155### Added
156
4cb259d3 157- Publish on GitHub packages registry on release.
15fc82ba
JB
158
159### Changed
160
4cb259d3 161- Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
15fc82ba 162
b47306a3
JB
163## [2.6.42] - 2023-09-06
164
ad11ca81
JB
165### Changed
166
167- Optimize hot code paths implementation: avoid unnecessary branching, add and use optimized helpers (min, max), use reduce() array helper, ...
168
1b37751d
JB
169## [2.6.41] - 2023-09-03
170
f3a91bac
JB
171### Changed
172
173- Optimize worker choice strategies implementation.
174
7790a494
JB
175## [2.6.40] - 2023-09-01
176
6fe200b4
JB
177### Fixed
178
179- Do not pre-choose in WRR worker choice strategy to avoid bias.
68738842 180- Avoid array out of bound in worker choice strategies after worker node removal.
6fe200b4 181
766c7f84
JB
182## [2.6.39] - 2023-08-30
183
edf8ce4e
JB
184### Fixed
185
4cb259d3 186- Fix race condition in worker choice strategies at worker node info querying while not yet initialized.
edf8ce4e 187
904a5689
JB
188## [2.6.38] - 2023-08-30
189
b40c4b06
JB
190### Added
191
192- Bundle typescript types declaration into one file.
193
619f403b
JB
194### Changed
195
196- Improve interleaved weighted round robin worker choice strategy implementation.
197
5a24d71c
JB
198## [2.6.37] - 2023-08-28
199
bdb9d712
JB
200### Fixed
201
202- Ensure unused worker usage statistics are deleted at runtime.
203
8c0b113f
JB
204### Changed
205
206- Rename worker choice strategy options `choiceRetries` to `retries`.
574c5c8d 207- Avoid unnecessary branching in worker choice strategies.
8c0b113f 208
ba821940
JB
209## [2.6.36] - 2023-08-27
210
9d2d0da1
JB
211### Fixed
212
213- Fix pool `execute()` arguments check.
214
1f0766e7
JB
215### Changed
216
217- Make continuous tasks stealing algorithm less aggressive.
8780236f 218- Fine tune tasks stealing algorithm under back pressure.
1f0766e7 219
ffd2c1ff
JB
220## [2.6.35] - 2023-08-25
221
dc021bcc
JB
222### Fixed
223
224- Don't account worker usage statistics for tasks that have failed.
3baa0837 225- Fix pool information runtime and wait time median computation.
dc021bcc
JB
226
227### Changed
228
229- Update simple moving average implementation to use a circular buffer.
230- Update simple moving median implementation to use a circular buffer.
68cbdc84
JB
231- Account for stolen tasks in worker usage statistics and pool information.
232
233### Added
234
235- Continuous tasks stealing algorithm.
dc021bcc 236
c58bc2a1
JB
237## [2.6.34] - 2023-08-24
238
0bc68267
JB
239### Fixes
240
241- Avoid cascading tasks stealing under back pressure.
242
243### Changed
244
245- Add fastpath to queued tasks rescheduling.
246
39fb7ad0
JB
247## [2.6.33] - 2023-08-24
248
dd951876
JB
249### Fixed
250
251- Fix queued tasks rescheduling.
252
ff3f866a
JB
253### Changed
254
255- Rename tasks queue options `queueMaxSize` to `size`.
256
a6b3272b 257### Added
dd951876 258
a6b3272b 259- Task stealing scheduling algorithm if tasks queueing is enabled.
dd951876 260
c55c9b5d
JB
261## [2.6.32] - 2023-08-23
262
15b176e0
JB
263### Fixed
264
265- Ensure no task can be executed when the pool is destroyed.
266
20c6f652
JB
267### Added
268
269- Add `queueMaxSize` option to tasks queue options.
574b351d 270- Add O(1) deque implementation implemented with doubly linked list and use it for tasks queueing.
72695f86 271- Add tasks stealing algorithm when a worker node queue is back pressured if tasks queueing is enabled.
20c6f652 272
e560a9f2
JB
273## [2.6.31] - 2023-08-20
274
b1aae695
JB
275### Fixed
276
3e8611a8 277- Fix worker choice strategy retries mechanism in some edge cases.
b1aae695 278
94407def
JB
279### Changed
280
e695d66f 281- Make orthogonal worker choice strategies tasks distribution and created dynamic worker usage.
a71b05bc 282- Remove the experimental status of the `LEAST_ELU` worker choice strategy.
94407def 283
962b9863
JB
284## [2.6.30] - 2023-08-19
285
33e6bb4c
JB
286### Fixed
287
288- Ensure pool event `backPressure` is emitted.
289- Ensure pool event `full` is emitted only once.
8735b4e5 290- Ensure worker node cannot be instantiated without proper arguments.
33e6bb4c 291
8cc4ea81
JB
292## [2.6.29] - 2023-08-18
293
6169563b
JB
294### Fixed
295
55082af9 296- Fix race condition between readiness and task functions worker message handling at startup.
5dd4043c 297- Fix duplicate task function worker usage statistics computation per task function.
db0e38ee 298- Update task function worker usage statistics if and only if there's at least two different task functions.
5bb5be17 299- Fix race condition at task function worker usage executing task computation leading to negative value.
6169563b 300
8990357d
JB
301### Added
302
445264e8 303- Add back pressure detection on the worker node queue. Event `backPressure` is emitted when all worker node queues are full (worker node queue size >= poolMaxSize^2).
8990357d
JB
304- Use back pressure detection in worker choice strategies.
305- Add worker choice strategies retries mechanism if no worker is eligible.
306
21157987
JB
307## [2.6.28] - 2023-08-16
308
f05ed93c
JB
309### Fixed
310
311- Ensure pool workers are properly initialized.
312
12d67776
JB
313### Added
314
315- HTTP server pool examples: express-cluster, express-hybrid.
316
d18fccb1
JB
317### Changed
318
319- Remove now useless branching in worker hot code path.
320
741cdb34
JB
321## [2.6.27] - 2023-08-15
322
50e7f498
JB
323### Fixed
324
325- Add `KillHandler` type definition to exported types.
326
ef3891a3
JB
327### Added
328
329- Add `destroy` event to pool API.
330
e9dc6efa
JB
331## [2.6.26] - 2023-08-15
332
2b099bf7
JB
333### Added
334
335- Add kill handler to worker options allowing to execute custom code when worker is killed.
ef3891a3 336- Add `listTaskFunctions()` method to pool API.
1f4553c6 337- SMTP client pool example: nodemailer.
2b099bf7 338
5b726f72
JB
339## [2.6.25] - 2023-08-13
340
72855e92
JB
341### Added
342
3b311539 343- HTTP server pool examples: fastify-cluster, fastify-hybrid.
02999424 344- WebSocket server pool examples: ws-cluster, ws-hybrid.
72855e92 345
7aadd6e5
JB
346## [2.6.24] - 2023-08-12
347
7d91a8cd
JB
348### Added
349
350- Add array of transferable objects to the `execute()` method arguments.
02999424 351- WebSocket server pool examples: ws-worker_threads.
7d91a8cd 352
6b4263b4
JB
353## [2.6.23] - 2023-08-11
354
3d76750a 355### Fixed
8e0af894 356
3d76750a 357- Fix pool busyness semantic when tasks queueing is enabled: the pool is busy when the number of executing tasks on each worker has reached the maximum tasks concurrency per worker.
9606b474 358
3d76750a
JB
359### Added
360
361- HTTP client pool examples: fetch, node-fetch and axios with multiple task functions.
02999424 362- HTTP server pool examples: express-worker_threads, fastify-worker_threads.
3d76750a
JB
363
364## [2.6.22] - 2023-08-10
9606b474 365
3d76750a 366### Fixed
9606b474
JB
367
368- Add missing `types` field to package.json `exports`.
369
3d76750a
JB
370### Changed
371
372- Structure markdown documentation (PR #811).
373
d9647bdd
JB
374## [2.6.21] - 2023-08-03
375
2111ec12
JB
376### Changed
377
378- Improve code documentation.
379- Code refactoring and cleanup for better maintainability and readability.
380
5c30b9d9
JB
381## [2.6.20] - 2023-07-21
382
10ecf8fd
JB
383### Fixed
384
385- Fix queued tasks redistribution on error task execution starvation.
a1763c54 386- Ensure tasks queueing per worker condition is untangled from the pool busyness semantic.
10ecf8fd 387
aa9eede8
JB
388### Changed
389
7c89e6a4 390- Drastically reduce lookups by worker in the worker nodes.
aa9eede8 391
62485908
JB
392## [2.6.19] - 2023-07-20
393
2e2ef9c3
JB
394### Added
395
396- Dedicated internal communication channel for worker_threads pools.
397
8f4c9491
JB
398## [2.6.18] - 2023-07-19
399
8660b972
JB
400### Changed
401
402- Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller.
403
206a3519
JB
404## [2.6.17] - 2023-07-16
405
b4899fae
JB
406### Added
407
1a3e01ba 408- Add `listTaskFunctions()` method to worker API.
b4899fae 409
58a06a6c
JB
410## [2.6.16] - 2023-07-12
411
2a69b8c5
JB
412### Fixed
413
80520ca4 414- Fix pool startup detection.
2a69b8c5
JB
415- Fix worker task functions handling.
416
b5900b02
JB
417## [2.6.15] - 2023-07-11
418
19dbc45b
JB
419### Added
420
421- Take into account worker node readiness in worker choice strategies.
422
4a0db581
JB
423## [2.6.14] - 2023-07-10
424
87e44747
JB
425### Fixed
426
427- Fix task function statistics tracking.
428
0265272f
JB
429## [2.6.13] - 2023-07-10
430
968a2e8c
JB
431### Added
432
433- Add per task function statistics tracking.
782299f8 434- Add public methods to manipulate the worker task functions at runtime.
968a2e8c 435
44c8c00f
JB
436## [2.6.12] - 2023-07-09
437
aa4bf4b2
JB
438### Fixed
439
440- Workaround import issue with `node:os` module in node 16.x.x.
441
b7cfced1
JB
442## [2.6.11] - 2023-07-09
443
d5024c00
JB
444### Fixed
445
446- Fix pool readiness semantic.
447
f313a208
JB
448## [2.6.10] - 2023-07-08
449
2431bdb4
JB
450### Fixed
451
452- Ensure workers are not recreated on error at pool startup.
453
454### Added
455
456- Add `ready` and `strategy` fields to pool information.
457- Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
caadbd41 458- Add dynamic pool sizing checks.
2431bdb4 459
369d0a51
JB
460## [2.6.9] - 2023-07-07
461
2845f2a5
JB
462### Fixed
463
464- Recreate the right worker type on uncaught exception.
465
466### Added
467
468- Add minimum and maximum to internal measurement statistics.
1dcf8b7b 469- Add `runTime` and `waitTime` to pool information.
75d3401a 470- Check worker inactive time only on dynamic worker.
2845f2a5 471
fc97d613
JB
472## [2.6.8] - 2023-07-03
473
92b1feaa
JB
474### Fixed
475
476- Brown paper bag release to fix version handling in pool information.
477
52d54060
JB
478## [2.6.7] - 2023-07-03
479
5bc91f3e
JB
480### Fixed
481
482- Ensure worker queued tasks at error are reassigned to other pool workers.
483
afe0d5bf
JB
484### Added
485
486- Add pool `utilization` ratio to pool information.
23ccf9d7 487- Add `version` to pool information.
e5b3047d 488- Add worker information to worker nodes.
afe0d5bf 489
f42c583f
JB
490## [2.6.6] - 2023-07-01
491
6961ca9a
JB
492### Added
493
d5e3c4ff 494- Add safe helper `availableParallelism()` to help sizing the pool.
6961ca9a 495
3749facb
JB
496### Fixed
497
498- Ensure message handler is only registered in worker.
499
6fed2513
JB
500## [2.6.5] - 2023-06-27
501
c72f6987
JB
502### Known issues
503
70726c28 504- Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
c72f6987
JB
505
506### Fixed
507
508- Artificial version bump to 2.6.5 to workaround publication issue.
d5e3c4ff 509- Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
c72f6987
JB
510- Ensure pool event is emitted before task error promise rejection.
511- Fix queued tasks count computation.
512
513### Removed
514
2fbe1783 515- Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
c72f6987 516
6426631b
JB
517## [2.6.4] - 2023-06-27
518
941f9a7c
JB
519### Known issues
520
70726c28 521- Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
941f9a7c 522
2c039e43
JB
523### Fixed
524
d5e3c4ff 525- Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
2c039e43 526- Ensure pool event is emitted before task error promise rejection.
9c16fb4b 527- Fix queued tasks count computation.
2c039e43 528
941f9a7c
JB
529### Removed
530
2fbe1783 531- Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
941f9a7c 532
bc1b0765
JB
533## [2.6.3] - 2023-06-19
534
a6a2dc4c
JB
535### Fixed
536
537- Ensure no tasks are queued when trying to soft kill a dynamic worker.
f0d7f803 538- Update strategies internals after statistics computation.
a6a2dc4c 539
7b56f532
JB
540### Changed
541
542- Optimize O(1) queue implementation.
543
b628596c
JB
544## [2.6.2] - 2023-06-12
545
a9e89d00
JB
546### Fixed
547
548- Fix new worker use after creation in dynamic pool given the current worker choice strategy.
549
4368a898
JB
550## [2.6.1] - 2023-06-10
551
931d43e2
JB
552### Added
553
13ab5b87 554- Add worker choice strategy documentation: [README.md](./docs/worker-choice-strategies.md).
931d43e2 555
f1c06930
JB
556### Fixed
557
558- Fix average statistics computation: ensure failed tasks are not accounted.
559
16671b07
JB
560## [2.6.0] - 2023-06-09
561
a1347286
JB
562### Added
563
5af9c0f7 564- Add `LEAST_ELU` worker choice strategy (experimental).
9adcefab 565- Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
a1347286 566
1c6fe997
JB
567### Changed
568
569- Refactor pool worker node usage internals.
477f48e7 570- Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
f63a9dda 571- Breaking change: pool information `info` property object fields have been renamed.
1c6fe997
JB
572
573### Fixed
574
575- Fix wait time accounting.
576- Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
577- Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
578
aa07d6ee
JB
579## [2.5.4] - 2023-06-07
580
b6b32453
JB
581### Added
582
583- Add Event Loop Utilization (ELU) statistics to worker tasks usage.
584
585### Changed
586
587- Compute statistics at the worker level only if needed.
2fbe1783 588- Add `worker_threads` options to thread pool options.
b6b32453 589
272d4d8f
JB
590### Fixed
591
592- Make the `LEAST_BUSY` strategy only relies on task runtime.
593
ed47fb3d
JB
594## [2.5.3] - 2023-06-04
595
89a4abfd
JB
596### Changed
597
598- Refine pool information content.
b4213b7f 599- Limit pool internals public exposure.
89a4abfd 600
8a9febf5
JB
601## [2.5.2] - 2023-06-02
602
91ee39ed
JB
603### Added
604
605- Add `taskError` pool event for task execution error.
6b27d407 606- Add pool information `info` property to pool.
91ee39ed
JB
607- Emit pool information on `busy` and `full` pool events.
608
8babb151
JB
609## [2.5.1] - 2023-06-01
610
0e05c4dc
JB
611### Added
612
1f68cede 613- Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
91ee39ed 614- Add `error` pool event for uncaught worker error.
0e05c4dc 615
a8766181
JB
616## [2.5.0] - 2023-05-31
617
e4543b14
JB
618### Added
619
620- Switch pool event emitter to `EventEmitterAsyncResource`.
6da80d38 621- Add tasks wait time accounting in per worker tasks usage.
5af9c0f7 622- Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
e4543b14
JB
623
624### Changed
625
626- Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
627
570efb11
JB
628## [2.4.14] - 2023-05-09
629
b0f28bad
JB
630### Fixed
631
632- Ensure no undefined task runtime can land in the tasks history.
633- Fix median computation implementation once again.
634
110b6d13
JB
635### Added
636
637- Unit tests for median and queue implementations.
638
72584880
JB
639## [2.4.13] - 2023-05-08
640
b0d6ed8f
JB
641### Fixed
642
e3058615 643- Fix worker choice strategy options validation.
b0d6ed8f
JB
644- Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
645
06140c32
JB
646## [2.4.12] - 2023-05-06
647
a86b6df1
JB
648### Added
649
650- Support multiple task functions per worker.
08f3f44c 651- Add custom worker weights support to worker choice strategies options.
a86b6df1 652
29ee7e9a
JB
653### Changed
654
655- Use O(1) queue implementation for tasks queueing.
656
0682ba15
JB
657### Fixed
658
659- Fix median computation implementation.
660- Fix fair share worker choice strategy internals update.
661
936d53ec
JB
662## [2.4.11] - 2023-04-23
663
cb70b19d
JB
664### Changed
665
666- Optimize free worker finding in worker choice strategies.
667
15bb637a
JB
668## [2.4.10] - 2023-04-15
669
ef41a6e6
JB
670### Fixed
671
82ea6492 672- Fix typescript type definition for task function: ensure the input data is optional.
ef41a6e6
JB
673- Fix typescript type definition for pool execute(): ensure the input data is optional.
674
181eb2b4
JB
675## [2.4.9] - 2023-04-15
676
a20f0ba5
JB
677### Added
678
679- Add tasks queue enablement runtime setter to pool.
680- Add tasks queue options runtime setter to pool.
681- Add worker choice strategy options runtime setter to pool.
682
683### Changed
684
685- Remove the tasks queuing experimental status.
686
d4aeae5a
JB
687### Fixed
688
82ea6492 689- Fix task function type definition and validation.
2fc5cae3 690- Fix worker choice strategy options handling.
d4aeae5a 691
1d9e7023
JB
692## [2.4.8] - 2023-04-12
693
f9b4bbf8
JB
694### Fixed
695
696- Fix message between main worker and worker type definition for tasks.
697- Fix code documentation.
698
12ae3210
JB
699## [2.4.7] - 2023-04-11
700
7171d33f
JB
701### Added
702
703- Add worker tasks queue options to pool options.
704
e8bd29ce
JB
705### Fixed
706
707- Fix missing documentation.
708
42c7bc10
JB
709## [2.4.6] - 2023-04-10
710
681196cc
JB
711### Fixed
712
713- Ensure one task at a time is executed per worker with tasks queueing enabled.
1c6fe997 714- Properly count worker executing tasks with tasks queueing enabled.
681196cc 715
54d360e3
JB
716## [2.4.5] - 2023-04-09
717
3fafb1b2
JB
718### Added
719
9e775f96
JB
720- Use monotonic high resolution timer for worker tasks runtime.
721- Add worker tasks median runtime to statistics.
ff733df7 722- Add worker tasks queue (experimental).
3fafb1b2 723
92fa3eb6
JB
724## [2.4.4] - 2023-04-07
725
aee46736
JB
726### Added
727
728- Add `PoolEvents` enumeration and `PoolEvent` type.
729
36b5e78f
JB
730### Fixed
731
ff0c2b3e 732- Destroy worker only on alive check.
36b5e78f 733
9fb0f324
JB
734## [2.4.3] - 2023-04-07
735
28cf3617
JB
736### Fixed
737
738- Fix typedoc generation with inheritance.
739
848f0f27
JB
740## [2.4.2] - 2023-04-06
741
164d950a
JB
742### Added
743
744- Add `full` event to dynamic pool.
32417142 745- Keep worker choice strategy in memory for conditional reuse.
164d950a 746
78ab2555
JB
747### Fixed
748
749- Fix possible negative worker key at worker removal in worker choice strategies.
750
79aafe9f
JB
751## [2.4.1] - 2023-04-05
752
9cd39dd4
JB
753### Changed
754
755- Optimize worker choice strategy for dynamic pool.
756
965415bb
JB
757### Fixed
758
759- Ensure dynamic pool does not alter worker choice strategy expected behavior.
760
d8b60b1c
JB
761## [2.4.0] - 2023-04-04
762
c6bd2650
JB
763### Added
764
765- Add `LESS_BUSY` worker choice strategy.
766
767### Changed
768
769- Optimize worker storage in pool.
770- Optimize worker alive status check.
771- BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
772- Optimize `LESS_USED` worker choice strategy.
2a87030e 773- Update benchmark versus external threads pools.
c6bd2650
JB
774- Optimize tasks usage statistics requirements for worker choice strategy.
775
776### Fixed
777
778- Ensure trimmable characters are checked at pool initialization.
779- Fix message id integer overflow.
780- Fix pool worker removal in worker choice strategy internals.
781- Fix package publication with pnpm.
782
d0a3f018
JB
783## [2.4.0-3] - 2023-04-04
784
b2ede285
JB
785### Added
786
787- Add `LESS_BUSY` worker choice strategy.
788
789### Changed
790
791- Optimize worker storage in pool.
792- Optimize worker alive status check.
793- BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
794- Optimize `LESS_USED` worker choice strategy.
2a87030e 795- Update benchmark versus external threads pools.
b2ede285
JB
796
797### Fixed
798
799- Ensure trimmable characters are checked at pool initialization.
800- Fix message id integer overflow.
801- Fix pool worker removal in worker choice strategy internals.
802- Fix package publication with pnpm.
803
a015ea40
JB
804## [2.4.0-2] - 2023-04-03
805
698f4bbc
JB
806### Added
807
808- Add `LESS_BUSY` worker choice strategy.
809
810### Changed
811
812- Optimize worker storage in pool.
813- Optimize worker alive status check.
814- BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
815- Optimize `LESS_USED` worker choice strategy.
816
817### Fixed
818
819- Ensure trimmable characters are checked at pool initialization.
820- Fix message id integer overflow.
821- Fix pool worker removal in worker choice strategy internals.
822- Fix package publication with pnpm.
823
8fe15920
JB
824## [2.4.0-1] - 2023-04-03
825
5b301c28
JB
826### Added
827
828- Add `LESS_BUSY` worker choice strategy.
829
830### Changed
831
832- Optimize worker storage in pool.
833- Optimize worker alive status check.
834- BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
835- Optimize `LESS_USED` worker choice strategy.
836
837### Fixed
838
839- Ensure trimmable characters are checked at pool initialization.
840- Fix message id integer overflow.
841- Fix pool worker removal in worker choice strategy internals.
842
2fb9ca9c
JB
843## [2.4.0-0] - 2023-04-03
844
168c526f
JB
845### Added
846
847- Add `LESS_BUSY` worker choice strategy.
848
1d71a908
JB
849### Changed
850
ffcbbad8 851- Optimize worker storage in pool.
1d71a908 852- Optimize worker alive status check.
65a60b3b 853- BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
737c6d97 854- Optimize `LESS_USED` worker choice strategy.
1d71a908 855
ffcbbad8
JB
856### Fixed
857
858- Ensure trimmable characters are checked at pool initialization.
b4e75778 859- Fix message id integer overflow.
97a2abc3 860- Fix pool worker removal in worker choice strategy internals.
ffcbbad8 861
08372738
JB
862## [2.3.10] - 2023-03-18
863
710826bc
JB
864### Fixed
865
9606b474 866- Fix package.json `exports` syntax for ESM and CommonJS.
710826bc
JB
867
868### Changed
869
870- Permit SemVer pre-release publication.
76e5ac6f 871
e4796ecd
JB
872## [2.3.10-2] - 2023-03-18
873
6abad580
JB
874### Fixed
875
9606b474 876- Fix package.json `exports` syntax for ESM and CommonJS.
6abad580 877
a2ee98cc
JB
878## [2.3.10-1] - 2023-03-18
879
7e060cee
JB
880### Changed
881
90483887 882- Permit SemVer pre-release publication.
7e060cee 883
c81bfafb
JB
884## [2.3.10-0] - 2023-03-18
885
fe18768d
JB
886### Fixed
887
9606b474 888- Fix package.json `exports` syntax for ESM and CommonJS.
fe18768d 889
d7b78217
JB
890## [2.3.9] - 2023-03-18
891
ed6dd37f
JB
892### Changed
893
894- Introduce ESM module support along with CommonJS one.
895
896### Fixed
897
898- Fix brown paper bag bug referencing the same object literal.
899
68e2ad86
JB
900## [2.3.8] - 2023-03-18
901
ca6c7d70
JB
902### Changed
903
904- Switch internal benchmarking code to benny.
fbdedeb9
JB
905- Switch to TypeScript 5.x.x.
906- Switch rollup bundler plugins to core ones.
ed6dd37f 907- Switch to TSDoc syntax.
fbdedeb9 908- Enforce conventional commits.
ca6c7d70 909
d15211d4
JB
910### Fixed
911
912- Fix random integer generator.
fbdedeb9 913- Fix worker choice strategy pool type identification at initialization.
d15211d4 914
995705ea
JB
915## [2.3.7] - 2022-10-23
916
b953022b
JB
917### Changed
918
919- Switch to open collective FOSS project funding platform.
78cea37e
JB
920- Switch to ts-standard linter configuration on TypeScript code.
921
922### Fixed
923
924- Fixed missing async on pool execute method.
925- Fixed typing in TypeScript example.
926- Fixed types in unit tests.
b953022b 927
3b9f6953
JB
928## [2.3.6] - 2022-10-22
929
f80cead4
JB
930### Changed
931
932- Cleanup pool attributes and methods.
933- Refine error types thrown.
934
935### Fixed
936
937- Fix continuous integration build on windows.
938- Fix code coverage reporting by using c8 instead of nyc.
939
efc22107
JB
940## [2.3.5] - 2022-10-21
941
7a6a0a96
JB
942### Changed
943
a05c10de
JB
944- Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
945- Optimize tasks usage lookup implementation.
7a6a0a96 946
b4904890
JB
947### Fixed
948
949- Fix missed pool event emitter type export.
950- Fix typedoc documentation generation.
951
a875f8d1
JB
952## [2.3.4] - 2022-10-17
953
73cda448
JB
954### Added
955
956- Fully automate release process with release-it.
957
45a5a54c
JB
958### Changed
959
73cda448 960- Optimize fair share task scheduling algorithm implementation.
2a87030e 961- Update benchmark versus external pools results with latest version.
45a5a54c 962
90ee1b18 963## [2.3.3] - 2022-10-15
1a76932b
JB
964
965### Added
966
967- Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
968
90ee1b18 969## [2.3.2] - 2022-10-14
11df3590
JB
970
971### Changed
972
973- Optimize fair share worker selection strategy implementation.
974
975### Fixed
976
977- Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
978
90ee1b18 979## [2.3.1] - 2022-10-13
23ff945a
JB
980
981### Added
982
983- Pool worker choice strategies:
984 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
985 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
986
90ee1b18 987## [2.2.2] - 2022-10-09
cb2b6c69
JB
988
989### Fixed
990
991- Fixed `README.md` file.
992
90ee1b18 993## [2.2.1] - 2022-10-08
bdacc2d2 994
bdaf31cd
JB
995### Added
996
997- Dynamic worker choice strategy change at runtime.
bdacc2d2 998
90ee1b18 999## [2.2.0] - 2022-01-05
7e0d447f
JB
1000
1001### Breaking Changes
1002
9606b474 1003- Support only Node.js version 16.x.x for cluster pool: upstream cluster API have changed on that version.
7e0d447f 1004
90ee1b18 1005## [2.1.0] - 2021-08-29
35cf1c03
JB
1006
1007### Added
1008
1009- Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
e088a00c
JB
1010
1011### Breaking Changes
1012
1013- `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
1014- `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
1015- `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
c365b2d3 1016- `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
e088a00c 1017
90ee1b18 1018## [2.0.2] - 2021-05-12
14916bf9
JB
1019
1020### Bug fixes
1021
1022- Fix `busy` event emission on fixed pool type
1023
90ee1b18 1024## [2.0.1] - 2021-03-16
7f685093
JB
1025
1026### Bug fixes
1027
1028- Check if pool options are properly set.
1029- `busy` event is emitted on all pool types.
1030
90ee1b18 1031## [2.0.0] - 2021-03-01
fa0f5b28 1032
f3f833ab 1033### Bug fixes
d63d3be3 1034
ddbeaffd 1035- Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
d63d3be3 1036
fa0f5b28
S
1037### Breaking Changes
1038
7f685093 1039- `FullPool` event is now renamed to `busy`.
1927ee67 1040- `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
1a81f8af 1041 _Find more details on our JSDoc._
ddbeaffd 1042
1927ee67
APA
1043- `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
1044
ddbeaffd 1045- We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
fa0f5b28 1046
ec2ccfc8
JB
1047### Pool options types declaration merge
1048
1049`FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
1050
fa0f5b28
S
1051#### New `export` strategy
1052
1053```js
1054// Before
0eee77cb 1055const DynamicThreadPool = require('poolifier/lib/dynamic')
fa0f5b28 1056// After
0eee77cb 1057const { DynamicThreadPool } = require('poolifier/lib/dynamic')
fa0f5b28
S
1058```
1059
1060But you should always prefer just using
1061
1062```js
0eee77cb 1063const { DynamicThreadPool } = require('poolifier')
fa0f5b28
S
1064```
1065
d3c8a1a8
S
1066#### New type definitions for input data and response
1067
6677a3d3 1068For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
9606b474 1069_This is not a limitation by poolifier but Node.js._
d3c8a1a8 1070
3a4b605f 1071#### Public property replacements
5c5a1fb7 1072
3a4b605f 1073`numWorkers` property is now `numberOfWorkers`
5c5a1fb7 1074
280c2a77 1075#### Internal (protected) properties and methods renaming
fa0f5b28 1076
280c2a77
S
1077These properties are not intended for end users
1078
1079- `id` => `nextMessageId`
1080
1081These methods are not intended for end users
fa0f5b28
S
1082
1083- `_chooseWorker` => `chooseWorker`
280c2a77 1084- `_newWorker` => `createWorker`
fa0f5b28
S
1085- `_execute` => `internalExecute`
1086- `_chooseWorker` => `chooseWorker`
1087- `_checkAlive` => `checkAlive`
1088- `_run` => `run`
1089- `_runAsync` => `runAsync`
1090
90ee1b18 1091## [1.1.0] - 2020-05-21
0312f71a
APA
1092
1093### Added
1094
1095- ThreadWorker support async functions as option
cf9aa6c3 1096- Various external library patches
0312f71a 1097
90ee1b18 1098## [1.0.0] - 2020-01-24
522eea03 1099
1100### Added
1101
1102- FixedThreadPool implementation
1103- DynamicThreadPool implementation
0312f71a 1104- WorkerThread implementation to improve developer experience