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