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