Unverified Commit 1dd15c50 authored by Sam Poder's avatar Sam Poder Committed by GitHub

[turbopack] Ignore writes to `exports` after a `module.exports = {}` writes (#96380)

Take this example:

```javascript
// Discarded by the literal below, so not an export.
exports.early = 'early-value'

module.exports = {
  used: 'used-value',
  unused: 'unused-value',
}

// Not exports: `exports` and top-level `this` hold the object the literal discarded.
exports.deadExports = 'dead-exports'
this.deadThis = 'dead-this'
Object.defineProperty(exports, 'deadDefined', { value: 'dead-defined' })

// Exports: `module.exports` is the live object.
module.exports.usedLate = 'used-late'
module.exports.unusedLate = 'unused-late'
```

Previously, we'd treat all of these as exports. Even though some of them
aren't, this PR cleans that inaccuracy up so that scope-hoisting can
land without a bug.

Now this does cause an odd case, consider:

```javascript
// Discarded by the literal below, so not an export.
exports.early = 'early-value'
exports.unused = 'unused-value'

module.exports = {
  used: 'used-value',
  unused: 'unused-value',
}

// Not exports: `exports` and top-level `this` hold the object the literal discarded.
exports.deadExports = 'dead-exports'
this.deadThis = 'dead-this'
Object.defineProperty(exports, 'deadDefined', { value: 'dead-defined' })

// Exports: `module.exports` is the live object.
module.exports.usedLate = 'used-late'
module.exports.unusedLate = 'unused-late'
```

We would actually not drop:

```
exports.unused = 'unused-value'
```

Now. But I'm going to make a follow-up PR to drop these.
parent 5005bd08
...@@ -24,7 +24,7 @@ use crate::{ ...@@ -24,7 +24,7 @@ use crate::{
Bump, BumpVec, ConstantValue, ImportMap, JsValue, WellKnownFunctionKind, Bump, BumpVec, ConstantValue, ImportMap, JsValue, WellKnownFunctionKind,
cjs_ast::{ cjs_ast::{
as_exports_define_property, as_module_exports_object_literal, as_exports_define_property, as_module_exports_object_literal,
define_property_sets_es_module, is_exports_object, is_global, define_property_sets_es_module, is_exports_object, is_global, is_module_exports_chain,
}, },
graph::{ConditionalKind, Effect, EffectArg, EffectsBlock, EvalContext, VarGraph}, graph::{ConditionalKind, Effect, EffectArg, EffectsBlock, EvalContext, VarGraph},
is_unresolved_id, is_unresolved_id,
...@@ -105,6 +105,8 @@ struct CjsExportsCollector { ...@@ -105,6 +105,8 @@ struct CjsExportsCollector {
writes: Vec<DroppableCjsExportAssignment>, writes: Vec<DroppableCjsExportAssignment>,
/// Whether the `exports.__esModule = true` interop marker is set. /// Whether the `exports.__esModule = true` interop marker is set.
has_es_module: bool, has_es_module: bool,
/// Whether a `module.exports = { … }` literal has replaced the exports object.
exports_object_replaced: bool,
} }
trait FunctionLike { trait FunctionLike {
...@@ -651,6 +653,21 @@ mod analyzer_state { ...@@ -651,6 +653,21 @@ mod analyzer_state {
self.state.cjs_exports = None; self.state.cjs_exports = None;
} }
pub(super) fn cjs_exports_object_replaced(&self) -> bool {
self.state
.cjs_exports
.as_ref()
.is_some_and(|c| c.exports_object_replaced)
}
pub(super) fn replace_cjs_exports_object(&mut self) {
if let Some(c) = &mut self.state.cjs_exports {
c.writes.clear();
c.has_es_module = false;
c.exports_object_replaced = true;
}
}
/// Records the `exports.__esModule = true` interop marker. /// Records the `exports.__esModule = true` interop marker.
pub(super) fn set_cjs_has_es_module(&mut self) { pub(super) fn set_cjs_has_es_module(&mut self) {
if let Some(c) = &mut self.state.cjs_exports { if let Some(c) = &mut self.state.cjs_exports {
...@@ -1327,6 +1344,12 @@ impl<'a> Analyzer<'a, '_> { ...@@ -1327,6 +1344,12 @@ impl<'a> Analyzer<'a, '_> {
let AssignTarget::Simple(SimpleAssignTarget::Member(member)) = &n.left else { let AssignTarget::Simple(SimpleAssignTarget::Member(member)) = &n.left else {
return; return;
}; };
// After a replacement only `module.exports` still reaches the exports object.
if self.cjs_exports_object_replaced()
&& !is_module_exports_chain(&member.obj, self.eval_context.unresolved_mark)
{
return;
}
let MemberProp::Ident(name) = &member.prop else { let MemberProp::Ident(name) = &member.prop else {
return; return;
}; };
...@@ -1362,6 +1385,13 @@ impl<'a> Analyzer<'a, '_> { ...@@ -1362,6 +1385,13 @@ impl<'a> Analyzer<'a, '_> {
self.taint_cjs_exports(); self.taint_cjs_exports();
return; return;
} }
if self.cjs_exports_object_replaced()
&& !n.args.first().is_some_and(|target| {
is_module_exports_chain(&target.expr, self.eval_context.unresolved_mark)
})
{
return;
}
if name == "__esModule" { if name == "__esModule" {
if define_property_sets_es_module(n) { if define_property_sets_es_module(n) {
self.set_cjs_has_es_module(); self.set_cjs_has_es_module();
...@@ -1387,6 +1417,13 @@ impl<'a> Analyzer<'a, '_> { ...@@ -1387,6 +1417,13 @@ impl<'a> Analyzer<'a, '_> {
else { else {
return; return;
}; };
// Only a statement-position assignment definitely runs.
if matches!(
ast_path.len().checked_sub(2).and_then(|i| ast_path.get(i)),
Some(AstParentNodeRef::ExprStmt(_, ExprStmtField::Expr))
) {
self.replace_cjs_exports_object();
}
let mut names = Vec::new(); let mut names = Vec::new();
for prop in &obj.props { for prop in &obj.props {
// A spread makes the export set unknowable. // A spread makes the export set unknowable.
......
// Discarded by the literal below, so not an export.
exports.early = 'early-value'
module.exports = {
used: 'used-value',
unused: 'unused-value',
}
// Not exports: `exports` and top-level `this` hold the object the literal discarded.
exports.deadExports = 'dead-exports'
this.deadThis = 'dead-this'
Object.defineProperty(exports, 'deadDefined', { value: 'dead-defined' })
// Exports: `module.exports` is the live object.
module.exports.usedLate = 'used-late'
module.exports.unusedLate = 'unused-late'
{
"removeUnusedImports": false,
"removeUnusedExports": true,
"cjsTreeShaking": true,
"treeShakingMode": "reexports-only"
}
(globalThis["TURBOPACK"] || (globalThis["TURBOPACK"] = [])).push([
"output/0nf9_cjs-remove-unused-exports_object-literal-replaces-exports_input_index_0wc-aj0.js",
{"otherChunks":["output/154e_cjs-remove-unused-exports_object-literal-replaces-exports_input_1f6j47z._.js"],"runtimeModuleIds":["[project]/turbopack/crates/turbopack-tests/tests/snapshot/cjs-remove-unused-exports/object-literal-replaces-exports/input/index.js [test] (ecmascript)"]}
]);
// Dummy runtime
\ No newline at end of file
(globalThis["TURBOPACK"] || (globalThis["TURBOPACK"] = [])).push(["output/154e_cjs-remove-unused-exports_object-literal-replaces-exports_input_1f6j47z._.js",
"[project]/turbopack/crates/turbopack-tests/tests/snapshot/cjs-remove-unused-exports/object-literal-replaces-exports/input/index.js [test] (ecmascript)", ((__turbopack_context__) => {
"use strict";
var __TURBOPACK__imported__module__$5b$project$5d2f$turbopack$2f$crates$2f$turbopack$2d$tests$2f$tests$2f$snapshot$2f$cjs$2d$remove$2d$unused$2d$exports$2f$object$2d$literal$2d$replaces$2d$exports$2f$input$2f$lib$2e$js__$5b$test$5d$__$28$ecmascript$29$__ = __turbopack_context__.i("[project]/turbopack/crates/turbopack-tests/tests/snapshot/cjs-remove-unused-exports/object-literal-replaces-exports/input/lib.js [test] (ecmascript)");
;
console.log(__TURBOPACK__imported__module__$5b$project$5d2f$turbopack$2f$crates$2f$turbopack$2d$tests$2f$tests$2f$snapshot$2f$cjs$2d$remove$2d$unused$2d$exports$2f$object$2d$literal$2d$replaces$2d$exports$2f$input$2f$lib$2e$js__$5b$test$5d$__$28$ecmascript$29$__["used"], __TURBOPACK__imported__module__$5b$project$5d2f$turbopack$2f$crates$2f$turbopack$2d$tests$2f$tests$2f$snapshot$2f$cjs$2d$remove$2d$unused$2d$exports$2f$object$2d$literal$2d$replaces$2d$exports$2f$input$2f$lib$2e$js__$5b$test$5d$__$28$ecmascript$29$__["usedLate"]);
__turbopack_context__.s([]);
}),
"[project]/turbopack/crates/turbopack-tests/tests/snapshot/cjs-remove-unused-exports/object-literal-replaces-exports/input/lib.js [test] (ecmascript)", ((__turbopack_context__, module, exports) => {
// Discarded by the literal below, so not an export.
exports.early = 'early-value';
module.exports = {
used: 'used-value',
...void 'unused-value'
};
// Not exports: `exports` and top-level `this` hold the object the literal discarded.
exports.deadExports = 'dead-exports';
/*TURBOPACK member replacement*/ __turbopack_context__.e.deadThis = 'dead-this';
Object.defineProperty(exports, 'deadDefined', {
value: 'dead-defined'
});
// Exports: `module.exports` is the live object.
module.exports.usedLate = 'used-late';
'unused-late';
}),
]);
//# sourceMappingURL=154e_cjs-remove-unused-exports_object-literal-replaces-exports_input_1f6j47z._.js.map
\ No newline at end of file
{
"version": 3,
"sources": [],
"sections": [
{"offset": {"line": 4, "column": 0}, "map": {"version":3,"sources":["turbopack:///[project]/turbopack/crates/turbopack-tests/tests/snapshot/cjs-remove-unused-exports/object-literal-replaces-exports/input/index.js"],"sourcesContent":["import { used, usedLate } from './lib.js'\n\nconsole.log(used, usedLate)\n"],"names":["console","log"],"mappings":"AAAA;;AAEAA,QAAQC,GAAG,CAAC,kQAAI,EAAE,sQAAQ"}},
{"offset": {"line": 11, "column": 0}, "map": {"version":3,"sources":["turbopack:///[project]/turbopack/crates/turbopack-tests/tests/snapshot/cjs-remove-unused-exports/object-literal-replaces-exports/input/lib.js"],"sourcesContent":["// Discarded by the literal below, so not an export.\nexports.early = 'early-value'\n\nmodule.exports = {\n used: 'used-value',\n unused: 'unused-value',\n}\n\n// Not exports: `exports` and top-level `this` hold the object the literal discarded.\nexports.deadExports = 'dead-exports'\nthis.deadThis = 'dead-this'\nObject.defineProperty(exports, 'deadDefined', { value: 'dead-defined' })\n\n// Exports: `module.exports` is the live object.\nmodule.exports.usedLate = 'used-late'\nmodule.exports.unusedLate = 'unused-late'\n"],"names":["exports","early","module","used","deadExports","deadThis","Object","defineProperty","value","usedLate"],"mappings":"AAAA,oDAAoD;AACpDA,QAAQC,KAAK,GAAG;AAEhBC,OAAOF,OAAO,GAAG;IACfG,MAAM;YACE;AACV;AAEA,qFAAqF;AACrFH,QAAQI,WAAW,GAAG;AACtB,yDAAKC,QAAQ,GAAG;AAChBC,OAAOC,cAAc,CAACP,SAAS,eAAe;IAAEQ,OAAO;AAAe;AAEtE,gDAAgD;AAChDN,OAAOF,OAAO,CAACS,QAAQ,GAAG;AACE"}}]
}
\ 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