docs: update changelog entries
[poolifier.git] / README.md
CommitLineData
f2b5671a 1<div align="center">
5ea22628 2<img src="./images/logo.png" width="340px" height="266px"/>
ddaa3a76 3</div>
4
063f8c5b 5<h2 align="center">Node Thread Pool and Cluster Pool :arrow_double_up: :on:</h2>
1d4f79e7
APA
6
7<p align="center">
8 <a href="https://www.npmjs.com/package/poolifier">
9 <img alt="Weekly Downloads" src="https://img.shields.io/npm/dw/poolifier"></a>
6ccc1262
JB
10 <a href="https://github.com/poolifier/poolifier/actions">
11 <img alt="Actions Status" src="https://github.com/poolifier/poolifier/workflows/NodeCI/badge.svg"></a>
1d4f79e7
APA
12 <a href="https://sonarcloud.io/dashboard?id=pioardi_poolifier">
13 <img alt="Quality Gate Status" src="https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=alert_status"></a>
14 <a href="https://sonarcloud.io/component_measures/metric/coverage/list?id=pioardi_poolifier">
22147b67 15 <img alt="Code Coverage" src="https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=coverage"></a>
1d4f79e7
APA
16 <a href="https://standardjs.com">
17 <img alt="Javascript Standard Style Guide" src="https://img.shields.io/badge/code_style-standard-brightgreen.svg"></a>
18 <a href="https://gitter.im/poolifier/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge">
19 <img alt="Gitter chat" src="https://badges.gitter.im/poolifier/community.svg"></a>
e8a862ca
JB
20 <a href="https://opencollective.com/poolifier">
21 <img alt="Open Collective" src="https://opencollective.com/poolifier/tiers/badge.svg"></a>
8f8dc0e0
JB
22 <a href="https://badgen.net/badge/Dependabot/enabled/green?icon=dependabot">
23 <img alt="Dependabot" src="https://badgen.net/badge/Dependabot/enabled/green?icon=dependabot"></a>
1d4f79e7
APA
24 <a href="http://makeapullrequest.com">
25 <img alt="PR Welcome" src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square"></a>
26 <a href="https://img.shields.io/static/v1?label=dependencies&message=no%20dependencies&color=brightgreen">
27 <img alt="No dependencies" src="https://img.shields.io/static/v1?label=dependencies&message=no%20dependencies&color=brightgreen"></a>
1d4f79e7
APA
28</p>
29
74750c7f 30## Why Poolifier?
e76f5485 31
c868b39b 32Poolifier 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.
50aa7901 33With poolifier you can improve your **performance** and resolve problems related to the event loop.
063f8c5b 34Moreover you can execute your tasks using an API designed to improve the **developer experience**.
e36cfb13 35Please consult our <a href="#general-guidance">general guidelines</a>
e76f5485 36
64060857 37- Performance :racehorse: [benchmarks](./benchmarks/README.md)
f2b5671a 38- 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)
b1b24f66 39- Easy to use :couple:
82be29c0
JB
40- Easy switch from a pool to another, easy to tune :white_check_mark:
41- Dynamic pool size :white_check_mark:
42- No runtime dependencies :white_check_mark:
43- Proper async integration with node async hooks :white_check_mark:
44- Support for worker threads and cluster node modules :white_check_mark:
45- Support sync and async tasks :white_check_mark:
46- General guidance on pools to use :white_check_mark:
47- Widely tested :white_check_mark:
48- Error handling out of the box :white_check_mark:
49- Active community :white_check_mark:
5fd75a2e 50- Code quality :octocat: [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=bugs)](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
d28c7996
JB
51 [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=code_smells)](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
52 [![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=duplicated_lines_density)](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
53 [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
54 [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
55 [![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=sqale_index)](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
ddaa3a76 56
50aa7901 57## Contents
e76f5485 58
34a572eb 59<h3 align="center">
50aa7901
S
60 <a href="#overview">Overview</a>
61 <span> · </span>
34a572eb 62 <a href="#installation">Installation</a>
63 <span> · </span>
64 <a href="#usage">Usage</a>
65 <span> · </span>
4f4ae1cb 66 <a href="#node-versions">Node versions</a>
50aa7901 67 <span> · </span>
34a572eb 68 <a href="#api">API</a>
69 <span> · </span>
e36cfb13 70 <a href="#general-guidance">General guidance</a>
48211d04 71 <span> · </span>
34a572eb 72 <a href="#contribute">Contribute</a>
73 <span> · </span>
50aa7901 74 <a href="#team">Team</a>
34a572eb 75 <span> · </span>
76 <a href="#license">License</a>
77</h3>
78
50aa7901 79## Overview
13031992 80
31b90205
JB
81Node pool contains two [worker-threads](https://nodejs.org/api/worker_threads.html#worker_threads_worker_threads)/[cluster worker](https://nodejs.org/api/cluster.html#cluster_class_worker) pool implementations, you don't have to deal with worker-threads/cluster worker complexity.
82The first implementation is a static worker pool, with a defined number of workers that are started at creation time and will be reused.
83The second implementation is a dynamic worker pool with a number of worker started at creation time (these workers will be always active and reused) and other workers created when the load will increase (with an upper limit, these workers will be reused when active), the new created workers will be stopped after a configurable period of inactivity.
84You have to implement your worker extending the ThreadWorker or ClusterWorker class
50aa7901
S
85
86## Installation
87
88```shell
27c5fb75 89npm install poolifier --save
1a4ec243 90```
1a4ec243 91
50aa7901
S
92## Usage
93
31b90205 94You can implement a worker-threads worker in a simple way by extending the class ThreadWorker:
1a4ec243
APA
95
96```js
97'use strict'
d2eb4964 98const { ThreadWorker } = require('poolifier')
1a4ec243 99
78cea37e 100function yourFunction(data) {
106744f7 101 // this will be executed in the worker thread,
102 // the data will be received by using the execute method
103 return { ok: 1 }
104}
105
50aa7901
S
106module.exports = new ThreadWorker(yourFunction, {
107 maxInactiveTime: 60000,
108 async: false
109})
1a4ec243
APA
110```
111
1f9a5a44 112Instantiate your pool based on your needed :
1a4ec243
APA
113
114```js
115'use strict'
aee46736 116const { DynamicThreadPool, FixedThreadPool, PoolEvents } = require('poolifier')
1a4ec243 117
31b90205 118// a fixed worker-threads pool
1a4ec243 119const pool = new FixedThreadPool(15,
106744f7 120 './yourWorker.js',
121 { errorHandler: (e) => console.error(e), onlineHandler: () => console.log('worker is online') })
1a4ec243 122
aee46736 123pool.emitter.on(PoolEvents.busy, () => console.log('Pool is busy'))
164d950a 124
31b90205 125// or a dynamic worker-threads pool
1a4ec243 126const pool = new DynamicThreadPool(10, 100,
106744f7 127 './yourWorker.js',
128 { errorHandler: (e) => console.error(e), onlineHandler: () => console.log('worker is online') })
129
aee46736
JB
130pool.emitter.on(PoolEvents.full, () => console.log('Pool is full'))
131pool.emitter.on(PoolEvents.busy, () => console.log('Pool is busy'))
1a4ec243
APA
132
133// the execute method signature is the same for both implementations,
134// so you can easy switch from one to another
135pool.execute({}).then(res => {
136 console.log(res)
777b7824 137}).catch ....
1a4ec243
APA
138
139```
140
17a9a094 141You can do the same with the classes ClusterWorker, FixedClusterPool and DynamicClusterPool.
31b90205 142
17a9a094
JB
143**See examples folder for more details (in particular if you want to use a pool for [multiple functions](./examples/multiFunctionExample.js)).**
144**Now TypeScript is also supported, find how to use it into the example folder**.
1a4ec243 145
ec2ccfc8 146Remember that workers can only send and receive serializable data.
deb85c12 147
50aa7901 148## Node versions
34a572eb 149
767d1512 150Node versions >= 16.x are supported.
1a4ec243 151
50aa7901 152## API
34a572eb 153
4680c1b2
JB
154### [Documentation](https://poolifier.github.io/poolifier/)
155
31b90205 156### `pool = new FixedThreadPool/FixedClusterPool(numberOfThreads/numberOfWorkers, filePath, opts)`
50aa7901 157
f42ca86f 158`numberOfThreads/numberOfWorkers` (mandatory) Number of workers for this pool
50aa7901 159`filePath` (mandatory) Path to a file with a worker implementation
f42ca86f 160`opts` (optional) An object with these properties:
50aa7901 161
46e857ca 162- `messageHandler` (optional) - A function that will listen for message event on each worker
f42ca86f
JB
163- `errorHandler` (optional) - A function that will listen for error event on each worker
164- `onlineHandler` (optional) - A function that will listen for online event on each worker
165- `exitHandler` (optional) - A function that will listen for exit event on each worker
46e857ca 166- `workerChoiceStrategy` (optional) - The worker choice strategy to use in this pool:
5519f8f3 167
46e857ca 168 - `WorkerChoiceStrategies.ROUND_ROBIN`: Submit tasks to worker in a round robbin fashion
737c6d97 169 - `WorkerChoiceStrategies.LESS_USED`: Submit tasks to the less used worker
168c526f 170 - `WorkerChoiceStrategies.LESS_BUSY`: Submit tasks to the less busy worker
cb9eb085 171 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN`: Submit tasks to worker using a weighted round robin scheduling algorithm based on tasks execution time
46e857ca 172 - `WorkerChoiceStrategies.FAIR_SHARE`: Submit tasks to worker using a fair share tasks scheduling algorithm based on tasks execution time
5519f8f3 173
cb5d2427 174 `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` and `WorkerChoiceStrategies.FAIR_SHARE` strategies are targeted to heavy and long tasks
f42ca86f 175 Default: `WorkerChoiceStrategies.ROUND_ROBIN`
5519f8f3 176
da309861
JB
177- `workerChoiceStrategyOptions` (optional) - The worker choice strategy options object to use in this pool.
178 Properties:
179
180 - `medRunTime` (optional) - Use the tasks median run time instead of the tasks average run time in worker choice strategies.
181 Default: { medRunTime: false }
182
f42ca86f 183- `enableEvents` (optional) - Events emission enablement in this pool. Default: true
ff733df7 184- `enableTasksQueue` (optional, experimental) - Tasks queue per worker enablement in this pool. Default: false
34a572eb 185
31b90205 186### `pool = new DynamicThreadPool/DynamicClusterPool(min, max, filePath, opts)`
50aa7901 187
31b90205
JB
188`min` (mandatory) Same as FixedThreadPool/FixedClusterPool numberOfThreads/numberOfWorkers, this number of workers will be always active
189`max` (mandatory) Max number of workers that this pool can contain, the new created workers will die after a threshold (default is 1 minute, you can override it in your worker implementation).
190`filePath` (mandatory) Same as FixedThreadPool/FixedClusterPool
191`opts` (optional) Same as FixedThreadPool/FixedClusterPool
34a572eb 192
193### `pool.execute(data)`
50aa7901 194
f42ca86f 195Execute method is available on both pool implementations (return type: Promise):
50aa7901 196`data` (mandatory) An object that you want to pass to your worker implementation
34a572eb 197
198### `pool.destroy()`
34a572eb 199
50aa7901
S
200Destroy method is available on both pool implementations.
201This method will call the terminate method on each worker.
34a572eb 202
31b90205 203### `class YourWorker extends ThreadWorker/ClusterWorker`
50aa7901 204
31b90205 205`fn` (mandatory) The function that you want to execute on the worker
50aa7901
S
206`opts` (optional) An object with these properties:
207
31b90205 208- `maxInactiveTime` - Max time to wait tasks to work on (in ms), after this period the new worker will die.
3832ad95
S
209 The last active time of your worker unit will be updated when a task is submitted to a worker or when a worker terminate a task.
210 If `killBehavior` is set to `KillBehaviors.HARD` this value represents also the timeout for the tasks that you submit to the pool, when this timeout expires your tasks is interrupted and the worker is killed if is not part of the minimum size of the pool.
211 If `killBehavior` is set to `KillBehaviors.SOFT` your tasks have no timeout and your workers will not be terminated until your task is completed.
bf9549ae 212 Default: 60000 ms
15eacd5d 213
46e857ca 214- `async` - true/false, true if your function contains async code pieces, else false
15eacd5d 215- `killBehavior` - Dictates if your async unit (worker/process) will be deleted in case that a task is active on it.
f42ca86f 216 **KillBehaviors.SOFT**: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still running, then the worker **won't** be deleted.
a9d9ea34 217 **KillBehaviors.HARD**: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still running, then the worker will be deleted.
3832ad95 218 This option only apply to the newly created workers.
f42ca86f 219 Default: `KillBehaviors.SOFT`
50aa7901 220
e36cfb13 221## General guidance
34a572eb 222
31b90205 223Performance is one of the main target of these worker pool implementations, we want to have a strong focus on this.
e36cfb13
APA
224We already have a bench folder where you can find some comparisons.
225
226### Internal Node.js thread pool
227
228Before to jump into each poolifier pool type, let highlight that **Node.js comes with a thread pool already**, the libuv thread pool where some particular tasks already run by default.
229Please take a look at [which tasks run on the libuv thread pool](https://nodejs.org/en/docs/guides/dont-block-the-event-loop/#what-code-runs-on-the-worker-pool).
230
e843b904 231**If your task runs on libuv thread pool**, you can try to:
e36cfb13
APA
232
233- Tune the libuv thread pool size setting the [UV_THREADPOOL_SIZE](https://nodejs.org/api/cli.html#cli_uv_threadpool_size_size)
234
235and/or
236
237- Use poolifier cluster pool that spawning child processes will also increase the number of libuv threads since that any new child process comes with a separated libuv thread pool. **More threads does not mean more fast, so please tune your application.**
238
239### Cluster vs Threads worker pools
240
241**If your task does not run into libuv thread pool** and is CPU intensive then poolifier **thread pools** (FixedThreadPool and DynamicThreadPool) are suggested to run CPU intensive tasks, you can still run I/O intensive tasks into thread pools, but performance enhancement is expected to be minimal.
063f8c5b 242Thread pools are built on top of Node.js [worker-threads](https://nodejs.org/api/worker_threads.html#worker_threads_worker_threads) module.
243
e36cfb13
APA
244**If your task does not run into libuv thread pool** and is I/O intensive then poolifier **cluster pools** (FixedClusterPool and DynamicClusterPool) are suggested to run I/O intensive tasks, again you can still run CPU intensive tasks into cluster pools, but performance enhancement is expected to be minimal.
245Consider that by default Node.js already has great performance for I/O tasks (asynchronous I/O).
4a6952ff 246Cluster pools are built on top of Node.js [cluster](https://nodejs.org/api/cluster.html) module.
75876e4c 247
e36cfb13
APA
248If your task contains code that runs on libuv plus code that is CPU intensive or I/O intensive you either split it either combine more strategies (i.e. tune the number of libuv threads and use cluster/thread pools).
249But in general, **always profile your application**
250
251### Fixed vs Dynamic pools
063f8c5b 252
31b90205 253To choose your pool consider that with a FixedThreadPool/FixedClusterPool or a DynamicThreadPool/DynamicClusterPool (in this case is important the min parameter passed to the constructor) your application memory footprint will increase.
063f8c5b 254Increasing the memory footprint, your application will be ready to accept more tasks, but during idle time your application will consume more memory.
31b90205
JB
255One good choose from my point of view is to profile your application using Fixed/Dynamic worker pool, and to see your application metrics when you increase/decrease the num of workers.
256For example you could keep the memory footprint low choosing a DynamicThreadPool/DynamicClusterPool with 5 workers, and allow to create new workers until 50/100 when needed, this is the advantage to use the DynamicThreadPool/DynamicClusterPool.
50aa7901 257But in general, **always profile your application**
48211d04 258
50aa7901 259## Contribute
34a572eb 260
50aa7901 261See guidelines [CONTRIBUTING](CONTRIBUTING.md)
d1affa4c 262Choose your task here [2.4.x](https://github.com/orgs/poolifier/projects/1), propose an idea, a fix, an improvement.
1a4ec243 263
50aa7901 264## Team
1a4ec243 265
39deb558 266<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
39deb558 267
268**Creator/Owner:**
39deb558 269
50aa7901
S
270- [**Alessandro Pio Ardizio**](https://github.com/pioardi)
271
272**_Contributors_**
273
274- [**Shinigami92**](https://github.com/Shinigami92)
275- [**Jérôme Benoit**](https://github.com/jerome-benoit)
39deb558 276
50aa7901 277## License
1a4ec243 278
9507c1d4 279[MIT](./LICENSE)