README.md

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