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