Enable codspeed for Rust perf tracking (#3231)

Saw this in North Bay Python 2024, seems like a great complement for
`asv` on the Rust side

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

.github/workflows/codspeed.yml

@@ -0,0 +1,34 @@
+name: codspeed-benchmarks
+
+on:
+  # Run on pushes to the main branch
+  push:
+    branches:
+      - "latest"
+  # Run on pull requests
+  pull_request:
+  # `workflow_dispatch` allows CodSpeed to trigger backtest
+  # performance analysis in order to generate initial data.
+  workflow_dispatch:
+
+jobs:
+  benchmarks-rust:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup rust toolchain, cache and cargo-codspeed binary
+        uses: moonrepo/setup-rust@v0
+        with:
+          channel: stable
+          cache-target: release
+          bins: cargo-codspeed
+
+      - name: Build the benchmark target(s)
+        run: cargo codspeed build -p sourmash
+
+      - name: Run the benchmarks
+        uses: CodSpeedHQ/action@v2
+        with:
+          run: "cd src/core && cargo codspeed run"
+          token: ${{ secrets.CODSPEED_TOKEN }}

.github/workflows/rust.yml

@@ -260,7 +260,7 @@ jobs:
         uses: actions-rs/cargo@v1
         with:
           command: build
-          args: --all-features --tests
+          args: --all-features
 
   check_cbindgen:
     name: "Check if cbindgen runs cleanly for generating the C headers"

flake.nix

@@ -123,6 +123,7 @@
             cargo-udeps
             cargo-deny
             cargo-wasi
+            cargo-codspeed
             #cargo-semver-checks
             nixpkgs-fmt
           ];

src/core/Cargo.toml

@@ -65,6 +65,7 @@ typed-builder = "0.18.0"
 vec-collections = "0.4.3"
 
 [dev-dependencies]
+codspeed-criterion-compat = "2.6.0"
 proptest = { version = "1.5.0", default-features = false, features = ["std"]}
 rand = "0.8.2"
 tempfile = "3.10.1"

src/core/benches/compute.rs

@@ -1,5 +1,4 @@
-#[macro_use]
-extern crate criterion;
+use codspeed_criterion_compat::{black_box, criterion_group, criterion_main, Criterion};
 
 use std::fs::File;
 use std::io::{Cursor, Read};
@@ -8,8 +7,6 @@ use needletail::parse_fastx_reader;
 use sourmash::cmd::ComputeParameters;
 use sourmash::signature::Signature;
 
-use criterion::Criterion;
-
 fn add_sequence(c: &mut Criterion) {
     let cp = ComputeParameters::default();
     let template_sig = Signature::from_params(&cp);

src/core/benches/gather.rs

@@ -7,7 +7,7 @@ use sourmash::signature::Signature;
 use sourmash::sketch::Sketch;
 use sourmash::{index::calculate_gather_stats, storage::SigStore};
 
-use criterion::{black_box, criterion_group, criterion_main, Criterion};
+use codspeed_criterion_compat::{black_box, criterion_group, criterion_main, Criterion};
 
 fn gather_stats_benchmarks(c: &mut Criterion) {
     let mut filename = PathBuf::from(env!("CARGO_MANIFEST_DIR"));

src/core/benches/minhash.rs

@@ -1,6 +1,3 @@
-#[macro_use]
-extern crate criterion;
-
 use std::fs::File;
 use std::io::BufReader;
 use std::path::PathBuf;
@@ -9,7 +6,7 @@ use sourmash::signature::{Signature, SigsTrait};
 use sourmash::sketch::minhash::{KmerMinHash, KmerMinHashBTree};
 use sourmash::sketch::Sketch;
 
-use criterion::Criterion;
+use codspeed_criterion_compat::{black_box, criterion_group, criterion_main, Criterion};
 
 fn intersection(c: &mut Criterion) {
     let mut filename = PathBuf::from(env!("CARGO_MANIFEST_DIR"));

src/core/benches/nodegraph.rs

@@ -1,12 +1,9 @@
-#[macro_use]
-extern crate criterion;
-
 use std::fs::File;
 use std::io::{BufWriter, Cursor, Read};
 
 use sourmash::sketch::nodegraph::Nodegraph;
 
-use criterion::Criterion;
+use codspeed_criterion_compat::{black_box, criterion_group, criterion_main, Criterion};
 
 fn save_load(c: &mut Criterion) {
     let mut data: Vec<u8> = vec![];