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