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