3 All notable changes to this project will be documented in this file.
5 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
8 ## [4.0.16](https://github.com/poolifier/poolifier/compare/v4.0.15...v4.0.16) (2024-07-05)
11 ### 📚 Documentation
13 * generate documentation ([224d008](https://github.com/poolifier/poolifier/commit/224d008191f52fa20b93e1ba67919569f8d6e315))
14 * generate documentation ([627fc57](https://github.com/poolifier/poolifier/commit/627fc572465ba2113cbf3df6bd055c3242ecd0fe))
15 * refine PR template ([f5e9127](https://github.com/poolifier/poolifier/commit/f5e91274ea67f61521fadf0ccbafc6d00f5d3b87))
16 * refine PR template ([e95501c](https://github.com/poolifier/poolifier/commit/e95501c05febf08366d375218728d5778432c1de))
17 * refine README.md badges ([7169bda](https://github.com/poolifier/poolifier/commit/7169bda30538a5244b2598a4ef466c5687953ebd))
22 * **ci:** cleanup GH actions ([c5db2d3](https://github.com/poolifier/poolifier/commit/c5db2d3ea50692486410eb1a33e5bb51d6d4181e))
23 * code reformatting ([fe6df28](https://github.com/poolifier/poolifier/commit/fe6df2852c1f0964cdffb0698461c9d66b1cf7ed))
24 * refine biome.js configuration ([1352ca7](https://github.com/poolifier/poolifier/commit/1352ca70c0b5c6b4ff3813b0c24354b5514b2796))
25 * silence linter ([a17b6fe](https://github.com/poolifier/poolifier/commit/a17b6fe6a9b7cde367fa1f1a0a89f6ee5db46ad6))
30 * **ci:** add autofix GH action ([14b39b9](https://github.com/poolifier/poolifier/commit/14b39b9c09ab382fa25dcb0d52c50b6d05a3affb))
31 * **ci:** do not cancel workflow in case of autofix failure ([177dbab](https://github.com/poolifier/poolifier/commit/177dbab8accac6267be8973103757de31f4a4c23))
32 * **ci:** fix autofix GH action ([e3a9678](https://github.com/poolifier/poolifier/commit/e3a9678311f735b7c951c5d72f26ef86c7beca9c))
33 * **ci:** fix autofix GH action ([0b7cbf7](https://github.com/poolifier/poolifier/commit/0b7cbf73dfdc8346132c002ba9c83fdafe286ee2))
34 * **ci:** fix eslint configuration ([c5d7f73](https://github.com/poolifier/poolifier/commit/c5d7f736e1e8c36a2c2d9cbe30e86d1d3ba863a1))
35 * **ci:** publish documentation at release ([3a83d94](https://github.com/poolifier/poolifier/commit/3a83d94cd44b504e3b9a3f3b15e9dec4f8c33d49))
36 * **ci:** refine autofix GH action ([8b7aa42](https://github.com/poolifier/poolifier/commit/8b7aa4204c27efd1dc699f7baea65b5262bd26b3))
37 * **ci:** refine autofix GH action ([8ab143b](https://github.com/poolifier/poolifier/commit/8ab143bb67ef7fb367d771c652cc44df70c9b625))
38 * **ci:** switch to release-please release manager ([4c7e68a](https://github.com/poolifier/poolifier/commit/4c7e68aa71533a8ef98296d2f50a2aac898d6b17))
39 * **deps-dev:** apply updates ([5c48a85](https://github.com/poolifier/poolifier/commit/5c48a8596b49dec06ec8995df4941ad63cc68f46))
40 * **deps-dev:** apply updates ([f94bb23](https://github.com/poolifier/poolifier/commit/f94bb23c8a460415f01bee2a34bf1e56b74236a8))
41 * **deps-dev:** apply updates ([1e98512](https://github.com/poolifier/poolifier/commit/1e9851233c950074ccbb5cd525fc0f4075e491d4))
42 * **deps-dev:** apply updates ([aaceda9](https://github.com/poolifier/poolifier/commit/aaceda9e4a134d9f8d3db37e349a18e7b2b1c303))
43 * **deps-dev:** apply updates ([3dcc95e](https://github.com/poolifier/poolifier/commit/3dcc95e54a6bfeb4b27460d60d3c90d27ac352dd))
44 * **deps-dev:** apply updates ([0aa0016](https://github.com/poolifier/poolifier/commit/0aa00166eaa9a8c9b505b4fa7fd5dc50d831b7ef))
45 * **deps-dev:** apply updates ([dea4237](https://github.com/poolifier/poolifier/commit/dea42379cfdbcf1c1c9800df7c097eab484ebc07))
46 * **deps-dev:** apply updates ([e06ce0e](https://github.com/poolifier/poolifier/commit/e06ce0ec82c8c076d6136f85f12101181d922612))
47 * **deps-dev:** apply updates ([80605a6](https://github.com/poolifier/poolifier/commit/80605a6c89c41c5b71e83385f615f85483987ea1))
48 * **deps-dev:** apply updates ([3b594fe](https://github.com/poolifier/poolifier/commit/3b594fe1b0f89d6665da2eb2ebdc14eb7628fe70))
49 * **deps-dev:** apply updates ([df01d9a](https://github.com/poolifier/poolifier/commit/df01d9a8a7053a4ff33e704cd5493f0a7bc4e2e7))
50 * **deps-dev:** apply updates ([a1b4a65](https://github.com/poolifier/poolifier/commit/a1b4a65143c0253b57fee18affd88a554122e955))
51 * **deps-dev:** apply updates ([31a42de](https://github.com/poolifier/poolifier/commit/31a42de7d691911759e12a673e5a2153f5558ed8))
52 * **deps-dev:** bump @cspell/eslint-plugin from 8.9.0 to 8.9.1 ([0b4d6a4](https://github.com/poolifier/poolifier/commit/0b4d6a4b0255f0172da50a9ba3989d21725027a5))
53 * **deps-dev:** bump eslint-plugin-jsdoc from 48.2.13 to 48.4.0 ([195a874](https://github.com/poolifier/poolifier/commit/195a874e9537a715e04b54e44c9a4eef04b1fefa))
54 * **deps-dev:** bump mocha from 10.4.0 to 10.5.0 ([b1b2093](https://github.com/poolifier/poolifier/commit/b1b20933105fb3c21f3d3825dc18a87501ad8275))
55 * **deps-dev:** bump mocha from 10.5.1 to 10.5.2 ([a4d1195](https://github.com/poolifier/poolifier/commit/a4d1195cd5b6d60f0d4424b32c638d304023e15e))
56 * **deps-dev:** bump neostandard from 0.7.2 to 0.8.0 ([7344812](https://github.com/poolifier/poolifier/commit/7344812ff30f82f3b7b88383eca5564c398d2de0))
57 * **deps-dev:** bump typedoc from 0.26.0 to 0.26.2 ([8004ea7](https://github.com/poolifier/poolifier/commit/8004ea76f77c3dee098569b37bc9dec9e82f8fe3))
58 * **deps-dev:** bump typescript ([fca1e52](https://github.com/poolifier/poolifier/commit/fca1e522f2df0e93e302e6278dc4725b2e28f561))
59 * **deps-dev:** bump typescript ([345d416](https://github.com/poolifier/poolifier/commit/345d416980bd3204398e730ca259d1755dcd0f64))
60 * **deps-dev:** bump typescript ([3aa8d66](https://github.com/poolifier/poolifier/commit/3aa8d6646706dd32bbd96795330f0a5365d52efa))
61 * **deps-dev:** bump typescript ([8837306](https://github.com/poolifier/poolifier/commit/8837306853d6b01efaf67bf69f129fc9ca47b071))
62 * **deps-dev:** bump typescript ([0b79799](https://github.com/poolifier/poolifier/commit/0b797997c9340aac75c7be6e5559b08076c387e7))
63 * **deps-dev:** bump typescript ([995d429](https://github.com/poolifier/poolifier/commit/995d429cce313177943d54e9c1f3e02a1cdc8c31))
64 * **deps-dev:** bump typescript ([2905914](https://github.com/poolifier/poolifier/commit/2905914e6e410cff2a1f8a75c8184abf701d7a16))
65 * **deps-dev:** bump typescript ([f2c2f1b](https://github.com/poolifier/poolifier/commit/f2c2f1b196b0cac64235304b5df4b24a97d09ffb))
66 * **deps-dev:** bump typescript ([37b0774](https://github.com/poolifier/poolifier/commit/37b07742956c3d25debda0048a60afd3659b547f))
67 * **deps-dev:** bump typescript ([f4a2509](https://github.com/poolifier/poolifier/commit/f4a2509b88456b0f6d16c8348c1e07470a94415f))
68 * **deps-dev:** bump typescript ([97bb99a](https://github.com/poolifier/poolifier/commit/97bb99ac1e28c87f59b75ea23a9c6643a8fba9c4))
69 * **deps:** bump poolifier ([5d5410e](https://github.com/poolifier/poolifier/commit/5d5410ec4203bc1ffa0a81fa52de85971916fed8))
70 * **deps:** bump poolifier ([177e46b](https://github.com/poolifier/poolifier/commit/177e46bb9cab33ad65c64b3dd5fd524bb0ac1eef))
71 * **deps:** bump poolifier ([580433b](https://github.com/poolifier/poolifier/commit/580433bc22585b6565a3404466a13e5babfd23fa))
72 * **deps:** bump poolifier ([a0583d4](https://github.com/poolifier/poolifier/commit/a0583d40e971f43f47b79fd049e99c069db8cac1))
73 * **deps:** bump poolifier ([161136f](https://github.com/poolifier/poolifier/commit/161136fe626ea7de93956b2e1e6228ffd6eba209))
74 * **deps:** bump poolifier ([70075ce](https://github.com/poolifier/poolifier/commit/70075ce9218f5a5a07c0decf0068775ae351c356))
75 * **deps:** bump poolifier ([d74c068](https://github.com/poolifier/poolifier/commit/d74c0684cb549b12897e79e31508b3cad5152456))
76 * **deps:** bump poolifier ([b8e4e7d](https://github.com/poolifier/poolifier/commit/b8e4e7dec768e992ba38e29dee0a0194eeb4fd50))
77 * **deps:** bump poolifier ([239d223](https://github.com/poolifier/poolifier/commit/239d22372bddd21106b22361038be2f3aae6e5de))
78 * **deps:** bump poolifier in /examples/typescript/http-client-pool ([1e6c12d](https://github.com/poolifier/poolifier/commit/1e6c12d988c87fdf1f95a2ffece8c1c76e49bcf3))
79 * **deps:** bump poolifier in /examples/typescript/smtp-client-pool ([4c29535](https://github.com/poolifier/poolifier/commit/4c29535a8e8669608907f0db799efa1c94f17421))
80 * **deps:** bump ws ([5ae7d26](https://github.com/poolifier/poolifier/commit/5ae7d26a61d9a13e49ccde6117c02d26f49d841d))
81 * **deps:** bump ws ([5fea98e](https://github.com/poolifier/poolifier/commit/5fea98eac18f518cb3c76dfed5e514e1aa27ecee))
82 * **deps:** bump ws ([cf6f83d](https://github.com/poolifier/poolifier/commit/cf6f83dd588e71b440f1454dd592c1e8029ada6d))
84 ## [4.0.15] - 2024-06-20
88 - Fix priority queue dequeue() from the last prioritized bucket.
90 ## [4.0.14] - 2024-06-12
94 - Add mapExecute() helper to execute a task function on an iterable data's input.
96 ## [4.0.13] - 2024-05-29
100 - Optimize tasks queue implementation.
101 - Enable prioritized tasks queueing only when necessary.
103 ## [4.0.12] - 2024-05-25
107 - Optimize circular buffer implementation to store task execution measurements.
109 ## [4.0.11] - 2024-05-21
113 - Switch to optimized circular buffer implementation to store task execution measurements.
115 ## [4.0.10] - 2024-05-20
119 - Ensure tasks stealing dynamic worker node is not destroyed on inactivity.
121 ## [4.0.9] - 2024-05-19
125 - Add ELU `utilization` statistics to pool information.
127 ## [4.0.8] - 2024-05-15
131 - Fix default task function worker choice strategy and priority handling.
133 ## [4.0.7] - 2024-05-13
137 - Add ELU statistics to pool information.
139 ## [4.0.6] - 2024-05-10
143 - Fix pools' `addTaskFunction()` type definition.
145 ## [4.0.5] - 2024-05-09
149 - Avoid queued tasks redistribution on the errored worker node.
151 ## [4.0.4] - 2024-05-08
155 - Disable `tasksStealingOnBackPressure` by default until performance issues under heavy load are sorted out.
157 ## [4.0.3] - 2024-05-08
161 - Optimize task(s) stealing by dequeuing task(s) from the last prioritized bucket.
163 ## [4.0.2] - 2024-05-06
167 - Ensure poolifier worker task performance measurement requirements are synchronized with task function objects' worker choice strategies.
169 ## [4.0.1] - 2024-05-02
173 - Ensure dynamic worker node are initialized with sensible worker node usage default values to avoid worker choice strategies biased decisions.
174 - Account for tasks wait time in task execution time computation in worker choice strategies to avoid biased decisions under load with several prioritized task functions and tasks queue enabled.
176 ## [4.0.0] - 2024-04-30
180 - Support per task function(s) priority and worker choice strategy definition via a task function object: `{ taskFunction: (data?: Data) => Response | Promise<Response>, priority?: number, strategy?: WorkerChoiceStrategy }`.
181 - Add priority queue based tasks queueing. One priority queue is divided into prioritized buckets to avoid queued tasks starvation under load.
182 - BREAKING CHANGE: `listTaskFunctionNames()` to `listTaskFunctionsProperties()` in pool and worker API returning registered task functions properties.
183 - BREAKING CHANGE: `strategy` field in pool information renamed to `defaultStrategy`.
187 - Ensure worker choice strategy options changes at runtime are propagated to poolifier workers.
189 ## [3.1.30] - 2024-04-22
193 - Fix `transferList` argument type definition.
195 ## [3.1.29] - 2024-04-02
199 - Fix possible race condition at worker node recreation on worker `error` and `exit` events.
201 ## [3.1.28] - 2024-04-01
205 - Ensure the minimum number of workers on a started pool is guaranteed.
207 ## [3.1.27] - 2024-03-27
211 - Fix publishing on JSR, take 4.
213 ## [3.1.26] - 2024-03-27
217 - Fix publishing on JSR, take 3.
219 ## [3.1.25] - 2024-03-27
223 - Fix publishing on JSR, take 2.
225 ## [3.1.24] - 2024-03-27
229 - Fix publishing on JSR.
231 ## [3.1.23] - 2024-03-27
237 ## [3.1.22] - 2024-03-15
241 - Fix pool event emitter registered callbacks removal at `destroy()`.
243 ## [3.1.21] - 2024-02-22
247 - Fix null exception regression: [#1496](https://github.com/poolifier/poolifier/issues/1496).
249 ## [3.1.20] - 2024-02-11
253 - Ensure `worker_threads` workers are unreferenced at termination.
255 ## [3.1.19] - 2024-01-16
259 - Fix possible null exception at task finishing handling.
263 - Optimize Deque implementation to improve tasks queueing performance.
265 ## [3.1.18] - 2024-01-06
269 - Fix dynamic pool with minimum number of workers set to zero: [#1748](https://github.com/poolifier/poolifier/issues/1748).
271 ## [3.1.17] - 2024-01-05
275 - Improve performance by clean up unneeded condition checks on hot code paths.
277 ## [3.1.16] - 2024-01-03
281 - Add missing type to TS type definitions.
283 ## [3.1.15] - 2024-01-02
287 - Fix CommonJS support with TypeScript: [#1821](https://github.com/poolifier/poolifier/issues/1821).
289 ## [3.1.15-0] - 2024-01-02
293 - Fix CommonJS support with TypeScript: [#1821](https://github.com/poolifier/poolifier/issues/1821).
295 ## [3.1.14] - 2024-01-01
299 - Properly handle dynamic pool with zero minimum size.
301 ## [3.1.13] - 2023-12-30
305 - Reduce branching in several hot code paths.
306 - Use faster object cloning implementation.
308 ## [3.1.12] - 2023-12-27
312 - Fix tasks redistribution triggers at pool destroying.
316 - Switch TypeScript module resolution to Node16.
318 ## [3.1.12-0] - 2023-12-27
322 - Fix tasks redistribution triggers at pool destroying.
324 ## [3.1.11] - 2023-12-24
328 - Avoid worker node cross tasks stealing.
329 - Ensure only half the pool worker nodes can steal tasks.
331 ## [3.1.10] - 2023-12-23
335 - Avoid useless branching on pool type.
337 ## [3.1.9] - 2023-12-22
341 - Readd ThreadPoolOptions and ClusterPoolOptions TS type aliases to PoolOptions.
343 ## [3.1.8] - 2023-12-21
347 - Fix default worker weight computation.
348 - Fix possible null exception at pool destroying.
350 ## [3.1.7] - 2023-12-20
354 - Ensure worker choice strategies implementation wait for worker node readiness: [#1748](https://github.com/poolifier/poolifier/issues/1748).
356 ## [3.1.6] - 2023-12-18
360 - Fix pool destroying with tasks queuing enabled.
362 ## [3.1.5] - 2023-12-18
366 - Add queued tasks end timeout support to worker node termination.
368 ## [3.1.4] - 2023-12-18
372 - Make more robust the fix for possible null exception at handling task execution response.
374 ## [3.1.3] - 2023-12-17
378 - Fix possible null exception at handling task execution response.
380 ## [3.1.2] - 2023-12-17
384 - Wait for queued tasks to end at worker node termination.
386 ## [3.1.1] - 2023-12-16
390 - Fix pool options TS type definition.
392 ## [3.1.0] - 2023-12-16
396 - TypeScript breaking change: merge ThreadPoolOptions and ClusterPoolOptions types into PoolOptions type.
398 ## [3.0.14] - 2023-12-13
402 - Fix possible null exception with worker_threads pools.
404 ## [3.0.13] - 2023-12-12
408 - Ensure worker choice strategy wait for worker nodes readiness.
412 - Remove infinite retries support in worker choice strategy to avoid configuration leading to possible infinite recursion or loop.
414 ## [3.0.12] - 2023-12-12
418 - Add infinite retries support in worker choice strategy.
420 ## [3.0.11] - 2023-12-11
424 - Ensure pool asynchronous resource properly track tasks execution.
426 ## [3.0.10] - 2023-12-08
430 - Add a fastpath when tasks stealing or redistribution is impossible.
432 ## [3.0.9] - 2023-11-26
436 - Remove all pool events listener at pool destroying.
437 - Remove all worker node events listener at worker node destroying.
438 - Fix worker node event emitter listeners handling memory leak at pool options runtime change.
440 ## [3.0.8] - 2023-11-25
444 - Ensure continuous tasks stealing on idle start at worker node idling.
446 ## [3.0.7] - 2023-11-24
450 - Make continuous tasks stealing start at worker node idling.
452 ## [3.0.6] - 2023-11-24
456 - Ensure pool statuses are checked at initialization, `start()` or `destroy()`.
457 - Ensure pool `ready` event can be emitted after several `start()/destroy()` cycles.
459 ## [3.0.5] - 2023-10-27
463 - Ensure pool `ready` event can be emitted only once.
465 ## [3.0.4] - 2023-10-20
469 - Switch to Bencher for benchmarking: [https://bencher.dev/perf/poolifier](https://bencher.dev/perf/poolifier).
470 - Use builtin retry mechanism in worker choice strategies instead of custom one.
472 ## [3.0.3] - 2023-10-19
476 - Avoid null exception at sending message to worker.
477 - Avoid null exception at checking worker node readiness.
479 ## [3.0.2] - 2023-10-17
483 - 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).
485 ## [3.0.1] - 2023-10-16
489 - Workaround possible race condition at work nodes array element removal and querying. See issue [#1468](https://github.com/poolifier/poolifier/issues/1468).
493 - Switch the worker node eventing code to `EventTarget` API.
495 ## [3.0.0] - 2023-10-08
499 - Remove Node.js 16.x.x (EOL) support.
501 ## [2.7.5] - 2023-10-03
505 - Use `EventEmitterAsyncResource` type from `@types/node` for pool event emitter. TypeScript users will need to update to latest `@types/node` version.
507 ## [2.7.4] - 2023-09-25
511 - Fix source maps (bundler issue).
513 ## [2.7.3] - 2023-09-24
517 - Convert pool event emitter to event emitter async resource.
519 ## [2.7.2] - 2023-09-23
523 - Add source maps to npm package to ease debugging.
527 - Continuous benchmarking versus other worker pools: [https://poolifier.github.io/benchmark](https://poolifier.github.io/benchmark).
529 ## [2.7.1] - 2023-09-20
533 - Ensure worker message listener used one time are removed after usage.
535 ## [2.7.0] - 2023-09-19
539 - Fix task stealing related tasks queue options handling at runtime.
543 - Rename `listTaskFunctions()` to `listTaskFunctionNames()` in pool and worker API.
547 - Add `hasTaskFunction()`, `addTaskFunction()`, `removeTaskFunction()`, `setDefaultTaskFunction()` methods to pool API: [PR #1148](https://github.com/poolifier/poolifier/pull/1148).
548 - Stricter worker constructor arguments validation.
550 ## [2.6.45] - 2023-09-17
554 - Disable publication on GitHub packages registry on release until authentication issue is fixed.
558 - Add `startWorkers` to pool options to whether start the minimum number of workers at pool initialization or not.
559 - Add `start()` method to pool API to start the minimum number of workers.
560 - Add `taskStealing` and `tasksStealingOnBackPressure` to tasks queue options to whether enable task stealing or not and whether enable tasks stealing under back pressure or not.
561 - Continuous internal benchmarking: [https://poolifier.github.io/benchmark-results/dev/bench](https://poolifier.github.io/benchmark-results/dev/bench).
563 ## [2.6.44] - 2023-09-08
567 - Use a dedicated PAT to publish on GitHub packages registry.
571 - Publish on GitHub packages registry on release.
575 - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
577 ## [2.6.43] - 2023-09-08
581 - Publish on GitHub packages registry on release.
585 - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
587 ## [2.6.42] - 2023-09-06
591 - Optimize hot code paths implementation: avoid unnecessary branching, add and use optimized helpers (min, max), use reduce() array helper, ...
593 ## [2.6.41] - 2023-09-03
597 - Optimize worker choice strategies implementation.
599 ## [2.6.40] - 2023-09-01
603 - Do not pre-choose in WRR worker choice strategy to avoid bias.
604 - Avoid array out of bound in worker choice strategies after worker node removal.
606 ## [2.6.39] - 2023-08-30
610 - Fix race condition in worker choice strategies at worker node info querying while not yet initialized.
612 ## [2.6.38] - 2023-08-30
616 - Bundle typescript types declaration into one file.
620 - Improve interleaved weighted round robin worker choice strategy implementation.
622 ## [2.6.37] - 2023-08-28
626 - Ensure unused worker usage statistics are deleted at runtime.
630 - Rename worker choice strategy options `choiceRetries` to `retries`.
631 - Avoid unnecessary branching in worker choice strategies.
633 ## [2.6.36] - 2023-08-27
637 - Fix pool `execute()` arguments check.
641 - Make continuous tasks stealing algorithm less aggressive.
642 - Fine tune tasks stealing algorithm under back pressure.
644 ## [2.6.35] - 2023-08-25
648 - Don't account worker usage statistics for tasks that have failed.
649 - Fix pool information runtime and wait time median computation.
653 - Update simple moving average implementation to use a circular buffer.
654 - Update simple moving median implementation to use a circular buffer.
655 - Account for stolen tasks in worker usage statistics and pool information.
659 - Continuous tasks stealing algorithm.
661 ## [2.6.34] - 2023-08-24
665 - Avoid cascading tasks stealing under back pressure.
669 - Add fastpath to queued tasks rescheduling.
671 ## [2.6.33] - 2023-08-24
675 - Fix queued tasks rescheduling.
679 - Rename tasks queue options `queueMaxSize` to `size`.
683 - Task stealing scheduling algorithm if tasks queueing is enabled.
685 ## [2.6.32] - 2023-08-23
689 - Ensure no task can be executed when the pool is destroyed.
693 - Add `queueMaxSize` option to tasks queue options.
694 - Add O(1) deque implementation implemented with doubly linked list and use it for tasks queueing.
695 - Add tasks stealing algorithm when a worker node queue is back pressured if tasks queueing is enabled.
697 ## [2.6.31] - 2023-08-20
701 - Fix worker choice strategy retries mechanism in some edge cases.
705 - Make orthogonal worker choice strategies tasks distribution and created dynamic worker usage.
706 - Remove the experimental status of the `LEAST_ELU` worker choice strategy.
708 ## [2.6.30] - 2023-08-19
712 - Ensure pool event `backPressure` is emitted.
713 - Ensure pool event `full` is emitted only once.
714 - Ensure worker node cannot be instantiated without proper arguments.
716 ## [2.6.29] - 2023-08-18
720 - Fix race condition between readiness and task functions worker message handling at startup.
721 - Fix duplicate task function worker usage statistics computation per task function.
722 - Update task function worker usage statistics if and only if there's at least two different task functions.
723 - Fix race condition at task function worker usage executing task computation leading to negative value.
727 - 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).
728 - Use back pressure detection in worker choice strategies.
729 - Add worker choice strategies retries mechanism if no worker is eligible.
731 ## [2.6.28] - 2023-08-16
735 - Ensure pool workers are properly initialized.
739 - HTTP server pool examples: express-cluster, express-hybrid.
743 - Remove now useless branching in worker hot code path.
745 ## [2.6.27] - 2023-08-15
749 - Add `KillHandler` type definition to exported types.
753 - Add `destroy` event to pool API.
755 ## [2.6.26] - 2023-08-15
759 - Add kill handler to worker options allowing to execute custom code when worker is killed.
760 - Add `listTaskFunctions()` method to pool API.
761 - SMTP client pool example: nodemailer.
763 ## [2.6.25] - 2023-08-13
767 - HTTP server pool examples: fastify-cluster, fastify-hybrid.
768 - WebSocket server pool examples: ws-cluster, ws-hybrid.
770 ## [2.6.24] - 2023-08-12
774 - Add array of transferable objects to the `execute()` method arguments.
775 - WebSocket server pool examples: ws-worker_threads.
777 ## [2.6.23] - 2023-08-11
781 - 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.
785 - HTTP client pool examples: fetch, node-fetch and axios with multiple task functions.
786 - HTTP server pool examples: express-worker_threads, fastify-worker_threads.
788 ## [2.6.22] - 2023-08-10
792 - Add missing `types` field to package.json `exports`.
796 - Structure markdown documentation (PR #811).
798 ## [2.6.21] - 2023-08-03
802 - Improve code documentation.
803 - Code refactoring and cleanup for better maintainability and readability.
805 ## [2.6.20] - 2023-07-21
809 - Fix queued tasks redistribution on error task execution starvation.
810 - Ensure tasks queueing per worker condition is untangled from the pool busyness semantic.
814 - Drastically reduce lookups by worker in the worker nodes.
816 ## [2.6.19] - 2023-07-20
820 - Dedicated internal communication channel for worker_threads pools.
822 ## [2.6.18] - 2023-07-19
826 - Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller.
828 ## [2.6.17] - 2023-07-16
832 - Add `listTaskFunctions()` method to worker API.
834 ## [2.6.16] - 2023-07-12
838 - Fix pool startup detection.
839 - Fix worker task functions handling.
841 ## [2.6.15] - 2023-07-11
845 - Take into account worker node readiness in worker choice strategies.
847 ## [2.6.14] - 2023-07-10
851 - Fix task function statistics tracking.
853 ## [2.6.13] - 2023-07-10
857 - Add per task function statistics tracking.
858 - Add public methods to manipulate the worker task functions at runtime.
860 ## [2.6.12] - 2023-07-09
864 - Workaround import issue with `node:os` module in node 16.x.x.
866 ## [2.6.11] - 2023-07-09
870 - Fix pool readiness semantic.
872 ## [2.6.10] - 2023-07-08
876 - Ensure workers are not recreated on error at pool startup.
880 - Add `ready` and `strategy` fields to pool information.
881 - Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
882 - Add dynamic pool sizing checks.
884 ## [2.6.9] - 2023-07-07
888 - Recreate the right worker type on uncaught exception.
892 - Add minimum and maximum to internal measurement statistics.
893 - Add `runTime` and `waitTime` to pool information.
894 - Check worker inactive time only on dynamic worker.
896 ## [2.6.8] - 2023-07-03
900 - Brown paper bag release to fix version handling in pool information.
902 ## [2.6.7] - 2023-07-03
906 - Ensure worker queued tasks at error are reassigned to other pool workers.
910 - Add pool `utilization` ratio to pool information.
911 - Add `version` to pool information.
912 - Add worker information to worker nodes.
914 ## [2.6.6] - 2023-07-01
918 - Add safe helper `availableParallelism()` to help sizing the pool.
922 - Ensure message handler is only registered in worker.
924 ## [2.6.5] - 2023-06-27
928 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
932 - Artificial version bump to 2.6.5 to workaround publication issue.
933 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
934 - Ensure pool event is emitted before task error promise rejection.
935 - Fix queued tasks count computation.
939 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
941 ## [2.6.4] - 2023-06-27
945 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
949 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
950 - Ensure pool event is emitted before task error promise rejection.
951 - Fix queued tasks count computation.
955 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
957 ## [2.6.3] - 2023-06-19
961 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
962 - Update strategies internals after statistics computation.
966 - Optimize O(1) queue implementation.
968 ## [2.6.2] - 2023-06-12
972 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
974 ## [2.6.1] - 2023-06-10
978 - Add worker choice strategy documentation: [README.md](./docs/worker-choice-strategies.md).
982 - Fix average statistics computation: ensure failed tasks are not accounted.
984 ## [2.6.0] - 2023-06-09
988 - Add `LEAST_ELU` worker choice strategy (experimental).
989 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
993 - Refactor pool worker node usage internals.
994 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
995 - Breaking change: pool information `info` property object fields have been renamed.
999 - Fix wait time accounting.
1000 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
1001 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
1003 ## [2.5.4] - 2023-06-07
1007 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
1011 - Compute statistics at the worker level only if needed.
1012 - Add `worker_threads` options to thread pool options.
1016 - Make the `LEAST_BUSY` strategy only relies on task runtime.
1018 ## [2.5.3] - 2023-06-04
1022 - Refine pool information content.
1023 - Limit pool internals public exposure.
1025 ## [2.5.2] - 2023-06-02
1029 - Add `taskError` pool event for task execution error.
1030 - Add pool information `info` property to pool.
1031 - Emit pool information on `busy` and `full` pool events.
1033 ## [2.5.1] - 2023-06-01
1037 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
1038 - Add `error` pool event for uncaught worker error.
1040 ## [2.5.0] - 2023-05-31
1044 - Switch pool event emitter to `EventEmitterAsyncResource`.
1045 - Add tasks wait time accounting in per worker tasks usage.
1046 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
1050 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
1052 ## [2.4.14] - 2023-05-09
1056 - Ensure no undefined task runtime can land in the tasks history.
1057 - Fix median computation implementation once again.
1061 - Unit tests for median and queue implementations.
1063 ## [2.4.13] - 2023-05-08
1067 - Fix worker choice strategy options validation.
1068 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
1070 ## [2.4.12] - 2023-05-06
1074 - Support multiple task functions per worker.
1075 - Add custom worker weights support to worker choice strategies options.
1079 - Use O(1) queue implementation for tasks queueing.
1083 - Fix median computation implementation.
1084 - Fix fair share worker choice strategy internals update.
1086 ## [2.4.11] - 2023-04-23
1090 - Optimize free worker finding in worker choice strategies.
1092 ## [2.4.10] - 2023-04-15
1096 - Fix typescript type definition for task function: ensure the input data is optional.
1097 - Fix typescript type definition for pool execute(): ensure the input data is optional.
1099 ## [2.4.9] - 2023-04-15
1103 - Add tasks queue enablement runtime setter to pool.
1104 - Add tasks queue options runtime setter to pool.
1105 - Add worker choice strategy options runtime setter to pool.
1109 - Remove the tasks queuing experimental status.
1113 - Fix task function type definition and validation.
1114 - Fix worker choice strategy options handling.
1116 ## [2.4.8] - 2023-04-12
1120 - Fix message between main worker and worker type definition for tasks.
1121 - Fix code documentation.
1123 ## [2.4.7] - 2023-04-11
1127 - Add worker tasks queue options to pool options.
1131 - Fix missing documentation.
1133 ## [2.4.6] - 2023-04-10
1137 - Ensure one task at a time is executed per worker with tasks queueing enabled.
1138 - Properly count worker executing tasks with tasks queueing enabled.
1140 ## [2.4.5] - 2023-04-09
1144 - Use monotonic high resolution timer for worker tasks runtime.
1145 - Add worker tasks median runtime to statistics.
1146 - Add worker tasks queue (experimental).
1148 ## [2.4.4] - 2023-04-07
1152 - Add `PoolEvents` enumeration and `PoolEvent` type.
1156 - Destroy worker only on alive check.
1158 ## [2.4.3] - 2023-04-07
1162 - Fix typedoc generation with inheritance.
1164 ## [2.4.2] - 2023-04-06
1168 - Add `full` event to dynamic pool.
1169 - Keep worker choice strategy in memory for conditional reuse.
1173 - Fix possible negative worker key at worker removal in worker choice strategies.
1175 ## [2.4.1] - 2023-04-05
1179 - Optimize worker choice strategy for dynamic pool.
1183 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
1185 ## [2.4.0] - 2023-04-04
1189 - Add `LESS_BUSY` worker choice strategy.
1193 - Optimize worker storage in pool.
1194 - Optimize worker alive status check.
1195 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1196 - Optimize `LESS_USED` worker choice strategy.
1197 - Update benchmark versus external threads pools.
1198 - Optimize tasks usage statistics requirements for worker choice strategy.
1202 - Ensure trimmable characters are checked at pool initialization.
1203 - Fix message id integer overflow.
1204 - Fix pool worker removal in worker choice strategy internals.
1205 - Fix package publication with pnpm.
1207 ## [2.4.0-3] - 2023-04-04
1211 - Add `LESS_BUSY` worker choice strategy.
1215 - Optimize worker storage in pool.
1216 - Optimize worker alive status check.
1217 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1218 - Optimize `LESS_USED` worker choice strategy.
1219 - Update benchmark versus external threads pools.
1223 - Ensure trimmable characters are checked at pool initialization.
1224 - Fix message id integer overflow.
1225 - Fix pool worker removal in worker choice strategy internals.
1226 - Fix package publication with pnpm.
1228 ## [2.4.0-2] - 2023-04-03
1232 - Add `LESS_BUSY` worker choice strategy.
1236 - Optimize worker storage in pool.
1237 - Optimize worker alive status check.
1238 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1239 - Optimize `LESS_USED` worker choice strategy.
1243 - Ensure trimmable characters are checked at pool initialization.
1244 - Fix message id integer overflow.
1245 - Fix pool worker removal in worker choice strategy internals.
1246 - Fix package publication with pnpm.
1248 ## [2.4.0-1] - 2023-04-03
1252 - Add `LESS_BUSY` worker choice strategy.
1256 - Optimize worker storage in pool.
1257 - Optimize worker alive status check.
1258 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1259 - Optimize `LESS_USED` worker choice strategy.
1263 - Ensure trimmable characters are checked at pool initialization.
1264 - Fix message id integer overflow.
1265 - Fix pool worker removal in worker choice strategy internals.
1267 ## [2.4.0-0] - 2023-04-03
1271 - Add `LESS_BUSY` worker choice strategy.
1275 - Optimize worker storage in pool.
1276 - Optimize worker alive status check.
1277 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1278 - Optimize `LESS_USED` worker choice strategy.
1282 - Ensure trimmable characters are checked at pool initialization.
1283 - Fix message id integer overflow.
1284 - Fix pool worker removal in worker choice strategy internals.
1286 ## [2.3.10] - 2023-03-18
1290 - Fix package.json `exports` syntax for ESM and CommonJS.
1294 - Permit SemVer pre-release publication.
1296 ## [2.3.10-2] - 2023-03-18
1300 - Fix package.json `exports` syntax for ESM and CommonJS.
1302 ## [2.3.10-1] - 2023-03-18
1306 - Permit SemVer pre-release publication.
1308 ## [2.3.10-0] - 2023-03-18
1312 - Fix package.json `exports` syntax for ESM and CommonJS.
1314 ## [2.3.9] - 2023-03-18
1318 - Introduce ESM module support along with CommonJS one.
1322 - Fix brown paper bag bug referencing the same object literal.
1324 ## [2.3.8] - 2023-03-18
1328 - Switch internal benchmarking code to benny.
1329 - Switch to TypeScript 5.x.x.
1330 - Switch rollup bundler plugins to core ones.
1331 - Switch to TSDoc syntax.
1332 - Enforce conventional commits.
1336 - Fix random integer generator.
1337 - Fix worker choice strategy pool type identification at initialization.
1339 ## [2.3.7] - 2022-10-23
1343 - Switch to open collective FOSS project funding platform.
1344 - Switch to ts-standard linter configuration on TypeScript code.
1348 - Fixed missing async on pool execute method.
1349 - Fixed typing in TypeScript example.
1350 - Fixed types in unit tests.
1352 ## [2.3.6] - 2022-10-22
1356 - Cleanup pool attributes and methods.
1357 - Refine error types thrown.
1361 - Fix continuous integration build on windows.
1362 - Fix code coverage reporting by using c8 instead of nyc.
1364 ## [2.3.5] - 2022-10-21
1368 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
1369 - Optimize tasks usage lookup implementation.
1373 - Fix missed pool event emitter type export.
1374 - Fix typedoc documentation generation.
1376 ## [2.3.4] - 2022-10-17
1380 - Fully automate release process with release-it.
1384 - Optimize fair share task scheduling algorithm implementation.
1385 - Update benchmark versus external pools results with latest version.
1387 ## [2.3.3] - 2022-10-15
1391 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
1393 ## [2.3.2] - 2022-10-14
1397 - Optimize fair share worker selection strategy implementation.
1401 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
1403 ## [2.3.1] - 2022-10-13
1407 - Pool worker choice strategies:
1408 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
1409 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
1411 ## [2.2.2] - 2022-10-09
1415 - Fixed `README.md` file.
1417 ## [2.2.1] - 2022-10-08
1421 - Dynamic worker choice strategy change at runtime.
1423 ## [2.2.0] - 2022-01-05
1425 ### Breaking Changes
1427 - Support only Node.js version 16.x.x for cluster pool: upstream cluster API have changed on that version.
1429 ## [2.1.0] - 2021-08-29
1433 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
1435 ### Breaking Changes
1437 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
1438 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
1439 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
1440 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
1442 ## [2.0.2] - 2021-05-12
1446 - Fix `busy` event emission on fixed pool type
1448 ## [2.0.1] - 2021-03-16
1452 - Check if pool options are properly set.
1453 - `busy` event is emitted on all pool types.
1455 ## [2.0.0] - 2021-03-01
1459 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
1461 ### Breaking Changes
1463 - `FullPool` event is now renamed to `busy`.
1464 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
1465 _Find more details on our JSDoc._
1467 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
1469 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
1471 ### Pool options types declaration merge
1473 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
1475 #### New `export` strategy
1479 const DynamicThreadPool = require('poolifier/lib/dynamic')
1481 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
1484 But you should always prefer just using
1487 const { DynamicThreadPool } = require('poolifier')
1490 #### New type definitions for input data and response
1492 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
1493 _This is not a limitation by poolifier but Node.js._
1495 #### Public property replacements
1497 `numWorkers` property is now `numberOfWorkers`
1499 #### Internal (protected) properties and methods renaming
1501 These properties are not intended for end users
1503 - `id` => `nextMessageId`
1505 These methods are not intended for end users
1507 - `_chooseWorker` => `chooseWorker`
1508 - `_newWorker` => `createWorker`
1509 - `_execute` => `internalExecute`
1510 - `_chooseWorker` => `chooseWorker`
1511 - `_checkAlive` => `checkAlive`
1513 - `_runAsync` => `runAsync`
1515 ## [1.1.0] - 2020-05-21
1519 - ThreadWorker support async functions as option
1520 - Various external library patches
1522 ## [1.0.0] - 2020-01-24
1526 - FixedThreadPool implementation
1527 - DynamicThreadPool implementation
1528 - WorkerThread implementation to improve developer experience