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