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

108 lines
3.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::{State, Vc, unmark_top_level_task_may_leak_eventually_consistent_state};
use turbo_tasks_testing::{Registration, register, run_once};
static REGISTRATION: Registration = register!();
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn test_hidden_mutate() {
run_once(&REGISTRATION, || async {
unmark_top_level_task_may_leak_eventually_consistent_state();
let input = *create_input().to_resolved().await?;
input.await?.state.set(1);
let changing_value = compute(input);
assert_eq!(changing_value.await?.value, 1);
let changing_value_resolved = *changing_value.to_resolved().await?;
let read_input = read_input(changing_value_resolved);
let static_immutable = immutable_fn(changing_value_resolved);
let read_self = changing_value_resolved.read_self();
let static_immutable_self = changing_value_resolved.immutable_self_fn();
assert_eq!(*read_input.await?, 1);
assert_eq!(*static_immutable.await?, 42);
assert_eq!(*read_self.await?, 1);
assert_eq!(*static_immutable_self.await?, 42);
println!("changing input");
input.await?.state.set(10);
assert_eq!(changing_value.strongly_consistent().await?.value, 10);
assert_eq!(*read_input.strongly_consistent().await?, 10);
assert_eq!(*static_immutable.strongly_consistent().await?, 42);
assert_eq!(*read_self.strongly_consistent().await?, 10);
assert_eq!(*static_immutable_self.strongly_consistent().await?, 42);
println!("changing input");
input.await?.state.set(5);
assert_eq!(changing_value.strongly_consistent().await?.value, 5);
assert_eq!(*read_input.strongly_consistent().await?, 5);
assert_eq!(*static_immutable.strongly_consistent().await?, 42);
assert_eq!(*read_self.strongly_consistent().await?, 5);
assert_eq!(*static_immutable_self.strongly_consistent().await?, 42);
anyhow::Ok(())
})
.await
.unwrap();
}
#[turbo_tasks::value]
struct ChangingInput {
state: State<u32>,
}
#[turbo_tasks::value]
struct Value {
value: u32,
}
#[turbo_tasks::function]
async fn create_input() -> Result<Vc<ChangingInput>> {
println!("create_input()");
Ok(ChangingInput {
state: State::new(0),
}
.cell())
}
#[turbo_tasks::function(root)]
async fn compute(input: Vc<ChangingInput>) -> Result<Vc<Value>> {
println!("compute()");
let input = input.await?;
let value = input.state.get();
Ok(Value { value: *value }.cell())
}
#[turbo_tasks::function(root)]
async fn read_input(input: Vc<Value>) -> Result<Vc<u32>> {
println!("read_input()");
let value = input.await?;
Ok(Vc::cell(value.value))
}
#[turbo_tasks::function(root)]
fn immutable_fn(input: Vc<Value>) -> Vc<u32> {
let _ = input;
println!("immutable_fn()");
Vc::cell(42)
}
#[turbo_tasks::value_impl]
impl Value {
#[turbo_tasks::function(root)]
fn read_self(&self) -> Vc<u32> {
println!("read_self()");
Vc::cell(self.value)
}
#[turbo_tasks::function(root)]
fn immutable_self_fn(self: Vc<Value>) -> Vc<u32> {
let _ = self;
println!("immutable_self_fn()");
Vc::cell(42)
}
}