<div align="center">
-<img src="./docs/logo.png" width="340px" height="266px"/>
+<img src="./images/logo.png" width="340px" height="266px"/>
</div>
<h2 align="center">Node Thread Pool and Cluster Pool :arrow_double_up: :on:</h2>
-<h2 align="center">
- <a href="https://ko-fi.com/Q5Q31D6QY">
- <img alt="Ko-fi" src="https://ko-fi.com/img/githubbutton_sm.svg"></a>
-</h2>
<p align="center">
<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/pioardi/node-pool/actions">
- <img alt="Actions Status" src="https://github.com/pioardi/node-pool/workflows/NodeCI/badge.svg"></a>
+ <a href="https://github.com/poolifier/poolifier/actions">
+ <img alt="Actions Status" src="https://github.com/poolifier/poolifier/workflows/NodeCI/badge.svg"></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://sonarcloud.io/component_measures/metric/coverage/list?id=pioardi_poolifier">
- <img alt="Code coverage" src="https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=coverage"></a>
+ <img alt="Code Coverage" src="https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=coverage"></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://badgen.net/dependabot/dependabot/dependabot-core/?icon=dependabot">
- <img alt="Dependabot" src="https://badgen.net/dependabot/dependabot/dependabot-core/?icon=dependabot"></a>
+ <a href="https://opencollective.com/poolifier">
+ <img alt="Open Collective" src="https://opencollective.com/poolifier/tiers/badge.svg"></a>
+ <a href="https://badgen.net/badge/Dependabot/enabled/green?icon=dependabot">
+ <img alt="Dependabot" src="https://badgen.net/badge/Dependabot/enabled/green?icon=dependabot"></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">
- Performance :racehorse: [benchmarks](./benchmarks/README.md)
- Security :bank: :cop: [](https://sonarcloud.io/dashboard?id=pioardi_poolifier) [](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
- Easy to use :couple:
-- Easy switch from a pool to another, easy to tune :heavy_check_mark:
-- Dynamic pool size :heavy_check_mark:
-- No runtime dependencies :heavy_check_mark:
-- Proper async integration with node async hooks :heavy_check_mark:
-- Support for worker threads and cluster node modules :heavy_check_mark:
-- Support sync and async tasks :heavy_check_mark:
-- General guidance on pools to use :heavy_check_mark:
-- Widely tested :heavy_check_mark:
-- Error handling out of the box :heavy_check_mark:
-- Active community :heavy_check_mark:
+- Easy switch from a pool to another, easy to tune :white_check_mark:
+- Dynamic pool size :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:
+- Support sync and async tasks :white_check_mark:
+- General guidance on pools to use :white_check_mark:
+- Widely tested :white_check_mark:
+- Error handling out of the box :white_check_mark:
+- Active community :white_check_mark:
- Code quality :octocat: [](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
[](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
[](https://sonarcloud.io/dashboard?id=pioardi_poolifier)
<span> · </span>
<a href="#usage">Usage</a>
<span> · </span>
- <a href="#node-versions"> Node versions</a>
+ <a href="#node-versions">Node versions</a>
<span> · </span>
<a href="#api">API</a>
<span> · </span>
'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 }
```js
'use strict'
-const { FixedThreadPool, DynamicThreadPool } = require('poolifier')
+const { DynamicThreadPool, FixedThreadPool, PoolEvents } = require('poolifier')
// a fixed worker-threads pool
const pool = new FixedThreadPool(15,
'./yourWorker.js',
{ errorHandler: (e) => console.error(e), onlineHandler: () => console.log('worker is online') })
+pool.emitter.on(PoolEvents.busy, () => console.log('Pool is busy'))
+
// or a dynamic worker-threads pool
const pool = new DynamicThreadPool(10, 100,
'./yourWorker.js',
{ errorHandler: (e) => console.error(e), onlineHandler: () => console.log('worker is online') })
-pool.emitter.on('FullPool', () => console.log('Pool is full'))
+pool.emitter.on(PoolEvents.full, () => console.log('Pool is full'))
+pool.emitter.on(PoolEvents.busy, () => console.log('Pool is busy'))
// the execute method signature is the same for both implementations,
// so you can easy switch from one to another
## Node versions
-You can use node versions 12.x, 13.x, 14.x
+Node versions >= 16.x are supported.
## API
+### [Documentation](https://poolifier.github.io/poolifier/)
+
### `pool = new FixedThreadPool/FixedClusterPool(numberOfThreads/numberOfWorkers, filePath, opts)`
-`numberOfThreads/numberOfWorkers` (mandatory) Num of workers for this worker pool
+`numberOfThreads/numberOfWorkers` (mandatory) Number of workers for this pool
`filePath` (mandatory) Path to a file with a worker implementation
-`opts` (optional) An object with these properties :
+`opts` (optional) An object with these properties:
+
+- `messageHandler` (optional) - A function that will listen for message event on each worker
+- `errorHandler` (optional) - A function that will listen for error event on each worker
+- `onlineHandler` (optional) - A function that will listen for online event on each worker
+- `exitHandler` (optional) - A function that will listen for exit event on each worker
+- `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.WEIGHTED_ROUND_ROBIN`: Submit tasks to worker using a weighted round robin scheduling algorithm based on tasks execution time
+ - `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
+ Default: `WorkerChoiceStrategies.ROUND_ROBIN`
-- `errorHandler` - A function that will listen for error event on each worker
-- `onlineHandler` - A function that will listen for online event on each worker
-- `exitHandler` - A function that will listen for exit event on each worker
+- `enableEvents` (optional) - Events emission enablement in this pool. Default: true
### `pool = new DynamicThreadPool/DynamicClusterPool(min, max, filePath, opts)`
### `pool.execute(data)`
-Execute method is available on both pool implementations (return type : Promise):
+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()`
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.
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.
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: 60.000 ms
+ Default: 60000 ms
-- `async` - true/false, true if your function contains async pieces else false
+- `async` - true/false, true if your function contains async code pieces, else false
- `killBehavior` - Dictates if your async unit (worker/process) will be deleted in case that a task is active on it.
- **SOFT**: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still running, then the worker **won't** be deleted.
- **HARD**: If `lastActiveTime` is greater than `maxInactiveTime` but a task is still running, then the worker will be deleted.
+ **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.
This option only apply to the newly created workers.
- Default: `SOFT`
+ Default: `KillBehaviors.SOFT`
## General guidance
Before 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.
Please 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).
-Now **if your task runs on libuv thread pool**, you can try to:
+**If your task runs on libuv thread pool**, you can try to:
- Tune the libuv thread pool size setting the [UV_THREADPOOL_SIZE](https://nodejs.org/api/cli.html#cli_uv_threadpool_size_size)
## 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.4.x](https://github.com/orgs/poolifier/projects/1), propose an idea, a fix, an improvement.
## Team
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
-<!-- prettier-ignore-start -->
-<!-- markdownlint-disable -->
**Creator/Owner:**
repositories / poolifier.git / blobdiff