next.js/turbopack/crates/turbo-tasks-backend/tests/task_statistics.rs

#![feature(arbitrary_self_types)]
#![feature(arbitrary_self_types_pointers)]
#![allow(clippy::needless_return)] // tokio macro-generated code doesn't respect this

use std::future::IntoFuture;

use anyhow::Result;
use once_cell::sync::Lazy;
use regex::Regex;
use serde_json::json;
use turbo_tasks::Vc;
use turbo_tasks_testing::{Registration, register, run_without_cache_check};

static REGISTRATION: Registration = register!();

#[tokio::test]
async fn test_simple_task() -> Result<()> {
    run_without_cache_check(&REGISTRATION, async move {
        enable_stats();
        for i in 0..10 {
            double(i).await.unwrap();
            // use cached results
            double(i).await.unwrap();
        }
        for i in 0..5 {
            double(i).await.unwrap();
        }
        assert_eq!(
            stats_json(),
            json!({
                "double": {
                    "cache_miss": 10,
                    "cache_hit": 15,
                },
            })
        );
        Ok(())
    })
    .await
}

#[tokio::test]
async fn test_await_same_vc_multiple_times() -> Result<()> {
    run_without_cache_check(&REGISTRATION, async move {
        enable_stats();
        let dvc = double(0);
        // this is awaited multiple times, but only resolved once
        tokio::try_join!(dvc.into_future(), dvc.into_future()).unwrap();
        dvc.await.unwrap();
        assert_eq!(
            stats_json(),
            json!({
                "double": {
                    "cache_miss": 1,
                    "cache_hit": 0,
                },
            })
        );
        Ok(())
    })
    .await
}

#[tokio::test]
async fn test_vc_receiving_task() -> Result<()> {
    run_without_cache_check(&REGISTRATION, async move {
        enable_stats();
        for i in 0..10 {
            let dvc = double(i);
            double_vc(dvc).await.unwrap();
            // use cached results
            double_vc(dvc).await.unwrap();
        }
        for i in 0..5 {
            let dvc = double(i);
            double_vc(dvc).await.unwrap();
        }
        assert_eq!(
            stats_json(),
            json!({
                "double": {
                    "cache_miss": 10,
                    "cache_hit": 5,
                },
                "double_vc": {
                    "cache_miss": 10,
                    "cache_hit": 15,
                },
            })
        );
        Ok(())
    })
    .await
}

#[tokio::test]
async fn test_trait_methods() -> Result<()> {
    run_without_cache_check(&REGISTRATION, async move {
        enable_stats();
        for i in 0..10 {
            let wvc = wrap(i);
            tokio::try_join!(wvc.double().into_future(), wvc.double().into_future()).unwrap();
            tokio::try_join!(wvc.double_vc().into_future(), wvc.double_vc().into_future()).unwrap();
        }
        // use cached results
        for i in 0..5 {
            let wvc = wrap(i);
            wvc.double().await.unwrap();
            wvc.double_vc().await.unwrap();
        }
        assert_eq!(
            stats_json(),
            json!({
                "wrap": {
                    "cache_miss": 10,
                    "cache_hit": 5,
                },
                "WrappedU64::Doublable::double": {
                    "cache_miss": 10,
                    "cache_hit": 15,
                },
                "WrappedU64::Doublable::double_vc": {
                    "cache_miss": 10,
                    "cache_hit": 15,
                },
            })
        );
        Ok(())
    })
    .await
}

