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