Make it easier to update benchmark results

Author: doesdev

README.md

@@ -34,18 +34,15 @@ Every resource has corresponding SCRUD actions which are expressed in the HTTP m
 
 # is it fast
 
-Glad you asked. Yes, it is.
+It is competitively fast. It's neither the fastest thing out there or the slowest, but it strives to be competitive with the fastest of the bunch.
 
 # benchmarks
 
 As always, take benches with a grain of salt. The point is that we care about performance and optimize for it. To see benchmarking details check out the bench directory. The gist is this, all libs return a simple JSON response and the proper content-type headers. Each server is run in their own forked process and gets a warm up run for 3 seconds before we start tracking the results.
 
-Node's `http` built-in is given the advantage of pre-rendered JSON, as it is the benchmark. SCRUD and Polka bounce back and forth in second position. To be clear SCRUD only handles resourceful SCRUD routes, Polka packs a more capable router which handles less standardized routes and an Express compatible middleware handler. SCRUD is focused on APIs and microservices.
-
-<div align="center" style="box-shadow: -4px 2px 6px rgba(0,0,0,0.4);">
-  <img src="https://github.com/doesdev/scrud/raw/master/assets/bench.png" alt="SCRUD" />
-</div>
+Node's `http` built-in is given the advantage of pre-rendered JSON, as it is the benchmark.
 
+![Benchmark](bench/results.png)
 
 # install
 

assets/bench.png

@@ -0,0 +1,22 @@
+{
+  "bench": {
+    "bg": "rgba(71,72,73,1)",
+    "t": "dracula",
+    "wt": "none",
+    "l": "auto",
+    "ds": "true",
+    "dsyoff": "20px",
+    "dsblur": "68px",
+    "wc": "true",
+    "wa": "true",
+    "pv": "48px",
+    "ph": "32px",
+    "ln": "false",
+    "fm": "Hack",
+    "fs": "14px",
+    "lh": "133%",
+    "si": "false",
+    "es": "2x",
+    "wm": "false"
+  }
+}

bench/.carbon.json

@@ -2,9 +2,12 @@
 
 const { fork } = require('child_process')
 const { join } = require('path')
+const { writeFileSync } = require('fs')
 const { get } = require('axios')
 const autocannon = require('autocannon')
 const table = require('tty-table')
+const warmupSec = 1
+const runSec = 1
 const ports = {
   http: 3010,
   fastify: 3011,
@@ -85,8 +88,8 @@ const bencher = (title) => new Promise((resolve, reject) => {
     pipelining: lob ? 1 : 10,
     headers: { 'accept-encoding': 'gzip, deflate, br' }
   }
-  autocannon(Object.assign({ duration: 3 }, acOpts), () => {
-    autocannon(Object.assign({ duration: 7 }, acOpts), done)
+  autocannon(Object.assign({ duration: warmupSec }, acOpts), () => {
+    autocannon(Object.assign({ duration: runSec }, acOpts), done)
   })
 })
 
@@ -147,6 +150,28 @@ async function bench () {
     memory[r.title].end.split('/').map(formatBytes).join('\n')
   ])
 
-  console.log(table(head, rows).render())
+  const consoleOut = table(head, rows).render()
+  console.log(consoleOut)
+
+  const borderCharacters = [
+    [
+      { v: ' ', l: ' ', j: ' ', h: ' ', r: ' ' },
+      { v: ' ', l: ' ', j: ' ', h: ' ', r: ' ' },
+      { v: ' ', l: ' ', j: ' ', h: ' ', r: ' ' }
+    ],
+    [
+      { v: '|', l: '+', j: '+', h: '-', r: '+' },
+      { v: '|', l: '+', j: '+', h: '-', r: '+' },
+      { v: '|', l: '+', j: '+', h: '-', r: '+' }
+    ],
+    [
+      { v: '|', l: '+', j: '+', h: '-', r: '+' },
+      { v: '|', l: '+', j: '+', h: '-', r: '+' },
+      { v: '|', l: '+', j: '+', h: '-', r: '+' }
+    ]
+  ]
+  const headerColor = null
+  const fileOut = table(head, rows, { borderCharacters, headerColor }).render()
+  writeFileSync('results.txt', fileOut, 'utf8')
   process.exit()
 }