use std::{ fs::{self}, panic::AssertUnwindSafe, path::Path, sync::{ Arc, atomic::{AtomicUsize, Ordering}, }, time::Duration, }; use anyhow::{Context, Result, anyhow}; use criterion::{ BenchmarkGroup, BenchmarkId, Criterion, measurement::{Measurement, WallTime}, }; use once_cell::sync::Lazy; use tokio::{ runtime::Runtime, time::{sleep, timeout}, }; use turbo_tasks::util::FormatDuration; use util::{ AsyncBencherExtension, BINDING_NAME, PreparedApp, build_test, create_browser, env::{read_env, read_env_bool, read_env_list}, module_picker::ModulePicker, }; use self::{bundlers::RenderType, util::resume_on_error}; use crate::{bundlers::Bundler, util::PageGuard}; pub mod bundlers; pub mod util; pub fn bench_startup(c: &mut Criterion, bundlers: &[Box]) { let mut g = c.benchmark_group("bench_startup"); g.sample_size(10); g.measurement_time(Duration::from_secs(60)); bench_startup_internal(g, false, bundlers); } pub fn bench_hydration(c: &mut Criterion, bundlers: &[Box]) { let mut g = c.benchmark_group("bench_hydration"); g.sample_size(10); g.measurement_time(Duration::from_secs(60)); bench_startup_internal(g, true, bundlers); } fn bench_startup_internal( mut g: BenchmarkGroup, hydration: bool, bundlers: &[Box], ) { let runtime = Runtime::new().unwrap(); let browser = Lazy::new(|| runtime.block_on(create_browser())); for bundler in bundlers { let wait_for_hydration = match bundler.render_type() { RenderType::ClientSideRendered => { // For bundlers without server rendered html "startup" means time to hydration // as they only render an empty screen without hydration. Since startup and // hydration would be the same we skip the hydration benchmark for them. if hydration { continue; } else { true } } RenderType::ServerSidePrerendered => hydration, RenderType::ServerSideRenderedWithEvents => hydration, RenderType::ServerSideRenderedWithoutInteractivity => { // For bundlers without interactivity there is no hydration event to wait for if hydration { continue; } else { false } } }; for module_count in get_module_counts() { let test_app = Lazy::new(|| build_test(module_count, bundler.as_ref())); let input = (bundler.as_ref(), &test_app); resume_on_error(AssertUnwindSafe(|| { g.bench_with_input( BenchmarkId::new(bundler.get_name(), format!("{module_count} modules")), &input, |b, &(bundler, test_app)| { let test_app = &**test_app; let browser = &*browser; b.to_async(&runtime).try_iter_custom(|iters, m| async move { let mut value = m.zero(); for _ in 0..iters { let mut app = PreparedApp::new(bundler, test_app.path().to_path_buf()) .await?; let start = m.start(); app.start_server()?; let mut guard = app.with_page(browser).await?; if wait_for_hydration { guard.wait_for_hydration().await?; } let duration = m.end(start); value = m.add(&value, &duration); // Defer the dropping of the guard. drop(guard); } Ok(value) }); }, ); })); } } g.finish(); } #[derive(Copy, Clone)] enum CodeLocation { Effect, Evaluation, } pub fn bench_hmr_to_eval(c: &mut Criterion, bundlers: &[Box]) { let mut g = c.benchmark_group("bench_hmr_to_eval"); g.sample_size(10); g.measurement_time(Duration::from_secs(60)); bench_hmr_internal(g, CodeLocation::Evaluation, bundlers); } pub fn bench_hmr_to_commit(c: &mut Criterion, bundlers: &[Box]) { let mut g = c.benchmark_group("bench_hmr_to_commit"); g.sample_size(10); g.measurement_time(Duration::from_secs(60)); bench_hmr_internal(g, CodeLocation::Effect, bundlers); } fn bench_hmr_internal( mut g: BenchmarkGroup, location: CodeLocation, bundlers: &[Box], ) { // Only capture one sample for warmup g.warm_up_time(Duration::from_millis(1)); let runtime = Runtime::new().unwrap(); let browser = Lazy::new(|| runtime.block_on(create_browser())); let hmr_warmup = read_env("TURBOPACK_BENCH_HMR_WARMUP", 10).unwrap(); for bundler in bundlers { if matches!( bundler.render_type(), RenderType::ServerSideRenderedWithEvents | RenderType::ServerSideRenderedWithoutInteractivity ) && matches!(location, CodeLocation::Evaluation) { // We can't measure evaluation time for these bundlers since it's not evaluated // in the browser continue; } for module_count in get_module_counts() { let test_app = Lazy::new(|| build_test(module_count, bundler.as_ref())); let input = (bundler.as_ref(), &test_app); let module_picker = Lazy::new(|| Arc::new(ModulePicker::new(test_app.modules().to_vec()))); resume_on_error(AssertUnwindSafe(|| { g.bench_with_input( BenchmarkId::new(bundler.get_name(), format!("{module_count} modules")), &input, |b, &(bundler, test_app)| { let test_app = &**test_app; let modules = test_app.modules(); let module_picker = &*module_picker; let browser = &*browser; let max_init_update_timeout = bundler.max_init_update_timeout(module_count); let max_update_timeout = bundler.max_update_timeout(module_count); b.to_async(&runtime).try_iter_async( &runtime, || async { let mut app = PreparedApp::new_without_copy( bundler, test_app.path().to_path_buf(), ) .await?; app.start_server()?; let mut guard = app.with_page(browser).await?; if bundler.has_hydration_event() { guard.wait_for_hydration().await?; } else { guard.page().wait_for_navigation().await?; } guard .page() .evaluate_expression("globalThis.HMR_IS_HAPPENING = true") .await .context( "Unable to evaluate JavaScript in the page for HMR check \ flag", )?; // There's a possible race condition between hydration and // connection to the HMR server. We attempt to make updates with an // exponential backoff until one succeeds. let mut exponential_duration = Duration::from_millis(100); loop { match make_change( &modules[0].0, bundler, &mut guard, location, exponential_duration, &WallTime, ) .await { Ok(_) => { break; } Err(e) => { exponential_duration *= 2; if exponential_duration > max_init_update_timeout { return Err( e.context("failed to make warmup change") ); } } } } // Once we know the HMR server is connected, we make a few warmup // changes. let mut hmr_warmup_iter = 0; let mut hmr_warmup_dropped = 0; while hmr_warmup_iter < hmr_warmup { match make_change( &modules[0].0, bundler, &mut guard, location, max_update_timeout, &WallTime, ) .await { Err(_) => { // We don't care about dropped updates during warmup. hmr_warmup_dropped += 1; if hmr_warmup_dropped >= hmr_warmup { anyhow::bail!( "failed to make warmup change {} times", hmr_warmup_dropped ) } } Ok(_) => { hmr_warmup_iter += 1; } } } Ok(guard) }, |mut guard, iters, m, verbose| { let module_picker = Arc::clone(module_picker); async move { let mut value = m.zero(); let mut dropped = 0; let mut iter = 0; while iter < iters { let module = module_picker.pick(); let duration = match make_change( module, bundler, &mut guard, location, max_update_timeout, &m, ) .await { Err(_) => { // Some bundlers (e.g. Turbopack and Vite) can drop // updates under certain conditions. We don't want // to crash or stop the benchmark // because of this. Instead, we keep going and // report the number of dropped updates at the end. dropped += 1; continue; } Ok(duration) => duration, }; value = m.add(&value, &duration); iter += 1; if verbose && iter != iters && iter.is_power_of_two() { eprint!( " [{:?} {:?}/{}{}]", duration, FormatDuration(value / (iter as u32)), iter, if dropped > 0 { format!(" ({dropped} dropped)") } else { "".to_string() } ); } } Ok((guard, value)) } }, |guard| async move { let hmr_is_happening = guard .page() .evaluate_expression("globalThis.HMR_IS_HAPPENING") .await .unwrap(); // Make sure that we are really measuring HMR and not accidentally // full refreshing the page assert!(hmr_is_happening.value().unwrap().as_bool().unwrap()); }, ); }, ); })); } } } fn insert_code( path: &Path, bundler: &dyn Bundler, message: &str, location: CodeLocation, ) -> Result Result<()>> { let mut contents = fs::read_to_string(path)?; const PRAGMA_EVAL_START: &str = "/* @turbopack-bench:eval-start */"; const PRAGMA_EVAL_END: &str = "/* @turbopack-bench:eval-end */"; let eval_start = contents .find(PRAGMA_EVAL_START) .ok_or_else(|| anyhow!("unable to find effect start pragma in {}", contents))?; let eval_end = contents .find(PRAGMA_EVAL_END) .ok_or_else(|| anyhow!("unable to find effect end pragma in {}", contents))?; match (location, bundler.render_type()) { (CodeLocation::Effect, _) => { contents.replace_range( eval_start + PRAGMA_EVAL_START.len()..eval_end, &format!("\nEFFECT_PROPS.message = \"{message}\";\n"), ); } ( CodeLocation::Evaluation, RenderType::ClientSideRendered | RenderType::ServerSidePrerendered, ) => { let code = format!( "\nglobalThis.{BINDING_NAME} && globalThis.{BINDING_NAME}(\"{message}\");\n" ); contents.replace_range(eval_start + PRAGMA_EVAL_START.len()..eval_end, &code); } ( CodeLocation::Evaluation, RenderType::ServerSideRenderedWithEvents | RenderType::ServerSideRenderedWithoutInteractivity, ) => { panic!("evaluation can't be measured for bundlers which evaluate on server side"); } } let path = path.to_owned(); Ok(move || Ok(fs::write(&path, contents)?)) } static CHANGE_TIMEOUT_MESSAGE: &str = "update was not registered by bundler"; async fn make_change( module: &Path, bundler: &dyn Bundler, guard: &mut PageGuard<'_>, location: CodeLocation, timeout_duration: Duration, measurement: &WallTime, ) -> Result { static CHANGE_COUNTER: AtomicUsize = AtomicUsize::new(0); let msg = format!( "TURBOPACK_BENCH_CHANGE_{}", CHANGE_COUNTER.fetch_add(1, Ordering::Relaxed) ); // Keep the IO out of the measurement. let commit = insert_code(module, bundler, &msg, location)?; let start = measurement.start(); commit()?; // Wait for the change introduced above to be reflected at runtime. // This expects HMR or automatic reloading to occur. timeout(timeout_duration, guard.wait_for_binding(&msg)) .await .context(CHANGE_TIMEOUT_MESSAGE)??; let duration = measurement.end(start); if cfg!(target_os = "linux") { // TODO(sokra) triggering HMR updates too fast can have weird effects on Linux tokio::time::sleep(std::cmp::max(duration, Duration::from_millis(100))).await; } Ok(duration) } pub fn bench_startup_cached(c: &mut Criterion, bundlers: &[Box]) { let mut g = c.benchmark_group("bench_startup_cached"); g.sample_size(10); g.measurement_time(Duration::from_secs(60)); bench_startup_cached_internal(g, false, bundlers); } pub fn bench_hydration_cached(c: &mut Criterion, bundlers: &[Box]) { let mut g = c.benchmark_group("bench_hydration_cached"); g.sample_size(10); g.measurement_time(Duration::from_secs(60)); bench_startup_cached_internal(g, true, bundlers); } fn bench_startup_cached_internal( mut g: BenchmarkGroup, hydration: bool, bundlers: &[Box], ) { if !read_env_bool("TURBOPACK_BENCH_CACHED") { return; } let runtime = Runtime::new().unwrap(); let browser = Lazy::new(|| runtime.block_on(create_browser())); for bundler in bundlers { let wait_for_hydration = match bundler.render_type() { RenderType::ClientSideRendered => { // For bundlers without server rendered html "startup" means time to hydration // as they only render an empty screen without hydration. Since startup and // hydration would be the same we skip the hydration benchmark for them. if hydration { continue; } else { true } } RenderType::ServerSidePrerendered => hydration, RenderType::ServerSideRenderedWithEvents => hydration, RenderType::ServerSideRenderedWithoutInteractivity => { // For bundlers without interactivity there is no hydration event to wait for if hydration { continue; } else { false } } }; for module_count in get_module_counts() { let test_app = Lazy::new(|| build_test(module_count, bundler.as_ref())); let input = (bundler.as_ref(), &test_app); resume_on_error(AssertUnwindSafe(|| { g.bench_with_input( BenchmarkId::new(bundler.get_name(), format!("{module_count} modules")), &input, |b, &(bundler, test_app)| { let test_app = &**test_app; let browser = &*browser; b.to_async(&runtime).try_iter_custom(|iters, m| async move { // Run a complete build, shut down, and test running it again let mut app = PreparedApp::new(bundler, test_app.path().to_path_buf()).await?; app.start_server()?; let mut guard = app.with_page(browser).await?; if bundler.has_hydration_event() { guard.wait_for_hydration().await?; } else { guard.page().wait_for_navigation().await?; } let mut app = guard.close_page().await?; // Give it 4 seconds time to store the cache sleep(Duration::from_secs(4)).await; app.stop_server()?; let mut value = m.zero(); for _ in 0..iters { let start = m.start(); app.start_server()?; let mut guard = app.with_page(browser).await?; if wait_for_hydration { guard.wait_for_hydration().await?; } let duration = m.end(start); value = m.add(&value, &duration); app = guard.close_page().await?; app.stop_server()?; } drop(app); Ok(value) }); }, ); })); } } } fn get_module_counts() -> Vec { read_env_list("TURBOPACK_BENCH_COUNTS", vec![1_000usize]).unwrap() }