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