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