Files
5d0dab5fc6 [turbopack] Enforce root attribute for strongly consistent reads and collectibles (#93114)
### What?

Replaces the silent "make root node" promotion in the turbo-tasks
backend with a panic that enforces tasks to already have the `root`
attribute before performing strongly consistent reads, reading task
collectibles, or removing collectibles.

### Why?

Previously, the backend would silently promote any non-root task to a
root node (aggregation number `u32::MAX`) when these operations were
requested. This masked incorrect task configuration — tasks that needed
root-level aggregation weren't explicitly declared as such, making it
harder to reason about the aggregation graph and hiding potential
performance issues from implicit promotions.

### How?

**Backend enforcement (3 locations):**
- **Strongly consistent read** (`backend/mod.rs`): Checks
`NativeFunction.is_root` on the target task. If it's a persistent task
without `root`, panics with both the target and reader task
descriptions.
- **Read task collectibles** (`backend/mod.rs`): Same check when reading
collectibles from a task.
- **Remove collectibles** (`operation/update_collectible.rs`): Same
check when removing collectibles (count < 0).

All three locations drop the task guard before panicking to avoid
deadlocking with `debug_get_task_description`.

**Macro support for `root` on methods:**
- `value_impl_macro.rs`: Now reads the `root` attribute from
`#[turbo_tasks::function(root)]` on inherent impl and trait impl methods
(previously hardcoded to `false`).
- `value_trait_macro.rs`: Same for trait default methods.

**`root` attribute additions:**
- All `#[turbo_tasks::function(operation)]` in test files, benchmarks,
and fuzz code
- Production operations in `crates/next-api/` that are read with strong
consistency
- Regular functions and methods in tests that use
`.strongly_consistent()`
- Trait methods in `value_impl` and `value_trait` blocks used with
strong consistency

**New test:**
- `non_root_task_panic.rs`: Verifies the panic fires when attempting a
strongly consistent read on a non-root operation task. Captures the
panic from the worker thread via a panic hook since the panic propagates
as a channel error to the test thread.

<!-- NEXT_JS_LLM_PR -->

---------

Co-authored-by: Claude Opus 4.7 (1M context) <[email protected]>
2026-05-12 18:56:02 +00:00

243 lines
7.4 KiB
Rust

#![feature(arbitrary_self_types)]
#![feature(arbitrary_self_types_pointers)]
#![allow(clippy::needless_return)] // tokio macro-generated code doesn't respect this
use anyhow::Result;
use turbo_tasks::{
ResolvedVc, State, Vc, unmark_top_level_task_may_leak_eventually_consistent_state,
};
use turbo_tasks_testing::{Registration, register, run, run_once};
static REGISTRATION: Registration = register!();
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn recompute() {
run_once(&REGISTRATION, || async {
unmark_top_level_task_may_leak_eventually_consistent_state();
let input = ChangingInput {
state: State::new(1),
}
.cell();
let input2 = ChangingInput {
state: State::new(10),
}
.cell();
let output = compute(input, input2);
let read = output.await?;
assert_eq!(read.state_value, 1);
assert_eq!(read.state_value2, 10);
let random_value = read.random_value;
println!("changing input");
input.await?.state.set(2);
let read = output.strongly_consistent().await?;
assert_eq!(read.state_value, 2);
assert_ne!(read.random_value, random_value);
let random_value = read.random_value;
println!("changing input2");
input2.await?.state.set(20);
let read = output.strongly_consistent().await?;
assert_eq!(read.state_value2, 20);
assert_ne!(read.random_value, random_value);
let random_value = read.random_value;
println!("changing input");
input.await?.state.set(5);
let read = output.strongly_consistent().await?;
assert_eq!(read.state_value, 5);
assert_eq!(read.state_value2, 42);
assert_ne!(read.random_value, random_value);
let random_value = read.random_value;
println!("changing input2");
input2.await?.state.set(30);
let read = output.strongly_consistent().await?;
assert_eq!(read.random_value, random_value);
anyhow::Ok(())
})
.await
.unwrap()
}
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn immutable_analysis() {
run_once(&REGISTRATION, || async {
unmark_top_level_task_may_leak_eventually_consistent_state();
let input = ChangingInput {
state: State::new(1),
}
.resolved_cell();
// Verify
let vc_holder = VcHolder { vc: input }.resolved_cell();
let read = vc_holder.compute().strongly_consistent().await?;
assert_eq!(read.state_value, 1);
assert_eq!(read.state_value2, 1);
let random_value = read.random_value;
println!("changing input1");
input.await?.state.set(30);
let read = vc_holder.compute().strongly_consistent().await?;
assert_eq!(read.state_value, 30);
assert_eq!(read.state_value2, 42);
assert_ne!(read.random_value, random_value);
anyhow::Ok(())
})
.await
.unwrap()
}
#[turbo_tasks::value]
struct ChangingInput {
state: State<u32>,
}
#[turbo_tasks::value]
struct VcHolder {
vc: ResolvedVc<ChangingInput>,
}
#[turbo_tasks::value_impl]
impl VcHolder {
#[turbo_tasks::function(root)]
fn compute(&self) -> Vc<Output> {
compute(*self.vc, *self.vc)
}
}
#[turbo_tasks::value]
struct Output {
state_value: u32,
state_value2: u32,
random_value: u32,
}
#[turbo_tasks::function(root)]
async fn compute(input: Vc<ChangingInput>, input2: Vc<ChangingInput>) -> Result<Vc<Output>> {
let state_value = *input.await?.state.get();
let state_value2 = if state_value < 5 {
*compute2(input2).await?
} else {
42
};
let random_value = rand::random();
Ok(Output {
state_value,
state_value2,
random_value,
}
.cell())
}
#[turbo_tasks::function]
async fn compute2(input: Vc<ChangingInput>) -> Result<Vc<u32>> {
let state_value = *input.await?.state.get();
Ok(Vc::cell(state_value))
}
// ============================================================================
// recompute_dependency test - verifies dependent tasks re-execute correctly
// ============================================================================
/// Tests that when a task's dependency changes, both the inner and outer
/// tasks re-execute correctly and return updated values.
/// This tests the basic dependency propagation through a simple two-task chain.
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn recompute_dependency() {
run(&REGISTRATION, || async {
unmark_top_level_task_may_leak_eventually_consistent_state();
let input = *get_dependency_input().to_resolved().await?;
// Reset state to 1 at the start of each iteration (important for multi-run tests)
input.await?.state.set(1);
// Initial execution - establishes dependency chain:
// outer_compute -> inner_compute -> input.state
let output = outer_compute(input);
let read = output.strongly_consistent().await?;
println!(
"first read: value={}, inner_random={}, outer_random={}",
read.value, read.inner_random, read.outer_random
);
assert_eq!(read.value, 1);
let prev_inner_random = read.inner_random;
let prev_outer_random = read.outer_random;
// Change state - should invalidate inner_compute,
// which should then invalidate outer_compute
println!("changing input");
input.await?.state.set(2);
let read = output.strongly_consistent().await?;
println!(
"second read: value={}, inner_random={}, outer_random={}",
read.value, read.inner_random, read.outer_random
);
// Value should be updated
assert_eq!(read.value, 2);
// Inner task should have re-executed (different random)
assert_ne!(
read.inner_random, prev_inner_random,
"inner_compute should have re-executed"
);
// CRITICAL: Outer task should ALSO have re-executed
// This is what the bug broke - outer_compute wasn't being
// invalidated because its output_dependent edge was removed
assert_ne!(
read.outer_random, prev_outer_random,
"outer_compute should have re-executed due to dependency on inner_compute"
);
anyhow::Ok(())
})
.await
.unwrap();
}
#[turbo_tasks::function]
fn get_dependency_input() -> Vc<ChangingInput> {
ChangingInput {
state: State::new(1),
}
.cell()
}
#[turbo_tasks::value]
struct DependencyOutput {
value: u32,
inner_random: u32,
outer_random: u32,
}
/// Inner task - reads state directly, returns value with embedded random
#[turbo_tasks::function]
async fn inner_compute(input: Vc<ChangingInput>) -> Result<Vc<u32>> {
println!("inner_compute()");
let value = *input.await?.state.get();
// Combine value with random to detect re-execution
// Value in lower 16 bits, random in upper 16 bits
Ok(Vc::cell(value | (rand::random::<u32>() << 16)))
}
/// Outer task - depends on inner_compute
#[turbo_tasks::function(root)]
async fn outer_compute(input: Vc<ChangingInput>) -> Result<Vc<DependencyOutput>> {
println!("outer_compute()");
let inner_result = *inner_compute(input).await?;
let value = inner_result & 0xFFFF;
let inner_random = inner_result >> 16;
Ok(DependencyOutput {
value,
inner_random,
outer_random: rand::random(),
}
.cell())
}