chore: migrate benchmark framework and deprecated hash-obj (#5)

Signed-off-by: JounQin <[email protected]>
Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

Author: 3 people

.github/workflows/ci.yml

@@ -42,6 +42,9 @@ jobs:
         env:
           PARSER_NO_WATCH: true
 
+      - name: Benchmark
+        run: node benchmark
+
       - name: Codecov
         # bad Windows -- https://github.com/codecov/codecov-action/issues/1787
         if: ${{ !github.event.pull_request.head.repo.fork && matrix.os != 'windows-latest' }}

.github/workflows/release.yml

@@ -40,8 +40,8 @@ jobs:
       - name: Create Release Pull Request or Publish to npm
         uses: changesets/action@v1
         with:
-          commit: 'chore: release lib-boilerplate'
-          title: 'chore: release lib-boilerplate'
+          commit: 'chore: release stable-hash-x'
+          title: 'chore: release stable-hash-x'
           version: yarn run version
           publish: yarn release
         env:

README.md

@@ -31,6 +31,7 @@ It's similar to `JSON.stringify(value)`, but:
   - [Array](#array)
   - [Object](#object)
   - [`Function`, `Class`, `Set`, `Map`, `Buffer`...](#function-class-set-map-buffer)
+- [Benchmark](#benchmark)
 - [Notes](#notes)
 - [Sponsors and Backers](#sponsors-and-backers)
   - [Sponsors](#sponsors)
@@ -152,6 +153,39 @@ hash(foo) === hash(foo)
 hash(foo) !== hash(new Set([1]))
 ```
 
+## Benchmark
+
+```log
+clk: ~2.91 GHz
+cpu: Apple M1 Max
+runtime: node 22.16.0 (arm64-darwin)
+
+benchmark                   avg (min … max) p75 / p99    (min … top 1%)
+------------------------------------------- -------------------------------
+stable-hash-x                  7.87 µs/iter   7.38 µs   █
+                      (6.67 µs … 749.13 µs)  11.42 µs  ▇█▃
+                    (104.00  b … 859.30 kb)  10.89 kb ▁███▅▂▂▂▂▁▁▁▁▁▁▁▁▁▁▁▁
+                  4.41 ipc (  1.81% stalls)  98.08% L1 data cache
+         28.04k cycles 123.52k instructions  29.75% retired LD/ST ( 36.75k)
+
+hash-object                   15.07 µs/iter  14.95 µs             █   █
+                      (14.77 µs … 16.93 µs)  15.00 µs ▅  ▅      ▅▅█  ▅█▅  ▅
+                    (659.78  b …   3.26 kb)   1.95 kb █▁▁█▁▁▁▁▁▁███▁▁███▁▁█
+                  4.97 ipc (  1.22% stalls)  99.33% L1 data cache
+         46.36k cycles 230.44k instructions  35.12% retired LD/ST ( 80.94k)
+
+json-stringify-deterministic   8.37 µs/iter   8.41 µs        █
+                        (8.29 µs … 8.50 µs)   8.44 µs     █  █
+                    (  1.65 kb …   1.65 kb)   1.65 kb █▁████▁██▁█▁▁▁█▁█▁███
+                  5.17 ipc (  1.28% stalls)  99.40% L1 data cache
+         25.99k cycles 134.30k instructions  35.51% retired LD/ST ( 47.69k)
+
+summary
+  stable-hash-x
+   1.06x faster than json-stringify-deterministic
+   1.91x faster than hash-object
+```
+
 ## Notes
 
 This function does something similar to `JSON.stringify`, but more than it. It doesn't generate a secure checksum, which usually has a fixed length and is hard to be reversed. With `stable-hash-x` it's still possible to get the original data. Also, the output might include any charaters, not just alphabets and numbers like other hash algorithms. So:

benchmark.js

@@ -4,9 +4,9 @@ import crypto from 'node:crypto'
 
 import { encodeUrl } from 'ab64'
 import { flattie } from 'flattie'
-import hashObject from 'hash-obj'
+import hashObject from 'hash-object'
 import stringify from 'json-stringify-deterministic'
-import bench from 'nanobench'
+import { bench, run, summary } from 'mitata'
 
 import { hash } from 'stable-hash-x'
 
@@ -41,33 +41,44 @@ const payload = {
 }
 
 /**
- * Benchmarking `hash-obj` vs. `stable-hash`
+ * Benchmarking `stable-hash-x` vs. `hash-object` vs.
+ * `json-stringify-deterministic`
  *
  * The goal is to represent a real use-case. Because that:
  *
  * - Ensure the input is flatten
  * - Output is base64 URL safe
  * - Sha512 is used as algorithm
- *
- * @param {object} obj - The object to hash
+ */
+
+/**
+ * @param {unknown} obj
  * @returns {string} The hash
  */
 const getHashOne = obj =>
-  encodeUrl(
-    hashObject(flattie(obj), {
-      encoding: 'base64',
-      algorithm: 'sha512',
-    }),
-  )
-
-const getHashTwo = obj =>
   encodeUrl(
     crypto
       .createHash('sha512')
       .update(hash(flattie(obj)))
       .digest('base64'),
   )
 
+/**
+ * @param {unknown} obj - The object to hash
+ * @returns {string} The hash
+ */
+const getHashTwo = obj =>
+  encodeUrl(
+    hashObject(flattie(obj), {
+      encoding: 'base64',
+      algorithm: 'sha512',
+    }),
+  )
+
+/**
+ * @param {unknown} obj
+ * @returns {string} The hash
+ */
 const getHashThree = obj =>
   encodeUrl(
     crypto
@@ -76,34 +87,12 @@ const getHashThree = obj =>
       .digest('base64'),
   )
 
-const count = 200_000
+summary(() => {
+  bench('stable-hash-x', () => getHashOne(payload)).baseline()
 
-bench('`hash-obj` 200.000 times', function (b) {
-  b.start()
+  bench('hash-object', () => getHashTwo(payload))
 
-  for (let i = 0; i < count; i++) {
-    getHashOne(payload)
-  }
-
-  b.end()
-})
-
-bench('`stable-hash` 200.000 times', function (b) {
-  b.start()
-
-  for (let i = 0; i < count; i++) {
-    getHashTwo(payload)
-  }
-
-  b.end()
+  bench('json-stringify-deterministic', () => getHashThree(payload))
 })
 
-bench('`json-stringify-deterministic` 200.000 times', function (b) {
-  b.start()
-
-  for (let i = 0; i < count; i++) {
-    getHashThree(payload)
-  }
-
-  b.end()
-})
+await run()

benchmark.txt

@@ -0,0 +1,28 @@
+clk: ~2.91 GHz
+cpu: Apple M1 Max
+runtime: node 22.16.0 (arm64-darwin)
+
+benchmark                   avg (min … max) p75 / p99    (min … top 1%)
+------------------------------------------- -------------------------------
+stable-hash-x                  7.87 µs/iter   7.38 µs   █                  
+                      (6.67 µs … 749.13 µs)  11.42 µs  ▇█▃                 
+                    (104.00  b … 859.30 kb)  10.89 kb ▁███▅▂▂▂▂▁▁▁▁▁▁▁▁▁▁▁▁
+                  4.41 ipc (  1.81% stalls)  98.08% L1 data cache
+         28.04k cycles 123.52k instructions  29.75% retired LD/ST ( 36.75k)
+
+hash-object                   15.07 µs/iter  14.95 µs             █   █    
+                      (14.77 µs … 16.93 µs)  15.00 µs ▅  ▅      ▅▅█  ▅█▅  ▅
+                    (659.78  b …   3.26 kb)   1.95 kb █▁▁█▁▁▁▁▁▁███▁▁███▁▁█
+                  4.97 ipc (  1.22% stalls)  99.33% L1 data cache
+         46.36k cycles 230.44k instructions  35.12% retired LD/ST ( 80.94k)
+
+json-stringify-deterministic   8.37 µs/iter   8.41 µs        █             
+                        (8.29 µs … 8.50 µs)   8.44 µs     █  █             
+                    (  1.65 kb …   1.65 kb)   1.65 kb █▁████▁██▁█▁▁▁█▁█▁███
+                  5.17 ipc (  1.28% stalls)  99.40% L1 data cache
+         25.99k cycles 134.30k instructions  35.51% retired LD/ST ( 47.69k)
+
+summary
+  stable-hash-x
+   1.06x faster than json-stringify-deterministic
+   1.91x faster than hash-object

package.json

@@ -31,6 +31,7 @@
     "lib"
   ],
   "scripts": {
+    "benchmark": "sudo env NO_COLOR=1 node benchmark > benchmark.txt",
     "build": "tsdown -d lib -f cjs,esm",
     "dev": "vitest",
     "docs": "vite",
@@ -52,8 +53,8 @@
     "@changesets/cli": "^2.29.4",
     "@commitlint/cli": "^19.8.1",
     "@mdx-js/rollup": "^3.1.0",
+    "@mitata/counters": "^0.0.8",
     "@shikijs/rehype": "^3.5.0",
-    "@types/nanobench": "^3.0.0",
     "@types/node": "^22.15.29",
     "@types/react": "^19",
     "@types/react-dom": "^19",
@@ -67,10 +68,10 @@
     "eslint": "^9.28.0",
     "flattie": "^1.1.1",
     "github-markdown-css": "^5.8.1",
-    "hash-obj": "^5.0.0",
+    "hash-object": "^5.0.1",
     "json-stringify-deterministic": "^1.0.12",
+    "mitata": "^1.0.34",
     "nano-staged": "^0.8.0",
-    "nanobench": "^3.0.0",
     "npm-run-all2": "^8.0.4",
     "prettier": "^3.5.3",
     "react": "^19.1.0",