Unverified Commit fc7ae172 authored by Luke Sandberg's avatar Luke Sandberg Committed by GitHub

[backport] [turbopack] Raise registration calls in hoisted modules to the top (#97308)

Backports #96697 ("[turbopack] Raise registration calls in hoisted
modules to the top") to `next-16-3`.

Fixes #96648: when a scope-hoisting group enters a second group that
depends back on the first, the
re-entry happened before the first group's module registrations had run.
Non-scope-hoisted modules
with cycles already raise the registration call to the top of the
factory; this restores that for
scope-hoisted modules.

Cherry-picked from 40680b95 with no
conflicts. All 16 files are
byte-identical to canary.

### Verification on this branch

- `cargo check`, `cargo clippy --all-targets`, `cargo fmt --check` on
`turbopack-ecmascript` — clean
- `cargo test -p turbopack-tests --test execution` — 255 passed, 0
failed, including the new
  `scope_hoisting__reentrant_group` fixture
- `cargo test -p turbopack-tests --test snapshot` — 113 passed, 0
failed; the working tree stays
clean afterwards, so the 5 updated snapshots match the generated output
exactly
- `pnpm build-all` — 18/18 tasks
- `test/e2e/app-dir/app/index.test.ts` (Turbopack, production) — 116
passed, 5 skipped

The snapshot updates are the intended effect of the change:
`__turbopack_context__.s([...])` now
precedes the merged-module bodies instead of following them.

<!-- NEXT_JS_LLM -->
Co-authored-by: 's avatarSam Poder <sampoder@berkeley.edu>
parent ec2b3197
......@@ -61,7 +61,7 @@ use swc_core::{
base::SwcComments,
common::{
BytePos, DUMMY_SP, FileName, GLOBALS, Globals, Loc, Mark, SourceFile, SourceMap,
SourceMapper, Span, SpanSnippetError, SyntaxContext,
SourceMapper, Span, SpanSnippetError, Spanned, SyntaxContext,
comments::{Comment, CommentKind, Comments},
source_map::{FileLinesResult, Files, SourceMapLookupError},
util::take::Take,
......@@ -1235,6 +1235,41 @@ impl EcmascriptModuleContent {
}
}
/// Comments delimiting the early hoisted statements, which [`merge_modules`] moves in front of the
/// merged module so that a cyclic importer can't re-enter it before they ran.
const EARLY_HOIST_START: &str = " TURBOPACK EARLY HOIST START";
const EARLY_HOIST_END: &str = " TURBOPACK EARLY HOIST END";
fn early_hoist_comment(text: &str) -> Comment {
Comment {
kind: CommentKind::Line,
span: DUMMY_SP,
text: text.into(),
}
}
/// Finds the statements delimited by [`EARLY_HOIST_START`] and [`EARLY_HOIST_END`], as an inclusive
/// index range over `body` covering both delimiters. Must run before the spans are rewritten.
fn early_hoist_range(
comments: &SwcComments,
body: impl Iterator<Item = Span>,
) -> Option<(usize, usize)> {
let (mut start, mut end) = (None, None);
for (i, span) in body.enumerate() {
let Some(leading) = comments.get_leading(span.lo) else {
continue;
};
for comment in leading {
if comment.text == EARLY_HOIST_START {
start = Some(i);
} else if comment.text == EARLY_HOIST_END {
end = Some(i);
}
}
}
Some((start?, end?))
}
/// Merges multiple Ecmascript modules into a single AST, setting the syntax contexts correctly so
/// that imports work.
///
......@@ -1404,18 +1439,32 @@ async fn merge_modules(
let mut unique_contexts_cache =
FxHashMap::with_capacity_and_hasher(contents.len() * 5, Default::default());
let mut merged_prelude = Vec::new();
let mut prepare_module =
|module_count: usize,
current_module_idx: usize,
(module, content): &(ResolvedVc<Box<dyn EcmascriptChunkPlaceable>>, CodeGenResult),
program: &mut Program,
merged_prelude: &mut Vec<ModuleItem>,
lookup_table: &mut Vec<ModulePosition>| {
let _ = tracing::trace_span!("prepare module").entered();
if let CodeGenResult {
scope_hoisting_syntax_contexts: Some((module_contexts, _)),
comments: CodeGenResultComments::Single { extra_comments, .. },
..
} = content
{
// The delimiter comments are keyed by the original spans, so this has to happen
// before the visitor below rewrites them.
let early_hoisted = match &*program {
Program::Module(module) => {
early_hoist_range(extra_comments, module.body.iter().map(|i| i.span()))
}
Program::Script(script) => {
early_hoist_range(extra_comments, script.body.iter().map(|s| s.span()))
}
};
let modules_header_width = module_count.next_power_of_two().trailing_zeros();
GLOBALS.set(globals_merged, || {
let mut visitor = SetSyntaxContextVisitor {
......@@ -1435,6 +1484,21 @@ async fn merge_modules(
visitor.error
})?;
// Move the delimited statements out, dropping the two delimiters themselves.
if let Some((start, end)) = early_hoisted {
let mut hoisted: Vec<ModuleItem> = match program {
Program::Module(module) => module.body.drain(start..=end).collect(),
Program::Script(script) => script
.body
.drain(start..=end)
.map(ModuleItem::Stmt)
.collect(),
};
hoisted.pop();
hoisted.remove(0);
merged_prelude.extend(hoisted);
}
Ok(match program.take() {
Program::Module(module) => Either::Left(module.body.into_iter()),
// A module without any ModuleItem::ModuleDecl but a
......@@ -1465,6 +1529,7 @@ async fn merge_modules(
i,
&contents[i],
&mut programs[i],
&mut merged_prelude,
&mut lookup_table,
)
.map_err(|err| (i, err))
......@@ -1495,6 +1560,7 @@ async fn merge_modules(
index,
&contents[index],
&mut programs[index],
&mut merged_prelude,
&mut lookup_table,
)
.map_err(|err| (index, err))?
......@@ -1547,7 +1613,7 @@ async fn merge_modules(
let span = tracing::trace_span!("hygiene").entered();
let mut merged_ast = Program::Module(swc_core::ecma::ast::Module {
body: result,
body: merged_prelude.into_iter().chain(result).collect(),
span: DUMMY_SP,
shebang: None,
});
......@@ -1844,7 +1910,8 @@ async fn process_parse_result(
trailing: Default::default(),
};
process_content_with_code_gens(&mut program, globals, &mut code_gens);
let early_hoisted_count =
process_content_with_code_gens(&mut program, globals, &mut code_gens);
for comments in code_gens.iter_mut().flat_map(|cg| cg.comments.as_mut()) {
let leading = Arc::unwrap_or_clone(take(&mut comments.leading));
......@@ -1860,6 +1927,31 @@ async fn process_parse_result(
}
GLOBALS.set(globals, || {
// Delimit the early hoisted statements, which `merge_modules` moves in front of
// the merged module this module is part of.
if retain_syntax_context.is_some() && early_hoisted_count > 0 {
let end = Span::dummy_with_cmt();
extra_comments.add_leading(end.lo, early_hoist_comment(EARLY_HOIST_END));
let start = Span::dummy_with_cmt();
extra_comments.add_leading(start.lo, early_hoist_comment(EARLY_HOIST_START));
let (end, start) = (
Stmt::Empty(EmptyStmt { span: end }),
Stmt::Empty(EmptyStmt { span: start }),
);
match &mut program {
Program::Module(module) => {
module
.body
.insert(early_hoisted_count, ModuleItem::Stmt(end));
module.body.insert(0, ModuleItem::Stmt(start));
}
Program::Script(script) => {
script.body.insert(early_hoisted_count, end);
script.body.insert(0, start);
}
}
}
if let Some(prepend_ident_comment) = prepend_ident_comment {
let span = Span::dummy_with_cmt();
extra_comments.add_leading(span.lo, prepend_ident_comment);
......@@ -2178,12 +2270,13 @@ async fn emit_content(
.cell())
}
/// Applies the code generations, returning the number of early hoisted statements it prepended.
#[instrument(level = Level::TRACE, skip_all, name = "apply code generation")]
fn process_content_with_code_gens(
program: &mut Program,
globals: &Globals,
code_gens: &mut Vec<CodeGeneration>,
) {
) -> usize {
let mut visitors = Vec::new();
let mut root_visitors = Vec::new();
let mut early_hoisted_stmts = FxIndexMap::default();
......@@ -2224,6 +2317,7 @@ fn process_content_with_code_gens(
}
});
let early_hoisted_count = early_hoisted_stmts.len();
match program {
Program::Module(ast::Module { body, .. }) => {
body.splice(
......@@ -2254,6 +2348,7 @@ fn process_content_with_code_gens(
);
}
};
early_hoisted_count
}
/// Like `hygiene`, but only renames the Atoms without clearing all SyntaxContexts
......
import './shared.js'
export { instance, instanceFromClosure } from './library/index.js'
it('should evaluate a merged module group only once', async () => {
const { instance, instanceFromClosure } = await import('./entry1.js')
await import('./entry2.js')
expect(globalThis.__evaluations).toBe(1)
expect(instanceFromClosure()).toBe(instance)
})
import * as z from './src/index.js'
export { RealError, instance, instanceFromClosure } from './src/index.js'
export { z }
export { any, instance, instanceFromClosure } from './schemas.js'
export { RealError } from './errors.js'
import * as schemas from './schemas.js'
export function datetime() {
return schemas
}
import * as iso from './iso.js'
import { RealError } from './errors.js'
globalThis.__evaluations = (globalThis.__evaluations ?? 0) + 1
export const instance = { evaluation: globalThis.__evaluations }
export function instanceFromClosure() {
return instance
}
RealError
iso.datetime()
export const anyBase = 1234
export function any() {
return anyBase
}
import { RealError } from './library/index.js'
import { z } from './library/index.js'
z.any()
RealError
......@@ -2,9 +2,9 @@
"[project]/turbopack/crates/turbopack-tests/tests/snapshot/scope-hoisting/duplicate-imports/input/index.js [test] (ecmascript)", ((__turbopack_context__) => {
"use strict";
__turbopack_context__.s([], "[project]/turbopack/crates/turbopack-tests/tests/snapshot/scope-hoisting/duplicate-imports/input/index.js [test] (ecmascript)");
// MERGED MODULE: [project]/turbopack/crates/turbopack-tests/tests/snapshot/scope-hoisting/duplicate-imports/input/index.js [test] (ecmascript)
;
__turbopack_context__.s([], "[project]/turbopack/crates/turbopack-tests/tests/snapshot/scope-hoisting/duplicate-imports/input/index.js [test] (ecmascript)");
// MERGED MODULE: [project]/turbopack/crates/turbopack-tests/tests/snapshot/scope-hoisting/duplicate-imports/input/c.js [test] (ecmascript)
;
// MERGED MODULE: [project]/turbopack/crates/turbopack-tests/tests/snapshot/scope-hoisting/duplicate-imports/input/b.js [test] (ecmascript)
......
......@@ -2,12 +2,12 @@
"[project]/turbopack/crates/turbopack-tests/tests/snapshot/scope-hoisting/split-shared/input/big/index.js [test] (ecmascript)", ((__turbopack_context__) => {
"use strict";
// MERGED MODULE: [project]/turbopack/crates/turbopack-tests/tests/snapshot/scope-hoisting/split-shared/input/big/index.js [test] (ecmascript)
;
__turbopack_context__.s([
"default",
()=>__TURBOPACK__default__export__1
], "[project]/turbopack/crates/turbopack-tests/tests/snapshot/scope-hoisting/split-shared/input/big/index.js [test] (ecmascript)");
// MERGED MODULE: [project]/turbopack/crates/turbopack-tests/tests/snapshot/scope-hoisting/split-shared/input/big/index.js [test] (ecmascript)
;
// MERGED MODULE: [project]/turbopack/crates/turbopack-tests/tests/snapshot/scope-hoisting/split-shared/input/big/other.js [test] (ecmascript)
;
const __TURBOPACK__default__export__ = `
......
......@@ -2,9 +2,9 @@
"[project]/turbopack/crates/turbopack-tests/tests/snapshot/scope-hoisting/split-shared/input/y/middle.js [test] (ecmascript)", ((__turbopack_context__) => {
"use strict";
__turbopack_context__.s([], "[project]/turbopack/crates/turbopack-tests/tests/snapshot/scope-hoisting/split-shared/input/y/middle.js [test] (ecmascript)");
// MERGED MODULE: [project]/turbopack/crates/turbopack-tests/tests/snapshot/scope-hoisting/split-shared/input/y/middle.js [test] (ecmascript)
;
__turbopack_context__.s([], "[project]/turbopack/crates/turbopack-tests/tests/snapshot/scope-hoisting/split-shared/input/y/middle.js [test] (ecmascript)");
// MERGED MODULE: [project]/turbopack/crates/turbopack-tests/tests/snapshot/scope-hoisting/split-shared/input/y/inner.js [test] (ecmascript)
;
var __TURBOPACK__imported__module__$5b$project$5d2f$turbopack$2f$crates$2f$turbopack$2d$tests$2f$tests$2f$snapshot$2f$scope$2d$hoisting$2f$split$2d$shared$2f$input$2f$big$2f$index$2e$js__$5b$test$5d$__$28$ecmascript$29$__ = __turbopack_context__.i("[project]/turbopack/crates/turbopack-tests/tests/snapshot/scope-hoisting/split-shared/input/big/index.js [test] (ecmascript)");
......
......@@ -2,9 +2,9 @@
"[project]/turbopack/crates/turbopack-tests/tests/snapshot/source_maps/input-source-map-merged/input/index.js [test] (ecmascript)", ((__turbopack_context__) => {
"use strict";
__turbopack_context__.s([], "[project]/turbopack/crates/turbopack-tests/tests/snapshot/source_maps/input-source-map-merged/input/index.js [test] (ecmascript)");
// MERGED MODULE: [project]/turbopack/crates/turbopack-tests/tests/snapshot/source_maps/input-source-map-merged/input/index.js [test] (ecmascript)
;
__turbopack_context__.s([], "[project]/turbopack/crates/turbopack-tests/tests/snapshot/source_maps/input-source-map-merged/input/index.js [test] (ecmascript)");
// MERGED MODULE: [project]/turbopack/crates/turbopack-tests/tests/snapshot/source_maps/input-source-map-merged/input/sourcemapped.js [test] (ecmascript)
;
function runExternalSourceMapped(fn) {
......
......@@ -2,9 +2,9 @@
"[project]/turbopack/crates/turbopack-tests/tests/snapshot/source_maps/merged-unicode/input/entry-base.js [test] (ecmascript)", ((__turbopack_context__) => {
"use strict";
__turbopack_context__.s([], "[project]/turbopack/crates/turbopack-tests/tests/snapshot/source_maps/merged-unicode/input/entry-base.js [test] (ecmascript)");
// MERGED MODULE: [project]/turbopack/crates/turbopack-tests/tests/snapshot/source_maps/merged-unicode/input/entry-base.js [test] (ecmascript)
;
__turbopack_context__.s([], "[project]/turbopack/crates/turbopack-tests/tests/snapshot/source_maps/merged-unicode/input/entry-base.js [test] (ecmascript)");
// MERGED MODULE: [project]/turbopack/crates/turbopack-tests/tests/snapshot/source_maps/merged-unicode/input/params.js [test] (ecmascript)
;
;
......
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