Skip to content

Commit 5f89433

Browse files
fix(optimizer): resolve pending discovered dep processing on close before init (#23567)
Co-authored-by: Santhi Prakash <[email protected]>
1 parent 6e09961 commit 5f89433

2 files changed

Lines changed: 77 additions & 4 deletions

File tree

‎packages/vite/src/node/__tests__/optimizer/discoverBeforeListen.spec.ts‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,3 +90,72 @@ test('does not crash when a dep is discovered before the server starts listening
9090
await ssr.depsOptimizer?.scanProcessing
9191
expect(errors).toStrictEqual([])
9292
})
93+
94+
// regression test for https://github.com/vitejs/vite/issues/23143
95+
// When a module importing a bare specifier is transformed through the JS API
96+
// before server.listen() is called, the dep is discovered and a pending warmup
97+
// request is issued for the optimized dep. That warmup waits on the dep's
98+
// processing promise, which is never resolved because depsOptimizer.init() has
99+
// not run. server.close() then waits forever for the pending warmup request.
100+
// The fix is for depsOptimizer.close() to resolve the processing promise so
101+
// in-flight requests can unblock during shutdown.
102+
test('resolves discovered dep processing promise on close before init', async () => {
103+
const errors: string[] = []
104+
const logger = createLogger('error')
105+
logger.error = (msg) => {
106+
errors.push(typeof msg === 'string' ? msg : String(msg))
107+
}
108+
109+
server = await createServer({
110+
configFile: false,
111+
customLogger: logger,
112+
root: path.join(
113+
import.meta.dirname,
114+
'../fixtures/optimizer-discover-before-listen',
115+
),
116+
cacheDir: 'node_modules/.vite-client-close',
117+
environments: {
118+
client: {
119+
dev: {
120+
preTransformRequests: false,
121+
},
122+
optimizeDeps: {
123+
// ensure no cached metadata/file is reused so the dep is discovered
124+
// and its processing promise stays unresolved until close()
125+
force: true,
126+
noDiscovery: false,
127+
},
128+
},
129+
},
130+
})
131+
132+
const client = server.environments.client
133+
134+
// Transform a module importing a bare specifier before the server is listening.
135+
// This discovers the dep and leaves its processing promise pending because
136+
// depsOptimizer.init() is deferred to listen().
137+
await client.transformRequest('/entry.js')
138+
139+
const info = client.depsOptimizer?.metadata.discovered?.vue
140+
expect(info).toBeDefined()
141+
142+
const processingPromise = info!.processing?.then(() => true)
143+
144+
// The dep's processing promise should still be pending at this point.
145+
const resolvedBeforeClose = await Promise.race([
146+
processingPromise,
147+
setTimeout(500, false),
148+
])
149+
expect(resolvedBeforeClose).toBe(false)
150+
151+
// close() should resolve the processing promise so any in-flight or future
152+
// requests waiting on it (including server.close()) can unblock.
153+
await client.depsOptimizer?.close()
154+
155+
const resolvedAfterClose = await Promise.race([
156+
processingPromise,
157+
setTimeout(500, false),
158+
])
159+
expect(resolvedAfterClose).toBe(true)
160+
expect(errors).toStrictEqual([])
161+
})

‎packages/vite/src/node/optimizer/optimizer.ts‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -148,11 +148,19 @@ export function createDepsOptimizer(
148148

149149
async function close() {
150150
closed = true
151+
152+
// Ensure that a rerun will not be issued
153+
if (debounceProcessingHandle) clearTimeout(debounceProcessingHandle)
154+
debounceProcessingHandle = undefined
155+
151156
await Promise.allSettled([
152157
discover?.cancel(),
153158
depsOptimizer.scanProcessing,
154159
optimizationResult?.cancel(),
155160
])
161+
162+
depOptimizationProcessing.resolve()
163+
resolveEnqueuedProcessingPromises()
156164
}
157165

158166
async function init() {
@@ -337,11 +345,8 @@ export function createDepsOptimizer(
337345

338346
if (closed) {
339347
currentlyProcessing = false
340-
depOptimizationProcessing.resolve()
341-
resolveEnqueuedProcessingPromises()
342348
return
343349
}
344-
345350
currentlyProcessing = true
346351

347352
try {
@@ -360,7 +365,6 @@ export function createDepsOptimizer(
360365
if (closed) {
361366
currentlyProcessing = false
362367
processingResult.cancel()
363-
resolveEnqueuedProcessingPromises()
364368
return
365369
}
366370

0 commit comments

Comments
 (0)