Unverified Commit f1dbc926 authored by JJ Kasper's avatar JJ Kasper Committed by GitHub

Ensure dev server side errors are correct (#28520)

parent 27c2937c
...@@ -9,7 +9,11 @@ export default async ({ assetPrefix }) => { ...@@ -9,7 +9,11 @@ export default async ({ assetPrefix }) => {
) )
}) })
setupPing(assetPrefix, () => Router.pathname, currentPage) setupPing(
assetPrefix,
() => Router.query.__NEXT_PAGE || Router.pathname,
currentPage
)
// prevent HMR connection from being closed when running tests // prevent HMR connection from being closed when running tests
if (!process.env.__NEXT_TEST_MODE) { if (!process.env.__NEXT_TEST_MODE) {
......
...@@ -29,7 +29,10 @@ export function setupPing(assetPrefix, pathnameFn, retry) { ...@@ -29,7 +29,10 @@ export function setupPing(assetPrefix, pathnameFn, retry) {
if (event.data.indexOf('{') === -1) return if (event.data.indexOf('{') === -1) return
try { try {
const payload = JSON.parse(event.data) const payload = JSON.parse(event.data)
if (payload.invalid) { // don't attempt fetching the page if we're already showing
// the dev overlay as this can cause the error to be triggered
// repeatedly
if (payload.invalid && !self.__NEXT_DATA__.err) {
// Payload can be invalid even if the page does not exist. // Payload can be invalid even if the page does not exist.
// So, we need to make sure it exists before reloading. // So, we need to make sure it exists before reloading.
fetch(location.href, { fetch(location.href, {
......
...@@ -59,6 +59,12 @@ initNext({ webpackHMR }) ...@@ -59,6 +59,12 @@ initNext({ webpackHMR })
} else if (event.data.indexOf('serverOnlyChanges') !== -1) { } else if (event.data.indexOf('serverOnlyChanges') !== -1) {
const { pages } = JSON.parse(event.data) const { pages } = JSON.parse(event.data)
// Make sure to reload when the dev-overlay is showing for an
// API route
if (pages.includes(router.query.__NEXT_PAGE)) {
return window.location.reload()
}
if (!router.clc && pages.includes(router.pathname)) { if (!router.clc && pages.includes(router.pathname)) {
console.log('Refreshing page data due to server-side change') console.log('Refreshing page data due to server-side change')
......
...@@ -25,7 +25,9 @@ export async function apiResolver( ...@@ -25,7 +25,9 @@ export async function apiResolver(
query: any, query: any,
resolverModule: any, resolverModule: any,
apiContext: __ApiPreviewProps, apiContext: __ApiPreviewProps,
propagateError: boolean propagateError: boolean,
dev?: boolean,
page?: string
): Promise<void> { ): Promise<void> {
const apiReq = req as NextApiRequest const apiReq = req as NextApiRequest
const apiRes = res as NextApiResponse const apiRes = res as NextApiResponse
...@@ -117,6 +119,13 @@ export async function apiResolver( ...@@ -117,6 +119,13 @@ export async function apiResolver(
if (err instanceof ApiError) { if (err instanceof ApiError) {
sendError(apiRes, err.statusCode, err.message) sendError(apiRes, err.statusCode, err.message)
} else { } else {
if (dev) {
if (err) {
err.page = page
}
throw err
}
console.error(err) console.error(err)
if (propagateError) { if (propagateError) {
throw err throw err
......
...@@ -134,7 +134,7 @@ export default class HotReloader { ...@@ -134,7 +134,7 @@ export default class HotReloader {
private webpackHotMiddleware: (NextHandleFunction & any) | null private webpackHotMiddleware: (NextHandleFunction & any) | null
private config: NextConfigComplete private config: NextConfigComplete
private stats: webpack.Stats | null private stats: webpack.Stats | null
private serverStats: webpack.Stats | null public serverStats: webpack.Stats | null
private clientError: Error | null = null private clientError: Error | null = null
private serverError: Error | null = null private serverError: Error | null = null
private serverPrevDocumentHash: string | null private serverPrevDocumentHash: string | null
......
import crypto from 'crypto' import crypto from 'crypto'
import fs from 'fs' import fs from 'fs'
import chalk from 'chalk'
import { IncomingMessage, ServerResponse } from 'http' import { IncomingMessage, ServerResponse } from 'http'
import { Worker } from 'jest-worker' import { Worker } from 'jest-worker'
import AmpHtmlValidator from 'next/dist/compiled/amphtml-validator' import AmpHtmlValidator from 'next/dist/compiled/amphtml-validator'
...@@ -47,6 +48,12 @@ import { ...@@ -47,6 +48,12 @@ import {
loadDefaultErrorComponents, loadDefaultErrorComponents,
} from '../load-components' } from '../load-components'
import { DecodeError } from '../../shared/lib/utils' import { DecodeError } from '../../shared/lib/utils'
import { parseStack } from '@next/react-dev-overlay/lib/internal/helpers/parseStack'
import {
createOriginalStackFrame,
getSourceById,
} from '@next/react-dev-overlay/lib/middleware'
import * as Log from '../../build/output/log'
// Load ReactDevOverlay only when needed // Load ReactDevOverlay only when needed
let ReactDevOverlayImpl: React.FunctionComponent let ReactDevOverlayImpl: React.FunctionComponent
...@@ -325,6 +332,15 @@ export default class DevServer extends Server { ...@@ -325,6 +332,15 @@ export default class DevServer extends Server {
) )
// This is required by the tracing subsystem. // This is required by the tracing subsystem.
setGlobal('telemetry', telemetry) setGlobal('telemetry', telemetry)
process.on('unhandledRejection', (reason) => {
this.logErrorWithOriginalStack(reason, 'unhandledRejection').catch(
() => {}
)
})
process.on('uncaughtException', (err) => {
this.logErrorWithOriginalStack(err, 'uncaughtException').catch(() => {})
})
} }
protected async close(): Promise<void> { protected async close(): Promise<void> {
...@@ -431,8 +447,85 @@ export default class DevServer extends Server { ...@@ -431,8 +447,85 @@ export default class DevServer extends Server {
// if they should match against the basePath or not // if they should match against the basePath or not
parsedUrl.pathname = originalPathname parsedUrl.pathname = originalPathname
} }
try {
return await super.run(req, res, parsedUrl)
} catch (err) {
res.statusCode = 500
try {
this.logErrorWithOriginalStack(err).catch(() => {})
return await this.renderError(err, req, res, pathname!, {
__NEXT_PAGE: err?.page || pathname,
})
} catch (internalErr) {
console.error(internalErr)
res.end('Internal Server Error')
}
}
}
return super.run(req, res, parsedUrl) private async logErrorWithOriginalStack(
possibleError?: any,
type?: 'unhandledRejection' | 'uncaughtException'
) {
let usedOriginalStack = false
if (possibleError?.name && possibleError?.stack && possibleError?.message) {
const err: Error & { stack: string } = possibleError
try {
const frames = parseStack(err.stack)
const frame = frames[0]
if (frame.lineNumber && frame?.file) {
const compilation = this.hotReloader?.serverStats?.compilation
const moduleId = frame.file!.replace(
/^(webpack-internal:\/\/\/|file:\/\/)/,
''
)
const source = await getSourceById(
!!frame.file?.startsWith(sep) || !!frame.file?.startsWith('file:'),
moduleId,
compilation,
this.hotReloader!.isWebpack5
)
const originalFrame = await createOriginalStackFrame({
line: frame.lineNumber!,
column: frame.column,
source,
frame,
modulePath: moduleId,
rootDirectory: this.dir,
})
if (originalFrame) {
const { originalCodeFrame, originalStackFrame } = originalFrame
const { file, lineNumber, column, methodName } = originalStackFrame
console.error(
chalk.red('error') +
' - ' +
`${file} (${lineNumber}:${column}) @ ${methodName}`
)
console.error(`${chalk.red(err.name)}: ${err.message}`)
console.error(originalCodeFrame)
usedOriginalStack = true
}
}
} catch (_) {
// failed to load original stack using source maps
// this un-actionable by users so we don't show the
// internal error and only show the provided stack
}
}
if (!usedOriginalStack) {
if (type) {
Log.error(`${type}:`, possibleError)
} else {
Log.error(possibleError)
}
}
} }
// override production loading of routes-manifest // override production loading of routes-manifest
......
...@@ -487,7 +487,7 @@ export default class Server { ...@@ -487,7 +487,7 @@ export default class Server {
try { try {
return await this.run(req, res, parsedUrl) return await this.run(req, res, parsedUrl)
} catch (err) { } catch (err) {
if (this.minimalMode) { if (this.minimalMode || this.renderOpts.dev) {
throw err throw err
} }
this.logError(err) this.logError(err)
...@@ -1125,7 +1125,9 @@ export default class Server { ...@@ -1125,7 +1125,9 @@ export default class Server {
query, query,
pageModule, pageModule,
this.renderOpts.previewProps, this.renderOpts.previewProps,
this.minimalMode this.minimalMode,
this.renderOpts.dev,
page
) )
return true return true
} }
...@@ -1857,6 +1859,7 @@ export default class Server { ...@@ -1857,6 +1859,7 @@ export default class Server {
ctx: RequestContext ctx: RequestContext
): Promise<ResponsePayload | null> { ): Promise<ResponsePayload | null> {
const { res, query, pathname } = ctx const { res, query, pathname } = ctx
let page = pathname
const bubbleNoFallback = !!query._nextBubbleNoFallback const bubbleNoFallback = !!query._nextBubbleNoFallback
delete query._nextBubbleNoFallback delete query._nextBubbleNoFallback
...@@ -1888,6 +1891,7 @@ export default class Server { ...@@ -1888,6 +1891,7 @@ export default class Server {
) )
if (dynamicRouteResult) { if (dynamicRouteResult) {
try { try {
page = dynamicRoute.page
return await this.renderToResponseWithComponents( return await this.renderToResponseWithComponents(
{ {
...ctx, ...ctx,
...@@ -1929,7 +1933,10 @@ export default class Server { ...@@ -1929,7 +1933,10 @@ export default class Server {
) )
if (!isWrappedError) { if (!isWrappedError) {
if (this.minimalMode) { if (this.minimalMode || this.renderOpts.dev) {
if (err) {
err.page = page
}
throw err throw err
} }
this.logError(err) this.logError(err)
......
...@@ -822,10 +822,7 @@ export async function renderToHTML( ...@@ -822,10 +822,7 @@ export async function renderToHTML(
;(renderOpts as any).pageData = props ;(renderOpts as any).pageData = props
} }
} catch (dataFetchError) { } catch (dataFetchError) {
if (isDataReq || !dev || !dataFetchError) throw dataFetchError throw dataFetchError
ctx.err = dataFetchError
renderOpts.err = dataFetchError
console.error(dataFetchError)
} }
if ( if (
......
...@@ -177,52 +177,50 @@ export async function createOriginalStackFrame({ ...@@ -177,52 +177,50 @@ export async function createOriginalStackFrame({
} }
} }
function getOverlayMiddleware(options: OverlayMiddlewareOptions) { export async function getSourceById(
async function getSourceById( isFile: boolean,
isServerSide: boolean, id: string,
isFile: boolean, compilation: any,
id: string isWebpack5: boolean
): Promise<Source> { ): Promise<Source> {
if (isFile) { if (isFile) {
const fileContent: string | null = await fs const fileContent: string | null = await fs
.readFile(id, 'utf-8') .readFile(id, 'utf-8')
.catch(() => null) .catch(() => null)
if (fileContent == null) { if (fileContent == null) {
return null return null
} }
const map = getRawSourceMap(fileContent)
if (map == null) {
return null
}
return { const map = getRawSourceMap(fileContent)
map() { if (map == null) {
return map return null
},
}
} }
try { return {
const compilation = isServerSide map() {
? options.serverStats()?.compilation return map
: options.stats()?.compilation },
if (compilation == null) { }
return null }
}
const module = [...compilation.modules].find( try {
(searchModule) => if (compilation == null) {
getModuleId(compilation, searchModule, options.isWebpack5) === id
)
return getModuleSource(compilation, module, options.isWebpack5)
} catch (err) {
console.error(`Failed to lookup module by ID ("${id}"):`, err)
return null return null
} }
const module = [...compilation.modules].find(
(searchModule) =>
getModuleId(compilation, searchModule, isWebpack5) === id
)
return getModuleSource(compilation, module, isWebpack5)
} catch (err) {
console.error(`Failed to lookup module by ID ("${id}"):`, err)
return null
} }
}
function getOverlayMiddleware(options: OverlayMiddlewareOptions) {
return async function ( return async function (
req: IncomingMessage, req: IncomingMessage,
res: ServerResponse, res: ServerResponse,
...@@ -254,10 +252,15 @@ function getOverlayMiddleware(options: OverlayMiddlewareOptions) { ...@@ -254,10 +252,15 @@ function getOverlayMiddleware(options: OverlayMiddlewareOptions) {
let source: Source let source: Source
try { try {
const compilation = isServerSide
? options.serverStats()?.compilation
: options.stats()?.compilation
source = await getSourceById( source = await getSourceById(
isServerSide,
frame.file.startsWith('file:'), frame.file.startsWith('file:'),
moduleId moduleId,
compilation,
!!options.isWebpack5
) )
} catch (err) { } catch (err) {
console.log('Failed to get source map:', err) console.log('Failed to get source map:', err)
......
...@@ -109,14 +109,24 @@ function runTests(dev = false) { ...@@ -109,14 +109,24 @@ function runTests(dev = false) {
const res = await fetchViaHTTP(appPort, '/api/user-error', null, {}) const res = await fetchViaHTTP(appPort, '/api/user-error', null, {})
const text = await res.text() const text = await res.text()
expect(res.status).toBe(500) expect(res.status).toBe(500)
expect(text).toBe('Internal Server Error')
if (dev) {
expect(text).toContain('User error')
} else {
expect(text).toBe('Internal Server Error')
}
}) })
it('should throw Internal Server Error (async)', async () => { it('should throw Internal Server Error (async)', async () => {
const res = await fetchViaHTTP(appPort, '/api/user-error-async', null, {}) const res = await fetchViaHTTP(appPort, '/api/user-error-async', null, {})
const text = await res.text() const text = await res.text()
expect(res.status).toBe(500) expect(res.status).toBe(500)
expect(text).toBe('Internal Server Error')
if (dev) {
expect(text).toContain('User error')
} else {
expect(text).toBe('Internal Server Error')
}
}) })
it('should parse JSON body', async () => { it('should parse JSON body', async () => {
......
export default function handler(req, res) {
res.status(200).json({ slug: req.query.slug })
}
export default function handler(req, res) {
res.status(200).json({ hello: 'world' })
}
export default function Page() {
return <p>dynamic getServerSideProps page</p>
}
export async function getServerSideProps() {
return {
props: {},
}
}
export default function Page() {
return <p>getStaticProps page</p>
}
export async function getStaticProps() {
return {
props: {},
}
}
export default function Page() {
return <p>getServerSideProps page</p>
}
export async function getServerSideProps() {
return {
props: {},
}
}
export default function Page() {
return <p>getServerSideProps page</p>
}
export async function getServerSideProps() {
setTimeout(() => {
throw new Error('catch this exception')
}, 10)
return {
props: {},
}
}
export default function Page() {
return <p>getServerSideProps page</p>
}
export async function getServerSideProps() {
setTimeout(() => {
Promise.reject(new Error('catch this rejection'))
}, 10)
return {
props: {},
}
}
/* eslint-env jest */
import fs from 'fs-extra'
import { join } from 'path'
import webdriver from 'next-webdriver'
import {
killApp,
findPort,
launchApp,
check,
hasRedbox,
getRedboxSource,
} from 'next-test-utils'
jest.setTimeout(1000 * 60 * 2)
const appDir = join(__dirname, '../')
const gspPage = join(appDir, 'pages/gsp.js')
const gsspPage = join(appDir, 'pages/gssp.js')
const dynamicGsspPage = join(appDir, 'pages/blog/[slug].js')
const apiPage = join(appDir, 'pages/api/hello.js')
const dynamicApiPage = join(appDir, 'pages/api/blog/[slug].js')
let stderr = ''
let appPort
let app
describe('server-side dev errors', () => {
beforeAll(async () => {
appPort = await findPort()
app = await launchApp(appDir, appPort, {
onStderr(msg) {
stderr += msg
},
env: {
__NEXT_TEST_WITH_DEVTOOL: 1,
},
})
})
afterAll(() => killApp(app))
it('should show server-side error for gsp page correctly', async () => {
const content = await fs.readFile(gspPage, 'utf8')
try {
const stderrIdx = stderr.length
await fs.writeFile(
gspPage,
content.replace('return {', 'missingVar;return {')
)
const browser = await webdriver(appPort, '/gsp')
await check(async () => {
const err = stderr.substr(stderrIdx)
return err.includes('pages/gsp.js') &&
err.includes('6:2') &&
err.includes('getStaticProps') &&
err.includes('missingVar')
? 'success'
: err
}, 'success')
expect(await hasRedbox(browser, true)).toBe(true)
expect(await getRedboxSource(browser)).toContain('missingVar')
await fs.writeFile(gspPage, content)
await hasRedbox(browser, false)
} finally {
await fs.writeFile(gspPage, content)
}
})
it('should show server-side error for gssp page correctly', async () => {
const content = await fs.readFile(gsspPage, 'utf8')
try {
const stderrIdx = stderr.length
await fs.writeFile(
gsspPage,
content.replace('return {', 'missingVar;return {')
)
const browser = await webdriver(appPort, '/gssp')
await check(async () => {
const err = stderr.substr(stderrIdx)
return err.includes('pages/gssp.js') &&
err.includes('6:2') &&
err.includes('getServerSideProps') &&
err.includes('missingVar')
? 'success'
: err
}, 'success')
expect(await hasRedbox(browser, true)).toBe(true)
expect(await getRedboxSource(browser)).toContain('missingVar')
await fs.writeFile(gsspPage, content)
await hasRedbox(browser, false)
} finally {
await fs.writeFile(gsspPage, content)
}
})
it('should show server-side error for dynamic gssp page correctly', async () => {
const content = await fs.readFile(dynamicGsspPage, 'utf8')
try {
const stderrIdx = stderr.length
await fs.writeFile(
dynamicGsspPage,
content.replace('return {', 'missingVar;return {')
)
const browser = await webdriver(appPort, '/blog/first')
await check(async () => {
const err = stderr.substr(stderrIdx)
return err.includes('pages/blog/[slug].js') &&
err.includes('6:2') &&
err.includes('getServerSideProps') &&
err.includes('missingVar')
? 'success'
: err
}, 'success')
expect(await hasRedbox(browser, true)).toBe(true)
expect(await getRedboxSource(browser)).toContain('missingVar')
await fs.writeFile(dynamicGsspPage, content)
await hasRedbox(browser, false)
} finally {
await fs.writeFile(dynamicGsspPage, content)
}
})
it('should show server-side error for api route correctly', async () => {
const content = await fs.readFile(apiPage, 'utf8')
try {
const stderrIdx = stderr.length
await fs.writeFile(
apiPage,
content.replace('res.status', 'missingVar;res.status')
)
const browser = await webdriver(appPort, '/api/hello')
await check(async () => {
const err = stderr.substr(stderrIdx)
return err.includes('pages/api/hello.js') &&
err.includes('2:2') &&
err.includes('default') &&
err.includes('missingVar')
? 'success'
: err
}, 'success')
expect(await hasRedbox(browser, true)).toBe(true)
expect(await getRedboxSource(browser)).toContain('missingVar')
await fs.writeFile(apiPage, content)
await hasRedbox(browser, false)
} finally {
await fs.writeFile(apiPage, content)
}
})
it('should show server-side error for dynamic api route correctly', async () => {
const content = await fs.readFile(dynamicApiPage, 'utf8')
try {
const stderrIdx = stderr.length
await fs.writeFile(
dynamicApiPage,
content.replace('res.status', 'missingVar;res.status')
)
const browser = await webdriver(appPort, '/api/blog/first')
await check(async () => {
const err = stderr.substr(stderrIdx)
return err.includes('pages/api/blog/[slug].js') &&
err.includes('2:2') &&
err.includes('default') &&
err.includes('missingVar')
? 'success'
: err
}, 'success')
expect(await hasRedbox(browser, true)).toBe(true)
expect(await getRedboxSource(browser)).toContain('missingVar')
await fs.writeFile(dynamicApiPage, content)
await hasRedbox(browser, false)
} finally {
await fs.writeFile(dynamicApiPage, content)
}
})
it('should show server-side error for uncaught rejection correctly', async () => {
const stderrIdx = stderr.length
await webdriver(appPort, '/uncaught-rejection')
await check(async () => {
const err = stderr.substr(stderrIdx)
return err.includes('pages/uncaught-rejection.js') &&
err.includes('7:19') &&
err.includes('getServerSideProps') &&
err.includes('catch this rejection')
? 'success'
: err
}, 'success')
})
it('should show server-side error for uncaught exception correctly', async () => {
const stderrIdx = stderr.length
await webdriver(appPort, '/uncaught-exception')
await check(async () => {
const err = stderr.substr(stderrIdx)
return err.includes('pages/uncaught-exception.js') &&
err.includes('7:10') &&
err.includes('getServerSideProps') &&
err.includes('catch this exception')
? 'success'
: err
}, 'success')
})
})
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