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