-# Node Thread Pool :arrow_double_up: :on:
-
-[](https://standardjs.com)
-[](https://badgen.net/dependabot/dependabot/dependabot-core/?icon=dependabot)
-[](https://www.npmjs.com/package/poolifier)
-[](https://github.com/pioardi/node-pool/actions)
-[](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
- [](https://sonarcloud.io/component_measures/metric/coverage/list)
-[](http://makeapullrequest.com)
-[](https://img.shields.io/static/v1?label=dependencies&message=no%20dependencies&color=brightgreen)
-[](https://gitter.im/poolifier/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
-
-<div align="left">
-<img src="./docs/logo.png" width="400" height="475"/>
+<div align="center">
+ <img src="./images/logo.png" width="340px" height="266px"/>
</div>
+<h1 align="center">Node.js Worker_Threads and Cluster Worker Pool</h1>
+
+<p align="center">
+ <a href="https://github.com/poolifier/poolifier/graphs/commit-activity">
+ <img alt="GitHub commit activity (master)" src="https://img.shields.io/github/commit-activity/m/poolifier/poolifier/master"></a>
+ <a href="https://www.npmjs.com/package/poolifier">
+ <img alt="Weekly Downloads" src="https://img.shields.io/npm/dw/poolifier"></a>
+ <a href="https://github.com/poolifier/poolifier/actions/workflows/ci.yml">
+ <img alt="Actions Status" src="https://github.com/poolifier/poolifier/actions/workflows/ci.yml/badge.svg"></a>
+ <a href="https://sonarcloud.io/dashboard?id=pioardi_poolifier">
+ <img alt="Code Coverage" src="https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=coverage"></a>
+ <a href="https://sonarcloud.io/dashboard?id=pioardi_poolifier">
+ <img alt="Quality Gate Status" src="https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=alert_status"></a>
+ <a href="https://standardjs.com">
+ <img alt="Javascript Standard Style Guide" src="https://img.shields.io/badge/code_style-standard-brightgreen.svg"></a>
+ <a href="https://gitter.im/poolifier/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge">
+ <img alt="Gitter chat" src="https://badges.gitter.im/poolifier/community.svg"></a>
+ <a href="https://opencollective.com/poolifier">
+ <img alt="Open Collective" src="https://opencollective.com/poolifier/tiers/badge.svg"></a>
+ <a href="http://makeapullrequest.com">
+ <img alt="PR Welcome" src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square"></a>
+ <a href="https://img.shields.io/static/v1?label=dependencies&message=no%20dependencies&color=brightgreen">
+ <img alt="No dependencies" src="https://img.shields.io/static/v1?label=dependencies&message=no%20dependencies&color=brightgreen"></a>
+</p>
+
## Why Poolifier?
-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).
+Poolifier 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.
With poolifier you can improve your **performance** and resolve problems related to the event loop.
-Moreover you can execute your CPU tasks using an API designed to improve the **developer experience**.
-
-- Performance :racehorse:
-- Security :bank: :cop: [](https://sonarcloud.io/dashboard?id=pioardi_poolifier)[](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
-
-- No runtime dependencies :white_check_mark: (until now we don't have any exception to that)
-- Easy to use :couple:
-- Code quality :octocat: [](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
-[](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
-[](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
-[](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
-[](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
-[](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
-- Easy switch from a pool to another, easy to tune.
-- Dynamic pool size
-- Proper async integration with node async hooks
-- Support for worker threads and cluster node modules
-- Active community
-- Support sync and async tasks
-- General guidance on pools to use
-- Widely tested
-- Error handling out of the box
-
-## Contents
-
-<h3 align="center">
- <a href="#overview">Overview</a>
- <span> · </span>
- <a href="#installation">Installation</a>
- <span> · </span>
- <a href="#usage">Usage</a>
- <span> · </span>
- <a href="#node-versions"> Node versions</a>
- <span> · </span>
- <a href="#api">API</a>
- <span> · </span>
- <a href="#choose-your-pool">Choose your pool</a>
- <span> · </span>
- <a href="#contribute">Contribute</a>
- <span> · </span>
- <a href="#team">Team</a>
- <span> · </span>
- <a href="#license">License</a>
-</h3>
+Moreover you can execute your tasks using an API designed to improve the **developer experience**.
+Please consult our [general guidelines](#general-guidelines).
+
+- Easy to use :white_check_mark:
+- Performance [benchmarks](./benchmarks/README.md) :white_check_mark:
+- Fixed and dynamic pool size :white_check_mark:
+- Easy switch from a pool type to another :white_check_mark:
+- No runtime dependencies :white_check_mark:
+- Proper integration with node [async_hooks](https://nodejs.org/api/async_hooks.html) :white_check_mark:
+- Support CommonJS, ESM, and TypeScript :white_check_mark:
+- 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:
+- Support multiple task functions :white_check_mark:
+- Support sync and async task functions :white_check_mark:
+- Tasks distribution strategies :white_check_mark:
+- General guidelines on pool choice :white_check_mark:
+- Error handling out of the box :white_check_mark:
+- Widely tested :white_check_mark:
+- Active community :white_check_mark:
+- Code quality [](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
+ [](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
+ [](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
+ [](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
+ [](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
+ [](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
+- Code security [](https://sonarcloud.io/dashboard?id=pioardi_poolifier) [](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
+
+## Table of contents
+
+- [Overview](#overview)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Node versions](#node-versions)
+- [API](#api)
+- [General guidelines](#general-guidelines)
+- [Worker choice strategies](#worker-choice-strategies)
+- [Contribute](#contribute)
+- [Team](#team)
+- [License](#license)
## Overview
-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.
-The first implementation is a static thread pool, with a defined number of threads that are started at creation time and will be reused.
-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.
-You have to implement your worker extending the ThreadWorker class
+Poolifier 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.
+The first implementation is a fixed worker pool, with a defined number of workers that are started at creation time and will be reused.
+The 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.
+You have to implement your worker by extending the _ThreadWorker_ or _ClusterWorker_ class.
## Installation
## Usage
-You can implement a worker in a simple way, extending the class ThreadWorker:
+You can implement a [worker_threads](https://nodejs.org/api/worker_threads.html#class-worker) worker in a simple way by extending the class _ThreadWorker_:
```js
'use strict'
const { ThreadWorker } = require('poolifier')
-function yourFunction (data) {
+function yourFunction(data) {
// this will be executed in the worker thread,
// the data will be received by using the execute method
return { ok: 1 }
}
module.exports = new ThreadWorker(yourFunction, {
- maxInactiveTime: 60000,
- async: false
+ maxInactiveTime: 60000
})
```
-Instantiate your pool based on your needed :
+Instantiate your pool based on your needs :
```js
'use strict'
-const { FixedThreadPool, DynamicThreadPool } = require('poolifier')
+const { DynamicThreadPool, FixedThreadPool, PoolEvents, availableParallelism } = require('poolifier')
-// a fixed thread pool
-const pool = new FixedThreadPool(15,
- './yourWorker.js',
- { errorHandler: (e) => console.error(e), onlineHandler: () => console.log('worker is online') })
+// a fixed worker_threads pool
+const pool = new FixedThreadPool(availableParallelism(), './yourWorker.js', {
+ errorHandler: e => console.error(e),
+ onlineHandler: () => console.info('worker is online')
+})
-// or a dynamic thread pool
-const pool = new DynamicThreadPool(10, 100,
- './yourWorker.js',
- { errorHandler: (e) => console.error(e), onlineHandler: () => console.log('worker is online') })
+pool.emitter.on(PoolEvents.ready, () => console.info('Pool is ready'))
+pool.emitter.on(PoolEvents.busy, () => console.info('Pool is busy'))
-pool.emitter.on('FullPool', () => console.log('Pool is full'))
+// or a dynamic worker_threads pool
+const pool = new DynamicThreadPool(Math.floor(availableParallelism() / 2), availableParallelism(), './yourWorker.js', {
+ errorHandler: e => console.error(e),
+ onlineHandler: () => console.info('worker is online')
+})
+
+pool.emitter.on(PoolEvents.full, () => console.info('Pool is full'))
+pool.emitter.on(PoolEvents.ready, () => console.info('Pool is ready'))
+pool.emitter.on(PoolEvents.busy, () => console.info('Pool is busy'))
// the execute method signature is the same for both implementations,
// so you can easy switch from one to another
-pool.execute({}).then(res => {
- console.log(res)
-}).catch ....
-
+pool
+ .execute()
+ .then(res => {
+ console.info(res)
+ })
+ .catch(err => {
+ console.error(err)
+ })
```
-**See examples folder for more details (in particular if you want to use a pool for [multiple functions](./examples/multiFunctionExample.js)).**
-**Now type script is also supported, find how to use it into the example folder**
-
-## Node versions
-
-You can use node versions 12.x, 13.x, 14.x
-
-## API
+You can do the same with the classes _ClusterWorker_, _FixedClusterPool_ and _DynamicClusterPool_.
-### `pool = new FixedThreadPool(numThreads, filePath, opts)`
+**See [examples](./examples/) folder for more details**:
-`numThreads` (mandatory) Num of threads for this worker pool
-`filePath` (mandatory) Path to a file with a worker implementation
-`opts` (optional) An object with these properties :
+- [Javascript](./examples/)
+- [Typescript](./examples/typescript/)
+ - [HTTP client pool](./examples/typescript/http-client/)
-- `errorHandler` - A function that will listen for error event on each worker thread
-- `onlineHandler` - A function that will listen for online event on each worker thread
-- `exitHandler` - A function that will listen for exit event on each worker thread
-- `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)
+Remember that workers can only send and receive structured-cloneable data.
-### `pool = new DynamicThreadPool(min, max, filePath, opts)`
-
-`min` (mandatory) Same as FixedThreadPool numThreads, this number of threads will be always active
-`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).
-`filePath` (mandatory) Same as FixedThreadPool
-`opts` (optional) Same as FixedThreadPool
-
-### `pool.execute(data)`
-
-Execute method is available on both pool implementations (return type : Promise):
-`data` (mandatory) An object that you want to pass to your worker implementation
-
-### `pool.destroy()`
-
-Destroy method is available on both pool implementations.
-This method will call the terminate method on each worker.
-
-### `class YourWorker extends ThreadWorker`
+## Node versions
-`fn` (mandatory) The function that you want to execute on the worker thread
-`opts` (optional) An object with these properties:
+Node versions >= 16.14.x are supported.
-- `maxInactiveTime` - Max time to wait tasks to work on ( in ms) , after this period the new worker threads will die.
-- `async` - true/false, true if your function contains async pieces else false
+## [API](./docs/api.md)
-## Choose your pool
+## [General guidelines](./docs/general-guidelines.md)
-Performance is one of the main target of these thread pool implementations, we want to have a strong focus on this.
-We already have a bench folder where you can find some comparisons.
-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.
-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.
-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.
-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.
-But in general, **always profile your application**
+## [Worker choice strategies](./docs/worker-choice-strategies.md)
## Contribute
-See guidelines [CONTRIBUTING](CONTRIBUTING.md)
-Choose your task here [2.0.0](https://github.com/pioardi/poolifier/projects/1), propose an idea, a fix, an improvement.
+Choose your task here [2.6.x](https://github.com/orgs/poolifier/projects/1), propose an idea, a fix, an improvement.
-## Team
+See [CONTRIBUTING](CONTRIBUTING.md) guidelines.
-<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
-<!-- prettier-ignore-start -->
-<!-- markdownlint-disable -->
+## Team
**Creator/Owner:**
repositories / poolifier.git / blobdiff