Unverified Commit 9f6889db authored by vercel-fleet-prod[bot]'s avatar vercel-fleet-prod[bot] Committed by GitHub

turbopack: preserve reexport intermediate side effects

Co-authored-by: 's avatarLuke Sandberg <210140+lukesandberg@users.noreply.github.com>
parent e6b43fb1
...@@ -5,9 +5,15 @@ use turbopack_core::resolve::ModulePart; ...@@ -5,9 +5,15 @@ use turbopack_core::resolve::ModulePart;
use crate::{ use crate::{
EcmascriptModuleAsset, EcmascriptModuleAsset,
chunk::EcmascriptChunkPlaceable, chunk::{EcmascriptChunkPlaceable, placeable::SideEffectsDeclaration},
module_fragments::part::module::EcmascriptModulePartAsset, module_fragments::{
references::{FollowExportsResult, follow_reexports}, part::module::{
EcmascriptModulePartAsset, FollowExportsWithSideEffectsResult,
follow_reexports_with_side_effects, side_effects_declaration_for_reexport,
},
side_effects::module::SideEffectsModule,
},
references::{FollowExportsResult, esm::FoundExportType, follow_reexports},
rename::module::EcmascriptModuleRenameModule, rename::module::EcmascriptModuleRenameModule,
side_effect_optimization::{ side_effect_optimization::{
facade::module::EcmascriptModuleFacadeModule, locals::module::EcmascriptModuleLocalsModule, facade::module::EcmascriptModuleFacadeModule, locals::module::EcmascriptModuleLocalsModule,
...@@ -34,6 +40,8 @@ pub async fn canonicalize_ecmascript_module( ...@@ -34,6 +40,8 @@ pub async fn canonicalize_ecmascript_module(
} }
EcmascriptModuleCanonicalization::FollowReexports(part) => { EcmascriptModuleCanonicalization::FollowReexports(part) => {
if *module.get_exports().split_locals_and_reexports().await? { if *module.get_exports().split_locals_and_reexports().await? {
let facade = EcmascriptModuleFacadeModule::new(Vc::upcast(*module));
if let Some(part) = part { if let Some(part) = part {
match part { match part {
ModulePart::Evaluation => { ModulePart::Evaluation => {
...@@ -41,11 +49,8 @@ pub async fn canonicalize_ecmascript_module( ...@@ -41,11 +49,8 @@ pub async fn canonicalize_ecmascript_module(
} }
ModulePart::Export(_) => { ModulePart::Export(_) => {
apply_reexport_tree_shaking( apply_reexport_tree_shaking(
Vc::upcast( module,
*EcmascriptModuleFacadeModule::new(Vc::upcast(*module)) Vc::upcast(*facade.to_resolved().await?),
.to_resolved()
.await?,
),
part, part,
) )
.await? .await?
...@@ -56,7 +61,7 @@ pub async fn canonicalize_ecmascript_module( ...@@ -56,7 +61,7 @@ pub async fn canonicalize_ecmascript_module(
), ),
} }
} else { } else {
Vc::upcast(EcmascriptModuleFacadeModule::new(Vc::upcast(*module))) Vc::upcast(facade)
} }
} else { } else {
Vc::upcast(*module) Vc::upcast(*module)
...@@ -66,16 +71,50 @@ pub async fn canonicalize_ecmascript_module( ...@@ -66,16 +71,50 @@ pub async fn canonicalize_ecmascript_module(
} }
async fn apply_reexport_tree_shaking( async fn apply_reexport_tree_shaking(
source_module: ResolvedVc<EcmascriptModuleAsset>,
module: Vc<Box<dyn EcmascriptChunkPlaceable>>, module: Vc<Box<dyn EcmascriptChunkPlaceable>>,
part: ModulePart, part: ModulePart,
) -> Result<Vc<Box<dyn EcmascriptChunkPlaceable>>> { ) -> Result<Vc<Box<dyn EcmascriptChunkPlaceable>>> {
if let ModulePart::Export(export) = &part { let ModulePart::Export(export) = &part else {
return Ok(module);
};
let declaration =
side_effects_declaration_for_reexport(ResolvedVc::upcast(source_module)).await?;
let (mut side_effects, result) = if matches!(declaration, SideEffectsDeclaration::None) {
(
Vec::new(),
follow_reexports(module, export.clone(), true, false)
.to_resolved()
.await?,
)
} else {
let FollowExportsWithSideEffectsResult {
side_effects,
result,
} = &*follow_reexports_with_side_effects(
module,
export.clone(),
true,
matches!(declaration, SideEffectsDeclaration::SideEffectful),
)
.await?;
(side_effects.clone(), *result)
};
let FollowExportsResult { let FollowExportsResult {
module: final_module, module: final_module,
export_name: new_export, export_name: new_export,
.. ty,
} = &*follow_reexports(module, export.clone(), true).await?; } = &*result.await?;
return Ok(if let Some(new_export) = new_export { if matches!(
ty,
FoundExportType::Dynamic | FoundExportType::Unknown | FoundExportType::NotFound
) {
// Dynamic and unknown targets need the original reexport module's runtime machinery. The
// statically composed side-effect wrapper only applies when a concrete binding was found.
side_effects.clear();
}
let final_module = if let Some(new_export) = new_export {
if *new_export == *export { if *new_export == *export {
**final_module **final_module
} else { } else {
...@@ -89,7 +128,19 @@ async fn apply_reexport_tree_shaking( ...@@ -89,7 +128,19 @@ async fn apply_reexport_tree_shaking(
**final_module, **final_module,
ModulePart::renamed_namespace(export.clone()), ModulePart::renamed_namespace(export.clone()),
)) ))
}); };
if side_effects.is_empty() {
return Ok(final_module);
} }
Ok(module)
Ok(Vc::upcast(SideEffectsModule::new(
*source_module,
part,
final_module,
side_effects
.iter()
.map(|side_effect| **side_effect)
.collect(),
)))
} }
...@@ -32,7 +32,7 @@ use crate::{ ...@@ -32,7 +32,7 @@ use crate::{
chunk::{EcmascriptChunkPlaceable, EcmascriptExports}, chunk::{EcmascriptChunkPlaceable, EcmascriptExports},
code_gen::{CodeGeneration, CodeGenerationHoistedStmt}, code_gen::{CodeGeneration, CodeGenerationHoistedStmt},
magic_identifier::MAGIC_IDENTIFIER_DEFAULT_EXPORT_ATOM, magic_identifier::MAGIC_IDENTIFIER_DEFAULT_EXPORT_ATOM,
module_fragments::part::module::EcmascriptModulePartAsset, module_fragments::part::module::{EcmascriptModulePartAsset, side_effects_for_reexport},
references::esm::{base::ReferencedAsset, mangle::mangled_export_names}, references::esm::{base::ReferencedAsset, mangle::mangled_export_names},
runtime_functions::{TURBOPACK_DYNAMIC, TURBOPACK_ESM}, runtime_functions::{TURBOPACK_DYNAMIC, TURBOPACK_ESM},
utils::module_id_to_lit, utils::module_id_to_lit,
...@@ -101,7 +101,7 @@ pub async fn is_export_missing( ...@@ -101,7 +101,7 @@ pub async fn is_export_missing(
return Ok(Vc::cell(true)); return Ok(Vc::cell(true));
} }
let all_export_names = get_all_export_names(*module).await?; let all_export_names = get_all_export_names(*module, false).await?;
if all_export_names.esm_exports.contains_key(&export_name) { if all_export_names.esm_exports.contains_key(&export_name) {
return Ok(Vc::cell(false)); return Ok(Vc::cell(false));
} }
...@@ -128,7 +128,7 @@ pub async fn is_export_missing( ...@@ -128,7 +128,7 @@ pub async fn is_export_missing(
pub async fn all_known_export_names( pub async fn all_known_export_names(
module: Vc<Box<dyn EcmascriptChunkPlaceable>>, module: Vc<Box<dyn EcmascriptChunkPlaceable>>,
) -> Result<Vc<Vec<RcStr>>> { ) -> Result<Vc<Vec<RcStr>>> {
let export_names = get_all_export_names(module).await?; let export_names = get_all_export_names(module, false).await?;
Ok(Vc::cell(export_names.esm_exports.keys().cloned().collect())) Ok(Vc::cell(export_names.esm_exports.keys().cloned().collect()))
} }
...@@ -153,15 +153,19 @@ pub async fn follow_reexports( ...@@ -153,15 +153,19 @@ pub async fn follow_reexports(
module: ResolvedVc<Box<dyn EcmascriptChunkPlaceable>>, module: ResolvedVc<Box<dyn EcmascriptChunkPlaceable>>,
export_name: RcStr, export_name: RcStr,
ignore_side_effect_of_entry: bool, ignore_side_effect_of_entry: bool,
preserve_intermediate_side_effects: bool,
) -> Result<Vc<FollowExportsResult>> { ) -> Result<Vc<FollowExportsResult>> {
let mut ignore_side_effects = ignore_side_effect_of_entry; let mut ignore_side_effects = ignore_side_effect_of_entry;
let mut module = module; let mut module = module;
let mut export_name = export_name; let mut export_name = export_name;
loop { loop {
if !ignore_side_effects let module_side_effects = if preserve_intermediate_side_effects {
&& *module.side_effects().await? != ModuleSideEffects::SideEffectFree side_effects_for_reexport(module).await?
{ } else {
*module.side_effects().await?
};
if !ignore_side_effects && module_side_effects != ModuleSideEffects::SideEffectFree {
// TODO It's unfortunate that we have to use the whole module here. // TODO It's unfortunate that we have to use the whole module here.
// This is often the Facade module, which includes all reexports. // This is often the Facade module, which includes all reexports.
// Often we could use Locals + the followed reexports instead. // Often we could use Locals + the followed reexports instead.
...@@ -199,7 +203,12 @@ pub async fn follow_reexports( ...@@ -199,7 +203,12 @@ pub async fn follow_reexports(
// Try to find the export in the star exports // Try to find the export in the star exports
if !exports_ref.star_exports.is_empty() && &*export_name != "default" { if !exports_ref.star_exports.is_empty() && &*export_name != "default" {
let result = find_export_from_reexports(*module, export_name.clone()).await?; let result = find_export_from_reexports(
*module,
export_name.clone(),
preserve_intermediate_side_effects,
)
.await?;
match &*result { match &*result {
FindExportFromReexportsResult::NotFound => { FindExportFromReexportsResult::NotFound => {
return Ok(FollowExportsResult::cell(FollowExportsResult { return Ok(FollowExportsResult::cell(FollowExportsResult {
...@@ -305,10 +314,14 @@ enum FindExportFromReexportsResult { ...@@ -305,10 +314,14 @@ enum FindExportFromReexportsResult {
async fn find_export_from_reexports( async fn find_export_from_reexports(
module: ResolvedVc<Box<dyn EcmascriptChunkPlaceable>>, module: ResolvedVc<Box<dyn EcmascriptChunkPlaceable>>,
export_name: RcStr, export_name: RcStr,
preserve_intermediate_side_effects: bool,
) -> Result<Vc<FindExportFromReexportsResult>> { ) -> Result<Vc<FindExportFromReexportsResult>> {
// TODO why do we need a special case for this? // TODO why do we need a special case for this?
if let Some(module) = ResolvedVc::try_downcast_type::<EcmascriptModulePartAsset>(module) if let Some(module) = ResolvedVc::try_downcast_type::<EcmascriptModulePartAsset>(module)
&& matches!(module.await?.part, ModulePart::Exports) && matches!(module.await?.part, ModulePart::Exports)
&& (!preserve_intermediate_side_effects
|| side_effects_for_reexport(ResolvedVc::upcast(module)).await?
== ModuleSideEffects::SideEffectFree)
{ {
let module_part = EcmascriptModulePartAsset::select_part( let module_part = EcmascriptModulePartAsset::select_part(
*module.await?.full_module, *module.await?.full_module,
...@@ -322,11 +335,16 @@ async fn find_export_from_reexports( ...@@ -322,11 +335,16 @@ async fn find_export_from_reexports(
)) ))
.is_none() .is_none()
{ {
return Ok(find_export_from_reexports(module_part, export_name)); return Ok(find_export_from_reexports(
module_part,
export_name,
preserve_intermediate_side_effects,
));
} }
} }
let all_export_names = get_all_export_names(*module).await?; let all_export_names =
get_all_export_names(*module, preserve_intermediate_side_effects).await?;
Ok( Ok(
if let Some(esm_export) = all_export_names.esm_exports.get(&export_name) { if let Some(esm_export) = all_export_names.esm_exports.get(&export_name) {
FindExportFromReexportsResult::EsmExport(esm_export.clone()) FindExportFromReexportsResult::EsmExport(esm_export.clone())
...@@ -353,6 +371,7 @@ struct AllExportNamesResult { ...@@ -353,6 +371,7 @@ struct AllExportNamesResult {
#[turbo_tasks::function] #[turbo_tasks::function]
async fn get_all_export_names( async fn get_all_export_names(
module: ResolvedVc<Box<dyn EcmascriptChunkPlaceable>>, module: ResolvedVc<Box<dyn EcmascriptChunkPlaceable>>,
preserve_intermediate_side_effects: bool,
) -> Result<Vc<AllExportNamesResult>> { ) -> Result<Vc<AllExportNamesResult>> {
let exports = module.get_exports().await?; let exports = module.get_exports().await?;
let EcmascriptExports::EsmExports(exports) = &*exports else { let EcmascriptExports::EsmExports(exports) = &*exports else {
...@@ -380,7 +399,11 @@ async fn get_all_export_names( ...@@ -380,7 +399,11 @@ async fn get_all_export_names(
if let ReferencedAsset::Some(m) = if let ReferencedAsset::Some(m) =
ReferencedAsset::from_resolve_result(esm_ref.resolve_reference()).await? ReferencedAsset::from_resolve_result(esm_ref.resolve_reference()).await?
{ {
Some(expand_star_exports(**esm_ref, *m)) Some(expand_star_exports(
**esm_ref,
*m,
preserve_intermediate_side_effects,
))
} else { } else {
None None
}, },
...@@ -418,13 +441,27 @@ pub struct ExpandStarResult { ...@@ -418,13 +441,27 @@ pub struct ExpandStarResult {
pub async fn expand_star_exports( pub async fn expand_star_exports(
root_reference: ResolvedVc<Box<dyn ModuleReference>>, root_reference: ResolvedVc<Box<dyn ModuleReference>>,
root_module: ResolvedVc<Box<dyn EcmascriptChunkPlaceable>>, root_module: ResolvedVc<Box<dyn EcmascriptChunkPlaceable>>,
preserve_intermediate_side_effects: bool,
) -> Result<Vc<ExpandStarResult>> { ) -> Result<Vc<ExpandStarResult>> {
let mut esm_exports = FxIndexMap::default(); let mut esm_exports = FxIndexMap::default();
let mut dynamic_exporting_modules = Vec::new(); let mut dynamic_exporting_modules = Vec::new();
let mut checked_modules = FxHashSet::default(); let mut checked_routes = FxHashSet::default();
checked_modules.insert(root_module); checked_routes.insert((root_module, None));
let mut queue = vec![(root_reference, root_module, root_module.get_exports())]; let mut queue = vec![(root_reference, None, root_module, root_module.get_exports())];
while let Some((reference, asset, exports)) = queue.pop() { while let Some((reference, side_effect_boundary, asset, exports)) = queue.pop() {
// Preserve the first effectful module on each star-export route. Bindings discovered
// further down are still valid exports of this boundary module, but resolving through the
// boundary ensures its evaluation is not lost when the star tree is flattened.
let side_effect_boundary = if !preserve_intermediate_side_effects {
None
} else if side_effect_boundary.is_some()
|| side_effects_for_reexport(asset).await? == ModuleSideEffects::SideEffectFree
{
side_effect_boundary
} else {
Some(reference)
};
match &*exports.await? { match &*exports.await? {
EcmascriptExports::EsmExports(exports) => { EcmascriptExports::EsmExports(exports) => {
let exports = exports.await?; let exports = exports.await?;
...@@ -433,22 +470,41 @@ pub async fn expand_star_exports( ...@@ -433,22 +470,41 @@ pub async fn expand_star_exports(
continue; continue;
} }
if let Entry::Vacant(entry) = esm_exports.entry(key.clone()) { if let Entry::Vacant(entry) = esm_exports.entry(key.clone()) {
entry.insert(match esm_export { entry.insert(if let Some(side_effect_boundary) = side_effect_boundary {
// Import through the first effectful module on the route even when the
// descendant export was already represented as an imported binding.
// That module still reexports `key`, and following through it gives the
// caller a chance to retain only its evaluation before continuing.
let is_mutable = match esm_export {
EsmExport::LocalBinding(_, liveness) => {
*liveness == Liveness::Mutable
}
EsmExport::ImportedBinding(_, _, is_mutable) => *is_mutable,
_ => false,
};
EsmExport::ImportedBinding(
side_effect_boundary,
key.clone(),
is_mutable,
)
} else {
match esm_export {
EsmExport::LocalBinding(_, liveness) => EsmExport::ImportedBinding( EsmExport::LocalBinding(_, liveness) => EsmExport::ImportedBinding(
reference, reference,
key.clone(), key.clone(),
*liveness == Liveness::Mutable, *liveness == Liveness::Mutable,
), ),
_ => esm_export.clone(), _ => esm_export.clone(),
}
}); });
} }
} }
for esm_ref in exports.star_exports.iter() { for esm_ref in exports.star_exports.iter() {
if let ReferencedAsset::Some(asset) = if let ReferencedAsset::Some(asset) =
&ReferencedAsset::from_resolve_result(esm_ref.resolve_reference()).await? &ReferencedAsset::from_resolve_result(esm_ref.resolve_reference()).await?
&& checked_modules.insert(*asset) && checked_routes.insert((*asset, side_effect_boundary))
{ {
queue.push((*esm_ref, *asset, asset.get_exports())); queue.push((*esm_ref, side_effect_boundary, *asset, asset.get_exports()));
} }
} }
} }
...@@ -610,7 +666,7 @@ impl EsmExports { ...@@ -610,7 +666,7 @@ impl EsmExports {
continue; continue;
}; };
let export_info = expand_star_exports(*esm_ref, **asset).await?; let export_info = expand_star_exports(*esm_ref, **asset, false).await?;
for export in export_info.esm_exports.keys() { for export in export_info.esm_exports.keys() {
if export == "default" { if export == "default" {
......
...@@ -37,7 +37,7 @@ use crate::{ ...@@ -37,7 +37,7 @@ use crate::{
/// [`EcmascriptModuleLocalsModule`]: crate::side_effect_optimization::locals::module::EcmascriptModuleLocalsModule /// [`EcmascriptModuleLocalsModule`]: crate::side_effect_optimization::locals::module::EcmascriptModuleLocalsModule
#[turbo_tasks::value] #[turbo_tasks::value]
pub struct EcmascriptModuleFacadeModule { pub struct EcmascriptModuleFacadeModule {
module: ResolvedVc<Box<dyn EcmascriptChunkPlaceable>>, pub(crate) module: ResolvedVc<Box<dyn EcmascriptChunkPlaceable>>,
} }
#[turbo_tasks::value_impl] #[turbo_tasks::value_impl]
......
export * from './left.js'
export * from './right.js'
export * from './commonjs.js'
import { effect } from './check-side-effect.js'
effect('effect.js')
...@@ -23,18 +23,32 @@ import { a as a9 } from 'package-intermediate-side-effect' ...@@ -23,18 +23,32 @@ import { a as a9 } from 'package-intermediate-side-effect'
import { effects as effects9 } from 'package-intermediate-side-effect/check-side-effect' import { effects as effects9 } from 'package-intermediate-side-effect/check-side-effect'
it('should run side effects of an intermediate module with side effects (star reexports)', () => { it('should run side effects of an intermediate module with side effects (star reexports)', () => {
expect(a9).toBe('a') expect(a9).toBe('a')
expect(effects9).toEqual([ expect(effects9).toEqual(['side-effect.js'])
// TODO This should execute the side effect of the intermediate module
// 'side-effect.js'
])
}) })
import { a as a10 } from 'package-intermediate-named-side-effect' import { a as a10 } from 'package-intermediate-named-side-effect'
import { effects as effects10 } from 'package-intermediate-named-side-effect/check-side-effect' import { effects as effects10 } from 'package-intermediate-named-side-effect/check-side-effect'
it('should run side effects of an intermediate module with side effects (named reexports)', () => { it('should run side effects of an intermediate module with side effects (named reexports)', () => {
expect(a10).toBe('a') expect(a10).toBe('a')
expect(effects10).toEqual([ expect(effects10).toEqual(['side-effect.js'])
// TODO This should execute the side effect of the intermediate module })
// 'side-effect.js'
]) import { a as a11 } from 'package-intermediate-mixed-star-side-effect'
import { effects as effects11 } from 'package-intermediate-mixed-star-side-effect/check-side-effect'
it('should preserve evaluation order across a mixed star reexport route', () => {
expect(a11).toBe('a')
expect(effects11).toEqual(['effect-2.js', 'effect-1.js'])
})
import {
selected as selected12,
dynamicValue as dynamicValue12,
} from 'package-intermediate-ambiguous-dynamic-side-effect'
import * as namespace12 from 'package-intermediate-ambiguous-dynamic-side-effect'
import { effects as effects12 } from 'package-intermediate-ambiguous-dynamic-side-effect/check-side-effect'
it('should preserve star ambiguity and dynamic fallback through an effectful route', () => {
expect(selected12).toBe('selected')
expect(dynamicValue12).toBe('dynamic')
expect(namespace12.ambiguous).toBe('right')
expect(effects12).toEqual(['effect.js'])
}) })
warning - [analysis] /turbopack/crates/turbopack-tests/tests/execution/turbopack/side-effects-optimization/node_modules/package-intermediate-ambiguous-dynamic-side-effect/commonjs.js unexpected export *
export * used with module [project]/turbopack/crates/turbopack-tests/tests/execution/turbopack/side-effects-optimization/node_modules/package-intermediate-ambiguous-dynamic-side-effect/commonjs.js [test] (ecmascript) which is a CommonJS module with exports only available at runtime
List all export names manually (`export { a, b, c } from "...") or rewrite the module to ESM, to avoid the additional runtime code.`
Import trace:
test:
./turbopack/crates/turbopack-tests/tests/execution/turbopack/side-effects-optimization/node_modules/package-intermediate-ambiguous-dynamic-side-effect/commonjs.js
./turbopack/crates/turbopack-tests/tests/execution/turbopack/side-effects-optimization/reexport-side-effects/input/index.js
\ No newline at end of file
warning - [analysis] /turbopack/crates/turbopack-tests/tests/execution/turbopack/side-effects-optimization/node_modules/package-intermediate-ambiguous-dynamic-side-effect/commonjs.js unexpected export *
export * used with module [project]/turbopack/crates/turbopack-tests/tests/execution/turbopack/side-effects-optimization/node_modules/package-intermediate-ambiguous-dynamic-side-effect/commonjs.js [test] (ecmascript) which is a CommonJS module with exports only available at runtime
List all export names manually (`export { a, b, c } from "...") or rewrite the module to ESM, to avoid the additional runtime code.`
Import trace:
test:
./turbopack/crates/turbopack-tests/tests/execution/turbopack/side-effects-optimization/node_modules/package-intermediate-ambiguous-dynamic-side-effect/commonjs.js
./turbopack/crates/turbopack-tests/tests/execution/turbopack/side-effects-optimization/reexport-side-effects/input/index.js
./turbopack/crates/turbopack-tests/tests/execution/turbopack/tree-shaking/reexport-side-effects/input/index.js
\ No newline at end of file
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