Unverified Commit 5eb90193 authored by Jimmy Miller's avatar Jimmy Miller Committed by GitHub

Turbopack: skip trimmed side-effect imports in SideEffectsModule (#95781)

A star re-export barrel with imports but no top-level side effects is
classified ModuleEvaluationIsSideEffectFree.
follow_reexports_with_side_effects
treats that as effectful and builds a SideEffectsModule that emits
TURBOPACK_IMPORT(<eval part id>), but
compute_side_effect_free_module_info
classifies the same module as side-effect-free, so binding-usage prunes
the
Evaluation edge and the eval part never gets a module id. The build then
panicked with 'ModuleId not found for ident: .../barrel.ts <internal
part 0>'
during middleware chunking.

SideEffectsModule is designed so graph tree-shaking may trim these
imports, so
the consumer must tolerate a trimmed side effect. Add
ModuleIdStrategy::try_get_id_from_module (returns None instead of
erroring when
an explicit id map lacks the module) and have chunk_item_content skip
side
effects with no id -- a pruned side-effect-free module has nothing to
evaluate.

Adds an e2e regression test (treeshake-mw).
parent 9f93a7eb
export default function RootLayout({
children,
}: {
children: React.ReactNode
}) {
return (
<html>
<body>{children}</body>
</html>
)
}
export default function Page() {
return <h1>home</h1>
}
// Star re-export barrel. Because `getKey` is not a static named entrypoint of
// this module, resolving `import { getKey } from './lib/barrel'` goes through
// `follow_reexports_with_side_effects`, which builds a `SideEffectsModule`.
// This barrel has an import but no top-level side effects, so it is classified
// `ModuleEvaluationIsSideEffectFree` — the status that triggers the desync.
export * from './keys'
export function getKey() {
return 'k'
}
import { NextResponse } from 'next/server'
import { getKey } from './lib/barrel'
export function middleware() {
const k = getKey()
const res = NextResponse.next()
res.headers.set('x-key', k)
return res
}
export const config = {
runtime: 'nodejs',
matcher: '/((?!_next/static|_next/image|favicon.ico).*)',
}
import { nextTestSetup } from 'e2e-utils'
// Regression test for `experimental.turbopackModuleFragments` + Node.js-runtime
// middleware that imports a binding through a star re-export barrel.
//
// The build used to panic during middleware chunking with:
// ModuleId not found for ident: .../lib/barrel.ts [middleware] (ecmascript) <internal part N>
// - Execution of <SideEffectsModule as EcmascriptChunkPlaceable>::chunk_item_content failed
//
// Cause: a re-export module with imports but no top-level side effects is
// classified `ModuleEvaluationIsSideEffectFree`. `follow_reexports` treats that
// as side-effectful (`!= SideEffectFree`) and builds a `SideEffectsModule` that
// emits `TURBOPACK_IMPORT(<eval part id>)`, but `compute_side_effect_free_module_info`
// classifies the same module as side-effect-free, so binding-usage prunes the
// `Evaluation` edge and the eval part never gets a module id.
//
// The build completing and the middleware running is the assertion.
describe('treeshake-mw', () => {
const { next } = nextTestSetup({ files: __dirname })
it('builds and runs Node.js middleware importing via a star re-export', async () => {
const res = await next.fetch('/')
expect(res.headers.get('x-key')).toBe('k')
})
})
/** @type {import("next").NextConfig} */
module.exports = {
typescript: { ignoreBuildErrors: true },
experimental: { turbopackModuleFragments: true },
}
...@@ -55,6 +55,16 @@ impl SideEffectsModule { ...@@ -55,6 +55,16 @@ impl SideEffectsModule {
} }
} }
fn side_effect_reference(
side_effect: ResolvedVc<Box<dyn EcmascriptChunkPlaceable>>,
) -> Vc<SingleChunkableModuleReference> {
SingleChunkableModuleReference::new(
*ResolvedVc::upcast(side_effect),
rcstr!("side effect"),
ExportUsage::evaluation(),
)
}
#[turbo_tasks::value_impl] #[turbo_tasks::value_impl]
impl Module for SideEffectsModule { impl Module for SideEffectsModule {
#[turbo_tasks::function] #[turbo_tasks::function]
...@@ -95,13 +105,7 @@ impl Module for SideEffectsModule { ...@@ -95,13 +105,7 @@ impl Module for SideEffectsModule {
.iter() .iter()
.map(async |side_effect| { .map(async |side_effect| {
Ok(ResolvedVc::upcast( Ok(ResolvedVc::upcast(
SingleChunkableModuleReference::new( side_effect_reference(*side_effect).to_resolved().await?,
*ResolvedVc::upcast(*side_effect),
rcstr!("side effect"),
ExportUsage::evaluation(),
)
.to_resolved()
.await?,
)) ))
}) })
.try_join() .try_join()
...@@ -150,7 +154,17 @@ impl EcmascriptChunkPlaceable for SideEffectsModule { ...@@ -150,7 +154,17 @@ impl EcmascriptChunkPlaceable for SideEffectsModule {
let mut code = RopeBuilder::default(); let mut code = RopeBuilder::default();
let mut has_top_level_await = false; let mut has_top_level_await = false;
let unused_references = chunking_context.unused_references();
for &side_effect in module.side_effects.iter() { for &side_effect in module.side_effects.iter() {
let reference = side_effect_reference(side_effect).to_resolved().await?;
if unused_references
.contains_key(&ResolvedVc::upcast(reference))
.await?
{
continue;
}
let need_await = 'need_await: { let need_await = 'need_await: {
let async_module = *side_effect.get_async_module().await?; let async_module = *side_effect.get_async_module().await?;
if let Some(async_module) = async_module if let Some(async_module) = async_module
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment