Documentation

Benchmarking

Benchmarking is important if you want to measure how a change can impact your application performance. We provide a simple way to benchmark your application from the point of view of a user and contributor. The setup allows you to automate benchmarks in different branches on different Node.js versions.

The modules we'll use:

  • Autocannon: A HTTP/1.1 benchmarking tool written in node.
  • Branch-comparer: Checkout multiple git branches, execute scripts and log the results.
  • Concurrently: Run commands concurrently.
  • Npx NPM package runner - We using it to run scripts against different Node.js Versions and execute local binaries. Shipped with [email protected].

Simple

Run the test in the current branch

npm run benchmark

Run the test against different Node.js versions ✨

npx -p [email protected] -- npm run benchmark

Advanced

Run the test in different branches

branchcmp --rounds 2 --script "npm run benchmark"

Run the test in different branches against different Node.js versions ✨

branchcmp --rounds 2 --script "npm run benchmark"

Compare current branch with master (Gitflow)

branchcmp --rounds 2 --gitflow --script "npm run benchmark"

or

npm run bench

Run different examples

branchcmp --rounds 2 -s "node ./node_modules/concurrently -k -s first \"node ./examples/asyncawait.js\" \"node ./node_modules/autocannon -c 100 -d 5 -p 10 localhost:3000/\""