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