chore(bench): add benchmarks

Author: JamieMason

.github/workflows/benchmark.yaml

@@ -0,0 +1,29 @@
+name: Benchmark v14-alpha
+
+on:
+  pull_request:
+    branches:
+      - v14-alpha
+  push:
+    branches:
+      - v14-alpha
+
+jobs:
+  benchmark:
+    name: Benchmark
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Install rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+      - name: Set up cargo cache
+        uses: Swatinem/rust-cache@v2
+      - name: Install just
+        uses: extractions/setup-just@v1
+        with:
+          just-version: 1.35.0
+      - name: Install hyperfine
+        run: cargo install hyperfine
+      - name: Run Hyperfine
+        run: just benchmark

.gitignore

@@ -11,3 +11,7 @@ target/
 
 # Generated packages published to npm
 npm/packages
+
+# Benchmarks
+dhat-heap.json
+flamegraph.svg

Cargo.lock

@@ -17,6 +17,7 @@ clap = { version = "4.5.40", features = ["cargo"] }
 color-print = "0.3.7"
 colored = "3.0.0"
 ctor = "0.4.2"
+dhat = { version = "0.3", optional = true }
 env_logger = "0.11.8"
 glob = "0.3.2"
 globset = "0.4.16"
@@ -34,3 +35,10 @@ serde_json = { version = "1.0.140", features = ["preserve_order"] }
 serde_yaml = "0.9"
 tokio = { version = "1", features = ["full"] }
 thiserror = "2.0.12"
+
+[features]
+default = []
+dhat-heap = ["dhat"]
+
+[profile.release]
+debug = true

Cargo.toml

@@ -17,6 +17,10 @@ install-system-dependencies:
     cargo +stable install cargo-llvm-cov
     # https://github.com/killercup/cargo-edit
     cargo +stable install cargo-edit
+    # https://github.com/sharkdp/hyperfine
+    cargo +stable install hyperfine
+    # https://github.com/flamegraph-rs/flamegraph
+    cargo +stable install flamegraph
 
 # ==============================================================================
 # Write
@@ -72,6 +76,40 @@ run-release-action:
 run-ci-action:
     act --workflows .github/workflows/ci.yml pull_request
 
+# ==============================================================================
+# Benchmark & Profile
+# ==============================================================================
+
+# Build release version with debug symbols for profiling
+build-profile-release:
+    cargo build --release
+
+# Benchmark the current release build with hyperfine
+benchmark:
+    #!/usr/bin/env bash
+    set -euxo pipefail
+
+    just build-profile-release
+    cd fixtures/fluid-framework
+    hyperfine --warmup 2 --runs 4 --ignore-failure "../../target/release/syncpack list"
+
+flamegraph:
+    #!/usr/bin/env bash
+    set -euxo pipefail
+
+    just build-profile-release
+    cd fixtures/fluid-framework
+    CARGO_PROFILE_RELEASE_DEBUG=true cargo flamegraph -- list
+
+dhat:
+    #!/usr/bin/env bash
+    set -euxo pipefail
+
+    just build-profile-release
+    cd fixtures/fluid-framework
+    cargo run --release --features dhat-heap -- lint
+    echo "Memory profile saved to dhat-heap.json - view at https://nnethercote.github.io/dh_view/dh_view.html"
+
 # ==============================================================================
 # Test
 # ==============================================================================

justfile

@@ -8,10 +8,15 @@ use {
   context::Context,
   effects::list,
   log::{debug, error},
+  std::process::exit,
   visit_formatting::visit_formatting,
   visit_packages::visit_packages,
 };
 
+#[cfg(feature = "dhat-heap")]
+#[global_allocator]
+static ALLOC: dhat::Alloc = dhat::Alloc;
+
 #[cfg(test)]
 #[path = "test/test.rs"]
 mod test;
@@ -37,7 +42,10 @@ mod visit_formatting;
 mod visit_packages;
 
 #[tokio::main]
-async fn main() -> ! {
+async fn main() {
+  #[cfg(feature = "dhat-heap")]
+  let _profiler = dhat::Profiler::new_heap();
+
   let cli = Cli::parse();
 
   logger::init(&cli);
@@ -53,7 +61,7 @@ async fn main() -> ! {
   match packages.all.len() {
     0 => {
       error!("Found 0 package.json files");
-      std::process::exit(1);
+      exit(1);
     }
     len => debug!("Found {len} package.json files"),
   }
@@ -84,4 +92,7 @@ async fn main() -> ! {
       list::run(ctx);
     }
   };
+
+  #[cfg(feature = "dhat-heap")]
+  drop(_profiler);
 }