<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>
+<div align="center">
+
+# Node.js Worker_Threads and Cluster Worker Pool
+
+</div>
+
+<div align="center">
+
+[](https://github.com/poolifier/poolifier/graphs/commit-activity)
+[](https://www.npmjs.com/package/poolifier)
+[](https://www.npmjs.com/package/poolifier)
+[](https://jsr.io/@poolifier/poolifier)
+[](https://github.com/poolifier/poolifier/actions/workflows/ci.yml)
+[](https://sonarcloud.io/dashboard?id=poolifier_poolifier)
+[](https://sonarcloud.io/dashboard?id=poolifier_poolifier)
+[](https://standardjs.com)
+[](https://discord.gg/vXxZhyb3b6)
+[](https://opencollective.com/poolifier)
+[](https://makeapullrequest.com)
+[](<https://badgen.net/static/dependencies/no dependencies/green>)
+
+</div>
## Why Poolifier?
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:
+- Performance [benchmarks](./benchmarks/README.md) :white_check_mark:
- No runtime dependencies :white_check_mark:
- Proper integration with Node.js [async_hooks](https://nodejs.org/api/async_hooks.html) :white_check_mark:
-- Support for CommonJS, ESM, and TypeScript :white_check_mark:
+- Support for 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 for multiple task functions :white_check_mark:
-- Support for sync and async task functions :white_check_mark:
- Tasks distribution strategies :white_check_mark:
- Lockless tasks queueing :white_check_mark:
- Queued tasks rescheduling:
- <!-- - Task stealing :white_check_mark: -->
+ - Task stealing on idle :white_check_mark:
- Tasks stealing under back pressure :white_check_mark:
- Tasks redistribution on worker error :white_check_mark:
+- Support for sync and async task function :white_check_mark:
+- Support for multiple task functions with per task function queuing priority and tasks distribution strategy :white_check_mark:
+- Support for task functions [CRUD](https://en.wikipedia.org/wiki/Create,_read,_update_and_delete) operations at runtime :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)
+- Code quality [](https://sonarcloud.io/dashboard?id=poolifier_poolifier)
+ [](https://sonarcloud.io/dashboard?id=poolifier_poolifier)
+ [](https://sonarcloud.io/dashboard?id=poolifier_poolifier)
+ [](https://sonarcloud.io/dashboard?id=poolifier_poolifier)
+ [](https://sonarcloud.io/dashboard?id=poolifier_poolifier)
+ [](https://sonarcloud.io/dashboard?id=poolifier_poolifier)
+- Code security [](https://sonarcloud.io/dashboard?id=poolifier_poolifier) [](https://sonarcloud.io/dashboard?id=poolifier_poolifier)
## Table of contents
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.
+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 newly 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
+### npmjs
+
```shell
npm install poolifier --save
```
+### JSR
+
+```shell
+npx jsr add @poolifier/poolifier
+```
+
## Usage
-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_:
+You can implement a poolifier [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')
+import { ThreadWorker } from 'poolifier'
function yourFunction(data) {
// this will be executed in the worker thread,
Instantiate your pool based on your needs :
```js
-'use strict'
-const { DynamicThreadPool, FixedThreadPool, PoolEvents, availableParallelism } = require('poolifier')
+import { DynamicThreadPool, FixedThreadPool, PoolEvents, availableParallelism } from 'poolifier'
// a fixed worker_threads pool
const pool = new FixedThreadPool(availableParallelism(), './yourWorker.js', {
- errorHandler: (e) => console.error(e),
- onlineHandler: () => console.info('worker is online')
+ onlineHandler: () => console.info('worker is online'),
+ errorHandler: e => console.error(e)
})
-pool.emitter.on(PoolEvents.ready, () => console.info('Pool is ready'))
-pool.emitter.on(PoolEvents.busy, () => console.info('Pool is busy'))
+pool.emitter?.on(PoolEvents.ready, () => console.info('Pool is ready'))
+pool.emitter?.on(PoolEvents.busy, () => console.info('Pool is busy'))
// 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')
+ onlineHandler: () => console.info('worker is online'),
+ errorHandler: e => console.error(e)
})
-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'))
+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 easily switch from one to another
pool
.execute()
- .then((res) => {
+ .then(res => {
console.info(res)
})
- .catch((err) => {
+ .catch(err => {
console.error(err)
})
```
## Node.js versions
-Node.js versions >= 16.14.x are supported.
+Node.js versions >= 18.x.x are supported.
## [API](./docs/api.md)
## Contribute
-Choose your task here [2.6.x](https://github.com/orgs/poolifier/projects/1), propose an idea, a fix, an improvement.
+Choose your task [here](https://github.com/orgs/poolifier/projects/1), propose an idea, a fix, an improvement.
-See [CONTRIBUTING](CONTRIBUTING.md) guidelines.
+See [CONTRIBUTING](./CONTRIBUTING.md) guidelines.
## Team
- [**Alessandro Pio Ardizio**](https://github.com/pioardi)
-**_Contributors_**
+**Maintainers:**
-- [**Shinigami92**](https://github.com/Shinigami92)
- [**Jérôme Benoit**](https://github.com/jerome-benoit)
+**Contributors:**
+
+- [**Shinigami92**](https://github.com/Shinigami92)
+
## License
[MIT](./LICENSE)
repositories / poolifier.git / blobdiff