Unverified Commit 9d13b676 authored by Jiwon Choi's avatar Jiwon Choi Committed by GitHub

Add `unstable_retry()` to error.js (#89685)

Extends the error components API to give better control over recovery.
Previously, the `reset()` prop only cleared the error state and
re-rendered the children. However, this only handles a temporary
rendering error.

The error can be due to data fetching or an RSC phase. In these cases,
`reset()` alone is not sufficient. Users would even need to implement
retry logic using `router.refresh()`.

Therefore, this PR adds a new `unstable_retry()` prop that calls
`router.refresh()` and `reset()` within a `startTransition()` to provide
built-in retry logic. This feature is expected to be preferred over the
`reset()` prop. Only the cases where you'd choose `reset()` are when you
have a reason to do a sync reset without loading any new data.

Closes NAR-767
parent 2ba73b7a
'use client' 'use client'
import React from 'react'
import { HandleISRError } from '../handle-isr-error' import { HandleISRError } from '../handle-isr-error'
import { errorStyles, errorThemeCss, ErrorIcon } from './error-styles' import { errorStyles, errorThemeCss, ErrorIcon } from './error-styles'
export type GlobalErrorComponent = React.ComponentType<{ export type GlobalErrorComponent = React.ComponentType<{
error: any error: any
reset: () => void reset: () => void
unstable_retry: () => void
}> }>
function DefaultGlobalError({ error }: { error: any }) { function DefaultGlobalError({ error }: { error: any }) {
......
'use client' 'use client'
import React, { type JSX } from 'react' import React, { startTransition, type JSX } from 'react'
import { useUntrackedPathname } from './navigation-untracked' import { useUntrackedPathname } from './navigation-untracked'
import { isNextRouterError } from './is-next-router-error' import { isNextRouterError } from './is-next-router-error'
import { handleHardNavError } from './nav-failure-handler' import { handleHardNavError } from './nav-failure-handler'
import { HandleISRError } from './handle-isr-error' import { HandleISRError } from './handle-isr-error'
import { isBot } from '../../shared/lib/router/utils/is-bot' import { isBot } from '../../shared/lib/router/utils/is-bot'
import {
AppRouterContext,
type AppRouterInstance,
} from '../../shared/lib/app-router-context.shared-runtime'
const isBotUserAgent = const isBotUserAgent =
typeof window !== 'undefined' && isBot(window.navigator.userAgent) typeof window !== 'undefined' && isBot(window.navigator.userAgent)
...@@ -13,6 +17,7 @@ const isBotUserAgent = ...@@ -13,6 +17,7 @@ const isBotUserAgent =
export type ErrorComponent = React.ComponentType<{ export type ErrorComponent = React.ComponentType<{
error: Error error: Error
reset: () => void reset: () => void
unstable_retry: () => void
}> }>
export interface ErrorBoundaryProps { export interface ErrorBoundaryProps {
...@@ -36,9 +41,15 @@ export class ErrorBoundaryHandler extends React.Component< ...@@ -36,9 +41,15 @@ export class ErrorBoundaryHandler extends React.Component<
ErrorBoundaryHandlerProps, ErrorBoundaryHandlerProps,
ErrorBoundaryHandlerState ErrorBoundaryHandlerState
> { > {
static contextType = AppRouterContext
declare context: AppRouterInstance | null
constructor(props: ErrorBoundaryHandlerProps) { constructor(props: ErrorBoundaryHandlerProps) {
super(props) super(props)
this.state = { error: null, previousPathname: this.props.pathname } this.state = {
error: null,
previousPathname: this.props.pathname,
}
} }
static getDerivedStateFromError(error: Error) { static getDerivedStateFromError(error: Error) {
...@@ -93,6 +104,13 @@ export class ErrorBoundaryHandler extends React.Component< ...@@ -93,6 +104,13 @@ export class ErrorBoundaryHandler extends React.Component<
this.setState({ error: null }) this.setState({ error: null })
} }
unstable_retry = () => {
startTransition(() => {
this.context?.refresh()
this.reset()
})
}
// Explicit type is needed to avoid the generated `.d.ts` having a wide return type that could be specific to the `@types/react` version. // Explicit type is needed to avoid the generated `.d.ts` having a wide return type that could be specific to the `@types/react` version.
render(): React.ReactNode { render(): React.ReactNode {
//When it's bot request, segment level error boundary will keep rendering the children, //When it's bot request, segment level error boundary will keep rendering the children,
...@@ -106,6 +124,7 @@ export class ErrorBoundaryHandler extends React.Component< ...@@ -106,6 +124,7 @@ export class ErrorBoundaryHandler extends React.Component<
<this.props.errorComponent <this.props.errorComponent
error={this.state.error} error={this.state.error}
reset={this.reset} reset={this.reset}
unstable_retry={this.unstable_retry}
/> />
</> </>
) )
......
import { PureComponent } from 'react' import React, { PureComponent, startTransition } from 'react'
import { dispatcher } from 'next/dist/compiled/next-devtools' import { dispatcher } from 'next/dist/compiled/next-devtools'
import { RuntimeErrorHandler } from '../../../client/dev/runtime-error-handler' import { RuntimeErrorHandler } from '../../../client/dev/runtime-error-handler'
import { ErrorBoundary } from '../../../client/components/error-boundary' import { ErrorBoundary } from '../../../client/components/error-boundary'
import DefaultGlobalError from '../../../client/components/builtin/global-error' import DefaultGlobalError from '../../../client/components/builtin/global-error'
import type { GlobalErrorState } from '../../../client/components/app-router-instance' import type { GlobalErrorState } from '../../../client/components/app-router-instance'
import { SEGMENT_EXPLORER_SIMULATED_ERROR_MESSAGE } from './segment-explorer-node' import { SEGMENT_EXPLORER_SIMULATED_ERROR_MESSAGE } from './segment-explorer-node'
import {
AppRouterContext,
type AppRouterInstance,
} from '../../../shared/lib/app-router-context.shared-runtime'
type AppDevOverlayErrorBoundaryProps = { type AppDevOverlayErrorBoundaryProps = {
children: React.ReactNode children: React.ReactNode
...@@ -19,10 +23,12 @@ function ErroredHtml({ ...@@ -19,10 +23,12 @@ function ErroredHtml({
globalError: [GlobalError, globalErrorStyles], globalError: [GlobalError, globalErrorStyles],
error, error,
reset, reset,
unstable_retry,
}: { }: {
globalError: GlobalErrorState globalError: GlobalErrorState
error: unknown error: unknown
reset: () => void reset: () => void
unstable_retry: () => void
}) { }) {
if (!error) { if (!error) {
return ( return (
...@@ -35,7 +41,11 @@ function ErroredHtml({ ...@@ -35,7 +41,11 @@ function ErroredHtml({
return ( return (
<ErrorBoundary errorComponent={DefaultGlobalError}> <ErrorBoundary errorComponent={DefaultGlobalError}>
{globalErrorStyles} {globalErrorStyles}
<GlobalError error={error} reset={reset} /> <GlobalError
error={error}
reset={reset}
unstable_retry={unstable_retry}
/>
</ErrorBoundary> </ErrorBoundary>
) )
} }
...@@ -44,7 +54,12 @@ export class AppDevOverlayErrorBoundary extends PureComponent< ...@@ -44,7 +54,12 @@ export class AppDevOverlayErrorBoundary extends PureComponent<
AppDevOverlayErrorBoundaryProps, AppDevOverlayErrorBoundaryProps,
AppDevOverlayErrorBoundaryState AppDevOverlayErrorBoundaryState
> { > {
state = { reactError: null } static contextType = AppRouterContext
declare context: AppRouterInstance | null
state: AppDevOverlayErrorBoundaryState = {
reactError: null,
}
static getDerivedStateFromError(error: Error) { static getDerivedStateFromError(error: Error) {
RuntimeErrorHandler.hadRuntimeError = true RuntimeErrorHandler.hadRuntimeError = true
...@@ -64,6 +79,13 @@ export class AppDevOverlayErrorBoundary extends PureComponent< ...@@ -64,6 +79,13 @@ export class AppDevOverlayErrorBoundary extends PureComponent<
dispatcher.openErrorOverlay() dispatcher.openErrorOverlay()
} }
unstable_retry = () => {
startTransition(() => {
this.context?.refresh()
this.reset()
})
}
reset = () => { reset = () => {
this.setState({ reactError: null }) this.setState({ reactError: null })
} }
...@@ -77,6 +99,7 @@ export class AppDevOverlayErrorBoundary extends PureComponent< ...@@ -77,6 +99,7 @@ export class AppDevOverlayErrorBoundary extends PureComponent<
globalError={globalError} globalError={globalError}
error={reactError} error={reactError}
reset={this.reset} reset={this.reset}
unstable_retry={this.unstable_retry}
/> />
) )
......
...@@ -2,13 +2,20 @@ ...@@ -2,13 +2,20 @@
import styles from './style.module.css' import styles from './style.module.css'
export default function ErrorBoundary({ error, reset }) { export default function ErrorBoundary({ error, reset, unstable_retry }) {
return ( return (
<> <>
<p id="error-boundary-message">An error occurred: {error.message}</p> <p id="error-boundary-message">An error occurred: {error.message}</p>
<button id="reset" onClick={() => reset()} className={styles.button}> <button id="reset" onClick={() => reset()} className={styles.button}>
Try again Try again
</button> </button>
<button
id="retry"
onClick={() => unstable_retry()}
className={styles.button}
>
Retry
</button>
</> </>
) )
} }
'use client' 'use client'
export default function ErrorBoundary({ error, reset }) { export default function ErrorBoundary({ error, reset, unstable_retry }) {
return ( return (
<> <>
<p id="error-boundary-message">{error.message}</p> <p id="error-boundary-message">{error.message}</p>
...@@ -8,6 +8,9 @@ export default function ErrorBoundary({ error, reset }) { ...@@ -8,6 +8,9 @@ export default function ErrorBoundary({ error, reset }) {
<button id="reset" onClick={() => reset()}> <button id="reset" onClick={() => reset()}>
Try again Try again
</button> </button>
<button id="retry" onClick={() => unstable_retry()}>
Retry
</button>
</> </>
) )
} }
import { Suspense } from 'react'
import { connection } from 'next/server'
export default function Page() {
return (
<Suspense>
<Container>
<Content />
</Container>
</Suspense>
)
}
function Container({ children }) {
return <div>{children}</div>
}
async function Content() {
await connection()
if (!globalThis.__nextTestRecover) {
throw new Error('this is a test')
}
return <p id="recover">Recovered</p>
}
export function GET(request) {
const enabled = request.nextUrl.searchParams.get('enabled') !== 'false'
globalThis.__nextTestRecover = enabled
return new Response('ok')
}
...@@ -325,5 +325,59 @@ describe('app-dir - errors', () => { ...@@ -325,5 +325,59 @@ describe('app-dir - errors', () => {
expect(output).toContain(`digest: '${digest}'`) expect(output).toContain(`digest: '${digest}'`)
}) })
} }
describe('unstable_retry', () => {
afterEach(async () => {
// Always restore __nextTestRecover so it doesn't leak between tests
await next.fetch('/server-component/recover/set-recover?enabled=false')
})
it('should recover Server Component error after unstable_retry', async () => {
const browser = await next.browser('/server-component/recover')
expect(
await browser.elementByCss('#error-boundary-message').text()
).toBe(
isNextDev
? 'this is a test'
: 'An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error.'
)
// Enable recovery via globalThis.__nextTestRecover
await next.fetch('/server-component/recover/set-recover')
await browser
.elementByCss('#retry')
.click()
.waitForElementByCss('#recover')
expect(await browser.elementByCss('#recover').text()).toBe('Recovered')
})
it('should recover Client Component error after unstable_retry', async () => {
const browser = await next.browser('/client-component')
// Try triggering and retrying a few times in a row
for (let i = 0; i < 5; i++) {
await browser
.elementByCss('#error-trigger-button')
.click()
.waitForElementByCss('#error-boundary-message')
expect(
await browser.elementByCss('#error-boundary-message').text()
).toBe('An error occurred: this is a test')
await browser
.elementByCss('#retry')
.click()
.waitForElementByCss('#error-trigger-button')
expect(
await browser.elementByCss('#error-trigger-button').text()
).toBe('Trigger Error!')
}
})
})
}) })
}) })
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