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