add benchmark for branch-listing

Author: Byron

Cargo.lock

@@ -47,3 +47,12 @@ gitbutler-git = { workspace = true, features = ["test-askpass-path"] }
 glob = "0.3.1"
 serial_test = "3.1.1"
 tempfile = "3.10"
+criterion = "0.5.1"
+
+[features]
+## Only enabled when benchmark runs are performed.
+benches = ["gitbutler-git/benches"]
+
+[[bench]]
+name = "branches"
+harness = false

crates/gitbutler-branch-actions/Cargo.toml

@@ -0,0 +1,13 @@
+To run benchmarks, add the `benches` feature.
+
+```shell
+cargo bench --features benches
+```
+
+It's used to get past a safety check in `gitbutler-git`.
+
+For faster compile times, specify the benchmark file directly, i.e.
+
+```shell
+cargo bench --bench branches --features benches
+```

crates/gitbutler-branch-actions/benches/README.md

@@ -0,0 +1,46 @@
+use criterion::{black_box, criterion_group, criterion_main, Criterion, Throughput};
+use gitbutler_branch_actions::list_branches;
+use gitbutler_command_context::CommandContext;
+
+pub fn project_ctx(name: &str, script: &str) -> CommandContext {
+    gitbutler_testsupport::read_only::fixture(script, name).unwrap()
+}
+
+pub fn benchmark_list_branches(c: &mut Criterion) {
+    for (bench_name, (repo_name, script_name)) in [
+        (
+            "list-branches[many local branches]",
+            ("many-local", "branch-benches.sh"),
+        ),
+        (
+            "list-branches[tiny repo]",
+            ("one-vbranch-on-integration-two-remotes", "for-listing.sh"),
+        ),
+        (
+            "list-branches[many local branches [packed]]",
+            ("many-local-packed", "branch-benches.sh"),
+        ),
+        (
+            "list-branches[many local branches [tracked]]",
+            ("many-local-tracked", "branch-benches.sh"),
+        ),
+        (
+            "list-branches[many local branches [tracked & packed]]",
+            ("many-local-tracked-packed", "branch-benches.sh"),
+        ),
+    ] {
+        let mut group = c.benchmark_group(bench_name);
+        let ctx = project_ctx(repo_name, script_name);
+        group.throughput(Throughput::Elements(1));
+        group
+            .bench_function("no filter", |b| {
+                b.iter(|| list_branches(black_box(&ctx), None, None))
+            })
+            .bench_function("name-filter rejecting all", |b| {
+                b.iter(|| list_branches(black_box(&ctx), None, Some(vec!["not available".into()])))
+            });
+    }
+}
+
+criterion_group!(benches, benchmark_list_branches);
+criterion_main!(benches);

crates/gitbutler-branch-actions/benches/branches.rs

@@ -73,7 +73,7 @@ pub fn list_branches(
             return true;
         }
 
-        // If the virtual virtual branch has a local branch, keep the grouping
+        // If the virtual branch has a local branch, keep the grouping
         if branch.has_local {
             return true;
         };