feat: flamegraph pprof (#453)

.github/workflows/flamegraph-upload.yml

@@ -0,0 +1,36 @@
+name: Flamegraph Upload
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+jobs:
+  flamegraph-upload:
+    runs-on: ubuntu-latest
+    permissions: 
+      issues: write
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 9
+          run_install: false
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: "pnpm"
+
+      - shell: bash
+        run: |
+          pnpm install --no-frozen-lockfile
+
+      - shell: bash
+        run: |
+          pnpm run flamegraph
+
+      - uses: pyroscope-io/flamegraph.com-github-action@main
+        with:
+          file: flamegraph.pprof
+          postInPR: false
+          token: ${{ secrets.GITHUB_TOKEN }}

package.json

@@ -26,7 +26,7 @@
   "coverage": "pnpm tsx scripts/coverage.ts",
   "docs": "typedoc",
   "e2e-test": "pnpm exec playwright test --fail-on-flaky-tests",
-  "flamegraph": "./scripts/flamegraph.sh",
+  "flamegraph": "pnpm tsx packages/object/tests/hashgraph.flamegraph.ts",
   "lint": "eslint .",
   "lint:fix": "eslint . --fix",
   "postinstall": "pnpm build:packages",

packages/object/README.md

@@ -14,3 +14,23 @@ For starting, you can install it using:
 ```bash
 pnpm install @ts-drp/object
 ```
+
+## Flamegraph
+
+### Prerequisites
+
+- `Golang` and `pprof` install
+
+### How to run
+
+```
+pnpm run flamegraph
+```
+
+### Visualize Profile
+
+```
+pprof -http=:8080 flamegraph.pb.gz
+```
+and preview in browser at `http://localhost:8080`
+

packages/object/package.json

@@ -41,6 +41,7 @@
   "es-toolkit": "1.30.1",
   "fast-deep-equal": "^3.1.3",
   "fast-equals": "^5.2.2",
+  "pprof": "^4.0.0",
   "uint8arrays": "^5.1.0"
  }
 }

packages/object/tests/hashgraph.flamegraph.ts

@@ -1,4 +1,6 @@
 import { SetDRP } from "@ts-drp/blueprints/src/index.js";
+import fs from "fs";
+import * as pprof from "pprof";
 
 import { DRPObject, ObjectACL } from "../src/index.js";
 
@@ -63,4 +65,22 @@ function flamegraphForSetDRP(numDRPs: number, verticesPerDRP: number, mergeFn: b
 	}
 }
 
+async function pprofTime() {
+	console.log("start to profile >>>");
+	const profile = await pprof.time.profile({
+		durationMillis: 1000,
+	});
+
+	const buf = await pprof.encode(profile);
+	fs.writeFile("flamegraph.pprof", buf, (err) => {
+		if (err) {
+			throw err;
+		}
+	});
+
+	console.log("<<< finished to profile");
+}
+
+pprofTime().catch(console.error);
+
 flamegraphForSetDRP(1, 1000, false);