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