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

Minimized runtime errors in app dir (#43511)

Currently when there's a runtime error - the error overlay opens up in
full screen mode. In app it should open in the minimized state.

Build errors will still have to open up in full screen since the app
will not be runnable due to it being broken.

Before

![image](https://user-images.githubusercontent.com/25056922/204551137-5a72c4b9-5340-49d7-8369-9087a7830732.png)

After

![image](https://user-images.githubusercontent.com/25056922/204550919-503a0dc5-1c36-4965-818e-c97e455f73bf.png)


Fixes #43460

## 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 1c89da60
...@@ -106,6 +106,7 @@ function performFullReload(err: any, sendMessage: any) { ...@@ -106,6 +106,7 @@ function performFullReload(err: any, sendMessage: any) {
JSON.stringify({ JSON.stringify({
event: 'client-full-reload', event: 'client-full-reload',
stackTrace, stackTrace,
hadRuntimeError: !!RuntimeErrorHandler.hadRuntimeError,
}) })
) )
......
...@@ -139,7 +139,7 @@ export const Errors: React.FC<ErrorsProps> = function Errors({ errors }) { ...@@ -139,7 +139,7 @@ export const Errors: React.FC<ErrorsProps> = function Errors({ errors }) {
const [displayState, setDisplayState] = React.useState< const [displayState, setDisplayState] = React.useState<
'minimized' | 'fullscreen' | 'hidden' 'minimized' | 'fullscreen' | 'hidden'
>('fullscreen') >('minimized')
const [activeIdx, setActiveIndex] = React.useState<number>(0) const [activeIdx, setActiveIndex] = React.useState<number>(0)
const previous = React.useCallback((e?: MouseEvent | TouchEvent) => { const previous = React.useCallback((e?: MouseEvent | TouchEvent) => {
e?.preventDefault() e?.preventDefault()
......
...@@ -49,7 +49,7 @@ describe('ReactRefreshLogBox app', () => { ...@@ -49,7 +49,7 @@ describe('ReactRefreshLogBox app', () => {
) )
await session.evaluate(() => document.querySelector('a').click()) await session.evaluate(() => document.querySelector('a').click())
expect(await session.hasRedbox(true)).toBe(true) await session.waitForAndOpenRuntimeError()
expect(await session.getRedboxSource()).toMatchSnapshot() expect(await session.getRedboxSource()).toMatchSnapshot()
await cleanup() await cleanup()
...@@ -228,7 +228,7 @@ describe('ReactRefreshLogBox app', () => { ...@@ -228,7 +228,7 @@ describe('ReactRefreshLogBox app', () => {
` `
) )
expect(await session.hasRedbox(true)).toBe(true) await session.waitForAndOpenRuntimeError()
expect(await session.getRedboxSource()).toMatchSnapshot() expect(await session.getRedboxSource()).toMatchSnapshot()
// TODO-APP: re-enable when error recovery doesn't reload the page. // TODO-APP: re-enable when error recovery doesn't reload the page.
...@@ -325,7 +325,7 @@ describe('ReactRefreshLogBox app', () => { ...@@ -325,7 +325,7 @@ describe('ReactRefreshLogBox app', () => {
export default ClassDefault; export default ClassDefault;
` `
) )
expect(await session.hasRedbox(true)).toBe(true) await session.waitForAndOpenRuntimeError()
expect(await session.getRedboxSource()).toMatchSnapshot() expect(await session.getRedboxSource()).toMatchSnapshot()
await cleanup() await cleanup()
...@@ -370,7 +370,7 @@ describe('ReactRefreshLogBox app', () => { ...@@ -370,7 +370,7 @@ describe('ReactRefreshLogBox app', () => {
` `
) )
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 {
...@@ -423,7 +423,7 @@ describe('ReactRefreshLogBox app', () => { ...@@ -423,7 +423,7 @@ describe('ReactRefreshLogBox app', () => {
) )
// We get an error because Foo didn't import React. Fair. // We get an error because Foo didn't import React. Fair.
expect(await session.hasRedbox(true)).toBe(true) await session.waitForAndOpenRuntimeError()
expect(await session.getRedboxSource()).toMatchSnapshot() expect(await session.getRedboxSource()).toMatchSnapshot()
// Let's add that to Foo. // Let's add that to Foo.
...@@ -475,7 +475,7 @@ describe('ReactRefreshLogBox app', () => { ...@@ -475,7 +475,7 @@ describe('ReactRefreshLogBox app', () => {
) )
await new Promise((resolve) => setTimeout(resolve, 1000)) await new Promise((resolve) => setTimeout(resolve, 1000))
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 {
...@@ -562,7 +562,7 @@ describe('ReactRefreshLogBox app', () => { ...@@ -562,7 +562,7 @@ describe('ReactRefreshLogBox app', () => {
`export default function FunctionDefault() { throw new Error('no'); }` `export default function FunctionDefault() { throw new Error('no'); }`
) )
expect(await session.hasRedbox(true)).toBe(true) await session.waitForAndOpenRuntimeError()
expect(await session.getRedboxSource()).toMatchSnapshot() expect(await session.getRedboxSource()).toMatchSnapshot()
expect( expect(
await session.evaluate(() => document.querySelector('h2').textContent) await session.evaluate(() => document.querySelector('h2').textContent)
...@@ -664,7 +664,7 @@ describe('ReactRefreshLogBox app', () => { ...@@ -664,7 +664,7 @@ describe('ReactRefreshLogBox app', () => {
` `
) )
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)
).toBe('hello') ).toBe('hello')
...@@ -681,7 +681,7 @@ describe('ReactRefreshLogBox app', () => { ...@@ -681,7 +681,7 @@ describe('ReactRefreshLogBox app', () => {
` `
) )
expect(await session.hasRedbox(true)).toBe(true) await session.waitForAndOpenRuntimeError()
expect(await session.getRedboxSource()).toMatchSnapshot() expect(await session.getRedboxSource()).toMatchSnapshot()
await session.patch( await session.patch(
...@@ -764,9 +764,9 @@ describe('ReactRefreshLogBox app', () => { ...@@ -764,9 +764,9 @@ describe('ReactRefreshLogBox app', () => {
` `
) )
expect(await session.hasRedbox()).toBe(false) expect(await session.hasErrorToast()).toBe(false)
await session.evaluate(() => document.querySelector('button').click()) await session.evaluate(() => document.querySelector('button').click())
expect(await session.hasRedbox(true)).toBe(true) await session.waitForAndOpenRuntimeError()
const header = await session.getRedboxDescription() const header = await session.getRedboxDescription()
expect(header).toMatchSnapshot() expect(header).toMatchSnapshot()
...@@ -810,9 +810,9 @@ describe('ReactRefreshLogBox app', () => { ...@@ -810,9 +810,9 @@ describe('ReactRefreshLogBox app', () => {
` `
) )
expect(await session.hasRedbox()).toBe(false) expect(await session.hasErrorToast()).toBe(false)
await session.evaluate(() => document.querySelector('button').click()) await session.evaluate(() => document.querySelector('button').click())
expect(await session.hasRedbox(true)).toBe(true) await session.waitForAndOpenRuntimeError()
const header2 = await session.getRedboxDescription() const header2 = await session.getRedboxDescription()
expect(header2).toMatchSnapshot() expect(header2).toMatchSnapshot()
...@@ -856,9 +856,9 @@ describe('ReactRefreshLogBox app', () => { ...@@ -856,9 +856,9 @@ describe('ReactRefreshLogBox app', () => {
` `
) )
expect(await session.hasRedbox()).toBe(false) expect(await session.hasErrorToast()).toBe(false)
await session.evaluate(() => document.querySelector('button').click()) await session.evaluate(() => document.querySelector('button').click())
expect(await session.hasRedbox(true)).toBe(true) await session.waitForAndOpenRuntimeError()
const header3 = await session.getRedboxDescription() const header3 = await session.getRedboxDescription()
expect(header3).toMatchSnapshot() expect(header3).toMatchSnapshot()
...@@ -902,9 +902,9 @@ describe('ReactRefreshLogBox app', () => { ...@@ -902,9 +902,9 @@ describe('ReactRefreshLogBox app', () => {
` `
) )
expect(await session.hasRedbox()).toBe(false) expect(await session.hasErrorToast()).toBe(false)
await session.evaluate(() => document.querySelector('button').click()) await session.evaluate(() => document.querySelector('button').click())
expect(await session.hasRedbox(true)).toBe(true) await session.waitForAndOpenRuntimeError()
const header4 = await session.getRedboxDescription() const header4 = await session.getRedboxDescription()
expect(header4).toMatchInlineSnapshot( expect(header4).toMatchInlineSnapshot(
......
...@@ -280,7 +280,7 @@ describe('ReactRefreshRegression app', () => { ...@@ -280,7 +280,7 @@ describe('ReactRefreshRegression app', () => {
await browser.refresh() await browser.refresh()
expect(await session.hasRedbox(true)).toBe(true) await session.waitForAndOpenRuntimeError()
const source = await session.getRedboxSource() const source = await session.getRedboxSource()
expect(source.split(/\r?\n/g).slice(2).join('\n')).toMatchInlineSnapshot(` expect(source.split(/\r?\n/g).slice(2).join('\n')).toMatchInlineSnapshot(`
...@@ -301,7 +301,7 @@ describe('ReactRefreshRegression app', () => { ...@@ -301,7 +301,7 @@ describe('ReactRefreshRegression app', () => {
await browser.refresh() await browser.refresh()
expect(await session.hasRedbox(true)).toBe(true) await session.waitForAndOpenRuntimeError()
const source = await session.getRedboxSource() const source = await session.getRedboxSource()
expect(source.split(/\r?\n/g).slice(2).join('\n')).toMatchInlineSnapshot(` expect(source.split(/\r?\n/g).slice(2).join('\n')).toMatchInlineSnapshot(`
...@@ -323,7 +323,7 @@ describe('ReactRefreshRegression app', () => { ...@@ -323,7 +323,7 @@ describe('ReactRefreshRegression app', () => {
await browser.refresh() await browser.refresh()
expect(await session.hasRedbox(true)).toBe(true) await session.waitForAndOpenRuntimeError()
const source = await session.getRedboxSource() const source = await session.getRedboxSource()
expect(source.split(/\r?\n/g).slice(2).join('\n')).toMatchInlineSnapshot(` expect(source.split(/\r?\n/g).slice(2).join('\n')).toMatchInlineSnapshot(`
......
...@@ -2,7 +2,9 @@ import { ...@@ -2,7 +2,9 @@ import {
getRedboxDescription, getRedboxDescription,
getRedboxHeader, getRedboxHeader,
getRedboxSource, getRedboxSource,
hasErrorToast,
hasRedbox, hasRedbox,
waitForAndOpenRuntimeError,
} from 'next-test-utils' } from 'next-test-utils'
import webdriver from 'next-webdriver' import webdriver from 'next-webdriver'
import { NextInstance } from 'test/lib/next-modes/base' import { NextInstance } from 'test/lib/next-modes/base'
...@@ -100,6 +102,12 @@ export async function sandbox( ...@@ -100,6 +102,12 @@ export async function sandbox(
async hasRedbox(expected = false) { async hasRedbox(expected = false) {
return hasRedbox(browser, expected) return hasRedbox(browser, expected)
}, },
async hasErrorToast(expected = false) {
return hasErrorToast(browser, expected)
},
async waitForAndOpenRuntimeError() {
await waitForAndOpenRuntimeError(browser)
},
async getRedboxDescription() { async getRedboxDescription() {
return getRedboxDescription(browser) return getRedboxDescription(browser)
}, },
......
import { createNext, FileRef } from 'e2e-utils' import { createNext, FileRef } from 'e2e-utils'
import { NextInstance } from 'test/lib/next-modes/base' import { NextInstance } from 'test/lib/next-modes/base'
import { getRedboxDescription, hasRedbox } from 'next-test-utils' import {
getRedboxDescription,
waitForAndOpenRuntimeError,
} from 'next-test-utils'
import path from 'path' import path from 'path'
import webdriver from 'next-webdriver' import webdriver from 'next-webdriver'
...@@ -29,7 +32,7 @@ describe('dynamic-href', () => { ...@@ -29,7 +32,7 @@ describe('dynamic-href', () => {
const browser = await webdriver(next.url, '/object') const browser = await webdriver(next.url, '/object')
// Error should show up // Error should show up
expect(await hasRedbox(browser, true)).toBeTrue() await waitForAndOpenRuntimeError(browser)
expect(await getRedboxDescription(browser)).toMatchInlineSnapshot( expect(await getRedboxDescription(browser)).toMatchInlineSnapshot(
`"Error: Dynamic href \`/object/[slug]\` found in <Link> while using the \`/app\` router, this is not supported. Read more: https://nextjs.org/docs/messages/app-dir-dynamic-href"` `"Error: Dynamic href \`/object/[slug]\` found in <Link> while using the \`/app\` router, this is not supported. Read more: https://nextjs.org/docs/messages/app-dir-dynamic-href"`
) )
...@@ -57,7 +60,7 @@ describe('dynamic-href', () => { ...@@ -57,7 +60,7 @@ describe('dynamic-href', () => {
const browser = await webdriver(next.url, '/string') const browser = await webdriver(next.url, '/string')
// Error should show up // Error should show up
expect(await hasRedbox(browser, true)).toBeTrue() await waitForAndOpenRuntimeError(browser)
expect(await getRedboxDescription(browser)).toMatchInlineSnapshot( expect(await getRedboxDescription(browser)).toMatchInlineSnapshot(
`"Error: Dynamic href \`/object/[slug]\` found in <Link> while using the \`/app\` router, this is not supported. Read more: https://nextjs.org/docs/messages/app-dir-dynamic-href"` `"Error: Dynamic href \`/object/[slug]\` found in <Link> while using the \`/app\` router, this is not supported. Read more: https://nextjs.org/docs/messages/app-dir-dynamic-href"`
) )
......
...@@ -7,11 +7,11 @@ import { ...@@ -7,11 +7,11 @@ import {
fetchViaHTTP, fetchViaHTTP,
findPort, findPort,
getRedboxHeader, getRedboxHeader,
hasRedbox,
initNextServerScript, initNextServerScript,
killApp, killApp,
renderViaHTTP, renderViaHTTP,
waitFor, waitFor,
waitForAndOpenRuntimeError,
} from 'next-test-utils' } from 'next-test-utils'
import path from 'path' import path from 'path'
import cheerio from 'cheerio' import cheerio from 'cheerio'
...@@ -2060,7 +2060,7 @@ describe('app dir', () => { ...@@ -2060,7 +2060,7 @@ describe('app dir', () => {
await browser.elementByCss('#error-trigger-button').click() await browser.elementByCss('#error-trigger-button').click()
if (isDev) { if (isDev) {
expect(await hasRedbox(browser)).toBe(true) await waitForAndOpenRuntimeError(browser)
expect(await getRedboxHeader(browser)).toMatch(/this is a test/) expect(await getRedboxHeader(browser)).toMatch(/this is a test/)
} else { } else {
await browser await browser
...@@ -2110,12 +2110,10 @@ describe('app dir', () => { ...@@ -2110,12 +2110,10 @@ describe('app dir', () => {
'/error/global-error-boundary' '/error/global-error-boundary'
) )
await browser.elementByCss('#error-trigger-button').click() await browser.elementByCss('#error-trigger-button').click()
// .waitForElementByCss('body')
if (isDev) { if (isDev) {
expect(await hasRedbox(browser)).toBe(true) await waitForAndOpenRuntimeError(browser)
console.log('getRedboxHeader', await getRedboxHeader(browser)) expect(await getRedboxHeader(browser)).toMatch(/this is a test/)
// expect(await getRedboxHeader(browser)).toMatch(/An error occurred: this is a test/)
} else { } else {
expect( expect(
await browser await browser
......
...@@ -643,6 +643,28 @@ export async function hasRedbox(browser, expected = true) { ...@@ -643,6 +643,28 @@ export async function hasRedbox(browser, expected = true) {
return false return false
} }
export async function hasErrorToast(browser, expected = true) {
for (let i = 0; i < 30; i++) {
const result = await evaluate(browser, () => {
return Boolean(
[].slice
.call(document.querySelectorAll('nextjs-portal'))
.find((p) => p.shadowRoot.querySelector('[data-nextjs-toast]'))
)
})
if (result === expected) {
return result
}
await waitFor(1000)
}
return false
}
export async function waitForAndOpenRuntimeError(browser) {
return browser.waitForElementByCss('[data-nextjs-toast]').click()
}
export async function getRedboxHeader(browser) { export async function getRedboxHeader(browser) {
return retry( return retry(
() => () =>
......
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