chore(term): support flamegraph

Cargo.toml

@@ -40,6 +40,7 @@ moka               = { version = "0.12.8", features = ["future"] }
 octocrab           = { version = "0.38.0", features = ["rustls-webpki-tokio"] }
 once_cell          = { version = "1.19.0" }
 parse_duration     = { version = "2.1.1" }
+pprof              = { version = "0.13", features = ["flamegraph", "criterion"] }
 proptest           = { version = "1.5.0" }
 rand               = { version = "0.8.5" }
 reqwest            = { version = "0.11.27", default-features = false, features = ["rustls-tls", "json"] }
@@ -53,6 +54,9 @@ tracing            = { version = "0.1.40" }
 tracing-subscriber = { version = "0.3.18", features = ["smallvec", "fmt", "ansi", "std", "env-filter", "time"], default-features = false }
 url                = { version = "2.5.2" }
 
+[profile.bench]
+# To enable framegraph
+debug = true
 
 [workspace.lints.rust]
 unsafe_code = "forbid"

crates/synd_term/Cargo.toml

@@ -73,6 +73,7 @@ criterion   = { workspace = true }
 fake        = { workspace = true }
 insta       = { workspace = true }
 kvsd        = { workspace = true }
+pprof       = { workspace = true }
 proptest    = { workspace = true }
 serial_test = { version = "3.1.1", default-features = false, features = ["async", "file_locks"] }
 tempfile    = { workspace = true }

crates/synd_term/benches/render.rs

@@ -1,3 +1,6 @@
+use criterion::Criterion;
+use pprof::criterion::{Output, PProfProfiler};
+
 mod bench {
     use criterion::Criterion;
     use synd_term::{integration, key};
@@ -31,12 +34,10 @@ mod bench {
     }
 }
 
-// Explicitly using the expanded code of the following lines.
-// criterion::criterion_group!(benches, bench::render);
-// criterion::criterion_main!(benches);
 pub fn benches() {
-    let mut criterion: criterion::Criterion<_> =
-        criterion::Criterion::default().configure_from_args();
+    let mut criterion: Criterion<_> = Criterion::default()
+        .with_profiler(PProfProfiler::new(100, Output::Flamegraph(None)))
+        .configure_from_args();
     bench::render(&mut criterion);
 }
 

flake.nix

@@ -69,6 +69,7 @@
             cargo-release
             cargo-machete
             cargo-insta
+            cargo-flamegraph
             oranda
             gnuplot # for rendering with criterion
           ] ++ ci_packages

justfile

@@ -51,7 +51,7 @@ fmt: fmt-toml
 
 # Run linter
 lint:
-    cargo clippy --all-features --tests
+    cargo clippy --all-features --tests --benches
 
 # Format toml files
 fmt-toml:
@@ -96,6 +96,14 @@ bench:
     cargo bench --package synd-term --bench render --features integration -- --verbose
     @start ./target/criterion/report/index.html
 
+# Generate flamegraph
+flamegraph:
+    cargo flamegraph \
+        --root --output target/flamegraph.svg \
+        --package synd-term --bench render --features integration \
+        -- --bench
+    @start target/flamegraph.svg
+
 # Update synd_api graphql schema
 update-gql-schema:
     @graphql-client introspect-schema https://localhost:5959/graphql --no-ssl \