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