Skip to content
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.

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

fix(error-logging): rollup errors weren't displaying id and codeframe #16540

Merged
merged 1 commit into from
May 9, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
53 changes: 47 additions & 6 deletions packages/vite/src/node/build.ts
Original file line number Diff line number Diff line change
Expand Up @@ -541,23 +541,64 @@ export async function build(
},
}

const mergeRollupError = (e: RollupError) => {
/**
* The stack string usually contains a copy of the message at the start of the stack.
* If the stack starts with the message, we remove it and just return the stack trace
* portion. Otherwise the original stack trace is used.
*/
function extractStack(e: RollupError) {
const { stack, name = 'Error', message } = e

// If we don't have a stack, not much we can do.
if (!stack) {
return stack
}

const expectedPrefix = `${name}: ${message}\n`
if (stack.startsWith(expectedPrefix)) {
return stack.slice(expectedPrefix.length)
}

return stack
}

/**
* Esbuild code frames have newlines at the start and end of the frame, rollup doesn't
* This function normalizes the frame to match the esbuild format which has more pleasing padding
*/
const normalizeCodeFrame = (frame: string) => {
const trimmedPadding = frame.replace(/^\n|\n$/g, '')
return `\n${trimmedPadding}\n`
}

const enhanceRollupError = (e: RollupError) => {
const stackOnly = extractStack(e)

let msg = colors.red((e.plugin ? `[${e.plugin}] ` : '') + e.message)
if (e.id) {
msg += `\nfile: ${colors.cyan(
e.id + (e.loc ? `:${e.loc.line}:${e.loc.column}` : ''),
)}`
}
if (e.frame) {
msg += `\n` + colors.yellow(e.frame)
msg += `\n` + colors.yellow(normalizeCodeFrame(e.frame))
}

e.message = msg

// We are rebuilding the stack trace to include the more detailed message at the top.
// Previously this code was relying on mutating e.message changing the generated stack
// when it was accessed, but we don't have any guarantees that the error we are working
// with hasn't already had its stack accessed before we get here.
if (stackOnly !== undefined) {
e.stack = `${e.message}\n${stackOnly}`
}
return msg
}

const outputBuildError = (e: RollupError) => {
const msg = mergeRollupError(e)
enhanceRollupError(e)
clearLine()
config.logger.error(msg, { error: e })
config.logger.error(e.message, { error: e })
}

let bundle: RollupBuild | undefined
Expand Down Expand Up @@ -711,7 +752,7 @@ export async function build(
)
return Array.isArray(outputs) ? res : res[0]
} catch (e) {
e.message = mergeRollupError(e)
enhanceRollupError(e)
clearLine()
if (startTime) {
config.logger.error(
Expand Down