Skip to content

chore(optimizer): add debug log when waiting for dep before init #23566

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sapphi-red merged 1 commit into from
Sep 24, 2026
Merged

chore(optimizer): add debug log when waiting for dep before init #23566

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/vite/src/node/optimizer/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ export type ExportsData = {

export interface DepsOptimizer {
init: () => Promise<void>
initState: 'idle' | 'initializing' | 'initialized'

metadata: DepOptimizationMetadata
scanProcessing?: Promise<void>
Expand Down
19 changes: 10 additions & 9 deletions packages/vite/src/node/optimizer/optimizer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ export function createDepsOptimizer(

const depsOptimizer: DepsOptimizer = {
init,
initState: 'idle',
metadata,
registerMissingImport,
run: () => debouncedProcessing(0),
Expand Down Expand Up @@ -154,10 +155,9 @@ export function createDepsOptimizer(
])
}

let initState: 'idle' | 'initializing' | 'initialized' = 'idle'
async function init() {
if (initState !== 'idle') return
initState = 'initializing'
if (depsOptimizer.initState !== 'idle') return
depsOptimizer.initState = 'initializing'

const cachedMetadata = await loadCachedDepOptimizationMetadata(environment)

Expand Down Expand Up @@ -283,7 +283,7 @@ export function createDepsOptimizer(
})
}
}
initState = 'initialized'
depsOptimizer.initState = 'initialized'
}

function startNextDiscoveredBatch() {
Expand Down Expand Up @@ -583,7 +583,7 @@ export function createDepsOptimizer(
// A module can be transformed between `createServer()` and `server.listen()`,
// which discovers a dep before `init()` runs. Starting a run here would race
// with `init()` resetting the metadata and crash in `commitProcessing`.
if (initState === 'initialized' && !waitingForCrawlEnd) {
if (depsOptimizer.initState === 'initialized' && !waitingForCrawlEnd) {
// Debounced rerun, let other missing dependencies be discovered before
// the running next optimizeDeps
debouncedProcessing()
Expand Down Expand Up @@ -753,8 +753,9 @@ export function createDepsOptimizer(
export function createExplicitDepsOptimizer(
environment: DevEnvironment,
): DepsOptimizer {
const depsOptimizer = {
const depsOptimizer: DepsOptimizer = {
metadata: initDepsOptimizerMetadata(environment),
initState: 'idle',
isOptimizedDepFile: createIsOptimizedDepFile(environment),
isOptimizedDepUrl: createIsOptimizedDepUrl(environment),
getOptimizedDepId: (depInfo: OptimizedDepInfo) =>
Expand All @@ -774,12 +775,12 @@ export function createExplicitDepsOptimizer(
options: environment.config.optimizeDeps,
}

let inited = false
async function init() {
if (inited) return
inited = true
if (depsOptimizer.initState !== 'idle') return
depsOptimizer.initState = 'initializing'

depsOptimizer.metadata = await optimizeExplicitEnvironmentDeps(environment)
depsOptimizer.initState = 'initialized'
Comment on lines 778 to +783

@graphite-app graphite-app Bot Sep 24, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If optimizeExplicitEnvironmentDeps() throws an exception, initState will remain stuck at 'initializing' and subsequent calls to init() will return early without retrying. This means initialization can never be retried after a failure.

async function init() {
  if (depsOptimizer.initState !== 'idle') return
  depsOptimizer.initState = 'initializing'
  
  try {
    depsOptimizer.metadata = await optimizeExplicitEnvironmentDeps(environment)
    depsOptimizer.initState = 'initialized'
  } catch (error) {
    depsOptimizer.initState = 'idle'
    throw error
  }
}
Suggested change
async function init() {
if (inited) return
inited = true
if (depsOptimizer.initState !== 'idle') return
depsOptimizer.initState = 'initializing'
depsOptimizer.metadata = await optimizeExplicitEnvironmentDeps(environment)
depsOptimizer.initState = 'initialized'
async function init() {
if (depsOptimizer.initState !== 'idle') return
depsOptimizer.initState = 'initializing'
try {
depsOptimizer.metadata = await optimizeExplicitEnvironmentDeps(environment)
depsOptimizer.initState = 'initialized'
} catch (error) {
depsOptimizer.initState = 'idle'
throw error
}

Spotted by Graphite

Fix in Graphite

Is this helpful? React 👍 or 👎 to let us know.

@sapphi-red sapphi-red Sep 24, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While I think this should be fixed, this existed before this PR, so I'm leaving this one.

}

return depsOptimizer
Expand Down
5 changes: 5 additions & 0 deletions packages/vite/src/node/plugins/optimizedDeps.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,11 @@ export function optimizedDepsPlugin(): Plugin {
}
try {
// This is an entry point, it may still not be bundled
if (info.processing && depsOptimizer.initState === 'idle') {
debug?.(
`transforming ${colors.cyan(file)} is waiting for the dependency optimizer to initialize`,
)
}
await info.processing
} catch {
// If the refresh has not happened after timeout, Vite considers
Expand Down
Loading