Unverified Commit 04c2509d authored by Hannes Bornö's avatar Hannes Bornö Committed by GitHub

Fast refresh should recover from event handler errors in app dir (#43882)

Component state should not be lost due to a full reload after an error occurs in an event handler. Only do a full reload if an error was caught by the error overlay error boundary.

Closes NEXT-182

## Bug

- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Errors have a helpful link attached, see [`contributing.md`](https://github.com/vercel/next.js/blob/canary/contributing.md)

## Feature

- [ ] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR.
- [ ] Related issues linked using `fixes #number`
- [ ] [e2e](https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs) tests added
- [ ] Documentation added
- [ ] Telemetry added. In case of a feature if it's used or not.
- [ ] Errors have a helpful link attached, see [`contributing.md`](https://github.com/vercel/next.js/blob/canary/contributing.md)

## Documentation / Examples

- [ ] Make sure the linting passes by running `pnpm build && pnpm lint`
- [ ] The "examples guidelines" are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md)
parent a34b20e6
...@@ -435,6 +435,9 @@ export default function HotReload({ ...@@ -435,6 +435,9 @@ export default function HotReload({
frames: parseStack(reason.stack!), frames: parseStack(reason.stack!),
}) })
}, []) }, [])
const handleOnReactError = useCallback(() => {
RuntimeErrorHandler.hadRuntimeError = true
}, [])
useErrorHandler(handleOnUnhandledError, handleOnUnhandledRejection) useErrorHandler(handleOnUnhandledError, handleOnUnhandledRejection)
const webSocketRef = useWebsocket(assetPrefix) const webSocketRef = useWebsocket(assetPrefix)
...@@ -467,5 +470,9 @@ export default function HotReload({ ...@@ -467,5 +470,9 @@ export default function HotReload({
return () => websocket && websocket.removeEventListener('message', handler) return () => websocket && websocket.removeEventListener('message', handler)
}, [sendMessage, router, webSocketRef, dispatcher]) }, [sendMessage, router, webSocketRef, dispatcher])
return <ReactDevOverlay state={state}>{children}</ReactDevOverlay> return (
<ReactDevOverlay onReactError={handleOnReactError} state={state}>
{children}
</ReactDevOverlay>
)
} }
...@@ -21,6 +21,7 @@ class ReactDevOverlay extends React.PureComponent< ...@@ -21,6 +21,7 @@ class ReactDevOverlay extends React.PureComponent<
{ {
state: OverlayState state: OverlayState
children: React.ReactNode children: React.ReactNode
onReactError: (error: Error) => void
}, },
ReactDevOverlayState ReactDevOverlayState
> { > {
...@@ -40,6 +41,10 @@ class ReactDevOverlay extends React.PureComponent< ...@@ -40,6 +41,10 @@ class ReactDevOverlay extends React.PureComponent<
return { reactError: errorEvent } return { reactError: errorEvent }
} }
componentDidCatch(componentErr: Error) {
this.props.onReactError(componentErr)
}
render() { render() {
const { state, children } = this.props const { state, children } = this.props
const { reactError } = this.state const { reactError } = this.state
......
...@@ -44,8 +44,6 @@ if (typeof window !== 'undefined') { ...@@ -44,8 +44,6 @@ if (typeof window !== 'undefined') {
return return
} }
RuntimeErrorHandler.hadRuntimeError = true
const error = ev?.error const error = ev?.error
if ( if (
!error || !error ||
...@@ -69,8 +67,6 @@ if (typeof window !== 'undefined') { ...@@ -69,8 +67,6 @@ if (typeof window !== 'undefined') {
window.addEventListener( window.addEventListener(
'unhandledrejection', 'unhandledrejection',
(ev: WindowEventMap['unhandledrejection']): void => { (ev: WindowEventMap['unhandledrejection']): void => {
RuntimeErrorHandler.hadRuntimeError = true
const reason = ev?.reason const reason = ev?.reason
if ( if (
!reason || !reason ||
......
...@@ -114,8 +114,7 @@ describe('ReactRefreshLogBox app', () => { ...@@ -114,8 +114,7 @@ describe('ReactRefreshLogBox app', () => {
await cleanup() await cleanup()
}) })
// TODO-APP: re-enable when error recovery doesn't reload the page. test('logbox: can recover from a event handler error', async () => {
test.skip('logbox: can recover from a event handler error', async () => {
const { session, cleanup } = await sandbox(next) const { session, cleanup } = await sandbox(next)
await session.patch( await session.patch(
...@@ -147,7 +146,7 @@ describe('ReactRefreshLogBox app', () => { ...@@ -147,7 +146,7 @@ describe('ReactRefreshLogBox app', () => {
await session.evaluate(() => document.querySelector('p').textContent) await session.evaluate(() => document.querySelector('p').textContent)
).toBe('1') ).toBe('1')
expect(await session.hasRedbox(true)).toBe(true) await session.waitForAndOpenRuntimeError()
if (process.platform === 'win32') { if (process.platform === 'win32') {
expect(await session.getRedboxSource()).toMatchSnapshot() expect(await session.getRedboxSource()).toMatchSnapshot()
} else { } else {
...@@ -173,6 +172,7 @@ describe('ReactRefreshLogBox app', () => { ...@@ -173,6 +172,7 @@ describe('ReactRefreshLogBox app', () => {
) )
expect(await session.hasRedbox()).toBe(false) expect(await session.hasRedbox()).toBe(false)
expect(await session.hasErrorToast()).toBe(false)
expect( expect(
await session.evaluate(() => document.querySelector('p').textContent) await session.evaluate(() => document.querySelector('p').textContent)
...@@ -183,6 +183,7 @@ describe('ReactRefreshLogBox app', () => { ...@@ -183,6 +183,7 @@ describe('ReactRefreshLogBox app', () => {
).toBe('Count: 2') ).toBe('Count: 2')
expect(await session.hasRedbox()).toBe(false) expect(await session.hasRedbox()).toBe(false)
expect(await session.hasErrorToast()).toBe(false)
await cleanup() await cleanup()
}) })
......
...@@ -66,6 +66,18 @@ exports[`ReactRefreshLogBox app logbox: can recover from a component error 1`] = ...@@ -66,6 +66,18 @@ exports[`ReactRefreshLogBox app logbox: can recover from a component error 1`] =
6 | " 6 | "
`; `;
exports[`ReactRefreshLogBox app logbox: can recover from a event handler error 1`] = `
"index.js (8:18) @ eval
6 | const increment = useCallback(() => {
7 | setCount(c => c + 1)
> 8 | throw new Error('oops')
| ^
9 | }, [setCount])
10 | return (
11 | <main>"
`;
exports[`ReactRefreshLogBox app logbox: can recover from a syntax error without losing state 1`] = ` exports[`ReactRefreshLogBox app logbox: can recover from a syntax error without losing state 1`] = `
"./index.js "./index.js
Error: Error:
......
...@@ -100,6 +100,15 @@ export async function sandbox( ...@@ -100,6 +100,15 @@ export async function sandbox(
async hasRedbox(expected = false) { async hasRedbox(expected = false) {
return hasRedbox(browser, expected) return hasRedbox(browser, expected)
}, },
async hasErrorToast() {
return browser.eval(() => {
return Boolean(
Array.from(document.querySelectorAll('nextjs-portal')).find((p) =>
p.shadowRoot.querySelector('[data-nextjs-toast]')
)
)
})
},
async getRedboxDescription() { async getRedboxDescription() {
return getRedboxDescription(browser) return getRedboxDescription(browser)
}, },
......
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