mirror of
https://github.com/hanzoai/next.js.git
synced 2026-09-24 17:00:51 +00:00
e9bc6190bd
### What? Redesigns the blocking-route error overlay for instant navigation errors with a distinct "Instant" overlay path, visual technique cards, and updated error wording framed around navigation impact. ### Why? The current overlay dumps every possible cause and fix in one block of text. The new design is friendlier — amber "Instant" badge, a short headline framed around navigation, and responsive code snippet cards showing each fix pattern. ### Demo - **Runtime template** (e.g. `cookies()`): https://error-messages-overhaul-ibsl.labs.vercel.dev/scenario/26-cookies-ssr-no-instant - **Dynamic template** (e.g. uncached `fetch`): https://error-messages-overhaul-ibsl.labs.vercel.dev/scenario/27-fetch-ssr-no-instant ### How? **Overlay** - New early-return path in `errors.tsx` for `blocking-route` errors without refinement — renders `InstantRuntimeError` with CodeFrame → description → technique cards → CallStack → ErrorCause - `InstantGuidance` component with responsive CSS grid of fix technique cards (3 per variant) - Color-coded cards with colored borders and matching highlight text (blue, purple, red) - "Make route params static" card (runtime only) has a dashed border indicating it's conditional **Build & CLI messages** - Build output messages extracted into `blocking-route-messages.ts` and deduplicated across `dynamic-rendering.ts` - `dynamicOrRuntimeBodyMessage` added for build-time static validation where the specific cause can't be pinpointed — lists all APIs (`fetch(...)`, `cookies()`, `headers()`, `params`, `searchParams`, `connection()`) - `isRuntimeVariant()` replaces the old `includes('cookies()')` heuristic which broke because both templates mention `cookies()` - `logBuildDebugHint()` extracted and shared between `logDisallowedDynamicError` and instant validation — adds "run `next dev`" and "`next build --debug-prerender`" hints to instant validation build output Results: <img width="2094" height="1478" alt="Google Chrome 2026-04-17 16 37 00" src="https://github.com/user-attachments/assets/04f126c5-250c-4e6e-bad0-d6960496cd13" /> <img width="1978" height="1512" alt="Google Chrome 2026-04-17 16 36 37" src="https://github.com/user-attachments/assets/46a502d8-9500-4055-814b-3efb739949db" /> --------- Co-authored-by: Janka Uryga <[email protected]>
87 lines
2.7 KiB
TypeScript
87 lines
2.7 KiB
TypeScript
import { nextTestSetup } from 'e2e-utils'
|
|
import {
|
|
getRedboxDescription,
|
|
openRedbox,
|
|
waitForNoRedbox,
|
|
retry,
|
|
} from 'next-test-utils'
|
|
|
|
describe('Cache Components Dev Errors', () => {
|
|
const { next } = nextTestSetup({
|
|
files: __dirname,
|
|
})
|
|
|
|
it('should not show a red box error on the SSR render', async () => {
|
|
const browser = await next.browser('/cached')
|
|
await waitForNoRedbox(browser)
|
|
let latestValue = await browser.elementByCss('#value').text()
|
|
|
|
await browser.refresh()
|
|
await waitForNoRedbox(browser)
|
|
let priorValue = latestValue
|
|
latestValue = await browser.elementByCss('#value').text()
|
|
|
|
expect(latestValue).toBe(priorValue)
|
|
|
|
await browser.elementByCss('#refresh').click()
|
|
await retry(async () => {
|
|
await waitForNoRedbox(browser)
|
|
let priorValue = latestValue
|
|
latestValue = await browser.elementByCss('#value').text()
|
|
expect(latestValue).not.toBe(priorValue)
|
|
})
|
|
|
|
await browser.elementByCss('#refresh').click()
|
|
await retry(async () => {
|
|
await waitForNoRedbox(browser)
|
|
let priorValue = latestValue
|
|
latestValue = await browser.elementByCss('#value').text()
|
|
expect(latestValue).not.toBe(priorValue)
|
|
})
|
|
|
|
// TODO CI is too flakey to run tests like this b/c timing cannot be controlled.
|
|
// we need to land this so we're deactivating these assertions for now.
|
|
// you should be able to reproduce the assertions below when testing locally
|
|
|
|
// await browser.elementByCss('#reload').click()
|
|
// await retry(async () => {
|
|
// await waitForNoRedbox(browser)
|
|
// let priorValue = latestValue
|
|
// latestValue = await browser.elementByCss('#value').text()
|
|
// expect(latestValue).toBe(priorValue)
|
|
// })
|
|
|
|
// await browser.elementByCss('#reload').click()
|
|
// await retry(async () => {
|
|
// await waitForNoRedbox(browser)
|
|
// let priorValue = latestValue
|
|
// latestValue = await browser.elementByCss('#value').text()
|
|
// expect(latestValue).toBe(priorValue)
|
|
// })
|
|
|
|
// await browser.elementByCss('#refresh').click()
|
|
// await retry(async () => {
|
|
// await waitForNoRedbox(browser)
|
|
// let priorValue = latestValue
|
|
// latestValue = await browser.elementByCss('#value').text()
|
|
// expect(latestValue).not.toBe(priorValue)
|
|
// })g
|
|
})
|
|
|
|
it('should show a red box error on the SSR render when data is uncached', async () => {
|
|
let desc
|
|
|
|
const browser = await next.browser('/uncached')
|
|
await openRedbox(browser)
|
|
desc = await getRedboxDescription(browser)
|
|
|
|
expect(desc).toContain('during the initial render')
|
|
|
|
await browser.refresh()
|
|
await openRedbox(browser)
|
|
desc = await getRedboxDescription(browser)
|
|
|
|
expect(desc).toContain('during the initial render')
|
|
})
|
|
})
|