benchmarks/README.md

   1 # Poolifier benchmarks
   2
   3 Welcome to poolifier benchmarks and thanks to look into this project.
   4
   5 ## Folder Structure
   6
   7 The [internal](./internal) folder contains poolifier internal benchmark.
   8
   9 ## Poolifier benchmark versus other worker pools
  10
  11 To compare poolifier pools performance vs other pools performance we chose to use [hyperfine](https://github.com/sharkdp/hyperfine).
  12 We chose to use this tool because it allows to run isolated Node.js processes so each pool does not impact each other.
  13
  14 - External pools with which we compare the poolifier results:
  15
  16   - [piscina](https://github.com/piscinajs/piscina)
  17   - [tinypool](https://github.com/tinylibs/tinypool)
  18   - [workerpool](https://github.com/josdejong/workerpool)
  19   - [worker-nodes](https://github.com/allegro/node-worker-nodes)
  20   - [node-worker-threads-pool](https://github.com/SUCHMOKUO/node-worker-threads-pool)
  21   - [nanothreads](https://github.com/snuffyDev/nanothreads)
  22
  23   Those are our results:
  24
  25   - CPU Intensive task with 100k operations submitted to each pool: [https://poolifier.github.io/benchmark](https://poolifier.github.io/benchmark).
  26
  27 - External pools with which we used to compare the poolifier results:
  28
  29   <!-- - [node-worker-threads-pool](https://github.com/SUCHMOKUO/node-worker-threads-pool): removed because it does not support dynamic modules import or import outside the task function. The task function is expected to be self-contained, which makes it difficult to use in real world application without ugly hacks. -->
  30
  31   - [worker-threads-pool](https://github.com/watson/worker-threads-pool): removed because unmaintained since more than 4 years.
  32   - [threadwork](https://github.com/kevlened/threadwork): removed because unmaintained since more than 3 years.
  33   - [microjob](https://github.com/wilk/microjob): removed because unmaintained since more than 5 years.
  34   - [threads.js](https://github.com/andywer/threads.js): removed because not a threads pool.
  35
  36 > :warning: **We would need funds to run our benchmark more often and on Cloud VMs, please consider to sponsor this project**
  37
  38 Read the [README.md](https://github.com/poolifier/benchmark#readme) to know how to run the benchmark.
  39
  40 ## Poolifier internal benchmark
  41
  42 ### Usage
  43
  44 To run the internal benchmark, you just need to navigate to the root of poolifier cloned repository and run `pnpm benchmark`.
  45
  46 ### [Results](https://poolifier.github.io/benchmark-results/dev/bench)