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