Adding Benchmarks tables and scripts

Author: Laurent B

README.md

@@ -139,3 +139,56 @@ Results
   To respond to HTTP requests, the user's define callback will be used.
   HTTPS is responded by `Fastify`.
 `
+
+## Test coverage
+
+This extension has 100% coverage, both in TypeScrypt and JavaScript
+
+## Benchmark
+
+_You can try it yourself using `npm run benchmark`_
+
+### Classic, Fastify without extension, but HTTPS only
+```
+ Running 5s test @ https://localhost:3000/
+ 100 connections with 10 pipelining factor
+
+ ┌─────────┬──────┬──────┬───────┬───────┬─────────┬─────────┬──────────┐
+ │ Stat    │ 2.5% │ 50%  │ 97.5% │ 99%   │ Avg     │ Stdev   │ Max      │
+ ├─────────┼──────┼──────┼───────┼───────┼─────────┼─────────┼──────────┤
+ │ Latency │ 0 ms │ 0 ms │ 29 ms │ 35 ms │ 4.14 ms │ 26.5 ms │ 974.2 ms │
+ └─────────┴──────┴──────┴───────┴───────┴─────────┴─────────┴──────────┘
+ ┌───────────┬────────┬────────┬─────────┬────────┬─────────┬──────────┬────────┐
+ │ Stat      │ 1%     │ 2.5%   │ 50%     │ 97.5%  │ Avg     │ Stdev    │ Min    │
+ ├───────────┼────────┼────────┼─────────┼────────┼─────────┼──────────┼────────┤
+ │ Req/Sec   │ 1559   │ 1559   │ 29423   │ 31695  │ 23767.8 │ 11409.48 │ 1559   │
+ ├───────────┼────────┼────────┼─────────┼────────┼─────────┼──────────┼────────┤
+ │ Bytes/Sec │ 256 kB │ 256 kB │ 4.83 MB │ 5.2 MB │ 3.9 MB  │ 1.87 MB  │ 256 kB │
+ └───────────┴────────┴────────┴─────────┴────────┴─────────┴──────────┴────────┘
+
+ Req/Bytes counts sampled once per second.
+
+ 119k requests in 5.13s, 19.5 MB read
+```
+### With extension enabled, but with HTTPS only
+```
+ Running 5s test @ https://localhost:3000/
+ 100 connections with 10 pipelining factor
+
+ ┌─────────┬──────┬──────┬───────┬───────┬─────────┬──────────┬───────────┐
+ │ Stat    │ 2.5% │ 50%  │ 97.5% │ 99%   │ Avg     │ Stdev    │ Max       │
+ ├─────────┼──────┼──────┼───────┼───────┼─────────┼──────────┼───────────┤
+ │ Latency │ 0 ms │ 0 ms │ 30 ms │ 37 ms │ 4.26 ms │ 27.62 ms │ 987.77 ms │
+ └─────────┴──────┴──────┴───────┴───────┴─────────┴──────────┴───────────┘
+ ┌───────────┬────────┬────────┬─────────┬─────────┬─────────┬──────────┬────────┐
+ │ Stat      │ 1%     │ 2.5%   │ 50%     │ 97.5%   │ Avg     │ Stdev    │ Min    │
+ ├───────────┼────────┼────────┼─────────┼─────────┼─────────┼──────────┼────────┤
+ │ Req/Sec   │ 1351   │ 1351   │ 28415   │ 30575   │ 23140.6 │ 11063.46 │ 1351   │
+ ├───────────┼────────┼────────┼─────────┼─────────┼─────────┼──────────┼────────┤
+ │ Bytes/Sec │ 222 kB │ 222 kB │ 4.66 MB │ 5.01 MB │ 3.79 MB │ 1.81 MB  │ 222 kB │
+ └───────────┴────────┴────────┴─────────┴─────────┴─────────┴──────────┴────────┘
+
+ Req/Bytes counts sampled once per second.
+
+ 116k requests in 5.15s, 19 MB read
+```

benchmark/cert.pem

@@ -0,0 +1,21 @@
+-----BEGIN CERTIFICATE-----
+MIIDiDCCAnCgAwIBAgIJAOPRYbqgI8yHMA0GCSqGSIb3DQEBCwUAMFkxCzAJBgNV
+BAYTAkFVMRMwEQYDVQQIDApTb21lLVN0YXRlMSEwHwYDVQQKDBhJbnRlcm5ldCBX
+aWRnaXRzIFB0eSBMdGQxEjAQBgNVBAMMCWxvY2FsaG9zdDAeFw0xODEyMDMyMTQ2
+NDZaFw0yODExMzAyMTQ2NDZaMFkxCzAJBgNVBAYTAkFVMRMwEQYDVQQIDApTb21l
+LVN0YXRlMSEwHwYDVQQKDBhJbnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQxEjAQBgNV
+BAMMCWxvY2FsaG9zdDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAL2k
+E4OZhz8Y1QGC3zoaliRT9bcWbdARvLz9Eutlq4KSfNpobFLl+Byr6FvSjO88pie9
+g2vYw4mA+pee5yXuJKASGmqdQo6XAnpuXpf7BAoUDSgZxLOgWdGKAqxRHKsFV8TL
+LdvIr9FjBJfQGJXvLE6ClPxyOwh9HKuruzkl2TLUYkcgaT1pF9B6KJQ49JItJEij
+4XPtdHdgNN1R0MWTWFwWnU1iAe0PdIPPWhOjnFCesJwQ+TJ8Ie++C+rRw5QIXilF
+KaUrkcsMi5qmP51pOgVRnforG04S2d+/zz99sDyJR+xTBiLndvn6BpOZCtsKEiD/
+07sXjg4/1MQ++Vwv4H0CAwEAAaNTMFEwHQYDVR0OBBYEFKrZr8wfxZ+sKCsLT4iB
+1z8PEkGLMB8GA1UdIwQYMBaAFKrZr8wfxZ+sKCsLT4iB1z8PEkGLMA8GA1UdEwEB
+/wQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEBABnAGnanNtCTeO1F7Cq5HlIntgm4
+yF7Hnu3aB0pTPDtZ1xbeeZIjjylSdDLF/9+L8YHdyxK3w3/sK3NNVzLfvg2FJtnv
+xyGvOqHtCyYGPytI6YbzRGXbxn3ZGX2HsG3LMk4xIzOkop2NTE5yPNvf2w19J95X
+cXvq5X8nhoPE24n6R7JfIBGAVNmo4K/Mj5677T/AZBdQke6sXnT2LyGr6PwjrneQ
+3ds2n6/Wko7l7HsqH3shoLMBeE1HVMzNUxNDbEoy7/aOMaBjEzijKpCAnxzFnM/N
+8NXc4VT3TFVHSfoicci8v+vq+zBK7fS/D/hthI3CSfzDVA0FoB4+PaPyBUo=
+-----END CERTIFICATE-----

benchmark/key.pem

@@ -0,0 +1,28 @@
+-----BEGIN PRIVATE KEY-----
+MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQC9pBODmYc/GNUB
+gt86GpYkU/W3Fm3QEby8/RLrZauCknzaaGxS5fgcq+hb0ozvPKYnvYNr2MOJgPqX
+nucl7iSgEhpqnUKOlwJ6bl6X+wQKFA0oGcSzoFnRigKsURyrBVfEyy3byK/RYwSX
+0BiV7yxOgpT8cjsIfRyrq7s5Jdky1GJHIGk9aRfQeiiUOPSSLSRIo+Fz7XR3YDTd
+UdDFk1hcFp1NYgHtD3SDz1oTo5xQnrCcEPkyfCHvvgvq0cOUCF4pRSmlK5HLDIua
+pj+daToFUZ36KxtOEtnfv88/fbA8iUfsUwYi53b5+gaTmQrbChIg/9O7F44OP9TE
+PvlcL+B9AgMBAAECggEASvuqP5mf8WHnLx7JFtdWUGzmNgtnRiMNRoimR28+3nT/
+avhpBGorrWKHkG7zDNElPYdghG8D+cWG0BajfMrprmUaDte5blnlP/WN73fwA/Aj
+t5xgu0mG2iRApFO6CyEksApKSqHSau9E7KX6YqZcFXrqX9rm3pdhk7tmXtVJSSAk
+rtgaFymZPJFSBEG3kpPxYojS6sfc3fBNO47CiIE0rdMMPsV31YnACa9VZ6wykpoF
+uh/lL0rOrV7fyG4tZOeMFK5KwEwqZ3TAoZ8TusEqFNfVtWTqpTaHGkjbkgaO0TnD
+kuy7iSJUEHjWjDLcTSKlhqrOuzb3Q42Gglr3RW2aoQKBgQDe3gLRIi2Md5SzjqXF
+eYh/RzUEnGroqXGwzV9ONAO3kFDMJFrAQzZg4sGCynKblqCI6Sbr1VbFBg96l85d
+4ZHmRqAY8urmY5rAtdN73xn81nMZtJrM2y9vbYRSCZ5r3RcMVDcL+7V0Byp9JbjS
+FohoF5TULR2EaCtRcB//XObwFQKBgQDZ1YW2ObkQzcqhGNyeKlJj/uRcjebxL9VA
+xsCW6EN6MpaflAr0iVHfvTxcfLw1WF7UbPGMJtwZWN3yZPbVJ1CNUirifsrpjE1j
+BSalQgAeNjDGgnP2bHmbOMPxNBKmgVOAI6PmkuZdS7wD69Jn2hpcUuVv8LZo5iOW
+i3q6fV/gyQKBgQC9l5A96R1mibPurENJowIDhMgNjCNGmh8lkRCqroUa+6JAiAzL
+0mHIOh707NRil9kpn26E4ZBXO7ifSdU8+E/t3dcEYmKCa+mSVxv6HOk2thhkncey
+ziOkXz5Zq+UhTYv16Q6LGy5Z7l6u6BA6aQDRzH3HojmiEhwHw6L00kuDoQKBgCob
+N+ltZvR0kwJox9xa2eoyTvoFA+sDD/mhcYC6DLEGLk9SUnvKP2U8Mvq9sbOuDUaK
+eHZa3JiZsO01zvCM1Ok8RMXbNGXIlPza9gljpJoyZ2M3vCqZ9Ten1Vg+dIxy2y0d
+toTPSHAoP4OShe1FH2tRKsBkix3jvmVPOL3rlijhAoGBANnkg5Y70AzFivsr1dpV
+cuWHZLbUE2Sra1j2mfJnbyqJC3kdN4C3CUFZ7mK6m8BouLID5PiBbBOixLA1qwVb
+rFHQvg7IEnjal2EUHYlrPDoPQRvcGMx7Sg9udISodq6R6ewJDrJrWXZAchX3qzjW
+xi+kKq2a3tCC+deJqrN0NWam
+-----END PRIVATE KEY-----

benchmark/with.js

@@ -0,0 +1,39 @@
+'use strict'
+const {readFileSync} = require("fs")
+
+const fastify = require('fastify')(
+  {
+    https: {
+      cert: readFileSync(__dirname + "/cert.pem"),
+      key: readFileSync(__dirname + "/key.pem")
+    },
+    logger: false,
+    serverFactory: require("..")()
+  }
+)
+
+const schema = {
+  schema: {
+    response: {
+      200: {
+        type: 'object',
+        properties: {
+          hello: {
+            type: 'string'
+          }
+        }
+      }
+    }
+  }
+}
+
+fastify
+  .get('/', schema, function (req, reply) {
+    reply
+      .send({ hello: 'world' })
+  })
+
+fastify.listen(3000, (err, address) => {
+  if (err) throw err
+  fastify.log.info(`server listening on ${address}`)
+})

benchmark/without.js

@@ -0,0 +1,38 @@
+'use strict'
+const {readFileSync} = require("fs")
+
+const fastify = require('fastify')(
+  {
+    https: {
+      cert: readFileSync(__dirname + "/cert.pem"),
+      key: readFileSync(__dirname + "/key.pem")
+    },
+    logger: false
+  }
+)
+
+const schema = {
+  schema: {
+    response: {
+      200: {
+        type: 'object',
+        properties: {
+          hello: {
+            type: 'string'
+          }
+        }
+      }
+    }
+  }
+}
+
+fastify
+  .get('/', schema, function (req, reply) {
+    reply
+      .send({ hello: 'world' })
+  })
+
+fastify.listen(3000, (err, address) => {
+  if (err) throw err
+  fastify.log.info(`server listening on ${address}`)
+})