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