build(deps-dev): bump @rollup/plugin-typescript
[poolifier.git] / README.md
... / ...
CommitLineData
1<div align="center">
2 <img src="./images/logo.png" width="340px" height="266px"/>
3</div>
4
5<h1 align="center">Node.js Worker_Threads and Cluster Worker Pool</h1>
6
7<p align="center">
8 <a href="https://github.com/poolifier/poolifier/graphs/commit-activity">
9 <img alt="GitHub commit activity (master)" src="https://img.shields.io/github/commit-activity/m/poolifier/poolifier/master"></a>
10 <a href="https://www.npmjs.com/package/poolifier">
11 <img alt="Weekly Downloads" src="https://img.shields.io/npm/dw/poolifier"></a>
12 <a href="https://github.com/poolifier/poolifier/actions/workflows/ci.yml">
13 <img alt="Actions Status" src="https://github.com/poolifier/poolifier/actions/workflows/ci.yml/badge.svg"></a>
14 <a href="https://sonarcloud.io/dashboard?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://sonarcloud.io/dashboard?id=pioardi_poolifier">
17 <img alt="Quality Gate Status" src="https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=alert_status"></a>
18 <a href="https://standardjs.com">
19 <img alt="Javascript Standard Style Guide" src="https://img.shields.io/badge/code_style-standard-brightgreen.svg"></a>
20 <a href="https://gitter.im/poolifier/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge">
21 <img alt="Gitter chat" src="https://badges.gitter.im/poolifier/community.svg"></a>
22 <a href="https://opencollective.com/poolifier">
23 <img alt="Open Collective" src="https://opencollective.com/poolifier/tiers/badge.svg"></a>
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>
28</p>
29
30## Why Poolifier?
31
32Poolifier is used to perform CPU and/or I/O intensive tasks on Node.js servers, it implements worker pools using [worker_threads](https://nodejs.org/api/worker_threads.html) and [cluster](https://nodejs.org/api/cluster.html) Node.js modules.
33With poolifier you can improve your **performance** and resolve problems related to the event loop.
34Moreover you can execute your tasks using an API designed to improve the **developer experience**.
35Please consult our [general guidelines](#general-guidelines).
36
37- Easy to use :white_check_mark:
38- Performance [benchmarks](./benchmarks/README.md) :white_check_mark:
39- Fixed and dynamic pool size :white_check_mark:
40- Easy switch from a pool type to another :white_check_mark:
41- No runtime dependencies :white_check_mark:
42- Proper integration with Node.js [async_hooks](https://nodejs.org/api/async_hooks.html) :white_check_mark:
43- Support for CommonJS, ESM, and TypeScript :white_check_mark:
44- Support for [worker_threads](https://nodejs.org/api/worker_threads.html) and [cluster](https://nodejs.org/api/cluster.html) Node.js modules :white_check_mark:
45- Support for multiple task functions :white_check_mark:
46- Support for sync and async task functions :white_check_mark:
47- Tasks distribution strategies :white_check_mark:
48- Lockless tasks queueing :white_check_mark:
49- Queued tasks rescheduling:
50 - Task stealing :white_check_mark:
51 - Tasks stealing under back pressure :white_check_mark:
52 - Tasks redistribution on worker error :white_check_mark:
53- General guidelines on pool choice :white_check_mark:
54- Error handling out of the box :white_check_mark:
55- Widely tested :white_check_mark:
56- Active community :white_check_mark:
57- Code quality [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=bugs)](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
58 [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=code_smells)](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
59 [![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=duplicated_lines_density)](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
60 [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
61 [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
62 [![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=sqale_index)](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
63- Code security [![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)
64
65## Table of contents
66
67- [Overview](#overview)
68- [Installation](#installation)
69- [Usage](#usage)
70- [Node.js versions](#nodejs-versions)
71- [API](#api)
72- [General guidelines](#general-guidelines)
73- [Worker choice strategies](#worker-choice-strategies)
74- [Contribute](#contribute)
75- [Team](#team)
76- [License](#license)
77
78## Overview
79
80Poolifier contains two [worker_threads](https://nodejs.org/api/worker_threads.html#class-worker)/[cluster](https://nodejs.org/api/cluster.html#cluster_class_worker) worker pool implementations, you don't have to deal with [worker_threads](https://nodejs.org/api/worker_threads.html)/[cluster](https://nodejs.org/api/cluster.html) complexity.
81The first implementation is a fixed worker pool, with a defined number of workers that are started at creation time and will be reused.
82The 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.
83You have to implement your worker by extending the _ThreadWorker_ or _ClusterWorker_ class.
84
85## Installation
86
87```shell
88npm install poolifier --save
89```
90
91## Usage
92
93You can implement a [worker_threads](https://nodejs.org/api/worker_threads.html#class-worker) worker in a simple way by extending the class _ThreadWorker_:
94
95```js
96'use strict'
97const { ThreadWorker } = require('poolifier')
98
99function yourFunction(data) {
100 // this will be executed in the worker thread,
101 // the data will be received by using the execute method
102 return { ok: 1 }
103}
104
105module.exports = new ThreadWorker(yourFunction, {
106 maxInactiveTime: 60000
107})
108```
109
110Instantiate your pool based on your needs :
111
112```js
113'use strict'
114const { DynamicThreadPool, FixedThreadPool, PoolEvents, availableParallelism } = require('poolifier')
115
116// a fixed worker_threads pool
117const pool = new FixedThreadPool(availableParallelism(), './yourWorker.js', {
118 errorHandler: (e) => console.error(e),
119 onlineHandler: () => console.info('worker is online')
120})
121
122pool.emitter.on(PoolEvents.ready, () => console.info('Pool is ready'))
123pool.emitter.on(PoolEvents.busy, () => console.info('Pool is busy'))
124
125// or a dynamic worker_threads pool
126const pool = new DynamicThreadPool(Math.floor(availableParallelism() / 2), availableParallelism(), './yourWorker.js', {
127 errorHandler: (e) => console.error(e),
128 onlineHandler: () => console.info('worker is online')
129})
130
131pool.emitter.on(PoolEvents.full, () => console.info('Pool is full'))
132pool.emitter.on(PoolEvents.ready, () => console.info('Pool is ready'))
133pool.emitter.on(PoolEvents.busy, () => console.info('Pool is busy'))
134
135// the execute method signature is the same for both implementations,
136// so you can easily switch from one to another
137pool
138 .execute()
139 .then((res) => {
140 console.info(res)
141 })
142 .catch((err) => {
143 console.error(err)
144 })
145```
146
147You can do the same with the classes _ClusterWorker_, _FixedClusterPool_ and _DynamicClusterPool_.
148
149**See [examples](./examples/) for more details**:
150
151- [Javascript](./examples/javascript/)
152- [Typescript](./examples/typescript/)
153 - [HTTP client pool](./examples/typescript/http-client-pool/)
154 - [SMTP client pool](./examples/typescript/smtp-client-pool/)
155 - [HTTP server pool](./examples/typescript/http-server-pool/)
156 - [Express worker_threads pool](./examples/typescript/http-server-pool/express-worker_threads/)
157 - [Express cluster pool](./examples/typescript/http-server-pool/express-cluster/)
158 - [Express hybrid pool](./examples/typescript/http-server-pool/express-hybrid/)
159 - [Fastify worker_threads pool](./examples/typescript/http-server-pool/fastify-worker_threads/)
160 - [Fastify cluster pool](./examples/typescript/http-server-pool/fastify-cluster/)
161 - [Fastify hybrid pool](./examples/typescript/http-server-pool/fastify-hybrid/)
162 - [WebSocket server pool](./examples/typescript/websocket-server-pool/)
163 - [ws worker_threads pool](./examples/typescript/websocket-server-pool/ws-worker_threads/)
164 - [ws cluster pool](./examples/typescript/websocket-server-pool/ws-cluster/)
165 - [ws hybrid pool](./examples/typescript/websocket-server-pool/ws-hybrid/)
166
167Remember that workers can only send and receive structured-cloneable data.
168
169## Node.js versions
170
171Node.js versions >= 16.14.x are supported.
172
173## [API](./docs/api.md)
174
175## [General guidelines](./docs/general-guidelines.md)
176
177## [Worker choice strategies](./docs/worker-choice-strategies.md)
178
179## Contribute
180
181Choose your task here [2.6.x](https://github.com/orgs/poolifier/projects/1), propose an idea, a fix, an improvement.
182
183See [CONTRIBUTING](CONTRIBUTING.md) guidelines.
184
185## Team
186
187**Creator/Owner:**
188
189- [**Alessandro Pio Ardizio**](https://github.com/pioardi)
190
191**_Contributors_**
192
193- [**Shinigami92**](https://github.com/Shinigami92)
194- [**Jérôme Benoit**](https://github.com/jerome-benoit)
195
196## License
197
198[MIT](./LICENSE)