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