#[tokio::test]
async fn test_dyn_trait_methods() -> Result<()> {
    run_without_cache_check(&REGISTRATION, async move {
        enable_stats();
        for i in 0..10 {
            let wvc: Vc<Box<dyn Doublable>> = Vc::upcast(wrap(i));
            let _ = tokio::try_join!(wvc.double().resolve(), wvc.double().resolve()).unwrap();
            let _ = tokio::try_join!(wvc.double_vc().resolve(), wvc.double_vc().resolve()).unwrap();
        }
        // use cached results
        for i in 0..5 {
            let wvc: Vc<Box<dyn Doublable>> = Vc::upcast(wrap(i));
            let _ = wvc.double().resolve().await.unwrap();
            let _ = wvc.double_vc().resolve().await.unwrap();
        }
        // use cached results without dynamic dispatch
        for i in 0..2 {
            let wvc = wrap(i);
            let _ = wvc.double().await.unwrap();
            let _ = wvc.double_vc().await.unwrap();
        }
        assert_eq!(
            stats_json(),
            json!({
                "wrap": {
                    "cache_miss": 10,
                    "cache_hit": 7,
                },
                "WrappedU64::Doublable::double": {
                    "cache_miss": 10,
                    "cache_hit": 17,
                },
                "WrappedU64::Doublable::double_vc": {
                    "cache_miss": 10,
                    "cache_hit": 17,
                },
            })
        );
        Ok(())
    })
    .await
}

// creates Vcs, but doesn't ever execute them
#[tokio::test]
async fn test_no_execution() -> Result<()> {
    run_without_cache_check(&REGISTRATION, async move {
        enable_stats();
        // don't await this!
        let _ = wrap_vc(double_vc(double(123))).double().double_vc();
        assert_eq!(
            stats_json(),
            json!({
                "double": {
                    "cache_miss": 1,
                    "cache_hit": 0,
                },
            })
        );
        Ok(())
    })
    .await
}

// Internally, this function uses `PersistentTaskType`.
#[turbo_tasks::function]
fn double(val: u64) -> Vc<u64> {
    Vc::cell(val * 2)
}

// Internally, this function uses `LocalTaskType::ResolveNative`.
#[turbo_tasks::function]
async fn double_vc(val: Vc<u64>) -> Result<Vc<u64>> {
    let val = *val.await?;
    Ok(Vc::cell(val * 2))
}

#[turbo_tasks::value]
struct WrappedU64(u64);

#[turbo_tasks::function]
fn wrap(val: u64) -> Vc<WrappedU64> {
    WrappedU64(val).cell()
}

#[turbo_tasks::function]
async fn wrap_vc(val: Vc<u64>) -> Result<Vc<WrappedU64>> {
    Ok(WrappedU64(*val.await?).cell())
}

#[turbo_tasks::value_trait]
pub trait Doublable {
    #[turbo_tasks::function]
    fn double(&self) -> Vc<Self>;
    #[turbo_tasks::function]
    fn double_vc(self: Vc<Self>) -> Vc<Self>;
}

#[turbo_tasks::value_impl]
impl Doublable for WrappedU64 {
    #[turbo_tasks::function]
    fn double(&self) -> Vc<Self> {
        WrappedU64(self.0 * 2).cell()
    }

    #[turbo_tasks::function]
    fn double_vc(&self) -> Result<Vc<Self>> {
        let val = self.0;
        Ok(WrappedU64(val * 2).cell())
    }
}

#[turbo_tasks::function]
fn fail(val: u64) -> Result<Vc<()>> {
    anyhow::bail!("failed using {val}");
}

fn enable_stats() {
    let tt = turbo_tasks::turbo_tasks();
    tt.task_statistics().enable();
}

fn stats_json() -> serde_json::Value {
    let tt = turbo_tasks::turbo_tasks();
    remove_crate_and_hashes(serde_json::to_value(tt.task_statistics().get()).unwrap())
}

// Global task identifiers can contain a hash of the crate and dependencies.
// Remove that so that we can compare against a stable value in tests.
fn remove_crate_and_hashes(mut json: serde_json::Value) -> serde_json::Value {
    static HASH_RE: Lazy<Regex> = Lazy::new(|| Regex::new("^[^:@]+@[^:]+:+").unwrap());
    match &mut json {
        serde_json::Value::Object(map) => {
            let old_map = std::mem::take(map);
            for (k, v) in old_map {
                map.insert(HASH_RE.replace(&k, "").into_owned(), v);
            }
        }
        _ => unreachable!("expected object"),
    };
    json
}