X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README.md;h=1a311e4d5fcec3b0a46125e11ffb42f7853b18d3;hb=70353024c44987c467dadcec306c699ce4ae1f06;hp=05865e2cfcecfddae76d46a05eb89a4b139ba2f4;hpb=0feeec4ab35dae438017f69feb1a1a560ea9ffe8;p=poolifier.git diff --git a/README.md b/README.md index 05865e2c..1a311e4d 100644 --- a/README.md +++ b/README.md @@ -7,11 +7,11 @@

Weekly Downloads - - Actions Status + + Actions Status Quality Gate Status - + Code Coverage Javascript Standard Style Guide @@ -29,7 +29,7 @@ ## Why Poolifier? -Poolifier is used to perform CPU intensive and I/O intensive tasks on nodejs servers, it implements worker pools (yes, more worker pool implementations, so you can choose which one fit better for you) using [worker-threads](https://nodejs.org/api/worker_threads.html#worker_threads_worker_threads) and cluster pools using [Node.js cluster](https://nodejs.org/api/cluster.html) modules. +Poolifier is used to perform CPU intensive and I/O intensive tasks on nodejs servers, it implements worker pools using [worker-threads](https://nodejs.org/api/worker_threads.html#worker_threads_worker_threads) and cluster pools using [Node.js cluster](https://nodejs.org/api/cluster.html) modules. With poolifier you can improve your **performance** and resolve problems related to the event loop. Moreover you can execute your tasks using an API designed to improve the **developer experience**. Please consult our [general guidelines](#general-guidance). @@ -37,8 +37,8 @@ Please consult our [general guidelines](#general-guidance). - Performance :racehorse: [benchmarks](./benchmarks/README.md) - Security :bank: :cop: [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=security_rating)](https://sonarcloud.io/dashboard?id=pioardi_poolifier) [![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=pioardi_poolifier) - Easy to use :couple: -- Easy switch from a pool to another, easy to tune :white_check_mark: - Dynamic pool size :white_check_mark: +- Easy switch from a pool to another :white_check_mark: - No runtime dependencies :white_check_mark: - Proper async integration with node async hooks :white_check_mark: - Support for worker threads and cluster node modules :white_check_mark: @@ -104,8 +104,7 @@ function yourFunction(data) { } module.exports = new ThreadWorker(yourFunction, { - maxInactiveTime: 60000, - async: false + maxInactiveTime: 60000 }) ``` @@ -140,14 +139,13 @@ pool.execute({}).then(res => { You can do the same with the classes ClusterWorker, FixedClusterPool and DynamicClusterPool. -**See examples folder for more details (in particular if you want to use a pool for [multiple functions](./examples/multiFunctionExample.js))**. -**Now TypeScript is also supported, find how to use it into the example folder**. +**See examples folder for more details (in particular if you want to use a pool with [multiple worker functions](./examples/multiFunctionExample.js))**. Remember that workers can only send and receive serializable data. ## Node versions -Node versions >= 16.x are supported. +Node versions >= 16.14.x are supported. ## [API](https://poolifier.github.io/poolifier/) @@ -164,9 +162,10 @@ Node versions >= 16.x are supported. - `workerChoiceStrategy` (optional) - The worker choice strategy to use in this pool: - `WorkerChoiceStrategies.ROUND_ROBIN`: Submit tasks to worker in a round robbin fashion - - `WorkerChoiceStrategies.LESS_USED`: Submit tasks to the less used worker - - `WorkerChoiceStrategies.LESS_BUSY`: Submit tasks to the less busy worker + - `WorkerChoiceStrategies.LEAST_USED`: Submit tasks to the least used worker + - `WorkerChoiceStrategies.LEAST_BUSY`: Submit tasks to the least busy worker - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN`: Submit tasks to worker using a weighted round robin scheduling algorithm based on tasks execution time + - `WorkerChoiceStrategies.INTERLEAVED_WEIGHTED_ROUND_ROBIN`: Submit tasks to worker using an interleaved weighted round robin scheduling algorithm based on tasks execution time (experimental) - `WorkerChoiceStrategies.FAIR_SHARE`: Submit tasks to worker using a fair share tasks scheduling algorithm based on tasks execution time `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` and `WorkerChoiceStrategies.FAIR_SHARE` strategies are targeted to heavy and long tasks. @@ -175,10 +174,13 @@ Node versions >= 16.x are supported. - `workerChoiceStrategyOptions` (optional) - The worker choice strategy options object to use in this pool. Properties: - - `medRunTime` (optional) - Use the tasks median run time instead of the tasks average run time in worker choice strategies. + - `medRunTime` (optional) - Use the tasks median runtime instead of the tasks average runtime in worker choice strategies. + - `weights` (optional) - The worker weights to use in the weighted round robin worker choice strategy: `{ 0: 200, 1: 300, ..., n: 100 }` Default: `{ medRunTime: false }` +- `restartWorkerOnError` (optional) - Restart worker on uncaught error in this pool. + Default: true - `enableEvents` (optional) - Events emission enablement in this pool. Default: true - `enableTasksQueue` (optional) - Tasks queue per worker enablement in this pool. @@ -210,7 +212,7 @@ This method will call the terminate method on each worker. ### `class YourWorker extends ThreadWorker/ClusterWorker` -`fn` (mandatory) The function that you want to execute on the worker +`taskFunctions` (mandatory) The task function(s) that you want to execute on the worker `opts` (optional) An object with these properties: - `maxInactiveTime` (optional) - Max time to wait tasks to work on in milliseconds, after this period the new worker will die. @@ -219,8 +221,6 @@ This method will call the terminate method on each worker. If `killBehavior` is set to `KillBehaviors.SOFT` your tasks have no timeout and your workers will not be terminated until your task is completed. Default: 60000 -- `async` (optional) - true/false. Set to true if your function contains async code pieces, else false. - Default: false - `killBehavior` (optional) - Dictates if your async unit (worker/process) will be deleted in case that a task is active on it. **KillBehaviors.SOFT**: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still running, then the worker **won't** be deleted. **KillBehaviors.HARD**: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still running, then the worker will be deleted.