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