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