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

turbopack: handle TypeScript in side effect annotations

Co-authored-by: 's avatarTobias Koppers <1365881+sokra@users.noreply.github.com>
parent 8c875cb8
......@@ -2460,12 +2460,6 @@ impl VisitAstPath for Analyzer<'_, '_> {
// Attempt to add import effects.
if let Some((esm_reference_index, export)) = self.eval_context.imports.get_binding(&id) {
let static_member = member_access_parent(ast_path).and_then(|member| {
self.eval_context
.eval_member_prop(self.arena, &member.prop)
.and_then(|prop| prop.as_str().map(|prop| (member, RcStr::from(prop))))
});
// Optimization: Look for a MemberExpr to see if we only access a few members from the
// module, add those specific effects instead of depending on the entire module.
//
......@@ -2475,13 +2469,15 @@ impl VisitAstPath for Analyzer<'_, '_> {
.eval_context
.imports
.should_import_all(esm_reference_index)
&& let Some((member, prop)) = &static_member
&& let Some(member) = member_access_parent(ast_path)
&& let Some(prop) = self.eval_context.eval_member_prop(self.arena, &member.prop)
&& let Some(prop_str) = prop.as_str()
{
// a namespace member access like
// `import * as ns from "..."; ns.exportName`
self.add_effect(Effect::ImportedBinding {
esm_reference_index,
export: Some(prop.clone()),
export: Some(prop_str.into()),
member: None,
// point to the MemberExpression instead
ast_path: as_parent_path_skip_in(self.arena, ast_path, 1),
......
......@@ -55,7 +55,7 @@ impl NoSideEffectsCollector<'_> {
}
impl Visit for NoSideEffectsCollector<'_> {
noop_visit_type!(fail);
noop_visit_type!();
fn visit_export_decl(&mut self, export: &ExportDecl) {
export.visit_children_with(self);
......@@ -110,3 +110,55 @@ impl Visit for NoSideEffectsCollector<'_> {
}
}
}
#[cfg(test)]
mod tests {
use swc_core::{
common::{FileName, GLOBALS, SourceMap, comments::SingleThreadedComments},
ecma::{
ast::EsVersion,
parser::{Syntax, TsSyntax, parse_file_as_program},
},
};
use super::*;
#[test]
fn collects_annotations_without_visiting_typescript_nodes() {
GLOBALS.set(&Default::default(), || {
let source_map = SourceMap::default();
let source = source_map.new_source_file(
FileName::Custom("fixture.ts".into()).into(),
r#"
interface Shape { value: string }
type Alias = Shape["value"]
export const annotated: (value: Alias) => Alias =
/*#__NO_SIDE_EFFECTS__*/ function (value: Alias): Alias { return value }
export default /*#__NO_SIDE_EFFECTS__*/ function (value: Alias): Alias {
return value
}
"#,
);
let comments = SingleThreadedComments::default();
let mut errors = Vec::new();
let program = parse_file_as_program(
&source,
Syntax::Typescript(TsSyntax::default()),
EsVersion::EsNext,
Some(&comments),
&mut errors,
)
.expect("TypeScript fixture should parse");
assert!(errors.is_empty(), "fixture should not contain parse errors");
let info = collect_no_side_effects(&program, Some(&comments));
assert!(
info.bindings.iter().any(|(name, _)| name == "annotated"),
"annotated TypeScript binding should be collected"
);
assert!(info.default_export());
});
}
}
......@@ -132,18 +132,21 @@ pub async fn is_export_missing(
/// Returns whether a statically resolved ESM export is backed by a binding annotated with
/// `NO_SIDE_EFFECTS`. Imported bindings and statically expandable star exports are followed to the
/// local binding that defines the contract.
/// local binding that defines the contract. When `member_name` is present, `export_name` must
/// resolve to an imported namespace and that member is then followed as a named export.
#[turbo_tasks::function]
pub async fn is_export_no_side_effects(
module: ResolvedVc<Box<dyn EcmascriptChunkPlaceable>>,
export_name: RcStr,
member_name: Option<RcStr>,
) -> Result<Vc<bool>> {
let mut module = module;
let mut export_name = export_name;
let mut member_name = member_name;
let mut visited = FxHashSet::default();
loop {
if !visited.insert((module, export_name.clone())) {
if !visited.insert((module, export_name.clone(), member_name.clone())) {
return Ok(Vc::cell(false));
}
......@@ -172,7 +175,7 @@ pub async fn is_export_no_side_effects(
match &export {
EsmExport::LocalBinding(_, _, no_side_effects) => {
return Ok(Vc::cell(*no_side_effects));
return Ok(Vc::cell(member_name.is_none() && *no_side_effects));
}
EsmExport::ImportedBinding(reference, imported_name, _) => {
let ReferencedAsset::Some(imported_module) =
......@@ -183,70 +186,19 @@ pub async fn is_export_no_side_effects(
module = imported_module;
export_name = imported_name.clone();
}
EsmExport::ImportedNamespace(_) | EsmExport::Error => {
return Ok(Vc::cell(false));
}
}
}
}
/// Returns whether `member_name` is a no-side-effects export of a namespace exported as
/// `export_name`. Named re-export chains leading to that namespace are followed.
#[turbo_tasks::function]
pub async fn is_exported_namespace_member_no_side_effects(
module: ResolvedVc<Box<dyn EcmascriptChunkPlaceable>>,
export_name: RcStr,
member_name: RcStr,
) -> Result<Vc<bool>> {
let mut module = module;
let mut export_name = export_name;
let mut visited = FxHashSet::default();
loop {
if !visited.insert((module, export_name.clone())) {
return Ok(Vc::cell(false));
}
let exports = module.get_exports().await?;
let EcmascriptExports::EsmExports(exports) = &*exports else {
return Ok(Vc::cell(false));
};
let exports_vc = *exports;
let exports = exports_vc.await?;
let export = if let Some(export) = exports.exports.get(&export_name) {
export.clone()
} else {
let expanded = exports_vc
.expand_exports(ModuleExportUsageInfo::all())
.await?;
if !expanded.dynamic_exports.is_empty() {
return Ok(Vc::cell(false));
}
let Some(export) = expanded.exports.get(&export_name) else {
return Ok(Vc::cell(false));
};
export.clone()
};
match &export {
EsmExport::ImportedBinding(reference, imported_name, _) => {
let ReferencedAsset::Some(imported_module) =
ReferencedAsset::from_resolve_result(reference.resolve_reference()).await?
else {
EsmExport::ImportedNamespace(reference) => {
let Some(member_name) = member_name.take() else {
return Ok(Vc::cell(false));
};
module = imported_module;
export_name = imported_name.clone();
}
EsmExport::ImportedNamespace(reference) => {
let ReferencedAsset::Some(imported_module) =
ReferencedAsset::from_resolve_result(reference.resolve_reference()).await?
else {
return Ok(Vc::cell(false));
};
return Ok(is_export_no_side_effects(*imported_module, member_name));
module = imported_module;
export_name = member_name;
}
EsmExport::LocalBinding(..) | EsmExport::Error => {
EsmExport::Error => {
return Ok(Vc::cell(false));
}
}
......
......@@ -23,7 +23,8 @@ annotated`tagged`
const alias = annotated
alias()
const parenthesizedAlias = annotated
// prettier-ignore
const parenthesizedAlias = (annotated)
parenthesizedAlias()
let argumentState = 0
......
......@@ -29,7 +29,8 @@ annotated`tagged`
const alias = annotated
alias()
const parenthesizedAlias = annotated
// prettier-ignore
const parenthesizedAlias = (annotated)
parenthesizedAlias()
let argumentState = 0
......
......@@ -8,7 +8,8 @@ namespace.annotated()
const alias = annotated
alias()
const parenthesizedAlias = annotated
// prettier-ignore
const parenthesizedAlias = (annotated)
parenthesizedAlias()
unannotated()
......
......@@ -12,6 +12,7 @@ var __TURBOPACK__imported__module__$5b$project$5d2f$turbopack$2f$crates$2f$turbo
/*#__PURE__*/ __TURBOPACK__imported__module__$5b$project$5d2f$turbopack$2f$crates$2f$turbopack$2d$tests$2f$tests$2f$snapshot$2f$basic$2f$no$2d$side$2d$effects$2d$import$2f$input$2f$namespace$2d$reexport$2e$js__$5b$test$5d$__$28$ecmascript$29$__["namespace"].annotated();
const alias = /*#__NO_SIDE_EFFECTS__*/ __TURBOPACK__imported__module__$5b$project$5d2f$turbopack$2f$crates$2f$turbopack$2d$tests$2f$tests$2f$snapshot$2f$basic$2f$no$2d$side$2d$effects$2d$import$2f$input$2f$library$2e$js__$5b$test$5d$__$28$ecmascript$29$__["annotated"];
alias();
// prettier-ignore
const parenthesizedAlias = /*#__NO_SIDE_EFFECTS__*/ __TURBOPACK__imported__module__$5b$project$5d2f$turbopack$2f$crates$2f$turbopack$2d$tests$2f$tests$2f$snapshot$2f$basic$2f$no$2d$side$2d$effects$2d$import$2f$input$2f$library$2e$js__$5b$test$5d$__$28$ecmascript$29$__["annotated"];
parenthesizedAlias();
(0, __TURBOPACK__imported__module__$5b$project$5d2f$turbopack$2f$crates$2f$turbopack$2d$tests$2f$tests$2f$snapshot$2f$basic$2f$no$2d$side$2d$effects$2d$import$2f$input$2f$library$2e$js__$5b$test$5d$__$28$ecmascript$29$__["unannotated"])();
......
......@@ -2,7 +2,7 @@
"version": 3,
"sources": [],
"sections": [
{"offset": {"line": 4, "column": 0}, "map": {"version":3,"sources":["turbopack:///[project]/turbopack/crates/turbopack-tests/tests/snapshot/basic/no-side-effects-import/input/index.js"],"sourcesContent":["import { annotated, unannotated } from './library'\nimport { namespace } from './namespace-reexport'\n\nannotated()\nannotated`tagged`\nnamespace.annotated()\n\nconst alias = annotated\nalias()\n\nconst parenthesizedAlias = (annotated)\nparenthesizedAlias()\n\nunannotated()\nunannotated`tagged`\n"],"names":["annotated","alias","parenthesizedAlias"],"mappings":";AAAA;AACA;;;cAEA,IAAA,qOAAS;cACT,IAAA,qOAAS,CAAA,CAAC,MAAM,CAAC;cACjB,mPAAS,CAACA,SAAS;AAEnB,MAAMC,iCAAQ,qOAAS;AACvBA;AAEA,MAAMC,8CAAsB,qOAAS;AACrCA;AAEA,IAAA,uOAAW;AACX,IAAA,uOAAW,CAAA,CAAC,MAAM,CAAC"}},
{"offset": {"line": 22, "column": 0}, "map": {"version":3,"sources":["turbopack:///[project]/turbopack/crates/turbopack-tests/tests/snapshot/basic/no-side-effects-import/input/library.js"],"sourcesContent":["export const annotated = /*#__NO_SIDE_EFFECTS__*/ function () {}\nexport function unannotated() {}\n"],"names":["annotated","unannotated"],"mappings":";;;;;;AAAO,MAAMA,YAAY,sBAAsB,GAAG,YAAa;AACxD,SAASC,eAAe"}},
{"offset": {"line": 34, "column": 0}, "map": {"version":3,"sources":["turbopack:///[project]/turbopack/crates/turbopack-tests/tests/snapshot/basic/no-side-effects-import/input/namespace-reexport.js"],"sourcesContent":["export * as namespace from './library'\n"],"names":[],"mappings":";;;;AAAA"}}]
{"offset": {"line": 4, "column": 0}, "map": {"version":3,"sources":["turbopack:///[project]/turbopack/crates/turbopack-tests/tests/snapshot/basic/no-side-effects-import/input/index.js"],"sourcesContent":["import { annotated, unannotated } from './library'\nimport { namespace } from './namespace-reexport'\n\nannotated()\nannotated`tagged`\nnamespace.annotated()\n\nconst alias = annotated\nalias()\n\n// prettier-ignore\nconst parenthesizedAlias = (annotated)\nparenthesizedAlias()\n\nunannotated()\nunannotated`tagged`\n"],"names":["annotated","alias","parenthesizedAlias"],"mappings":";AAAA;AACA;;;cAEA,IAAA,qOAAS;cACT,IAAA,qOAAS,CAAA,CAAC,MAAM,CAAC;cACjB,mPAAS,CAACA,SAAS;AAEnB,MAAMC,iCAAQ,qOAAS;AACvBA;AAEA,kBAAkB;AAClB,MAAMC,8CAAsB,qOAAS;AACrCA;AAEA,IAAA,uOAAW;AACX,IAAA,uOAAW,CAAA,CAAC,MAAM,CAAC"}},
{"offset": {"line": 23, "column": 0}, "map": {"version":3,"sources":["turbopack:///[project]/turbopack/crates/turbopack-tests/tests/snapshot/basic/no-side-effects-import/input/library.js"],"sourcesContent":["export const annotated = /*#__NO_SIDE_EFFECTS__*/ function () {}\nexport function unannotated() {}\n"],"names":["annotated","unannotated"],"mappings":";;;;;;AAAO,MAAMA,YAAY,sBAAsB,GAAG,YAAa;AACxD,SAASC,eAAe"}},
{"offset": {"line": 35, "column": 0}, "map": {"version":3,"sources":["turbopack:///[project]/turbopack/crates/turbopack-tests/tests/snapshot/basic/no-side-effects-import/input/namespace-reexport.js"],"sourcesContent":["export * as namespace from './library'\n"],"names":[],"mappings":";;;;AAAA"}}]
}
\ 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