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