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