refactor: move existing benchmarks to new proof-of-sql-benches crate (#767)

# Rationale for this change
The benchmarks need to use the `proof-of-sql-parser`. In order to do
that we need to move the existing benchmarks to a new crate,
`proof-of-sql-benches`. This PR simply moves the existing benchmarks to
the new crate without any functionality changes or improvements.
Additionally, the new create is excluded from the test code coverage
report since it is not intended to
 be used in production code.

# What changes are included in this PR?
- The benchmarks in `proof-of-sql/benches` are moved to
`proof-of-sql-benches` without any functionally changes or improvements.
- The new `proof-of-sql-benches` crate is excluded from the code
coverage check in commit
b20d59f

# Are these changes tested?
Yes

Author: jacobtrombetta

.github/workflows/lint-and-test.yml

@@ -177,7 +177,7 @@ jobs:
       - name: Clean Previous Coverage Artifacts
         run: cargo llvm-cov clean --workspace
       - name: Run Tests to Generate Coverage Data (All Features)
-        run: cargo llvm-cov --no-report --all-features
+        run: cargo llvm-cov --no-report --all-features --workspace --exclude proof-of-sql-benches
       #- name: Run Tests to Generate Coverage Data (Rayon Only)
       #  run: cargo llvm-cov --no-report --no-default-features --features="rayon"
       #- name: Run Tests to Generate Coverage Data (Blitzar Only)

Cargo.toml

@@ -1,6 +1,6 @@
 [workspace]
 resolver = "2"
-members = ["crates/powers-of-tau-util", "crates/proof-of-sql", "crates/proof-of-sql-parser", "crates/proof-of-sql-planner"]
+members = ["crates/powers-of-tau-util", "crates/proof-of-sql", "crates/proof-of-sql-benches", "crates/proof-of-sql-parser", "crates/proof-of-sql-planner"]
 
 [workspace.package]
 edition = "2021"

crates/proof-of-sql-benches/Cargo.toml

@@ -0,0 +1,36 @@
+[package]
+name = "proof-of-sql-benches"
+edition.workspace = true
+exclude.workspace = true
+repository.workspace = true
+version.workspace = true
+license-file.workspace = true
+
+[dependencies]
+ark-serialize = { version = "0.5.0" }
+ark-std = { version = "0.5.0", default-features = false }
+blitzar = { version = "4.3.0" }
+bumpalo = { version = "3.11.0" }
+clap = { version = "4.5.4", features = ["derive", "env"] }
+criterion = { version = "0.5.1", features = ["html_reports"] }
+csv = { version = "1.3.1" }
+curve25519-dalek = { version = "4", features = ["rand_core"] }
+ff = { version = "0.13.0"}
+halo2curves = { version = "0.8.0", default-features = false }
+indexmap = { version = "2.8", default-features = false }
+nova-snark = { version = "0.41.0" }
+opentelemetry = { version = "0.23.0" }
+opentelemetry-jaeger = { version = "0.20.0" }
+proof-of-sql = { path = "../proof-of-sql", default-features = false, features = ["arrow", "hyperkzg_proof"] }
+rand = { version = "0.8", default-features = false }
+sqlparser = { version = "0.45.0", default-features = false }
+tracing = { version = "0.1.36", default-features = false }
+tracing-opentelemetry = { version = "0.22.0" }
+tracing-subscriber = { version = "0.3.0", features = ["env-filter"] }
+
+[lints]
+workspace = true
+
+[[bench]]
+name = "bench_append_rows"
+harness = false

crates/proof-of-sql/benches/bench_append_rows.rs renamed to crates/proof-of-sql-benches/benches/bench_append_rows.rs

@@ -10,22 +10,22 @@ The Jaeger benchmarks/tracing is wrapped by a binary. The motivation of the wrap
     ```
 2. See all the options to run a benchmark.
     ```bash
-    cargo run --release --bin jaeger_benches --features="bench" -- --help
+    cargo run --release --bin proof-of-sql-benches -- --help
     ```
 3. Navigate to http://localhost:16686/ to see the results.
 4. To end the Jaeger service, run
     ```bash
     docker kill jaeger
     ```
 
-All the options are outlined in the help and `jaeger_benches.rs` module.
+All the options are outlined in the help and `main.rs` module.
 
 ### Example
 
 To run a benchmark on the `HyperKZG` commitment scheme using the `Single Column Filter` query with a table size of `1_000_000` for `3` iterations, your command would be the following.
 
 ```bash
-cargo run --release --bin jaeger_benches --features="bench" -- --s hyper-kzg -i 3 -t 1000000 -q single-column-filter
+cargo run --release --bin proof-of-sql-benches -- --s hyper-kzg -i 3 -t 1000000 -q single-column-filter
 ```
 
 ### Memory logging (optional)
@@ -34,7 +34,7 @@ Jaeger benchmarks default to logging any traces at `DEBUG` level and above. Memo
 
 Example
 ```
-RUST_LOG=trace cargo bench -p proof-of-sql --bench jaeger_benches DynamicDory
+RUST_LOG=trace cargo run --release --bin proof-of-sql-benches
 ```
 
 ## Criterion benchmarking
@@ -43,6 +43,6 @@ To run benchmarks with Criterion, you need to do the following
 
 1. Run the benchmarks. (Warning: this takes a very long time.)
     ```bash
-    cargo bench -p proof-of-sql --bench bench_append_rows --features="test"
+    cargo bench -p proof-of-sql-benches --bench bench_append_rows --features="test"
     ```
 2. Navigate to `target/criterion/report/index.html` to see the results.

crates/proof-of-sql/benches/README.md renamed to crates/proof-of-sql-benches/src/README.md

@@ -3,7 +3,7 @@
 //! To run, execute the following commands:
 //! ```bash
 //! docker run --rm -d --name jaeger -p 6831:6831/udp -p 16686:16686 jaegertracing/all-in-one:1.62.0
-//! cargo run --release --bin jaeger_benches --features="bench" -- --help
+//! cargo run --release --bin proof-of-sql-benches -- --help
 //! ```
 //! Then, navigate to <http://localhost:16686> to view the traces.
 //!

crates/proof-of-sql/benches/jaeger/bin/jaeger_benches.rs renamed to crates/proof-of-sql-benches/src/main.rs

@@ -34,7 +34,6 @@ bumpalo = { workspace = true, features = ["collections"] }
 bytemuck = { workspace = true }
 byte-slice-cast = { workspace = true }
 clap = { workspace = true, features = ["derive", "env"], optional = true }
-csv = { workspace = true, optional = true }
 curve25519-dalek = { workspace = true, features = ["serde"] }
 chrono = { workspace = true, features = ["serde"] }
 derive_more = { workspace = true }
@@ -48,8 +47,6 @@ merlin = { workspace = true, optional = true }
 nova-snark = { workspace = true, optional = true }
 num-traits = { workspace = true }
 num-bigint = { workspace = true, default-features = false }
-opentelemetry = { workspace = true, optional = true  }
-opentelemetry-jaeger = { workspace = true, optional = true }
 postcard = { workspace = true, features = ["alloc"] }
 proof-of-sql-parser = { workspace = true }
 rand = { workspace = true, default-features = false, optional = true }
@@ -64,13 +61,10 @@ sysinfo = {workspace = true, optional = true }
 tempfile = { workspace = true, optional = true }
 tiny-keccak = { workspace = true }
 tracing = { workspace = true, features = ["attributes"] }
-tracing-opentelemetry = { workspace = true, optional = true }
-tracing-subscriber = { workspace = true, optional = true }
 zerocopy = { workspace = true }
 
 [dev-dependencies]
 arrow-csv = { workspace = true }
-criterion = { workspace = true, features = ["html_reports"] }
 hex = { workspace = true }
 merlin = { workspace = true }
 rand = { workspace = true, default-features = false, features = ["std"] }
@@ -82,13 +76,12 @@ proptest = { workspace = true }
 proptest-derive = { workspace = true }
 
 [package.metadata.cargo-udeps.ignore]
-development = ["arrow-csv", "criterion", "opentelemetry", "opentelemetry-jaeger", "tracing-opentelemetry", "tracing-subscriber"]
+development = ["arrow-csv"]
 
 [features]
 default = ["arrow", "perf"]
 utils = ["dep:indicatif", "dep:rand_chacha", "dep:sha2", "dep:clap", "dep:tempfile"]
 arrow = ["dep:arrow", "std"]
-bench = ["blitzar", "dep:clap", "csv", "dep:rand", "hyperkzg_proof", "opentelemetry", "opentelemetry-jaeger", "std", "tracing-opentelemetry", "tracing-subscriber" ]
 blitzar = ["dep:blitzar", "dep:merlin", "std"]
 hyperkzg_proof = ["dep:nova-snark", "std", "dep:ff", "dep:halo2curves", "blitzar"]
 test = ["dep:rand", "std"]
@@ -110,11 +103,6 @@ name = "commitment-utility"
 path = "utils/commitment-utility/main.rs"
 required-features = [ "std", "blitzar", "utils" ]
 
-[[bin]]
-name = "jaeger_benches"
-path = "benches/jaeger/bin/jaeger_benches.rs"
-required-features = [ "bench" ]
-
 [[example]]
 name = "hello_world"
 required-features = ["test"]
@@ -190,8 +178,3 @@ required-features = [ "arrow" ]
 [[example]]
 name = "rockets"
 required-features = [ "arrow" ]
-
-[[bench]]
-name = "bench_append_rows"
-harness = false
-required-features = ["test"]