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