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