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