chore: add benchmarks (#161)

Reference:
- #71
- #72
- #75
- #76

Started by #160

Author: H4ad

.gitignore

@@ -31,4 +31,5 @@
 !/tap-snapshots/
 !/test/
 !/tsconfig.json
+!benchmarks/
 tap-testdir*/

benchmarks/match.js

@@ -0,0 +1,32 @@
+const Benchmark = require('benchmark')
+const ssri = require('..')
+const suite = new Benchmark.Suite()
+const fs = require('fs')
+const crypto = require('crypto')
+
+const TEST_DATA = fs.readFileSync(__filename)
+const STATIC_DATA = 'static content'
+
+function hash (data, algorithm) {
+  return crypto.createHash(algorithm).update(data).digest('base64')
+}
+
+const testSha = hash(TEST_DATA, 'sha512')
+const testIntegrity = `sha512-${testSha}`
+const testParsed = ssri.parse(testIntegrity, { single: true })
+
+const staticSha = hash(STATIC_DATA, 'sha512')
+const staticIntegrity = `sha512-${staticSha}`
+const staticParsed = ssri.parse(staticIntegrity, { single: true })
+
+suite
+  .add('match to self', function () {
+    testParsed.match(testParsed)
+  })
+  .add('match to other', function () {
+    testParsed.match(staticParsed)
+  })
+  .on('cycle', function (event) {
+    console.log(String(event.target))
+  })
+  .run({ async: false })

benchmarks/parse.js

@@ -0,0 +1,34 @@
+// From https://github.com/npm/ssri/pull/71
+const Benchmark = require('benchmark')
+const ssri = require('..')
+const suite = new Benchmark.Suite()
+const fs = require('fs')
+const crypto = require('crypto')
+
+const TEST_DATA = fs.readFileSync(__filename)
+
+function hash (data, algorithm) {
+  return crypto.createHash(algorithm).update(data).digest('base64')
+}
+
+const sha = hash(TEST_DATA, 'sha512')
+const integrity = `sha512-${sha}`
+const parsed = ssri.parse(integrity, { single: true })
+
+suite
+  .add('ssri.parse(base64, { single: true })', function () {
+    ssri.parse(integrity, { single: true })
+  })
+  .add('ssri.parse(base64, { single: true, strict: true })', function () {
+    ssri.parse(integrity, { single: true, strict: true })
+  })
+  .add('ssri.parse(parsed, { single: true })', function () {
+    ssri.parse(parsed, { single: true })
+  })
+  .add('ssri.parse(parsed, { single: true, strict: true })', function () {
+    ssri.parse(parsed, { single: true, strict: true })
+  })
+  .on('cycle', function (event) {
+    console.log(String(event.target))
+  })
+  .run({ async: false })

benchmarks/stream.js

@@ -0,0 +1,118 @@
+// From https://github.com/npm/ssri/pull/71
+const Benchmark = require('benchmark')
+// const wtf = require("wtfnode");
+// wtf.init();
+const ssri = require('..')
+const suite = new Benchmark.Suite()
+const crypto = require('crypto')
+const { Readable } = require('stream')
+
+const largeText = 'a'.repeat(64).repeat(100)
+const largeTextSplitted = largeText.split('')
+
+const tinyText = 'a'.repeat(64)
+const tinyTextSplitted = tinyText.split('')
+
+const getStream = (text) => Readable.from(text)
+
+function hash (data, algorithm) {
+  return crypto.createHash(algorithm).update(data).digest('base64')
+}
+
+const largeIntegrity = `sha512-${hash(largeText, 'sha512')}`
+const tinyIntegrity = `sha512-${hash(tinyText, 'sha512')}`
+
+suite
+  .add('ssri.fromStream(stream, largeIntegrity)', {
+    defer: true,
+    fn: function (deferred) {
+      const stream = getStream(largeTextSplitted)
+
+      return ssri.fromStream(stream, largeIntegrity).then(() => deferred.resolve())
+    },
+  })
+  .add('ssri.fromStream(stream, tinyIntegrity)', {
+    defer: true,
+    fn: function (deferred) {
+      const stream = getStream(tinyTextSplitted)
+
+      return ssri.fromStream(stream, tinyIntegrity).then(() => deferred.resolve())
+    },
+  })
+  .add('ssri.checkStream(stream, largeIntegrity)', {
+    defer: true,
+    fn: function (deferred) {
+      const stream = getStream(largeTextSplitted)
+
+      return ssri.checkStream(stream, largeIntegrity).then(() => deferred.resolve())
+    },
+  })
+  .add('ssri.checkStream(stream, tinyIntegrity)', {
+    defer: true,
+    fn: function (deferred) {
+      const stream = getStream(tinyTextSplitted)
+
+      return ssri.checkStream(stream, tinyIntegrity).then(() => deferred.resolve())
+    },
+  })
+  .add('ssri.checkStream(stream, largeIntegrity, { single: true })', {
+    defer: true,
+    fn: function (deferred) {
+      const stream = getStream(largeTextSplitted)
+
+      return ssri.checkStream(stream, largeIntegrity, {
+        single: true,
+      }).then(() => deferred.resolve())
+    },
+  })
+  .add('ssri.checkStream(stream, tinyIntegrity, { single: true })', {
+    defer: true,
+    fn: function (deferred) {
+      const stream = getStream(tinyTextSplitted)
+
+      return ssri.checkStream(stream, tinyIntegrity, {
+        single: true,
+      }).then(() => deferred.resolve())
+    },
+  })
+  .add('ssri + createHash (largeIntegrity)', {
+    defer: true,
+    fn: function (deferred) {
+      const stream = getStream(largeTextSplitted)
+      const parsed = ssri.parse(largeIntegrity, { single: true })
+      const h = crypto.createHash(parsed.algorithm)
+
+      stream.pipe(h)
+      stream.on('end', () => {
+        const digest = h.digest('base64')
+
+        if (parsed.digest !== digest) {
+          throw new Error('Integrity check failed')
+        }
+        deferred.resolve()
+      })
+    },
+  })
+  .add('ssri + createHash (tinyIntegrity)', {
+    defer: true,
+    fn: function (deferred) {
+      const stream = getStream(tinyTextSplitted)
+      const parsed = ssri.parse(tinyIntegrity, { single: true })
+      const h = crypto.createHash(parsed.algorithm)
+
+      stream.pipe(h)
+      stream.on('end', () => {
+        const digest = h.digest('base64')
+
+        if (parsed.digest !== digest) {
+          throw new Error('Integrity check failed')
+        }
+        deferred.resolve()
+      })
+    },
+  })
+  .on('cycle', function (event) {
+    console.log(String(event.target))
+    // wtf.dump();
+  })
+  .run({ async: false })

benchmarks/to-string.js

@@ -0,0 +1,20 @@
+// From https://github.com/npm/ssri/pull/75
+const Benchmark = require('benchmark')
+const ssri = require('..')
+const suite = new Benchmark.Suite()
+
+const integrity = `sha512-WrLorGiX4iEWOOOaJSiCrmDIamA47exH+Bz7tVwIPb4sCU8w4iNqGCqYuspMMeU5pgz/sU7koP5u8W3RCUojGw== sha256-Qhx213Vjr6GRSEawEL0WTzlb00whAuXpngy5zxc8HYc=`
+const parsed = ssri.parse(integrity)
+const parsedStrict = ssri.parse(integrity, { strict: true })
+
+suite
+  .add('parsed.toString()', function () {
+    parsed.toString()
+  })
+  .add('parsedStrict.toString()', function () {
+    parsedStrict.toString()
+  })
+  .on('cycle', function (event) {
+    console.log(String(event.target))
+  })
+  .run({ async: false })

package.json

@@ -53,6 +53,7 @@
   "devDependencies": {
     "@npmcli/eslint-config": "^6.0.0",
     "@npmcli/template-oss": "4.28.1",
+    "benchmark": "^2.1.4",
     "tap": "^16.0.1"
   },
   "engines": {
@@ -61,6 +62,9 @@
   "templateOSS": {
     "//@npmcli/template-oss": "This file is partially managed by @npmcli/template-oss. Edits may be overwritten.",
     "version": "4.28.1",
-    "publish": "true"
+    "publish": "true",
+    "allowPaths": [
+      "benchmarks/"
+    ]
   }
 }