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