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

Skip client-side data-fetching after ssr error #51377

Merged
merged 11 commits into from
Feb 8, 2024
13 changes: 12 additions & 1 deletion packages/next/src/client/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ declare global {
type RenderRouteInfo = PrivateRouteInfo & {
App: AppComponent
scroll?: { x: number; y: number } | null
isHydratePass?: boolean
}
type RenderErrorProps = Omit<RenderRouteInfo, 'Component' | 'styleSheets'>
type RegisterFn = (input: [string, () => void]) => void
Expand Down Expand Up @@ -806,7 +807,16 @@ function doRender(input: RenderRouteInfo): Promise<any> {
}

async function render(renderingProps: RenderRouteInfo): Promise<void> {
if (renderingProps.err) {
// if an error occurs in a server-side page (e.g. in getInitialProps),
// skip re-rendering the error page client-side as data-fetching operations
// will already have been done on the server and NEXT_DATA contains the correct
// data for straight-forward hydration of the error page
if (
renderingProps.err &&
// renderingProps.Component might be undefined if there is a top/module-level error
(typeof renderingProps.Component === 'undefined' ||
!renderingProps.isHydratePass)
) {
await renderError(renderingProps)
return
}
Expand Down Expand Up @@ -975,6 +985,7 @@ export async function hydrate(opts?: { beforeRender?: () => Promise<void> }) {
Component: CachedComponent,
props: initialData.props,
err: initialErr,
isHydratePass: true,
}

if (opts?.beforeRender) {
Expand Down
95 changes: 95 additions & 0 deletions test/production/error-hydration/error-hydration.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
import { NextInstance, createNextDescribe } from 'e2e-utils'

async function setupErrorHydrationTests(
next: NextInstance,
targetPath: string
) {
const consoleMessages: string[] = []

const browser = await next.browser(targetPath, {
beforePageLoad(page) {
page.on('console', (event) => {
consoleMessages.push(event.text())
})
},
})

return [browser, consoleMessages] as const
}

createNextDescribe(
'error-hydration',
{
files: __dirname,
},
({ next }) => {
// Recommended for tests that need a full browser
it('should log no error messages for server-side errors', async () => {
const [, consoleMessages] = await setupErrorHydrationTests(
next,
'/with-error'
)

expect(
consoleMessages.find((message) =>
message.startsWith('A client-side exception has occurred')
)
).toBeUndefined()

expect(
consoleMessages.find(
(message) =>
message ===
'{name: Internal Server Error., message: 500 - Internal Server Error., statusCode: 500}'
)
).toBeUndefined()
})

it('should not invoke the error page getInitialProps client-side for server-side errors', async () => {
const [b] = await setupErrorHydrationTests(next, '/with-error')

expect(
await b.eval(
() =>
(window as any).__ERROR_PAGE_GET_INITIAL_PROPS_INVOKED_CLIENT_SIDE__
)
).toBe(undefined)
})

it('should log an message for client-side errors, including the full, custom error', async () => {
const [browser, consoleMessages] = await setupErrorHydrationTests(
next,
'/no-error'
)

const link = await browser.elementByCss('a')
await link.click()

expect(
consoleMessages.some((m) => m.includes('Error: custom error'))
).toBe(true)

expect(
consoleMessages.some((m) =>
m.includes(
'A client-side exception has occurred, see here for more info'
)
)
).toBe(true)
})

it("invokes _error's getInitialProps for client-side errors", async () => {
const [browser] = await setupErrorHydrationTests(next, '/no-error')

const link = await browser.elementByCss('a')
await link.click()

expect(
await browser.eval(
() =>
(window as any).__ERROR_PAGE_GET_INITIAL_PROPS_INVOKED_CLIENT_SIDE__
)
).toBe(true)
})
}
)
11 changes: 11 additions & 0 deletions test/production/error-hydration/pages/_error.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
export default function ErrorPage() {
return <div>Error Page Content</div>
}

ErrorPage.getInitialProps = async () => {
if (typeof window !== 'undefined') {
;(window as any).__ERROR_PAGE_GET_INITIAL_PROPS_INVOKED_CLIENT_SIDE__ = true
}

return {}
}
9 changes: 9 additions & 0 deletions test/production/error-hydration/pages/no-error.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import Link from 'next/link'

export default function Page() {
return (
<p>
<Link href="/with-error">click me</Link>
</p>
)
}
7 changes: 7 additions & 0 deletions test/production/error-hydration/pages/with-error.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
export default function Page() {
return <p>hello world</p>
}

Page.getInitialProps = () => {
throw new Error('custom error')
}