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).
10 ## [3.1.6] - 2023-12-18
14 - Fix pool destroying with tasks queuing enabled.
16 ## [3.1.5] - 2023-12-18
20 - Add queued tasks end timeout support to worker node termination.
22 ## [3.1.4] - 2023-12-18
26 - Make more robust the fix for possible null exception at handling task execution response.
28 ## [3.1.3] - 2023-12-17
32 - Fix possible null exception at handling task execution response.
34 ## [3.1.2] - 2023-12-17
38 - Wait for queued tasks to end at worker node termination.
40 ## [3.1.1] - 2023-12-16
44 - Fix pool options TS type definition.
46 ## [3.1.0] - 2023-12-16
50 - TypeScript breaking change: merge ThreadPoolOptions and ClusterPoolOptions types into PoolOptions type.
52 ## [3.0.14] - 2023-12-13
56 - Fix possible null exception with worker_threads pools.
58 ## [3.0.13] - 2023-12-12
62 - Ensure worker choice strategy wait for worker nodes readiness.
66 - Remove infinite retries support in worker choice strategy to avoid configuration leading to possible infinite recursion or loop.
68 ## [3.0.12] - 2023-12-12
72 - Add infinite retries support in worker choice strategy.
74 ## [3.0.11] - 2023-12-11
78 - Ensure pool asynchronous resource properly track tasks execution.
80 ## [3.0.10] - 2023-12-08
84 - Add a fastpath when tasks stealing or redistribution is impossible.
86 ## [3.0.9] - 2023-11-26
90 - Remove all pool events listener at pool destroying.
91 - Remove all worker node events listener at worker node destroying.
92 - Fix worker node event emitter listeners handling memory leak at pool options runtime change.
94 ## [3.0.8] - 2023-11-25
98 - Ensure continuous tasks stealing on idle start at worker node idling.
100 ## [3.0.7] - 2023-11-24
104 - Make continuous tasks stealing start at worker node idling.
106 ## [3.0.6] - 2023-11-24
110 - Ensure pool statuses are checked at initialization, `start()` or `destroy()`.
111 - Ensure pool `ready` event can be emitted after several `start()/destroy()` cycles.
113 ## [3.0.5] - 2023-10-27
117 - Ensure pool `ready` event can be emitted only once.
119 ## [3.0.4] - 2023-10-20
123 - Switch to Bencher for benchmarking: [https://bencher.dev/perf/poolifier](https://bencher.dev/perf/poolifier).
124 - Use builtin retry mechanism in worker choice strategies instead of custom one.
126 ## [3.0.3] - 2023-10-19
130 - Avoid null exception at sending message to worker.
131 - Avoid null exception at checking worker node readiness.
133 ## [3.0.2] - 2023-10-17
137 - 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).
139 ## [3.0.1] - 2023-10-16
143 - Workaround possible race condition at work nodes array element removal and querying. See issue [#1468](https://github.com/poolifier/poolifier/issues/1468).
147 - Switch the worker node eventing code to `EventTarget` API.
149 ## [3.0.0] - 2023-10-08
153 - Remove Node.js 16.x.x (EOL) support.
155 ## [2.7.5] - 2023-10-03
159 - Use `EventEmitterAsyncResource` type from `@types/node` for pool event emitter. TypeScript users will need to update to latest `@types/node` version.
161 ## [2.7.4] - 2023-09-25
165 - Fix source maps (bundler issue).
167 ## [2.7.3] - 2023-09-24
171 - Convert pool event emitter to event emitter async resource.
173 ## [2.7.2] - 2023-09-23
177 - Add source maps to npm package to ease debugging.
181 - Continuous benchmarking versus other worker pools: [https://poolifier.github.io/benchmark](https://poolifier.github.io/benchmark).
183 ## [2.7.1] - 2023-09-20
187 - Ensure worker message listener used one time are removed after usage.
189 ## [2.7.0] - 2023-09-19
193 - Fix task stealing related tasks queue options handling at runtime.
197 - Rename `listTaskFunctions()` to `listTaskFunctionNames()` in pool and worker API.
201 - Add `hasTaskFunction()`, `addTaskFunction()`, `removeTaskFunction()`, `setDefaultTaskFunction()` methods to pool API: [PR #1148](https://github.com/poolifier/poolifier/pull/1148).
202 - Stricter worker constructor arguments validation.
204 ## [2.6.45] - 2023-09-17
208 - Disable publication on GitHub packages registry on release until authentication issue is fixed.
212 - Add `startWorkers` to pool options to whether start the minimum number of workers at pool initialization or not.
213 - Add `start()` method to pool API to start the minimum number of workers.
214 - 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.
215 - Continuous internal benchmarking: [https://poolifier.github.io/benchmark-results/dev/bench](https://poolifier.github.io/benchmark-results/dev/bench).
217 ## [2.6.44] - 2023-09-08
221 - Use a dedicated PAT to publish on GitHub packages registry.
225 - Publish on GitHub packages registry on release.
229 - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
231 ## [2.6.43] - 2023-09-08
235 - Publish on GitHub packages registry on release.
239 - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
241 ## [2.6.42] - 2023-09-06
245 - Optimize hot code paths implementation: avoid unnecessary branching, add and use optimized helpers (min, max), use reduce() array helper, ...
247 ## [2.6.41] - 2023-09-03
251 - Optimize worker choice strategies implementation.
253 ## [2.6.40] - 2023-09-01
257 - Do not pre-choose in WRR worker choice strategy to avoid bias.
258 - Avoid array out of bound in worker choice strategies after worker node removal.
260 ## [2.6.39] - 2023-08-30
264 - Fix race condition in worker choice strategies at worker node info querying while not yet initialized.
266 ## [2.6.38] - 2023-08-30
270 - Bundle typescript types declaration into one file.
274 - Improve interleaved weighted round robin worker choice strategy implementation.
276 ## [2.6.37] - 2023-08-28
280 - Ensure unused worker usage statistics are deleted at runtime.
284 - Rename worker choice strategy options `choiceRetries` to `retries`.
285 - Avoid unnecessary branching in worker choice strategies.
287 ## [2.6.36] - 2023-08-27
291 - Fix pool `execute()` arguments check.
295 - Make continuous tasks stealing algorithm less aggressive.
296 - Fine tune tasks stealing algorithm under back pressure.
298 ## [2.6.35] - 2023-08-25
302 - Don't account worker usage statistics for tasks that have failed.
303 - Fix pool information runtime and wait time median computation.
307 - Update simple moving average implementation to use a circular buffer.
308 - Update simple moving median implementation to use a circular buffer.
309 - Account for stolen tasks in worker usage statistics and pool information.
313 - Continuous tasks stealing algorithm.
315 ## [2.6.34] - 2023-08-24
319 - Avoid cascading tasks stealing under back pressure.
323 - Add fastpath to queued tasks rescheduling.
325 ## [2.6.33] - 2023-08-24
329 - Fix queued tasks rescheduling.
333 - Rename tasks queue options `queueMaxSize` to `size`.
337 - Task stealing scheduling algorithm if tasks queueing is enabled.
339 ## [2.6.32] - 2023-08-23
343 - Ensure no task can be executed when the pool is destroyed.
347 - Add `queueMaxSize` option to tasks queue options.
348 - Add O(1) deque implementation implemented with doubly linked list and use it for tasks queueing.
349 - Add tasks stealing algorithm when a worker node queue is back pressured if tasks queueing is enabled.
351 ## [2.6.31] - 2023-08-20
355 - Fix worker choice strategy retries mechanism in some edge cases.
359 - Make orthogonal worker choice strategies tasks distribution and created dynamic worker usage.
360 - Remove the experimental status of the `LEAST_ELU` worker choice strategy.
362 ## [2.6.30] - 2023-08-19
366 - Ensure pool event `backPressure` is emitted.
367 - Ensure pool event `full` is emitted only once.
368 - Ensure worker node cannot be instantiated without proper arguments.
370 ## [2.6.29] - 2023-08-18
374 - Fix race condition between readiness and task functions worker message handling at startup.
375 - Fix duplicate task function worker usage statistics computation per task function.
376 - Update task function worker usage statistics if and only if there's at least two different task functions.
377 - Fix race condition at task function worker usage executing task computation leading to negative value.
381 - 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).
382 - Use back pressure detection in worker choice strategies.
383 - Add worker choice strategies retries mechanism if no worker is eligible.
385 ## [2.6.28] - 2023-08-16
389 - Ensure pool workers are properly initialized.
393 - HTTP server pool examples: express-cluster, express-hybrid.
397 - Remove now useless branching in worker hot code path.
399 ## [2.6.27] - 2023-08-15
403 - Add `KillHandler` type definition to exported types.
407 - Add `destroy` event to pool API.
409 ## [2.6.26] - 2023-08-15
413 - Add kill handler to worker options allowing to execute custom code when worker is killed.
414 - Add `listTaskFunctions()` method to pool API.
415 - SMTP client pool example: nodemailer.
417 ## [2.6.25] - 2023-08-13
421 - HTTP server pool examples: fastify-cluster, fastify-hybrid.
422 - WebSocket server pool examples: ws-cluster, ws-hybrid.
424 ## [2.6.24] - 2023-08-12
428 - Add array of transferable objects to the `execute()` method arguments.
429 - WebSocket server pool examples: ws-worker_threads.
431 ## [2.6.23] - 2023-08-11
435 - 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.
439 - HTTP client pool examples: fetch, node-fetch and axios with multiple task functions.
440 - HTTP server pool examples: express-worker_threads, fastify-worker_threads.
442 ## [2.6.22] - 2023-08-10
446 - Add missing `types` field to package.json `exports`.
450 - Structure markdown documentation (PR #811).
452 ## [2.6.21] - 2023-08-03
456 - Improve code documentation.
457 - Code refactoring and cleanup for better maintainability and readability.
459 ## [2.6.20] - 2023-07-21
463 - Fix queued tasks redistribution on error task execution starvation.
464 - Ensure tasks queueing per worker condition is untangled from the pool busyness semantic.
468 - Drastically reduce lookups by worker in the worker nodes.
470 ## [2.6.19] - 2023-07-20
474 - Dedicated internal communication channel for worker_threads pools.
476 ## [2.6.18] - 2023-07-19
480 - Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller.
482 ## [2.6.17] - 2023-07-16
486 - Add `listTaskFunctions()` method to worker API.
488 ## [2.6.16] - 2023-07-12
492 - Fix pool startup detection.
493 - Fix worker task functions handling.
495 ## [2.6.15] - 2023-07-11
499 - Take into account worker node readiness in worker choice strategies.
501 ## [2.6.14] - 2023-07-10
505 - Fix task function statistics tracking.
507 ## [2.6.13] - 2023-07-10
511 - Add per task function statistics tracking.
512 - Add public methods to manipulate the worker task functions at runtime.
514 ## [2.6.12] - 2023-07-09
518 - Workaround import issue with `node:os` module in node 16.x.x.
520 ## [2.6.11] - 2023-07-09
524 - Fix pool readiness semantic.
526 ## [2.6.10] - 2023-07-08
530 - Ensure workers are not recreated on error at pool startup.
534 - Add `ready` and `strategy` fields to pool information.
535 - Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
536 - Add dynamic pool sizing checks.
538 ## [2.6.9] - 2023-07-07
542 - Recreate the right worker type on uncaught exception.
546 - Add minimum and maximum to internal measurement statistics.
547 - Add `runTime` and `waitTime` to pool information.
548 - Check worker inactive time only on dynamic worker.
550 ## [2.6.8] - 2023-07-03
554 - Brown paper bag release to fix version handling in pool information.
556 ## [2.6.7] - 2023-07-03
560 - Ensure worker queued tasks at error are reassigned to other pool workers.
564 - Add pool `utilization` ratio to pool information.
565 - Add `version` to pool information.
566 - Add worker information to worker nodes.
568 ## [2.6.6] - 2023-07-01
572 - Add safe helper `availableParallelism()` to help sizing the pool.
576 - Ensure message handler is only registered in worker.
578 ## [2.6.5] - 2023-06-27
582 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
586 - Artificial version bump to 2.6.5 to workaround publication issue.
587 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
588 - Ensure pool event is emitted before task error promise rejection.
589 - Fix queued tasks count computation.
593 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
595 ## [2.6.4] - 2023-06-27
599 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
603 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
604 - Ensure pool event is emitted before task error promise rejection.
605 - Fix queued tasks count computation.
609 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
611 ## [2.6.3] - 2023-06-19
615 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
616 - Update strategies internals after statistics computation.
620 - Optimize O(1) queue implementation.
622 ## [2.6.2] - 2023-06-12
626 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
628 ## [2.6.1] - 2023-06-10
632 - Add worker choice strategy documentation: [README.md](./docs/worker-choice-strategies.md).
636 - Fix average statistics computation: ensure failed tasks are not accounted.
638 ## [2.6.0] - 2023-06-09
642 - Add `LEAST_ELU` worker choice strategy (experimental).
643 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
647 - Refactor pool worker node usage internals.
648 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
649 - Breaking change: pool information `info` property object fields have been renamed.
653 - Fix wait time accounting.
654 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
655 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
657 ## [2.5.4] - 2023-06-07
661 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
665 - Compute statistics at the worker level only if needed.
666 - Add `worker_threads` options to thread pool options.
670 - Make the `LEAST_BUSY` strategy only relies on task runtime.
672 ## [2.5.3] - 2023-06-04
676 - Refine pool information content.
677 - Limit pool internals public exposure.
679 ## [2.5.2] - 2023-06-02
683 - Add `taskError` pool event for task execution error.
684 - Add pool information `info` property to pool.
685 - Emit pool information on `busy` and `full` pool events.
687 ## [2.5.1] - 2023-06-01
691 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
692 - Add `error` pool event for uncaught worker error.
694 ## [2.5.0] - 2023-05-31
698 - Switch pool event emitter to `EventEmitterAsyncResource`.
699 - Add tasks wait time accounting in per worker tasks usage.
700 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
704 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
706 ## [2.4.14] - 2023-05-09
710 - Ensure no undefined task runtime can land in the tasks history.
711 - Fix median computation implementation once again.
715 - Unit tests for median and queue implementations.
717 ## [2.4.13] - 2023-05-08
721 - Fix worker choice strategy options validation.
722 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
724 ## [2.4.12] - 2023-05-06
728 - Support multiple task functions per worker.
729 - Add custom worker weights support to worker choice strategies options.
733 - Use O(1) queue implementation for tasks queueing.
737 - Fix median computation implementation.
738 - Fix fair share worker choice strategy internals update.
740 ## [2.4.11] - 2023-04-23
744 - Optimize free worker finding in worker choice strategies.
746 ## [2.4.10] - 2023-04-15
750 - Fix typescript type definition for task function: ensure the input data is optional.
751 - Fix typescript type definition for pool execute(): ensure the input data is optional.
753 ## [2.4.9] - 2023-04-15
757 - Add tasks queue enablement runtime setter to pool.
758 - Add tasks queue options runtime setter to pool.
759 - Add worker choice strategy options runtime setter to pool.
763 - Remove the tasks queuing experimental status.
767 - Fix task function type definition and validation.
768 - Fix worker choice strategy options handling.
770 ## [2.4.8] - 2023-04-12
774 - Fix message between main worker and worker type definition for tasks.
775 - Fix code documentation.
777 ## [2.4.7] - 2023-04-11
781 - Add worker tasks queue options to pool options.
785 - Fix missing documentation.
787 ## [2.4.6] - 2023-04-10
791 - Ensure one task at a time is executed per worker with tasks queueing enabled.
792 - Properly count worker executing tasks with tasks queueing enabled.
794 ## [2.4.5] - 2023-04-09
798 - Use monotonic high resolution timer for worker tasks runtime.
799 - Add worker tasks median runtime to statistics.
800 - Add worker tasks queue (experimental).
802 ## [2.4.4] - 2023-04-07
806 - Add `PoolEvents` enumeration and `PoolEvent` type.
810 - Destroy worker only on alive check.
812 ## [2.4.3] - 2023-04-07
816 - Fix typedoc generation with inheritance.
818 ## [2.4.2] - 2023-04-06
822 - Add `full` event to dynamic pool.
823 - Keep worker choice strategy in memory for conditional reuse.
827 - Fix possible negative worker key at worker removal in worker choice strategies.
829 ## [2.4.1] - 2023-04-05
833 - Optimize worker choice strategy for dynamic pool.
837 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
839 ## [2.4.0] - 2023-04-04
843 - Add `LESS_BUSY` worker choice strategy.
847 - Optimize worker storage in pool.
848 - Optimize worker alive status check.
849 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
850 - Optimize `LESS_USED` worker choice strategy.
851 - Update benchmark versus external threads pools.
852 - Optimize tasks usage statistics requirements for worker choice strategy.
856 - Ensure trimmable characters are checked at pool initialization.
857 - Fix message id integer overflow.
858 - Fix pool worker removal in worker choice strategy internals.
859 - Fix package publication with pnpm.
861 ## [2.4.0-3] - 2023-04-04
865 - Add `LESS_BUSY` worker choice strategy.
869 - Optimize worker storage in pool.
870 - Optimize worker alive status check.
871 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
872 - Optimize `LESS_USED` worker choice strategy.
873 - Update benchmark versus external threads pools.
877 - Ensure trimmable characters are checked at pool initialization.
878 - Fix message id integer overflow.
879 - Fix pool worker removal in worker choice strategy internals.
880 - Fix package publication with pnpm.
882 ## [2.4.0-2] - 2023-04-03
886 - Add `LESS_BUSY` worker choice strategy.
890 - Optimize worker storage in pool.
891 - Optimize worker alive status check.
892 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
893 - Optimize `LESS_USED` worker choice strategy.
897 - Ensure trimmable characters are checked at pool initialization.
898 - Fix message id integer overflow.
899 - Fix pool worker removal in worker choice strategy internals.
900 - Fix package publication with pnpm.
902 ## [2.4.0-1] - 2023-04-03
906 - Add `LESS_BUSY` worker choice strategy.
910 - Optimize worker storage in pool.
911 - Optimize worker alive status check.
912 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
913 - Optimize `LESS_USED` worker choice strategy.
917 - Ensure trimmable characters are checked at pool initialization.
918 - Fix message id integer overflow.
919 - Fix pool worker removal in worker choice strategy internals.
921 ## [2.4.0-0] - 2023-04-03
925 - Add `LESS_BUSY` worker choice strategy.
929 - Optimize worker storage in pool.
930 - Optimize worker alive status check.
931 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
932 - Optimize `LESS_USED` worker choice strategy.
936 - Ensure trimmable characters are checked at pool initialization.
937 - Fix message id integer overflow.
938 - Fix pool worker removal in worker choice strategy internals.
940 ## [2.3.10] - 2023-03-18
944 - Fix package.json `exports` syntax for ESM and CommonJS.
948 - Permit SemVer pre-release publication.
950 ## [2.3.10-2] - 2023-03-18
954 - Fix package.json `exports` syntax for ESM and CommonJS.
956 ## [2.3.10-1] - 2023-03-18
960 - Permit SemVer pre-release publication.
962 ## [2.3.10-0] - 2023-03-18
966 - Fix package.json `exports` syntax for ESM and CommonJS.
968 ## [2.3.9] - 2023-03-18
972 - Introduce ESM module support along with CommonJS one.
976 - Fix brown paper bag bug referencing the same object literal.
978 ## [2.3.8] - 2023-03-18
982 - Switch internal benchmarking code to benny.
983 - Switch to TypeScript 5.x.x.
984 - Switch rollup bundler plugins to core ones.
985 - Switch to TSDoc syntax.
986 - Enforce conventional commits.
990 - Fix random integer generator.
991 - Fix worker choice strategy pool type identification at initialization.
993 ## [2.3.7] - 2022-10-23
997 - Switch to open collective FOSS project funding platform.
998 - Switch to ts-standard linter configuration on TypeScript code.
1002 - Fixed missing async on pool execute method.
1003 - Fixed typing in TypeScript example.
1004 - Fixed types in unit tests.
1006 ## [2.3.6] - 2022-10-22
1010 - Cleanup pool attributes and methods.
1011 - Refine error types thrown.
1015 - Fix continuous integration build on windows.
1016 - Fix code coverage reporting by using c8 instead of nyc.
1018 ## [2.3.5] - 2022-10-21
1022 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
1023 - Optimize tasks usage lookup implementation.
1027 - Fix missed pool event emitter type export.
1028 - Fix typedoc documentation generation.
1030 ## [2.3.4] - 2022-10-17
1034 - Fully automate release process with release-it.
1038 - Optimize fair share task scheduling algorithm implementation.
1039 - Update benchmark versus external pools results with latest version.
1041 ## [2.3.3] - 2022-10-15
1045 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
1047 ## [2.3.2] - 2022-10-14
1051 - Optimize fair share worker selection strategy implementation.
1055 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
1057 ## [2.3.1] - 2022-10-13
1061 - Pool worker choice strategies:
1062 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
1063 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
1065 ## [2.2.2] - 2022-10-09
1069 - Fixed `README.md` file.
1071 ## [2.2.1] - 2022-10-08
1075 - Dynamic worker choice strategy change at runtime.
1077 ## [2.2.0] - 2022-01-05
1079 ### Breaking Changes
1081 - Support only Node.js version 16.x.x for cluster pool: upstream cluster API have changed on that version.
1083 ## [2.1.0] - 2021-08-29
1087 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
1089 ### Breaking Changes
1091 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
1092 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
1093 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
1094 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
1096 ## [2.0.2] - 2021-05-12
1100 - Fix `busy` event emission on fixed pool type
1102 ## [2.0.1] - 2021-03-16
1106 - Check if pool options are properly set.
1107 - `busy` event is emitted on all pool types.
1109 ## [2.0.0] - 2021-03-01
1113 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
1115 ### Breaking Changes
1117 - `FullPool` event is now renamed to `busy`.
1118 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
1119 _Find more details on our JSDoc._
1121 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
1123 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
1125 ### Pool options types declaration merge
1127 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
1129 #### New `export` strategy
1133 const DynamicThreadPool = require('poolifier/lib/dynamic')
1135 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
1138 But you should always prefer just using
1141 const { DynamicThreadPool } = require('poolifier')
1144 #### New type definitions for input data and response
1146 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
1147 _This is not a limitation by poolifier but Node.js._
1149 #### Public property replacements
1151 `numWorkers` property is now `numberOfWorkers`
1153 #### Internal (protected) properties and methods renaming
1155 These properties are not intended for end users
1157 - `id` => `nextMessageId`
1159 These methods are not intended for end users
1161 - `_chooseWorker` => `chooseWorker`
1162 - `_newWorker` => `createWorker`
1163 - `_execute` => `internalExecute`
1164 - `_chooseWorker` => `chooseWorker`
1165 - `_checkAlive` => `checkAlive`
1167 - `_runAsync` => `runAsync`
1169 ## [1.1.0] - 2020-05-21
1173 - ThreadWorker support async functions as option
1174 - Various external library patches
1176 ## [1.0.0] - 2020-01-24
1180 - FixedThreadPool implementation
1181 - DynamicThreadPool implementation
1182 - WorkerThread implementation to improve developer experience