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