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