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