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

92 lines
2.7 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::{
Vc, mark_top_level_task, unmark_top_level_task_may_leak_eventually_consistent_state,
};
use turbo_tasks_testing::{Registration, register, run_once};
static REGISTRATION: Registration = register!();
#[turbo_tasks::value]
#[derive(Clone, Debug)]
struct Value {
value: u32,
}
#[turbo_tasks::function(operation, root)]
async fn returns_value_operation() -> Result<Vc<Value>> {
Ok(Value { value: 42 }.cell())
}
/// Test that eventually consistent reads (default .await) cause an error in top-level tasks
/// The panic happens but we just verify it's an error, not the exact message
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
#[should_panic]
async fn test_eventual_read_in_top_level_task_fails() {
run_once(&REGISTRATION, || async {
// This should fail because we're in a top-level task (run_once)
// and doing an eventually consistent read (default .await)
returns_value_operation().connect().await
})
.await
.unwrap()
}
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn test_cell_read_in_top_level_task_succeeds() {
run_once(&REGISTRATION, || async {
let cell = returns_value_operation()
.resolve()
.strongly_consistent()
.await?;
let value = cell.await?;
assert_eq!(value.value, 42);
Ok(())
})
.await
.unwrap()
}
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn test_manual_mark_unmark_top_level_task() {
run_once(&REGISTRATION, || async {
// We're in a top-level task initially, but let's unmark it
unmark_top_level_task_may_leak_eventually_consistent_state();
// Now eventually consistent reads should work
let value = returns_value_operation().connect().await?;
assert_eq!(value.value, 42);
// Re-mark as top-level task
mark_top_level_task();
anyhow::Ok(())
})
.await
.unwrap()
}
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
#[should_panic]
async fn test_manual_mark_top_level_task_causes_error() {
#[turbo_tasks::function(operation, root)]
async fn operation() -> Result<Vc<Value>> {
// Manually mark as top-level task
mark_top_level_task();
// This should panic because we marked it as a top-level task
returns_value_operation().connect().await?;
Ok(Value { value: 42 }.cell())
}
run_once(&REGISTRATION, || async {
operation().read_strongly_consistent().await
})
.await
.unwrap()
}