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