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