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