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