README.MD

   1 # Node Thread Pool :arrow_double_up: :on:
   2 [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
   3 [![Dependabot](https://badgen.net/dependabot/dependabot/dependabot-core/?icon=dependabot)](https://badgen.net/dependabot/dependabot/dependabot-core/?icon=dependabot)
   4 [![npm w](https://img.shields.io/npm/dw/poolifier)](https://www.npmjs.com/package/poolifier)
   5 [![Actions Status](https://github.com/pioardi/node-pool/workflows/NodeCI/badge.svg)](https://github.com/pioardi/node-pool/actions)
   6 [![Coverage Status](https://coveralls.io/repos/github/pioardi/poolifier/badge.svg?branch=master)](https://coveralls.io/github/pioardi/poolifier?branch=master)[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
   7 [![NODEP](https://img.shields.io/static/v1?label=dependencies&message=no%20dependencies&color=brightgreen
   8 )](https://img.shields.io/static/v1?label=dependencies&message=no%20dependencies&color=brightgreen
   9 )
  10 [![Gitter](https://badges.gitter.im/poolifier/community.svg)](https://gitter.im/poolifier/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
  11
  12 <h2>Why Poolifier? </h2>
  13 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 <a href="https://nodejs.org/api/worker_threads.html#worker_threads_worker_threads">worker-threads </a>.<br>
  14 With poolifier you can improve your <strong>performance</strong> and resolve problems related to the event loop.<br>
  15 Moreover you can execute your CPU tasks using an API designed to improve the <strong>developer experience</strong>.
  16
  17
  18
  19 <h2>Contents </h2>
  20 <h3 align="center">
  21   <a href="#installation">Installation</a>
  22   <span> · </span>
  23   <a href="#usage">Usage</a>
  24   <span> · </span>
  25   <a href="#api">API</a>
  26   <span> · </span>
  27   <a href="#cyp">Choose a pool</a>
  28   <span> · </span>
  29   <a href="#contribute">Contribute</a>
  30   <span> · </span>
  31   <a href="#Team">Team</a>
  32   <span> · </span>
  33   <a href="#nv">Compatibility</a>
  34   <span> · </span>
  35   <a href="#license">License</a>
  36 </h3>
  37
  38 <h2> Overview </h2>
  39 Node pool contains two <a href="https://nodejs.org/api/worker_threads.html#worker_threads_worker_threads">worker-threads </a> pool implementations , you don' t have to deal with worker-threads complexity. <br>
  40 The first implementation is a static thread pool , with a defined number of threads that are started at creation time and will be reused.<br>
  41 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. <br>
  42 You have to implement your worker extending the ThreadWorker class<br>
  43 <h2 id="installation">Installation</h2>
  44
  45 ```
  46 npm install poolifier --save
  47 ```
  48 <h2 id="usage">Usage</h2>
  49
  50 You can implement a worker in a simple way , extending the class ThreadWorker :
  51
  52 ```js
  53 'use strict'
  54 const { ThreadWorker } = require('poolifier')
  55
  56 function yourFunction (data) {
  57   // this will be executed in the worker thread,
  58   // the data will be received by using the execute method
  59   return { ok: 1 }
  60 }
  61
  62 module.exports = new ThreadWorker(yourFunction, { maxInactiveTime: 60000, async: false })
  63 ```
  64
  65 Instantiate your pool based on your needed :
  66
  67 ```js
  68 'use strict'
  69 const { FixedThreadPool, DynamicThreadPool } = require('poolifier')
  70
  71 // a fixed thread pool
  72 const pool = new FixedThreadPool(15,
  73   './yourWorker.js',
  74   { errorHandler: (e) => console.error(e), onlineHandler: () => console.log('worker is online') })
  75
  76 // or a dynamic thread pool
  77 const pool = new DynamicThreadPool(10, 100,
  78   './yourWorker.js',
  79   { errorHandler: (e) => console.error(e), onlineHandler: () => console.log('worker is online') })
  80
  81 pool.emitter.on('FullPool', () => console.log('Pool is full'))
  82
  83 // the execute method signature is the same for both implementations,
  84 // so you can easy switch from one to another
  85 pool.execute({}).then(res => {
  86   console.log(res)
  87 }).catch ....
  88
  89 ```
  90
  91 <strong> See examples folder for more details( in particular if you want to use a pool for [multiple functions](./examples/multiFunctionExample.js) ).</strong>
  92 <strong>Now type script is also supported, find how to use it into the example folder </strong>
  93
  94 <h2 id="nv">Node versions</h2>
  95
  96 You can use node versions 12.x , 13.x, 14.x <br>
  97
  98 <h2 id="api">API</h2>
  99
 100 ### `pool = new FixedThreadPool(numThreads, filePath, opts)`
 101 `numThreads` (mandatory) Num of threads for this worker pool <br>
 102 `filePath` (mandatory) Path to a file with a worker implementation <br>
 103 `opts` (optional) An object with these properties :
 104 - `errorHandler` - A function that will listen for error event on each worker thread
 105 - `onlineHandler` - A function that will listen for online event on each worker thread
 106 - `exitHandler` - A function that will listen for exit event on each worker thread
 107 - `maxTasks` - This is just to avoid not useful warnings message, is used to set <a href="https://nodejs.org/dist/latest-v12.x/docs/api/events.html#events_emitter_setmaxlisteners_n">maxListeners</a> on event emitters ( workers are event emitters)
 108
 109 ### `pool = new DynamicThreadPool(min, max, filePath, opts)`
 110 `min` (mandatory) Same as FixedThreadPool numThreads , this number of threads will be always active <br>
 111 `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). <br>
 112 `filePath` (mandatory) Same as FixedThreadPool  <br>
 113 `opts` (optional) Same as FixedThreadPool <br>
 114
 115 ### `pool.execute(data)`
 116 Execute method is available on both pool implementations ( return type : Promise): <br>
 117 `data` (mandatory) An object that you want to pass to your worker implementation <br>
 118
 119 ### `pool.destroy()`
 120 Destroy method is available on both pool implementations.<br>
 121 This method will call the terminate method on each worker.
 122
 123
 124 ### `class YourWorker extends ThreadWorker`
 125 `fn` (mandatory) The function that you want to execute on the worker thread <br>
 126 `opts` (optional) An object with these properties :
 127 - `maxInactiveTime` - Max time to wait tasks to work on ( in ms) , after this period the new worker threads will die.
 128 - `async` - true/false , true if your function contains async pieces else false
 129
 130 <h2 id="cyp">Choose your pool</h2>
 131 Performance is one of the main target of these thread pool implementations, we want to have a strong focus on this.<br>
 132 We already have a bench folder where you can find some comparisons.
 133 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 . <br>
 134 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. <br>
 135 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. <br>
 136 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. <br>
 137 But in general , <strong>always profile your application </strong>
 138
 139 <h2 id="contribute">Contribute</h2>
 140
 141 See guidelines [CONTRIBUTING](CONTRIBUTING.md) <br>
 142 Choose your task here <a href="https://github.com/pioardi/poolifier/projects/1"> 2.0.0</a>, propose an idea, a fix, an improvement. <br>
 143
 144
 145 <h2 id="Team">Team</h2>
 146 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
 147 <!-- prettier-ignore-start -->
 148 <!-- markdownlint-disable -->
 149
 150 **Creator/Owner:**
 151 * [__Alessandro Pio Ardizio__](https://github.com/pioardi)
 152
 153 ***Contributors***
 154 * [__Shinigami92__](https://github.com/Shinigami92)
 155 * [__Jérôme Benoit__](https://github.com/jerome-benoit)
 156
 157 <h2 id="license">License</h2>
 158
 159 [MIT](./LICENSE)