Skip to content

Commit f5a22e6

Browse files
fix(module-runner): prevent partial-exports race on concurrent imports of in-flight invalidated re-export chains (#22369)
1 parent 66f3194 commit f5a22e6

6 files changed

Lines changed: 142 additions & 37 deletions

File tree

‎packages/vite/src/module-runner/runner.ts‎

Lines changed: 26 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -133,37 +133,32 @@ export class ModuleRunner {
133133
return exports
134134
}
135135

136-
private isCircularModule(mod: EvaluatedModuleNode) {
137-
for (const importedFile of mod.imports) {
138-
if (mod.importers.has(importedFile)) {
139-
return true
140-
}
136+
private isCircularRequest(
137+
mod: EvaluatedModuleNode,
138+
callstack: string[],
139+
visited = new Set<string>(),
140+
): boolean {
141+
if (visited.has(mod.id)) {
142+
return false
141143
}
142-
return false
143-
}
144+
visited.add(mod.id)
144145

145-
private isCircularImport(
146-
importers: Set<string>,
147-
moduleUrl: string,
148-
visited = new Set<string>(),
149-
) {
150-
for (const importer of importers) {
151-
if (visited.has(importer)) {
152-
continue
153-
}
154-
visited.add(importer)
155-
if (importer === moduleUrl) {
146+
for (const importedModuleId of mod.imports) {
147+
if (callstack.includes(importedModuleId)) {
156148
return true
157149
}
158-
const mod = this.evaluatedModules.getModuleById(importer)
150+
151+
const importedModule =
152+
this.evaluatedModules.getModuleById(importedModuleId)
159153
if (
160-
mod &&
161-
mod.importers.size &&
162-
this.isCircularImport(mod.importers, moduleUrl, visited)
154+
importedModule?.promise &&
155+
!importedModule.evaluated &&
156+
this.isCircularRequest(importedModule, callstack, visited)
163157
) {
164158
return true
165159
}
166160
}
161+
167162
return false
168163
}
169164

@@ -176,24 +171,23 @@ export class ModuleRunner {
176171
const meta = mod.meta!
177172
const moduleId = meta.id
178173

179-
const { importers } = mod
180-
181174
const importee = callstack[callstack.length - 1]
182175

183-
if (importee) importers.add(importee)
176+
if (importee) mod.importers.add(importee)
184177

185178
// fast path: already evaluated modules can't deadlock
186179
if (mod.evaluated && mod.promise) {
187180
return this.processImport(await mod.promise, meta, metadata)
188181
}
189182

190-
// check circular dependency (only for modules still being evaluated)
191-
if (
192-
callstack.includes(moduleId) ||
193-
this.isCircularModule(mod) ||
194-
this.isCircularImport(importers, moduleId)
195-
) {
196-
if (mod.exports) return this.processImport(mod.exports, meta, metadata)
183+
if (mod.promise) {
184+
if (
185+
mod.exports &&
186+
(callstack.includes(moduleId) || this.isCircularRequest(mod, callstack))
187+
) {
188+
return this.processImport(mod.exports, meta, metadata)
189+
}
190+
return this.processImport(await mod.promise, meta, metadata)
197191
}
198192

199193
let debugTimer: any
@@ -212,10 +206,6 @@ export class ModuleRunner {
212206
}
213207

214208
try {
215-
// cached module (in-progress, not yet evaluated)
216-
if (mod.promise)
217-
return this.processImport(await mod.promise, meta, metadata)
218-
219209
const promise = this.directRequest(url, mod, callstack)
220210
mod.promise = promise
221211
mod.evaluated = false
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
await globalThis.__vite_ssr_hmr_reexport_race__?.wait?.()
2+
3+
export function createThing(value) {
4+
return value
5+
}
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
import { createThing } from './shared.js'
2+
3+
export const result = createThing('a')
4+
5+
import.meta.hot?.accept()
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
import { createThing } from './shared.js'
2+
3+
export const result = createThing('b')
4+
5+
import.meta.hot?.accept()
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
import './entry-a.js'
2+
3+
export * from './core.js'

‎packages/vite/src/node/ssr/runtime/__tests__/server-hmr.spec.ts‎

Lines changed: 98 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { describe, expect } from 'vitest'
1+
import { describe, expect, onTestFinished } from 'vitest'
22
import { createModuleRunnerTester } from './utils'
33

44
describe(
@@ -36,6 +36,103 @@ describe(
3636
expect(runner.hmrClient!.ctxToListenersMap.has(fixture)).toBe(true)
3737
}
3838
})
39+
40+
it('does not expose partial exports during concurrent updates', async ({
41+
runner,
42+
}) => {
43+
const testGlobal = globalThis as any
44+
45+
testGlobal.__vite_ssr_hmr_reexport_race__ = {
46+
wait: () => Promise.resolve(),
47+
}
48+
onTestFinished(() => {
49+
delete testGlobal.__vite_ssr_hmr_reexport_race__
50+
})
51+
52+
await runner.import('/fixtures/hmr-reexport-race/entry-a.js')
53+
await runner.import('/fixtures/hmr-reexport-race/entry-b.js')
54+
55+
const sharedModule = runner.evaluatedModules.getModuleByUrl(
56+
'/fixtures/hmr-reexport-race/shared.js',
57+
)
58+
const coreModule = runner.evaluatedModules.getModuleByUrl(
59+
'/fixtures/hmr-reexport-race/core.js',
60+
)
61+
const entryAModule = runner.evaluatedModules.getModuleByUrl(
62+
'/fixtures/hmr-reexport-race/entry-a.js',
63+
)
64+
const entryBModule = runner.evaluatedModules.getModuleByUrl(
65+
'/fixtures/hmr-reexport-race/entry-b.js',
66+
)
67+
expect(sharedModule).toBeDefined()
68+
expect(coreModule).toBeDefined()
69+
expect(entryAModule).toBeDefined()
70+
expect(entryBModule).toBeDefined()
71+
72+
let waitStarted!: () => void
73+
const waitStartedPromise = new Promise<void>((resolve) => {
74+
waitStarted = resolve
75+
})
76+
let releaseWait!: () => void
77+
const waitPromise = new Promise<void>((resolve) => {
78+
releaseWait = resolve
79+
})
80+
81+
testGlobal.__vite_ssr_hmr_reexport_race__ = {
82+
wait: () => {
83+
waitStarted()
84+
return waitPromise
85+
},
86+
}
87+
88+
for (const module of [
89+
entryAModule!,
90+
entryBModule!,
91+
sharedModule!,
92+
coreModule!,
93+
]) {
94+
runner.evaluatedModules.invalidateModule(module)
95+
}
96+
97+
const importA = runner.import('/fixtures/hmr-reexport-race/entry-a.js')
98+
await waitStartedPromise
99+
100+
const importB = runner.import('/fixtures/hmr-reexport-race/entry-b.js')
101+
// Wait deterministically until entry-b has reached the point where it
102+
// observes shared as in-flight. The `mod.imports.add(depMod.id)` line
103+
// in `request()` runs synchronously immediately before `cachedRequest`
104+
// executes its cycle-detection prefix, so observing this edge means
105+
// the buggy/fixed branch has either just run or is about to run on
106+
// the same microtask. `imports` is cleared by invalidateModule, so
107+
// this is a fresh signal (unlike `importers`, which is preserved).
108+
const entryBNode = runner.evaluatedModules.getModuleByUrl(
109+
'/fixtures/hmr-reexport-race/entry-b.js',
110+
)!
111+
while (!entryBNode.imports.has(sharedModule!.id)) {
112+
await new Promise((resolve) => setImmediate(resolve))
113+
}
114+
releaseWait()
115+
const results = await Promise.allSettled([importA, importB] as const)
116+
117+
expect(results).toEqual([
118+
{
119+
status: 'fulfilled',
120+
value: expect.objectContaining({ result: 'a' }),
121+
},
122+
{
123+
status: 'fulfilled',
124+
value: expect.objectContaining({ result: 'b' }),
125+
},
126+
])
127+
128+
const hmrListeners = runner.hmrClient!.hotModulesMap
129+
expect(hmrListeners.has('/fixtures/hmr-reexport-race/entry-a.js')).toBe(
130+
true,
131+
)
132+
expect(hmrListeners.has('/fixtures/hmr-reexport-race/entry-b.js')).toBe(
133+
true,
134+
)
135+
})
39136
},
40137
process.env.CI ? 50_00 : 5_000,
41138
)

0 commit comments

Comments
 (0)