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

Call Error.getInitialProps for the top level error #21240

Merged
merged 12 commits into from
Jul 6, 2022
Merged
2 changes: 1 addition & 1 deletion packages/next/client/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -521,7 +521,7 @@ function renderError(renderErrorProps: RenderErrorProps): Promise<any> {
},
}
return Promise.resolve(
renderErrorProps.props
renderErrorProps.props?.err
? renderErrorProps.props
: loadGetInitialProps(App, appCtx)
).then((initProps) =>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
const Error = ({ message }) => {
return <p id="error-p">Error Rendered with: {message}</p>
}

Error.getInitialProps = ({ err }) => {
return {
message: err && err.message,
}
}

export default Error
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
if (typeof window !== 'undefined') {
throw new Error('top level error')
}

const Page = () => 'page'

export default Page
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
/* eslint-env jest */

import { nextBuild, nextServer, startApp, stopApp } from 'next-test-utils'
import webdriver from 'next-webdriver'
import { join } from 'path'

jest.setTimeout(1000 * 60 * 2)

let appPort
let app
let server

describe('Top Level Error', () => {
beforeAll(async () => {
const appDir = join(__dirname, '../')
await nextBuild(appDir)
app = nextServer({
dir: appDir,
dev: false,
quiet: true,
})

server = await startApp(app)
appPort = server.address().port
})
afterAll(() => stopApp(server))

it('should render error page with getInitialProps', async () => {
const browser = await webdriver(appPort, '/')
try {
const text = await browser.waitForElementByCss('#error-p').text()
expect(text).toBe('Error Rendered with: top level error')
} finally {
await browser.close()
}
})
})
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
const Error = () => {
return <p id="error-p">Error Rendered</p>
}

export default Error
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
if (typeof window !== 'undefined') {
throw new Error('top level error')
}

const Page = () => 'page'

export default Page
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
/* eslint-env jest */

import { nextBuild, nextServer, startApp, stopApp } from 'next-test-utils'
import webdriver from 'next-webdriver'
import { join } from 'path'

jest.setTimeout(1000 * 60 * 2)

let appPort
let app
let server

describe('Top Level Error', () => {
beforeAll(async () => {
const appDir = join(__dirname, '../')
await nextBuild(appDir)
app = nextServer({
dir: appDir,
dev: false,
quiet: true,
})

server = await startApp(app)
appPort = server.address().port
})
afterAll(() => stopApp(server))

it('should render error page', async () => {
const browser = await webdriver(appPort, '/')
try {
const text = await browser.waitForElementByCss('#error-p').text()
expect(text).toBe('Error Rendered')
} finally {
await browser.close()
}
})
})