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