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