Bump mocha from 8.3.0 to 8.3.1 (#254)
[poolifier.git] / benchmarks / README.md
CommitLineData
be0676b3
APA
1# Poolifier Benchmarks
2
3Welcome to poolifier benchmarks and thanks to look into this project.
4
5## Folder Structure
6
6ed0e2d4 7The internal folder contains poolifier internal benchmarks.
be0676b3
APA
8The versus-external-pools folder contains benchmarks versus other Node.js pools.
9
10## Poolifier vs other pools benchmark
11
6ed0e2d4 12To compare poolifier pools performance vs other pools performance we chose to use [hyperfine](https://github.com/sharkdp/hyperfine).
13We chose to use this tool because it allows to run isolated Node.js processes so that each pool does not impact each other.
0c757ef3 14External pools with which we compared the poolifier results:
15
16- [piscina](https://github.com/piscinajs/piscina)
17- [SUCHMOKUO/node-worker-threads-pool](https://github.com/SUCHMOKUO/node-worker-threads-pool)
75876e4c 18- [threads.js](https://github.com/andywer/threads.js/)
be0676b3 19
be0676b3
APA
20Those are our results:
21
9f7e7a99 22- CPU Intensive task with 100k operations submitted to each pool [BENCH-100000.MD](./versus-external-pools/BENCH-100000.MD).
8d3782fa 23 This benchmark ran on a MacBook Pro 2015, 2,2 GHz Intel Core i7 quad-core, 16 GB 1600 MHz DDR3.
0c757ef3 24
25> :warning: **We would need funds to run our benchmarks more often and on Cloud VMs, please consider to sponsor this project**
be0676b3
APA
26
27## How to run benchmarks
28
29### Internal
30
31To run the internal benchmark you just need to navigate to the root of poolifier project and run `npm run benchmark`
32
33## Versus other pools
34
35To run the benchmark versus other pools you will need to:
36
37- [Install hyperfine](https://github.com/sharkdp/hyperfine#installation)
38- Run the `./bench.sh` into the `versus-external-pools` folder
9f7e7a99 39
40> :warning: **Please be sure to use a quite PC when you run the benchmarks**