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