|
| 1 | +#![allow(clippy::disallowed_macros)] |
| 2 | + |
| 3 | +use anyhow::{bail, ensure, Context, Result}; |
| 4 | +use serde_json::Value; |
| 5 | +use spacetimedb_guard::{ensure_binaries_built, SpacetimeDbGuard}; |
| 6 | +use std::{ |
| 7 | + env, fs, |
| 8 | + path::{Path, PathBuf}, |
| 9 | + process::Command, |
| 10 | +}; |
| 11 | + |
| 12 | +const DATABASE_NAME: &str = "test-1"; |
| 13 | +const KEYNOTE_DIR: &str = "templates/keynote-2"; |
| 14 | +const KEYNOTE_MODULE_DIR: &str = "templates/keynote-2/spacetimedb"; |
| 15 | +const KEYNOTE_BINDINGS_DIR: &str = "templates/keynote-2/module_bindings"; |
| 16 | +const MIN_TPS: f64 = 250_000.0; |
| 17 | +const BENCH_SECONDS: &str = "60"; |
| 18 | +const BENCH_CONCURRENCY: &str = "64"; |
| 19 | +const MAX_INFLIGHT_PER_WORKER: &str = "64"; |
| 20 | +const SEED_ACCOUNTS: &str = "100000"; |
| 21 | +const SEED_INITIAL_BALANCE: &str = "1000000000000"; |
| 22 | + |
| 23 | +pub fn run() -> Result<()> { |
| 24 | + build_typescript_sdk()?; |
| 25 | + build_release_binaries()?; |
| 26 | + |
| 27 | + let cli_path = ensure_binaries_built(); |
| 28 | + let server = SpacetimeDbGuard::spawn_in_temp_data_dir(); |
| 29 | + let cli_config_dir = tempfile::tempdir().context("failed to create temporary CLI config directory")?; |
| 30 | + let cli_config_path = cli_config_dir.path().join("config.toml"); |
| 31 | + |
| 32 | + publish_module(&cli_path, &cli_config_path, &server.host_url)?; |
| 33 | + generate_module_bindings(&cli_path, &cli_config_path)?; |
| 34 | + seed_accounts(&cli_path, &cli_config_path, &server.host_url)?; |
| 35 | + |
| 36 | + let runs_dir = tempfile::tempdir().context("failed to create temporary benchmark runs directory")?; |
| 37 | + run_benchmark(&server.host_url, runs_dir.path())?; |
| 38 | + |
| 39 | + let result_path = find_result_json(runs_dir.path())?; |
| 40 | + let result_json = fs::read_to_string(&result_path) |
| 41 | + .with_context(|| format!("failed to read benchmark result {}", result_path.display()))?; |
| 42 | + let tps = result_tps(&result_json)?; |
| 43 | + |
| 44 | + if tps < MIN_TPS { |
| 45 | + eprintln!( |
| 46 | + "Keynote perf regression: throughput {tps:.0} TPS < {MIN_TPS:.0} TPS\n\nResult JSON:\n{}", |
| 47 | + result_json |
| 48 | + ); |
| 49 | + bail!("keynote benchmark throughput is below threshold"); |
| 50 | + } |
| 51 | + |
| 52 | + println!( |
| 53 | + "Keynote perf check passed: throughput {tps:.0} TPS >= {MIN_TPS:.0} TPS ({})", |
| 54 | + result_path.display() |
| 55 | + ); |
| 56 | + Ok(()) |
| 57 | +} |
| 58 | + |
| 59 | +fn build_typescript_sdk() -> Result<()> { |
| 60 | + let mut cmd = Command::new("pnpm"); |
| 61 | + cmd.arg("build").current_dir("crates/bindings-typescript"); |
| 62 | + run_command(&mut cmd, "pnpm build in crates/bindings-typescript") |
| 63 | +} |
| 64 | + |
| 65 | +fn build_release_binaries() -> Result<()> { |
| 66 | + eprintln!("Building spacetimedb-cli and spacetimedb-standalone (release)..."); |
| 67 | + let mut cmd = Command::new("cargo"); |
| 68 | + cmd.args([ |
| 69 | + "build", |
| 70 | + "--release", |
| 71 | + "-p", |
| 72 | + "spacetimedb-cli", |
| 73 | + "-p", |
| 74 | + "spacetimedb-standalone", |
| 75 | + "--features", |
| 76 | + "spacetimedb-standalone/allow_loopback_http_for_tests", |
| 77 | + ]); |
| 78 | + remove_cargo_env_vars(&mut cmd); |
| 79 | + run_command(&mut cmd, "cargo build --release spacetimedb-cli spacetimedb-standalone") |
| 80 | +} |
| 81 | + |
| 82 | +fn remove_cargo_env_vars(cmd: &mut Command) { |
| 83 | + for (key, _) in env::vars() { |
| 84 | + let should_remove = (key.starts_with("CARGO") && key != "CARGO_HOME" && key != "CARGO_TARGET_DIR") |
| 85 | + || key.starts_with("RUST") |
| 86 | + || key == "__CARGO_FIX_YOLO"; |
| 87 | + if should_remove { |
| 88 | + cmd.env_remove(key); |
| 89 | + } |
| 90 | + } |
| 91 | +} |
| 92 | + |
| 93 | +fn publish_module(cli_path: &Path, config_path: &Path, server_url: &str) -> Result<()> { |
| 94 | + run_cli( |
| 95 | + cli_path, |
| 96 | + config_path, |
| 97 | + &[ |
| 98 | + "publish", |
| 99 | + "--server", |
| 100 | + server_url, |
| 101 | + "--module-path", |
| 102 | + KEYNOTE_MODULE_DIR, |
| 103 | + "--yes", |
| 104 | + "--clear-database", |
| 105 | + DATABASE_NAME, |
| 106 | + ], |
| 107 | + "spacetime publish keynote module", |
| 108 | + ) |
| 109 | +} |
| 110 | + |
| 111 | +fn generate_module_bindings(cli_path: &Path, config_path: &Path) -> Result<()> { |
| 112 | + run_cli( |
| 113 | + cli_path, |
| 114 | + config_path, |
| 115 | + &[ |
| 116 | + "generate", |
| 117 | + "--lang", |
| 118 | + "typescript", |
| 119 | + "--out-dir", |
| 120 | + KEYNOTE_BINDINGS_DIR, |
| 121 | + "--module-path", |
| 122 | + KEYNOTE_MODULE_DIR, |
| 123 | + "--yes", |
| 124 | + ], |
| 125 | + "spacetime generate keynote TypeScript bindings", |
| 126 | + ) |
| 127 | +} |
| 128 | + |
| 129 | +fn seed_accounts(cli_path: &Path, config_path: &Path, server_url: &str) -> Result<()> { |
| 130 | + run_cli( |
| 131 | + cli_path, |
| 132 | + config_path, |
| 133 | + &[ |
| 134 | + "call", |
| 135 | + "--server", |
| 136 | + server_url, |
| 137 | + DATABASE_NAME, |
| 138 | + "seed", |
| 139 | + SEED_ACCOUNTS, |
| 140 | + SEED_INITIAL_BALANCE, |
| 141 | + ], |
| 142 | + "spacetime call seed", |
| 143 | + ) |
| 144 | +} |
| 145 | + |
| 146 | +fn run_cli(cli_path: &Path, config_path: &Path, args: &[&str], label: &str) -> Result<()> { |
| 147 | + let mut cmd = Command::new(cli_path); |
| 148 | + cmd.arg("--config-path").arg(config_path).args(args); |
| 149 | + run_command(&mut cmd, label) |
| 150 | +} |
| 151 | + |
| 152 | +fn run_benchmark(server_url: &str, runs_dir: &Path) -> Result<()> { |
| 153 | + let mut cmd = Command::new("pnpm"); |
| 154 | + cmd.args([ |
| 155 | + "run", |
| 156 | + "bench", |
| 157 | + DATABASE_NAME, |
| 158 | + "--seconds", |
| 159 | + BENCH_SECONDS, |
| 160 | + "--concurrency", |
| 161 | + BENCH_CONCURRENCY, |
| 162 | + "--connectors", |
| 163 | + "spacetimedb", |
| 164 | + ]) |
| 165 | + .current_dir(KEYNOTE_DIR) |
| 166 | + .env("NODE_ENV", "production") |
| 167 | + .env("BENCH_PIPELINED", "1") |
| 168 | + .env("MAX_INFLIGHT_PER_WORKER", MAX_INFLIGHT_PER_WORKER) |
| 169 | + .env("BENCH_RUNS_DIR", runs_dir) |
| 170 | + .env("STDB_URL", server_url) |
| 171 | + .env("STDB_MODULE", DATABASE_NAME) |
| 172 | + .env("SEED_ACCOUNTS", SEED_ACCOUNTS) |
| 173 | + .env("SEED_INITIAL_BALANCE", SEED_INITIAL_BALANCE); |
| 174 | + run_command(&mut cmd, "keynote SpacetimeDB benchmark") |
| 175 | +} |
| 176 | + |
| 177 | +fn run_command(cmd: &mut Command, label: &str) -> Result<()> { |
| 178 | + let status = cmd.status().with_context(|| format!("failed to spawn {label}"))?; |
| 179 | + ensure!(status.success(), "{label} failed with status {status}"); |
| 180 | + Ok(()) |
| 181 | +} |
| 182 | + |
| 183 | +fn find_result_json(runs_dir: &Path) -> Result<PathBuf> { |
| 184 | + let mut matches = Vec::new(); |
| 185 | + for entry in fs::read_dir(runs_dir).with_context(|| format!("failed to read {}", runs_dir.display()))? { |
| 186 | + let entry = entry?; |
| 187 | + let path = entry.path(); |
| 188 | + let Some(name) = path.file_name().and_then(|name| name.to_str()) else { |
| 189 | + continue; |
| 190 | + }; |
| 191 | + if name.starts_with("test-1-spacetimedb-") && name.ends_with(".json") { |
| 192 | + matches.push(path); |
| 193 | + } |
| 194 | + } |
| 195 | + |
| 196 | + match matches.len() { |
| 197 | + 0 => bail!( |
| 198 | + "benchmark did not write a test-1-spacetimedb result JSON in {}", |
| 199 | + runs_dir.display() |
| 200 | + ), |
| 201 | + 1 => Ok(matches.remove(0)), |
| 202 | + _ => bail!( |
| 203 | + "benchmark wrote multiple test-1-spacetimedb result JSON files in {}: {:?}", |
| 204 | + runs_dir.display(), |
| 205 | + matches |
| 206 | + ), |
| 207 | + } |
| 208 | +} |
| 209 | + |
| 210 | +fn result_tps(result_json: &str) -> Result<f64> { |
| 211 | + let value: Value = serde_json::from_str(result_json).context("failed to parse benchmark result JSON")?; |
| 212 | + value |
| 213 | + .pointer("/results/0/res/tps") |
| 214 | + .and_then(Value::as_f64) |
| 215 | + .context("benchmark result JSON is missing results[0].res.tps") |
| 216 | +} |
0 commit comments