Unverified Commit ad030d78 authored by Tobias Koppers's avatar Tobias Koppers Committed by GitHub

Turbopack: Tree shaking fixes and code organization (#89295)

## Summary

A series of bug fixes, refactors, and code organization improvements to Turbopack's tree shaking and side effect optimization:

- **Fix `ModulePart` handling for `FreeVarReference::EcmaScriptModule`** — pass `ModulePart` correctly so free variable references resolve to the right module part
- **Extract `EcmascriptModuleRenameModule`** — split the rename/reexport logic (`RenamedExport`, `RenamedNamespace`) out of `EcmascriptModuleFacadeModule` into a dedicated `rename` module, shared between side effects optimization and tree shaking
- **Simplify `EcmascriptModuleFacadeModule`** — now only handles the `Facade` case (locals + reexports), no longer overloaded with rename variants
- **Reorganize tree shaking code** — moved `asset.rs` → `part/module.rs`, `chunk_item.rs` → `part/chunk_item.rs` + `side_effects/chunk_item.rs`, `side_effect_module.rs` → `side_effects/module.rs` for clearer separation between part modules and side effect modules
- **Use `EsmExport` in `FindExportFromReexportsResult`** — reduces code duplication by reusing the existing `EsmExport` enum
- **Minor simplifications** — code deduplication, reordered checks, and general cleanup
parent 286a73f8
......@@ -42,7 +42,7 @@ use turbopack_core::{
};
use turbopack_ecmascript::{
EcmascriptParsable, chunk::EcmascriptChunkPlaceable, parse::ParseResult,
tree_shake::asset::EcmascriptModulePartAsset,
tree_shake::part::module::EcmascriptModulePartAsset,
};
/// Metadata for a server action: (layer, exported_name, filename)
......
......@@ -40,6 +40,20 @@ fn dynamic_ref_description() -> RcStr {
rcstr!("next/dynamic reference")
}
impl NextDynamicEntryModule {
async fn module_reference(&self) -> Result<ResolvedVc<Box<dyn ModuleReference>>> {
Ok(ResolvedVc::upcast(
SingleChunkableModuleReference::new(
Vc::upcast(*self.module),
dynamic_ref_description(),
ExportUsage::all(),
)
.to_resolved()
.await?,
))
}
}
#[turbo_tasks::value_impl]
impl Module for NextDynamicEntryModule {
#[turbo_tasks::function]
......@@ -56,15 +70,7 @@ impl Module for NextDynamicEntryModule {
#[turbo_tasks::function]
async fn references(&self) -> Result<Vc<ModuleReferences>> {
Ok(Vc::cell(vec![ResolvedVc::upcast(
SingleChunkableModuleReference::new(
Vc::upcast(*self.module),
dynamic_ref_description(),
ExportUsage::all(),
)
.to_resolved()
.await?,
)]))
Ok(Vc::cell(vec![self.module_reference().await?]))
}
#[turbo_tasks::function]
fn side_effects(self: Vc<Self>) -> Vc<ModuleSideEffects> {
......
......@@ -61,6 +61,16 @@ impl NextServerComponentModule {
}
}
impl NextServerComponentModule {
async fn module_reference(&self) -> Result<ResolvedVc<Box<dyn ModuleReference>>> {
Ok(ResolvedVc::upcast(
NextServerComponentModuleReference::new(Vc::upcast(*self.module))
.to_resolved()
.await?,
))
}
}
#[turbo_tasks::value_impl]
impl Module for NextServerComponentModule {
#[turbo_tasks::function]
......@@ -77,11 +87,7 @@ impl Module for NextServerComponentModule {
#[turbo_tasks::function]
async fn references(&self) -> Result<Vc<ModuleReferences>> {
Ok(Vc::cell(vec![ResolvedVc::upcast(
NextServerComponentModuleReference::new(Vc::upcast(*self.module))
.to_resolved()
.await?,
)]))
Ok(Vc::cell(vec![self.module_reference().await?]))
}
#[turbo_tasks::function]
fn side_effects(self: Vc<Self>) -> Vc<ModuleSideEffects> {
......
......@@ -41,6 +41,16 @@ impl NextServerUtilityModule {
}
}
impl NextServerUtilityModule {
async fn module_reference(&self) -> Result<ResolvedVc<Box<dyn ModuleReference>>> {
Ok(ResolvedVc::upcast(
NextServerUtilityModuleReference::new(Vc::upcast(*self.module))
.to_resolved()
.await?,
))
}
}
#[turbo_tasks::value_impl]
impl Module for NextServerUtilityModule {
#[turbo_tasks::function]
......@@ -57,11 +67,7 @@ impl Module for NextServerUtilityModule {
#[turbo_tasks::function]
async fn references(&self) -> Result<Vc<ModuleReferences>> {
Ok(Vc::cell(vec![ResolvedVc::upcast(
NextServerUtilityModuleReference::new(Vc::upcast(*self.module))
.to_resolved()
.await?,
)]))
Ok(Vc::cell(vec![self.module_reference().await?]))
}
#[turbo_tasks::function]
......
......@@ -23,6 +23,7 @@ pub mod minify;
pub mod parse;
mod path_visitor;
pub mod references;
pub mod rename;
pub mod runtime_functions;
pub mod side_effect_optimization;
pub mod single_file_ecmascript_output;
......@@ -95,7 +96,7 @@ use turbopack_core::{
reference::ModuleReferences,
reference_type::InnerAssets,
resolve::{
FindContextFileResult, ModulePart, find_context_file, origin::ResolveOrigin, package_json,
FindContextFileResult, find_context_file, origin::ResolveOrigin, package_json,
parse::Request,
},
source::Source,
......@@ -118,10 +119,7 @@ use crate::{
async_module::OptionAsyncModule,
esm::{UrlRewriteBehavior, base::EsmAssetReferences, export},
},
side_effect_optimization::{
facade::module::EcmascriptModuleFacadeModule, locals::module::EcmascriptModuleLocalsModule,
reference::EcmascriptModulePartReference,
},
side_effect_optimization::reference::EcmascriptModulePartReference,
swc_comments::{CowComments, ImmutableComments},
transform::{remove_directives, remove_shebang},
};
......@@ -832,44 +830,6 @@ impl EcmascriptChunkPlaceable for EcmascriptModuleAsset {
}
}
#[turbo_tasks::value_impl]
impl EcmascriptModuleAsset {
/// Returns the locals module if the module should be split (has re-exports), otherwise self.
///
/// The locals module contains only the local bindings and evaluation side effects,
/// while re-exports are handled separately by the facade module.
#[turbo_tasks::function]
pub async fn get_locals_if_split(
self: Vc<Self>,
) -> Result<Vc<Box<dyn EcmascriptChunkPlaceable>>> {
let should_split = *self.get_exports().split_locals_and_reexports().await?;
Ok(if should_split {
Vc::upcast(EcmascriptModuleLocalsModule::new(self))
} else {
Vc::upcast(self)
})
}
/// Returns the facade module if the module should be split (has re-exports), otherwise self.
///
/// The facade module re-exports all exports from the original module, including
/// both local bindings (via the locals module) and re-exports from other modules.
#[turbo_tasks::function]
pub async fn get_facade_if_split(
self: Vc<Self>,
) -> Result<Vc<Box<dyn EcmascriptChunkPlaceable>>> {
let should_split = *self.get_exports().split_locals_and_reexports().await?;
Ok(if should_split {
Vc::upcast(EcmascriptModuleFacadeModule::new(
Vc::upcast(self),
ModulePart::Facade,
))
} else {
Vc::upcast(self)
})
}
}
#[turbo_tasks::value_impl]
impl MergeableModule for EcmascriptModuleAsset {
#[turbo_tasks::function]
......
......@@ -49,7 +49,7 @@ use crate::{
util::throw_module_not_found_expr,
},
runtime_functions::{TURBOPACK_EXTERNAL_IMPORT, TURBOPACK_EXTERNAL_REQUIRE, TURBOPACK_IMPORT},
tree_shake::{TURBOPACK_PART_IMPORT_SOURCE, asset::EcmascriptModulePartAsset},
tree_shake::{TURBOPACK_PART_IMPORT_SOURCE, part::module::EcmascriptModulePartAsset},
utils::module_id_to_lit,
};
......
......@@ -3087,12 +3087,7 @@ async fn handle_free_var_reference(
span.hi.to_u32(),
),
Default::default(),
match state.tree_shaking_mode {
Some(
TreeShakingMode::ModuleFragments | TreeShakingMode::ReexportsOnly,
) => export.clone().map(ModulePart::export),
None => None,
},
export.clone().map(ModulePart::export),
ImportUsage::TopLevel,
state.import_externals,
state.tree_shaking_mode,
......
This diff is collapsed.
......@@ -18,6 +18,7 @@ use crate::{
chunk::EcmascriptChunkPlaceable,
code_gen::{CodeGeneration, CodeGenerationHoistedStmt},
references::esm::base::{ReferencedAsset, ReferencedAssetIdent},
rename::module::EcmascriptModuleRenameModule,
runtime_functions::TURBOPACK_IMPORT,
side_effect_optimization::{
facade::module::EcmascriptModuleFacadeModule, locals::module::EcmascriptModuleLocalsModule,
......@@ -101,11 +102,15 @@ impl ModuleReference for EcmascriptModulePartReference {
};
Vc::upcast::<Box<dyn Module>>(EcmascriptModuleLocalsModule::new(*module))
}
ModulePart::Facade
| ModulePart::RenamedExport { .. }
| ModulePart::RenamedNamespace { .. } => Vc::upcast(
EcmascriptModuleFacadeModule::new(*self.module, self.part.clone()),
),
ModulePart::Facade => {
Vc::upcast(EcmascriptModuleFacadeModule::new(*self.module))
}
ModulePart::RenamedExport { .. } | ModulePart::RenamedNamespace { .. } => {
Vc::upcast(EcmascriptModuleRenameModule::new(
*self.module,
self.part.clone(),
))
}
_ => {
bail!(
"Unexpected ModulePart \"{}\" for EcmascriptModulePartReference",
......
......@@ -24,11 +24,11 @@ use crate::{
EcmascriptModuleAsset, EcmascriptParsable, analyzer::graph::EvalContext, parse::ParseResult,
};
pub mod asset;
mod graph;
pub mod merge;
mod optimizations;
pub mod side_effect_module;
pub mod part;
pub mod side_effects;
#[cfg(test)]
mod tests;
mod util;
......
......@@ -10,7 +10,6 @@ use turbopack_core::{
resolve::{ExportUsage, ModulePart},
};
use super::{SplitResult, get_part_id, part_of_module, split_module};
use crate::{
AnalyzeEcmascriptModuleResult, EcmascriptAnalyzable, EcmascriptAnalyzableExt,
EcmascriptModuleAsset, EcmascriptModuleAssetType, EcmascriptModuleContent,
......@@ -23,8 +22,11 @@ use crate::{
references::{
FollowExportsResult, analyze_ecmascript_module, esm::FoundExportType, follow_reexports,
},
side_effect_optimization::facade::module::EcmascriptModuleFacadeModule,
tree_shake::{Key, side_effect_module::SideEffectsModule},
rename::module::EcmascriptModuleRenameModule,
tree_shake::{
Key, SplitResult, get_part_id, part_of_module, side_effects::module::SideEffectsModule,
split_module,
},
};
/// A reference to part of an ES module.
......@@ -41,6 +43,7 @@ impl EcmascriptParsable for EcmascriptModulePartAsset {
#[turbo_tasks::function]
fn failsafe_parse(&self) -> Result<Vc<ParseResult>> {
let split_data = split_module(*self.full_module);
assert_ne!(self.part, ModulePart::Facade);
Ok(part_of_module(split_data, self.part.clone()))
}
#[turbo_tasks::function]
......@@ -187,7 +190,7 @@ impl EcmascriptModulePartAsset {
*final_module
} else {
ResolvedVc::upcast(
EcmascriptModuleFacadeModule::new(
EcmascriptModuleRenameModule::new(
**final_module,
ModulePart::renamed_export(new_export.clone(), export.clone()),
)
......@@ -197,7 +200,7 @@ impl EcmascriptModulePartAsset {
}
} else {
ResolvedVc::upcast(
EcmascriptModuleFacadeModule::new(
EcmascriptModuleRenameModule::new(
**final_module,
ModulePart::renamed_namespace(export.clone()),
)
......
......@@ -25,7 +25,7 @@ use crate::{
};
#[turbo_tasks::value]
pub(super) struct SideEffectsModule {
pub struct SideEffectsModule {
/// Original module
pub module: ResolvedVc<EcmascriptModuleAsset>,
/// The part of the original module that is the binding
......
......@@ -54,8 +54,11 @@ use turbopack_ecmascript::{
external_module::{CachedExternalModule, CachedExternalTracingMode, CachedExternalType},
follow_reexports,
},
side_effect_optimization::facade::module::EcmascriptModuleFacadeModule,
tree_shake::asset::EcmascriptModulePartAsset,
rename::module::EcmascriptModuleRenameModule,
side_effect_optimization::{
facade::module::EcmascriptModuleFacadeModule, locals::module::EcmascriptModuleLocalsModule,
},
tree_shake::part::module::EcmascriptModulePartAsset,
};
use turbopack_node::transforms::webpack::{WebpackLoaderItem, WebpackLoaderItems, WebpackLoaders};
use turbopack_resolve::{
......@@ -196,22 +199,36 @@ async fn apply_module_type(
))
}
Some(TreeShakingMode::ReexportsOnly) => {
// Returns the split module if necessary due to re-exports
if let Some(part) = part {
match part {
ModulePart::Evaluation => Vc::upcast(module.get_locals_if_split()),
ModulePart::Export(_) => {
apply_reexport_tree_shaking(module.get_facade_if_split(), part)
if *module.get_exports().split_locals_and_reexports().await? {
if let Some(part) = part {
match part {
ModulePart::Evaluation => {
Vc::upcast(EcmascriptModuleLocalsModule::new(*module))
}
ModulePart::Export(_) => {
apply_reexport_tree_shaking(
Vc::upcast(
EcmascriptModuleFacadeModule::new(Vc::upcast(
*module,
))
.resolve()
.await?,
),
part,
)
.await?
}
_ => bail!(
"Invalid module part \"{}\" for reexports only tree \
shaking mode",
part
),
}
_ => bail!(
"Invalid module part \"{}\" for reexports only tree shaking \
mode",
part
),
} else {
Vc::upcast(EcmascriptModuleFacadeModule::new(Vc::upcast(*module)))
}
} else {
Vc::upcast(module.get_facade_if_split())
Vc::upcast(*module)
}
}
None => Vc::upcast(*module),
......@@ -292,13 +309,13 @@ async fn apply_reexport_tree_shaking(
if *new_export == *export {
Vc::upcast(**final_module)
} else {
Vc::upcast(EcmascriptModuleFacadeModule::new(
Vc::upcast(EcmascriptModuleRenameModule::new(
**final_module,
ModulePart::renamed_export(new_export.clone(), export.clone()),
))
}
} else {
Vc::upcast(EcmascriptModuleFacadeModule::new(
Vc::upcast(EcmascriptModuleRenameModule::new(
**final_module,
ModulePart::renamed_namespace(export.clone()),
))
......
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