Update README.md
[poolifier.git] / README.md
1 <div align="center">
2 <img src="./docs/logo.png" width="300" height="350"/>
3 </div>
4
5 <h2 align="center">Node Thread Pool :arrow_double_up: :on:</h2>
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>
10 <a href="https://github.com/pioardi/node-pool/actions">
11 <img alt="Actions Status" src="https://github.com/pioardi/node-pool/workflows/NodeCI/badge.svg"></a>
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">
15 <img alt="Code coverage" src="https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=coverage"></a>
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>
20 <a href="https://badgen.net/dependabot/dependabot/dependabot-core/?icon=dependabot">
21 <img alt="Dependabot" src="https://badgen.net/dependabot/dependabot/dependabot-core/?icon=dependabot"></a>
22 <a href="http://makeapullrequest.com">
23 <img alt="PR Welcome" src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square"></a>
24 <a href="https://img.shields.io/static/v1?label=dependencies&message=no%20dependencies&color=brightgreen">
25 <img alt="No dependencies" src="https://img.shields.io/static/v1?label=dependencies&message=no%20dependencies&color=brightgreen"></a>
26
27 </p>
28
29
30
31
32 ## Why Poolifier?
33
34 Poolifier is used to perform heavy CPU bound tasks on nodejs servers, it implements thread pools (yes, more thread 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).
35 With poolifier you can improve your **performance** and resolve problems related to the event loop.
36 Moreover you can execute your CPU tasks using an API designed to improve the **developer experience**.
37
38 - Performance :racehorse:
39 - 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)
40
41 - No runtime dependencies :heavy_check_mark:
42 - Easy to use :couple:
43 - Easy switch from a pool to another, easy to tune
44 - Dynamic pool size
45 - Proper async integration with node async hooks
46 - Support for worker threads and cluster node modules
47 - Active community
48 - Support sync and async tasks
49 - General guidance on pools to use
50 - Widely tested
51 - Error handling out of the box
52 - Code quality :octocat: [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=bugs)](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
53 [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=code_smells)](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
54 [![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=duplicated_lines_density)](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
55 [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
56 [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
57 [![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=sqale_index)](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
58
59
60 ## Contents
61
62 <h3 align="center">
63 <a href="#overview">Overview</a>
64 <span> · </span>
65 <a href="#installation">Installation</a>
66 <span> · </span>
67 <a href="#usage">Usage</a>
68 <span> · </span>
69 <a href="#node-versions"> Node versions</a>
70 <span> · </span>
71 <a href="#api">API</a>
72 <span> · </span>
73 <a href="#choose-your-pool">Choose your pool</a>
74 <span> · </span>
75 <a href="#contribute">Contribute</a>
76 <span> · </span>
77 <a href="#team">Team</a>
78 <span> · </span>
79 <a href="#license">License</a>
80 </h3>
81
82 ## Overview
83
84 Node pool contains two [worker-threads](https://nodejs.org/api/worker_threads.html#worker_threads_worker_threads) pool implementations, you don't have to deal with worker-threads complexity.
85 The first implementation is a static thread pool, with a defined number of threads that are started at creation time and will be reused.
86 The second implementation is a dynamic thread pool with a number of threads started at creation time (these threads will be always active and reused) and other threads created when the load will increase (with an upper limit, these threads will be reused when active), the new created threads will be stopped after a configurable period of inactivity.
87 You have to implement your worker extending the ThreadWorker class
88
89 ## Installation
90
91 ```shell
92 npm install poolifier --save
93 ```
94
95 ## Usage
96
97 You can implement a worker in a simple way, extending the class ThreadWorker:
98
99 ```js
100 'use strict'
101 const { ThreadWorker } = require('poolifier')
102
103 function yourFunction (data) {
104 // this will be executed in the worker thread,
105 // the data will be received by using the execute method
106 return { ok: 1 }
107 }
108
109 module.exports = new ThreadWorker(yourFunction, {
110 maxInactiveTime: 60000,
111 async: false
112 })
113 ```
114
115 Instantiate your pool based on your needed :
116
117 ```js
118 'use strict'
119 const { FixedThreadPool, DynamicThreadPool } = require('poolifier')
120
121 // a fixed thread pool
122 const pool = new FixedThreadPool(15,
123 './yourWorker.js',
124 { errorHandler: (e) => console.error(e), onlineHandler: () => console.log('worker is online') })
125
126 // or a dynamic thread pool
127 const pool = new DynamicThreadPool(10, 100,
128 './yourWorker.js',
129 { errorHandler: (e) => console.error(e), onlineHandler: () => console.log('worker is online') })
130
131 pool.emitter.on('FullPool', () => console.log('Pool is full'))
132
133 // the execute method signature is the same for both implementations,
134 // so you can easy switch from one to another
135 pool.execute({}).then(res => {
136 console.log(res)
137 }).catch ....
138
139 ```
140
141 **See examples folder for more details (in particular if you want to use a pool for [multiple functions](./examples/multiFunctionExample.js)).**
142 **Now type script is also supported, find how to use it into the example folder**
143
144 ## Node versions
145
146 You can use node versions 12.x, 13.x, 14.x
147
148 ## API
149
150 ### `pool = new FixedThreadPool(numThreads, filePath, opts)`
151
152 `numThreads` (mandatory) Num of threads for this worker pool
153 `filePath` (mandatory) Path to a file with a worker implementation
154 `opts` (optional) An object with these properties :
155
156 - `errorHandler` - A function that will listen for error event on each worker thread
157 - `onlineHandler` - A function that will listen for online event on each worker thread
158 - `exitHandler` - A function that will listen for exit event on each worker thread
159 - `maxTasks` - This is just to avoid not useful warnings message, is used to set [maxListeners](https://nodejs.org/dist/latest-v12.x/docs/api/events.html#events_emitter_setmaxlisteners_n) on event emitters (workers are event emitters)
160
161 ### `pool = new DynamicThreadPool(min, max, filePath, opts)`
162
163 `min` (mandatory) Same as FixedThreadPool numThreads, this number of threads will be always active
164 `max` (mandatory) Max number of workers that this pool can contain, the new created threads will die after a threshold (default is 1 minute, you can override it in your worker implementation).
165 `filePath` (mandatory) Same as FixedThreadPool
166 `opts` (optional) Same as FixedThreadPool
167
168 ### `pool.execute(data)`
169
170 Execute method is available on both pool implementations (return type : Promise):
171 `data` (mandatory) An object that you want to pass to your worker implementation
172
173 ### `pool.destroy()`
174
175 Destroy method is available on both pool implementations.
176 This method will call the terminate method on each worker.
177
178 ### `class YourWorker extends ThreadWorker`
179
180 `fn` (mandatory) The function that you want to execute on the worker thread
181 `opts` (optional) An object with these properties:
182
183 - `maxInactiveTime` - Max time to wait tasks to work on ( in ms) , after this period the new worker threads will die.
184 - `async` - true/false, true if your function contains async pieces else false
185
186 ## Choose your pool
187
188 Performance is one of the main target of these thread pool implementations, we want to have a strong focus on this.
189 We already have a bench folder where you can find some comparisons.
190 To choose your pool consider that with a FixedThreadPool or a DynamicThreadPool (in this case is important the min parameter passed to the constructor) your application memory footprint will increase.
191 Increasing the memory footprint, your application will be ready to accept more CPU bound tasks, but during idle time your application will consume more memory.
192 One good choose from my point of view is to profile your application using Fixed/Dynamic thread pool, and to see your application metrics when you increase/decrease the num of threads.
193 For example you could keep the memory footprint low choosing a DynamicThreadPool with 5 threads, and allow to create new threads until 50/100 when needed, this is the advantage to use the DynamicThreadPool.
194 But in general, **always profile your application**
195
196 ## Contribute
197
198 See guidelines [CONTRIBUTING](CONTRIBUTING.md)
199 Choose your task here [2.0.0](https://github.com/pioardi/poolifier/projects/1), propose an idea, a fix, an improvement.
200
201 ## Team
202
203 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
204 <!-- prettier-ignore-start -->
205 <!-- markdownlint-disable -->
206
207 **Creator/Owner:**
208
209 - [**Alessandro Pio Ardizio**](https://github.com/pioardi)
210
211 **_Contributors_**
212
213 - [**Shinigami92**](https://github.com/Shinigami92)
214 - [**Jérôme Benoit**](https://github.com/jerome-benoit)
215
216 ## License
217
218 [MIT](./LICENSE)