feat: Add benchmarking (#1311)

* feat: Add benchmarking into ci

* Update ci.yml

* fix: Conditionally run benchmarking

* Update ci.yml

* Update ci.yml

* test: Try to move action to separate file

* Update codspeed.yml

* Update codspeed.yml

* Update codspeed.yml

* Update codspeed.yml

* Update codspeed.yml

* feat: Add more formats for signing

* feat: Add reading benchmarks

* feat: Cool new feature

* fix: Revert changes

* chore: Remove unused imports

* chore: Error

* fix: Remove the extra tests

* ci: run codspeed only on c2pa with no default features and rust_native_crypto

* ci: use consistent install workflow for benchmarks

* ci: use cargo-binstall@main

* ci: run benchmarks on all 'safe to test'

* ci: disable default features on WASM/WASI for criterion

* build: simplify conditional dev dependency target

---------

Co-authored-by: ok-nick <[email protected]>

Author: alextrnnn

.github/workflows/ci.yml

@@ -311,6 +311,42 @@ jobs:
         env:
           WASM_BINDGEN_TEST_TIMEOUT: 60
 
+  benchmarks:
+    name: Run benchmarks on signing and reading
+    if: |
+      github.event_name != 'pull_request' ||
+      github.event.pull_request.author_association == 'COLLABORATOR' ||
+      github.event.pull_request.author_association == 'MEMBER' ||
+      github.event.pull_request.user.login == 'dependabot[bot]' ||
+      contains(github.event.pull_request.labels.*.name, 'safe to test')
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Install cargo-binstall
+        uses: cargo-bins/cargo-binstall@main
+
+      - name: Install cargo-codspeed
+        run: cargo binstall --no-confirm cargo-codspeed
+
+      - name: Cache Rust dependencies
+        uses: Swatinem/rust-cache@v2
+
+      - name: Build the benchmark target(s)
+        run: cargo codspeed build -p c2pa --no-default-features --features rust_native_crypto
+
+      - name: Run the benchmarks
+        uses: CodSpeedHQ/action@v3
+        with:
+          run: cargo codspeed run
+          token: ${{ secrets.CODSPEED_TOKEN }}
+
   tests-wasi:
     name: Unit tests (WASI)
     needs: get-features

Cargo.lock

@@ -288,6 +288,21 @@ wasm-bindgen-test = "0.3.45"
 [target.'cfg(not(target_arch = "wasm32"))'.dev-dependencies]
 httpmock = "0.7.0"
 tokio = { version = "1.44.2", features = ["full"] }
+criterion = { package = "codspeed-criterion-compat", version = "3.0.5" }
+#
+# WASM/WASI doesn't support default criterion features.
+# https://github.com/bheisler/criterion.rs/blob/4c19e913b84e6a7e4a8470cb0f766796886ed891/book/src/user_guide/wasi.md
+[target.'cfg(target_arch = "wasm32")'.dev-dependencies]
+criterion = { package = "codspeed-criterion-compat", version = "3.0.5", default-features = false }
+
+[[bench]]
+name = "sign"
+harness = false
+
+[[bench]]
+name = "read"
+harness = false
+
 
 [package.metadata.cargo-udeps.ignore]
 normal = ["windows-core"]