From 34a572ebf9c071ffb2f5b1efefd6784d84170138 Mon Sep 17 00:00:00 2001 From: pioardi Date: Mon, 20 Jan 2020 17:47:26 +0100 Subject: [PATCH] Documenation and improvements --- .github/CONTRIBUTING.MD | 26 +++++++++++++++ README.MD | 72 ++++++++++++++++++++++++++++++++++------- lib/dynamic.js | 4 +-- lib/util.js | 5 --- lib/workers.js | 1 + package.json | 2 +- tests/testWorker.js | 4 +-- tests/util.test.js | 12 +------ 8 files changed, 93 insertions(+), 33 deletions(-) create mode 100644 .github/CONTRIBUTING.MD diff --git a/.github/CONTRIBUTING.MD b/.github/CONTRIBUTING.MD new file mode 100644 index 00000000..0636dcaa --- /dev/null +++ b/.github/CONTRIBUTING.MD @@ -0,0 +1,26 @@ +

How to contribute

+ +[![JavaScript Style Guide](https://cdn.rawgit.com/standard/standard/master/badge.svg)](https://github.com/standard/standard)
+This repo use standard js style , please use it if you want to contribute
+Take tasks from todo list, develop a new feature or fix a bug and do a pull request.
+Another thing that you can do to contribute is to build something on top of ring-election and link ring-election to your project
+ +Please ask your PR to be merged on develop branch .
+ +How to run tests
+ +Unit tests
+ +```bash + npm run test +``` + + + How to check if your new code is standard style
+```bash + npm run standard +``` +How to lint your code
+```bash + npm run lint +``` \ No newline at end of file diff --git a/README.MD b/README.MD index 1e661a2d..53234a73 100644 --- a/README.MD +++ b/README.MD @@ -1,17 +1,33 @@ # Node Pool :arrow_double_up: :on: -[![JavaScript Style Guide](https://cdn.rawgit.com/standard/standard/master/badge.svg)](https://github.com/standard/standard) +[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com) [![Dependabot](https://badgen.net/dependabot/dependabot/dependabot-core/?icon=dependabot)](https://badgen.net/dependabot/dependabot/dependabot-core/?icon=dependabot) [![Actions Status](https://github.com/pioardi/node-pool/workflows/NodeCI/badge.svg)](https://github.com/pioardi/node-pool/actions) +

Contents

+

+ Installation + · + Usage + · + API + · + Contribute + · + Compatibility + · + License +

+ Node pool contains two 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 .
-The second implementation is a dynamic thread pool with a number of threads started at creation time and other threads created when the load will increase ( with an upper limit ).
+The second implementation is a dynamic thread pool with a number of threads started at creation time and other threads created when the load will increase ( with an upper limit ), the new created threads will be stopped after a threshold.
+You have to implement your worker extending the ThreadWorker class
+

Installation

-## Installation ``` npm install node-pool --save ``` -# Usage +

Usage

You can implement a worker in a simple way , extending the class ThreadWorker : @@ -22,9 +38,10 @@ const { ThreadWorker } = require('node-pool') class MyWorker extends ThreadWorker { constructor () { super((data) => { - // this will be executed in the worker thread, the data will be received by using the execute method + // this will be executed in the worker thread, + // the data will be received by using the execute method return { ok: 1 } - }) + }, { maxInactiveTime: 1000 * 60}) } } module.exports = new MyWorker() @@ -34,7 +51,7 @@ Instantiate your pool based on your needed : ```js 'use strict' -const { FixedThreadPool } = require('node-pool') +const { FixedThreadPool, DynamicThreadPool } = require('node-pool') // a fixed thread pool const pool = new FixedThreadPool(15, @@ -55,14 +72,47 @@ pool.execute({}).then(res => { See examples folder for more details. -## Node versions +

Node versions

+ You can use node version 10.x with --experimental-worker flag, or you can use an higher version (i.e 12.x)
-## API +

API

+ +### `pool = new FixedThreadPool(numThreads, filePath, opts)` +`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 : +- `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 on event emitters ( workers are event emitters) + +### `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` +`fn` (mandatory) The function that you want to execute on the worker thread
+`opts` (optional) An object with these properties : +- `maxInactiveTime` - Max time to wait tasks to work on ( in ms) , after this period the new worker threads will die. + +

Contribute

+ +See guidelines [CONTRIBUTING](./.github/CONTRIBUTING.md) -TODO -## License +

License

[MIT](https://github.com/pioardi/node-pool/blob/master/LICENSE) diff --git a/lib/dynamic.js b/lib/dynamic.js index e5a9c690..36db0c75 100644 --- a/lib/dynamic.js +++ b/lib/dynamic.js @@ -1,6 +1,5 @@ 'use strict' const FixedThreadPool = require('./fixed') -const { randomWorker } = require('./util') const EventEmitter = require('events') class MyEmitter extends EventEmitter {} @@ -16,7 +15,6 @@ class DynamicThreadPool extends FixedThreadPool { * * @param {Number} min Min number of threads that will be always active * @param {Number} max Max number of threads that will be active - * @param {Object} an object with possible options for example maxConcurrency */ constructor (min, max, filename, opts) { super(min, filename, opts) @@ -39,7 +37,7 @@ class DynamicThreadPool extends FixedThreadPool { } else { if (this.workers.length === this.max) { this.emitter.emit('FullPool') - return randomWorker(this.tasks) + return super._chooseWorker() } // all workers are busy create a new worker const worker = this._newWorker() diff --git a/lib/util.js b/lib/util.js index bac53ec4..70a50744 100644 --- a/lib/util.js +++ b/lib/util.js @@ -11,8 +11,3 @@ const uuid = require('uuid/v4') module.exports.generateID = () => { return uuid() } - -module.exports.randomWorker = (collection) => { - const keys = Array.from(collection.keys()) - return keys[Math.floor(Math.random() * keys.length)] -} diff --git a/lib/workers.js b/lib/workers.js index ee03778d..c192f181 100644 --- a/lib/workers.js +++ b/lib/workers.js @@ -37,6 +37,7 @@ class ThreadWorker extends AsyncResource { } else if (value.kill) { // here is time to kill this thread, just clearing the interval clearInterval(this.interval) + this.emitDestroy() } }) } diff --git a/package.json b/package.json index ca55edc6..cfe41cbf 100644 --- a/package.json +++ b/package.json @@ -5,7 +5,7 @@ "main": "index.js", "scripts": { "build": "npm install", - "test": "standard && nyc mocha --experimental-worker --exit --timeout 10000 **/*test.js ", + "test": "standard && nyc mocha --experimental-worker --exit --timeout 10000 tests/*test.js ", "demontest": "nodemon --exec \"npm test\"", "coverage": "nyc report --reporter=text-lcov --timeout 5000 **/*test.js | coveralls", "standard-verbose": "npx standard --verbose", diff --git a/tests/testWorker.js b/tests/testWorker.js index d6923045..60e41d79 100644 --- a/tests/testWorker.js +++ b/tests/testWorker.js @@ -5,14 +5,14 @@ const { isMainThread } = require('worker_threads') class MyWorker extends ThreadWorker { constructor () { super((data) => { - for (let i = 0; i <= 100; i++) { + for (let i = 0; i <= 50; i++) { const o = { a: i } JSON.stringify(o) } return isMainThread - }, { maxInactiveTime: 1000 }) + }, { maxInactiveTime: 500 }) } } diff --git a/tests/util.test.js b/tests/util.test.js index 0cba02ce..71782ea1 100644 --- a/tests/util.test.js +++ b/tests/util.test.js @@ -1,5 +1,5 @@ const expect = require('expect') -const { generateID, randomWorker } = require('../lib/util') +const { generateID } = require('../lib/util') describe('Utility Tests ', () => { it('Generate an id', () => { @@ -7,14 +7,4 @@ describe('Utility Tests ', () => { expect(res).toBeTruthy() expect(typeof res).toBe('string') }) - - it('Choose a random worker', () => { - const input = new Map() - input.set(1, 1) - input.set(2, 2) - input.set(3, 3) - const worker = randomWorker(input) - expect(worker).toBeTruthy() - expect(Array.from(input.keys()).includes(worker)).toBeTruthy() - }) }) -- 2.34.1