| import { createSandbox } from 'development-sandbox' |
| import { FileRef, nextTestSetup } from 'e2e-utils' |
| import path from 'path' |
| import { outdent } from 'outdent' |
| import { getRedboxTotalErrorCount, retry } from 'next-test-utils' |
|
|
| const isReact18 = parseInt(process.env.NEXT_TEST_REACT_VERSION) === 18 |
| |
|
|
| describe('Error overlay for hydration errors in Pages router', () => { |
| const { next } = nextTestSetup({ |
| files: new FileRef(path.join(__dirname, 'fixtures', 'default-template')), |
| skipStart: true, |
| }) |
|
|
| it('includes a React docs link when hydration error does occur', async () => { |
| await using sandbox = await createSandbox( |
| next, |
| new Map([ |
| [ |
| 'index.js', |
| outdent` |
| const isClient = typeof window !== 'undefined' |
| export default function Mismatch() { |
| return ( |
| <div className="parent"> |
| <main className="child">{isClient ? "client" : "server"}</main> |
| </div> |
| ); |
| } |
| `, |
| ], |
| ]), |
| '/', |
| { pushErrorAsConsoleLog: true } |
| ) |
| const { browser } = sandbox |
| const logs = await browser.log() |
| expect(logs).toEqual( |
| expect.arrayContaining([ |
| { |
| message: isReact18 |
| ? |
| expect.stringContaining('Warning: Text content did not match.') |
| : |
| expect.stringContaining( |
| 'https://react.dev/link/hydration-mismatch' |
| ), |
| source: 'error', |
| }, |
| ]) |
| ) |
| }) |
|
|
| it('should show correct hydration error when client and server render different text', async () => { |
| await using sandbox = await createSandbox( |
| next, |
| new Map([ |
| [ |
| 'index.js', |
| outdent` |
| const isClient = typeof window !== 'undefined' |
| export default function Mismatch() { |
| return ( |
| <div className="parent"> |
| <main className="child">{isClient ? "client" : "server"}</main> |
| </div> |
| ); |
| } |
| `, |
| ], |
| ]) |
| ) |
| const { session, browser } = sandbox |
|
|
| |
| if (isReact18) { |
| await expect(browser).toDisplayRedbox(` |
| [ |
| { |
| "componentStack": "<Mismatch> |
| <div> |
| <main> |
| + "server" |
| - "client"", |
| "description": "Text content did not match. Server: "server" Client: "client"", |
| "environmentLabel": null, |
| "label": "Recoverable Error", |
| "source": null, |
| "stack": [], |
| }, |
| { |
| "description": "There was an error while hydrating. Because the error happened outside of a Suspense boundary, the entire root will switch to client rendering.", |
| "environmentLabel": null, |
| "label": "Recoverable Error", |
| "source": null, |
| "stack": [], |
| }, |
| ] |
| `) |
| } else { |
| await expect(browser).toDisplayRedbox(` |
| { |
| "componentStack": "... |
| <AppContainer> |
| <Container fn={function fn}> |
| <PagesDevOverlayBridge> |
| <PagesDevOverlayErrorBoundary> |
| <PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}> |
| <App pageProps={{}} Component={function Mismatch} err={undefined} router={{sdc:{},sbc:{}, ...}}> |
| <Mismatch> |
| <div className="parent"> |
| <main className="child"> |
| + client |
| - server |
| ...", |
| "description": "Hydration failed because the server rendered HTML didn't match the client. As a result this tree will be regenerated on the client. This can happen if a SSR-ed Client Component used:", |
| "environmentLabel": null, |
| "label": "Recoverable Error", |
| "source": "index.js (5:9) @ Mismatch |
| > 5 | <main className="child">{isClient ? "client" : "server"}</main> |
| | ^", |
| "stack": [ |
| "main <anonymous>", |
| "Mismatch index.js (5:9)", |
| ], |
| } |
| `) |
| } |
|
|
| await session.patch( |
| 'index.js', |
| outdent` |
| export default function Mismatch() { |
| return ( |
| <div className="parent"> |
| <main className="child">Value</main> |
| </div> |
| ); |
| } |
| ` |
| ) |
|
|
| await session.assertNoRedbox() |
|
|
| expect(await browser.elementByCss('.child').text()).toBe('Value') |
| }) |
|
|
| it('should show correct hydration error when client renders an extra element', async () => { |
| await using sandbox = await createSandbox( |
| next, |
| new Map([ |
| [ |
| 'index.js', |
| outdent` |
| const isClient = typeof window !== 'undefined' |
| export default function Mismatch() { |
| return ( |
| <div className="parent"> |
| {isClient && <main className="only" />} |
| </div> |
| ); |
| } |
| `, |
| ], |
| ]) |
| ) |
| const { browser } = sandbox |
|
|
| await retry(async () => { |
| expect(await getRedboxTotalErrorCount(browser)).toBe(isReact18 ? 3 : 1) |
| }) |
|
|
| if (isReact18) { |
| await expect(browser).toDisplayRedbox(` |
| [ |
| { |
| "componentStack": "<Mismatch> |
| > <div> |
| > <main>", |
| "description": "Expected server HTML to contain a matching <main> in <div>.", |
| "environmentLabel": null, |
| "label": "Runtime Error", |
| "source": null, |
| "stack": [], |
| }, |
| { |
| "componentStack": "<Mismatch> |
| > <div> |
| > <main>", |
| "description": "Expected server HTML to contain a matching <main> in <div>.", |
| "environmentLabel": null, |
| "label": "Recoverable Error", |
| "source": null, |
| "stack": [], |
| }, |
| { |
| "description": "There was an error while hydrating. Because the error happened outside of a Suspense boundary, the entire root will switch to client rendering.", |
| "environmentLabel": null, |
| "label": "Recoverable Error", |
| "source": null, |
| "stack": [], |
| }, |
| ] |
| `) |
| } else { |
| await expect(browser).toDisplayRedbox(` |
| { |
| "componentStack": "... |
| <AppContainer> |
| <Container fn={function fn}> |
| <PagesDevOverlayBridge> |
| <PagesDevOverlayErrorBoundary> |
| <PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}> |
| <App pageProps={{}} Component={function Mismatch} err={undefined} router={{sdc:{},sbc:{}, ...}}> |
| <Mismatch> |
| <div className="parent"> |
| + <main className="only"> |
| ...", |
| "description": "Hydration failed because the server rendered HTML didn't match the client. As a result this tree will be regenerated on the client. This can happen if a SSR-ed Client Component used:", |
| "environmentLabel": null, |
| "label": "Recoverable Error", |
| "source": "index.js (5:20) @ Mismatch |
| > 5 | {isClient && <main className="only" />} |
| | ^", |
| "stack": [ |
| "main <anonymous>", |
| "Mismatch index.js (5:20)", |
| ], |
| } |
| `) |
| } |
| }) |
|
|
| it('should show correct hydration error when client renders an extra text node', async () => { |
| await using sandbox = await createSandbox( |
| next, |
| new Map([ |
| [ |
| 'index.js', |
| outdent` |
| const isClient = typeof window !== 'undefined' |
| export default function Mismatch() { |
| return ( |
| <div className="parent"> |
| <header className="1" /> |
| {isClient && "second"} |
| <footer className="3" /> |
| </div> |
| ); |
| } |
| `, |
| ], |
| ]) |
| ) |
| const { browser } = sandbox |
|
|
| await retry(async () => { |
| expect(await getRedboxTotalErrorCount(browser)).toBe(isReact18 ? 3 : 1) |
| }) |
|
|
| if (isReact18) { |
| await expect(browser).toDisplayRedbox(` |
| [ |
| { |
| "componentStack": "<Mismatch> |
| <div> |
| > <div> |
| > "second"", |
| "description": "Expected server HTML to contain a matching text node for "second" in <div>.", |
| "environmentLabel": null, |
| "label": "Runtime Error", |
| "source": null, |
| "stack": [], |
| }, |
| { |
| "componentStack": "<Mismatch> |
| <div> |
| > <div> |
| > "second"", |
| "description": "Expected server HTML to contain a matching text node for "second" in <div>.", |
| "environmentLabel": null, |
| "label": "Recoverable Error", |
| "source": null, |
| "stack": [], |
| }, |
| { |
| "description": "There was an error while hydrating. Because the error happened outside of a Suspense boundary, the entire root will switch to client rendering.", |
| "environmentLabel": null, |
| "label": "Recoverable Error", |
| "source": null, |
| "stack": [], |
| }, |
| ] |
| `) |
| } else { |
| await expect(browser).toDisplayRedbox(` |
| { |
| "componentStack": "... |
| <AppContainer> |
| <Container fn={function fn}> |
| <PagesDevOverlayBridge> |
| <PagesDevOverlayErrorBoundary> |
| <PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}> |
| <App pageProps={{}} Component={function Mismatch} err={undefined} router={{sdc:{},sbc:{}, ...}}> |
| <Mismatch> |
| <div className="parent"> |
| <header> |
| + second |
| - <footer className="3"> |
| ... |
| ...", |
| "description": "Hydration failed because the server rendered HTML didn't match the client. As a result this tree will be regenerated on the client. This can happen if a SSR-ed Client Component used:", |
| "environmentLabel": null, |
| "label": "Recoverable Error", |
| "source": "index.js (4:5) @ Mismatch |
| > 4 | <div className="parent"> |
| | ^", |
| "stack": [ |
| "div <anonymous>", |
| "Mismatch index.js (4:5)", |
| ], |
| } |
| `) |
| } |
| }) |
|
|
| it('should show correct hydration error when server renders an extra element', async () => { |
| await using sandbox = await createSandbox( |
| next, |
| new Map([ |
| [ |
| 'index.js', |
| outdent` |
| const isClient = typeof window !== 'undefined' |
| export default function Mismatch() { |
| return ( |
| <div className="parent"> |
| {!isClient && <main className="only" />} |
| </div> |
| ); |
| } |
| `, |
| ], |
| ]) |
| ) |
| const { browser } = sandbox |
|
|
| if (isReact18) { |
| await expect(browser).toDisplayRedbox(` |
| [ |
| { |
| "componentStack": "<Mismatch> |
| > <div>", |
| "description": "Did not expect server HTML to contain a <main> in <div>.", |
| "environmentLabel": null, |
| "label": "Recoverable Error", |
| "source": null, |
| "stack": [], |
| }, |
| { |
| "description": "There was an error while hydrating. Because the error happened outside of a Suspense boundary, the entire root will switch to client rendering.", |
| "environmentLabel": null, |
| "label": "Recoverable Error", |
| "source": null, |
| "stack": [], |
| }, |
| ] |
| `) |
| } else { |
| await expect(browser).toDisplayRedbox(` |
| { |
| "componentStack": "<Root callbacks={[...]}> |
| <Head> |
| <AppContainer> |
| <Container fn={function fn}> |
| <PagesDevOverlayBridge> |
| <PagesDevOverlayErrorBoundary> |
| <PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}> |
| <App pageProps={{}} Component={function Mismatch} err={undefined} router={{sdc:{},sbc:{}, ...}}> |
| <Mismatch> |
| <div className="parent"> |
| - <main className="only"> |
| ...", |
| "description": "Hydration failed because the server rendered HTML didn't match the client. As a result this tree will be regenerated on the client. This can happen if a SSR-ed Client Component used:", |
| "environmentLabel": null, |
| "label": "Recoverable Error", |
| "source": "index.js (4:5) @ Mismatch |
| > 4 | <div className="parent"> |
| | ^", |
| "stack": [ |
| "div <anonymous>", |
| "Mismatch index.js (4:5)", |
| ], |
| } |
| `) |
| } |
| }) |
|
|
| it('should show correct hydration error when server renders an extra text node', async () => { |
| await using sandbox = await createSandbox( |
| next, |
| new Map([ |
| [ |
| 'index.js', |
| outdent` |
| const isClient = typeof window !== 'undefined' |
| export default function Mismatch() { |
| return <div className="parent">{!isClient && "only"}</div>; |
| } |
| `, |
| ], |
| ]) |
| ) |
| const { browser } = sandbox |
|
|
| if (isReact18) { |
| await expect(browser).toDisplayRedbox(` |
| [ |
| { |
| "componentStack": "<Mismatch> |
| <div> |
| > <div> |
| > "only"", |
| "description": "Did not expect server HTML to contain the text node "only" in <div>.", |
| "environmentLabel": null, |
| "label": "Recoverable Error", |
| "source": null, |
| "stack": [], |
| }, |
| { |
| "description": "There was an error while hydrating. Because the error happened outside of a Suspense boundary, the entire root will switch to client rendering.", |
| "environmentLabel": null, |
| "label": "Recoverable Error", |
| "source": null, |
| "stack": [], |
| }, |
| ] |
| `) |
| } else { |
| await expect(browser).toDisplayRedbox(` |
| { |
| "componentStack": "<Root callbacks={[...]}> |
| <Head> |
| <AppContainer> |
| <Container fn={function fn}> |
| <PagesDevOverlayBridge> |
| <PagesDevOverlayErrorBoundary> |
| <PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}> |
| <App pageProps={{}} Component={function Mismatch} err={undefined} router={{sdc:{},sbc:{}, ...}}> |
| <Mismatch> |
| <div className="parent"> |
| - only |
| ...", |
| "description": "Hydration failed because the server rendered HTML didn't match the client. As a result this tree will be regenerated on the client. This can happen if a SSR-ed Client Component used:", |
| "environmentLabel": null, |
| "label": "Recoverable Error", |
| "source": "index.js (3:10) @ Mismatch |
| > 3 | return <div className="parent">{!isClient && "only"}</div>; |
| | ^", |
| "stack": [ |
| "div <anonymous>", |
| "Mismatch index.js (3:10)", |
| ], |
| } |
| `) |
| } |
| }) |
|
|
| it('should show correct hydration error when server renders an extra text node in an invalid place', async () => { |
| await using sandbox = await createSandbox( |
| next, |
| new Map([ |
| [ |
| 'index.js', |
| outdent` |
| export default function Page() { |
| return ( |
| <table> |
| <tbody> |
| <tr>test</tr> |
| </tbody> |
| </table> |
| ) |
| } |
| `, |
| ], |
| ]) |
| ) |
| const { browser } = sandbox |
|
|
| await retry(async () => { |
| expect(await getRedboxTotalErrorCount(browser)).toBe( |
| isReact18 |
| ? 3 |
| : |
| 1 |
| ) |
| }) |
|
|
| if (isReact18) { |
| await expect(browser).toDisplayRedbox(` |
| [ |
| { |
| "componentStack": "<Page> |
| > <table>", |
| "description": "Expected server HTML to contain a matching <table> in <div>.", |
| "environmentLabel": null, |
| "label": "Runtime Error", |
| "source": null, |
| "stack": [], |
| }, |
| { |
| "componentStack": "<Page> |
| > <table>", |
| "description": "Expected server HTML to contain a matching <table> in <div>.", |
| "environmentLabel": null, |
| "label": "Recoverable Error", |
| "source": null, |
| "stack": [], |
| }, |
| { |
| "description": "There was an error while hydrating. Because the error happened outside of a Suspense boundary, the entire root will switch to client rendering.", |
| "environmentLabel": null, |
| "label": "Recoverable Error", |
| "source": null, |
| "stack": [], |
| }, |
| ] |
| `) |
| } else { |
| await expect(browser).toDisplayRedbox(` |
| { |
| "componentStack": "... |
| <Container fn={function fn}> |
| <PagesDevOverlayBridge> |
| <PagesDevOverlayErrorBoundary> |
| <PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}> |
| <App pageProps={{}} Component={function Page} err={undefined} router={{sdc:{},sbc:{}, ...}}> |
| <Page> |
| <table> |
| <tbody> |
| <tr> |
| > test |
| ...", |
| "description": "In HTML, text nodes cannot be a child of <tr>. |
| This will cause a hydration error.", |
| "environmentLabel": null, |
| "label": "Recoverable Error", |
| "source": "index.js (3:5) @ Page |
| > 3 | <table> |
| | ^", |
| "stack": [ |
| "table <anonymous>", |
| "Page index.js (3:5)", |
| ], |
| } |
| `) |
| } |
| }) |
|
|
| it('should show correct hydration error when server renders an extra whitespace in an invalid place', async () => { |
| await using sandbox = await createSandbox( |
| next, |
| new Map([ |
| [ |
| 'index.js', |
| outdent` |
| export default function Page() { |
| return ( |
| <table> |
| {' 123'} |
| <tbody></tbody> |
| </table> |
| ) |
| } |
| `, |
| ], |
| ]) |
| ) |
| const { browser } = sandbox |
|
|
| await retry(async () => { |
| expect(await getRedboxTotalErrorCount(browser)).toBe(isReact18 ? 3 : 1) |
| }) |
|
|
| if (isReact18) { |
| await expect(browser).toDisplayRedbox(` |
| [ |
| { |
| "componentStack": "<Page> |
| > <table>", |
| "description": "Expected server HTML to contain a matching <table> in <div>.", |
| "environmentLabel": null, |
| "label": "Runtime Error", |
| "source": null, |
| "stack": [], |
| }, |
| { |
| "componentStack": "<Page> |
| > <table>", |
| "description": "Expected server HTML to contain a matching <table> in <div>.", |
| "environmentLabel": null, |
| "label": "Recoverable Error", |
| "source": null, |
| "stack": [], |
| }, |
| { |
| "description": "There was an error while hydrating. Because the error happened outside of a Suspense boundary, the entire root will switch to client rendering.", |
| "environmentLabel": null, |
| "label": "Recoverable Error", |
| "source": null, |
| "stack": [], |
| }, |
| ] |
| `) |
| } else { |
| await expect(browser).toDisplayRedbox(` |
| { |
| "componentStack": "<Root callbacks={[...]}> |
| <Head> |
| <AppContainer> |
| <Container fn={function fn}> |
| <PagesDevOverlayBridge> |
| <PagesDevOverlayErrorBoundary> |
| <PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}> |
| <App pageProps={{}} Component={function Page} err={undefined} router={{sdc:{},sbc:{}, ...}}> |
| <Page> |
| > <table> |
| > {" 123"} |
| ... |
| ...", |
| "description": "In HTML, text nodes cannot be a child of <table>. |
| This will cause a hydration error.", |
| "environmentLabel": null, |
| "label": "Recoverable Error", |
| "source": "index.js (3:5) @ Page |
| > 3 | <table> |
| | ^", |
| "stack": [ |
| "table <anonymous>", |
| "Page index.js (3:5)", |
| ], |
| } |
| `) |
| } |
| }) |
|
|
| it('should show correct hydration error when client renders an extra node inside Suspense content', async () => { |
| await using sandbox = await createSandbox( |
| next, |
| new Map([ |
| [ |
| 'index.js', |
| outdent` |
| import React from "react" |
| const isClient = typeof window !== 'undefined' |
| export default function Mismatch() { |
| return ( |
| <div className="parent"> |
| <React.Suspense fallback={<p>Loading...</p>}> |
| <header className="1" /> |
| {isClient && <main className="second" />} |
| <footer className="3" /> |
| </React.Suspense> |
| </div> |
| ); |
| } |
| `, |
| ], |
| ]) |
| ) |
| const { browser } = sandbox |
|
|
| await retry(async () => { |
| expect(await getRedboxTotalErrorCount(browser)).toBe(isReact18 ? 3 : 1) |
| }) |
|
|
| if (isReact18) { |
| await expect(browser).toDisplayRedbox(` |
| [ |
| { |
| "componentStack": "<Mismatch> |
| > <div> |
| <Suspense> |
| > <main>", |
| "description": "Expected server HTML to contain a matching <main> in <div>.", |
| "environmentLabel": null, |
| "label": "Runtime Error", |
| "source": null, |
| "stack": [], |
| }, |
| { |
| "componentStack": "<Mismatch> |
| > <div> |
| <Suspense> |
| > <main>", |
| "description": "Expected server HTML to contain a matching <main> in <div>.", |
| "environmentLabel": null, |
| "label": "Recoverable Error", |
| "source": null, |
| "stack": [], |
| }, |
| { |
| "description": "There was an error while hydrating this Suspense boundary. Switched to client rendering.", |
| "environmentLabel": null, |
| "label": "Recoverable Error", |
| "source": null, |
| "stack": [], |
| }, |
| ] |
| `) |
| } else { |
| await expect(browser).toDisplayRedbox(` |
| { |
| "componentStack": "... |
| <PagesDevOverlayBridge> |
| <PagesDevOverlayErrorBoundary> |
| <PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}> |
| <App pageProps={{}} Component={function Mismatch} err={undefined} router={{sdc:{},sbc:{}, ...}}> |
| <Mismatch> |
| <div className="parent"> |
| <Suspense fallback={<p>}> |
| <header> |
| + <main className="second"> |
| - <footer className="3"> |
| ... |
| ...", |
| "description": "Hydration failed because the server rendered HTML didn't match the client. As a result this tree will be regenerated on the client. This can happen if a SSR-ed Client Component used:", |
| "environmentLabel": null, |
| "label": "Recoverable Error", |
| "source": "index.js (8:22) @ Mismatch |
| > 8 | {isClient && <main className="second" />} |
| | ^", |
| "stack": [ |
| "main <anonymous>", |
| "Mismatch index.js (8:22)", |
| ], |
| } |
| `) |
| } |
| }) |
|
|
| it('should not show a hydration error when using `useId` in a client component', async () => { |
| await using sandbox = await createSandbox( |
| next, |
| new Map([ |
| [ |
| 'index.js', |
| outdent` |
| import { useId } from "react" |
| |
| export default function Page() { |
| let id = useId(); |
| return ( |
| <div className="parent" data-id={id}> |
| Hello World |
| </div> |
| ); |
| } |
| `, |
| ], |
| ]) |
| ) |
| const { browser } = sandbox |
| const logs = await browser.log() |
| const errors = logs |
| .filter((x) => x.source === 'error') |
| .map((x) => x.message) |
| .join('\n') |
|
|
| expect(errors).not.toInclude( |
| 'Warning: Prop `%s` did not match. Server: %s Client: %s' |
| ) |
| }) |
|
|
| it('should only show one hydration error when bad nesting happened - p under p', async () => { |
| await using sandbox = await createSandbox( |
| next, |
| new Map([ |
| [ |
| 'index.js', |
| outdent` |
| export default function Page() { |
| return ( |
| <p> |
| <p>Nested p tags</p> |
| </p> |
| ) |
| } |
| `, |
| ], |
| ]) |
| ) |
| const { browser } = sandbox |
|
|
| await retry(async () => { |
| expect(await getRedboxTotalErrorCount(browser)).toBe(isReact18 ? 3 : 1) |
| }) |
|
|
| if (isReact18) { |
| await expect(browser).toDisplayRedbox(` |
| [ |
| { |
| "componentStack": "<Page> |
| > <p> |
| > <p>", |
| "description": "Expected server HTML to contain a matching <p> in <p>.", |
| "environmentLabel": null, |
| "label": "Runtime Error", |
| "source": null, |
| "stack": [], |
| }, |
| { |
| "componentStack": "<Page> |
| > <p> |
| > <p>", |
| "description": "Expected server HTML to contain a matching <p> in <p>.", |
| "environmentLabel": null, |
| "label": "Recoverable Error", |
| "source": null, |
| "stack": [], |
| }, |
| { |
| "description": "There was an error while hydrating. Because the error happened outside of a Suspense boundary, the entire root will switch to client rendering.", |
| "environmentLabel": null, |
| "label": "Recoverable Error", |
| "source": null, |
| "stack": [], |
| }, |
| ] |
| `) |
| } else { |
| await expect(browser).toDisplayRedbox(` |
| { |
| "componentStack": "<Root callbacks={[...]}> |
| <Head> |
| <AppContainer> |
| <Container fn={function fn}> |
| <PagesDevOverlayBridge> |
| <PagesDevOverlayErrorBoundary> |
| <PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}> |
| <App pageProps={{}} Component={function Page} err={undefined} router={{sdc:{},sbc:{}, ...}}> |
| <Page> |
| > <p> |
| > <p> |
| ...", |
| "description": "In HTML, <p> cannot be a descendant of <p>. |
| This will cause a hydration error.", |
| "environmentLabel": null, |
| "label": "Recoverable Error", |
| "source": "index.js (4:7) @ Page |
| > 4 | <p>Nested p tags</p> |
| | ^", |
| "stack": [ |
| "p <anonymous>", |
| "Page index.js (4:7)", |
| ], |
| } |
| `) |
| } |
| }) |
|
|
| it('should only show one hydration error when bad nesting happened - div under p', async () => { |
| await using sandbox = await createSandbox( |
| next, |
| new Map([ |
| [ |
| 'index.js', |
| outdent` |
| export default function Page() { |
| return ( |
| <div> |
| <div> |
| <p> |
| <div>Nested div under p tag</div> |
| </p> |
| </div> |
| </div> |
| ) |
| } |
| `, |
| ], |
| ]) |
| ) |
| const { browser } = sandbox |
|
|
| await retry(async () => { |
| expect(await getRedboxTotalErrorCount(browser)).toBe(isReact18 ? 3 : 1) |
| }) |
|
|
| if (isReact18) { |
| await expect(browser).toDisplayRedbox(` |
| [ |
| { |
| "componentStack": "<Page> |
| <div> |
| <div> |
| > <p> |
| > <div>", |
| "description": "Expected server HTML to contain a matching <div> in <p>.", |
| "environmentLabel": null, |
| "label": "Runtime Error", |
| "source": null, |
| "stack": [], |
| }, |
| { |
| "componentStack": "<Page> |
| <div> |
| <div> |
| > <p> |
| > <div>", |
| "description": "Expected server HTML to contain a matching <div> in <p>.", |
| "environmentLabel": null, |
| "label": "Recoverable Error", |
| "source": null, |
| "stack": [], |
| }, |
| { |
| "description": "There was an error while hydrating. Because the error happened outside of a Suspense boundary, the entire root will switch to client rendering.", |
| "environmentLabel": null, |
| "label": "Recoverable Error", |
| "source": null, |
| "stack": [], |
| }, |
| ] |
| `) |
| } else { |
| await expect(browser).toDisplayRedbox(` |
| { |
| "componentStack": "... |
| <Container fn={function fn}> |
| <PagesDevOverlayBridge> |
| <PagesDevOverlayErrorBoundary> |
| <PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}> |
| <App pageProps={{}} Component={function Page} err={undefined} router={{sdc:{},sbc:{}, ...}}> |
| <Page> |
| <div> |
| <div> |
| > <p> |
| > <div> |
| ...", |
| "description": "In HTML, <div> cannot be a descendant of <p>. |
| This will cause a hydration error.", |
| "environmentLabel": null, |
| "label": "Recoverable Error", |
| "source": "index.js (6:11) @ Page |
| > 6 | <div>Nested div under p tag</div> |
| | ^", |
| "stack": [ |
| "div <anonymous>", |
| "Page index.js (6:11)", |
| ], |
| } |
| `) |
| } |
| }) |
|
|
| it('should only show one hydration error when bad nesting happened - div > tr', async () => { |
| await using sandbox = await createSandbox( |
| next, |
| new Map([ |
| [ |
| 'index.js', |
| outdent` |
| export default function Page() { |
| return <div><tr></tr></div> |
| } |
| `, |
| ], |
| ]) |
| ) |
| const { browser } = sandbox |
|
|
| await retry(async () => { |
| expect(await getRedboxTotalErrorCount(browser)).toBe(isReact18 ? 3 : 1) |
| }) |
|
|
| if (isReact18) { |
| await expect(browser).toDisplayRedbox(` |
| [ |
| { |
| "componentStack": "<Page> |
| > <div> |
| > <tr>", |
| "description": "Expected server HTML to contain a matching <tr> in <div>.", |
| "environmentLabel": null, |
| "label": "Runtime Error", |
| "source": null, |
| "stack": [], |
| }, |
| { |
| "componentStack": "<Page> |
| > <div> |
| > <tr>", |
| "description": "Expected server HTML to contain a matching <tr> in <div>.", |
| "environmentLabel": null, |
| "label": "Recoverable Error", |
| "source": null, |
| "stack": [], |
| }, |
| { |
| "description": "There was an error while hydrating. Because the error happened outside of a Suspense boundary, the entire root will switch to client rendering.", |
| "environmentLabel": null, |
| "label": "Recoverable Error", |
| "source": null, |
| "stack": [], |
| }, |
| ] |
| `) |
| } else { |
| await expect(browser).toDisplayRedbox(` |
| { |
| "componentStack": "<Root callbacks={[...]}> |
| <Head> |
| <AppContainer> |
| <Container fn={function fn}> |
| <PagesDevOverlayBridge> |
| <PagesDevOverlayErrorBoundary> |
| <PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}> |
| <App pageProps={{}} Component={function Page} err={undefined} router={{sdc:{},sbc:{}, ...}}> |
| <Page> |
| > <div> |
| > <tr> |
| ...", |
| "description": "In HTML, <tr> cannot be a child of <div>. |
| This will cause a hydration error.", |
| "environmentLabel": null, |
| "label": "Recoverable Error", |
| "source": "index.js (2:15) @ Page |
| > 2 | return <div><tr></tr></div> |
| | ^", |
| "stack": [ |
| "tr <anonymous>", |
| "Page index.js (2:15)", |
| ], |
| } |
| `) |
| } |
| }) |
|
|
| it('should show the highlighted bad nesting html snippet when bad nesting happened', async () => { |
| await using sandbox = await createSandbox( |
| next, |
| new Map([ |
| [ |
| 'index.js', |
| outdent` |
| export default function Page() { |
| return ( |
| <p><span><span><span><span><p>hello world</p></span></span></span></span></p> |
| ) |
| } |
| `, |
| ], |
| ]) |
| ) |
| const { browser } = sandbox |
|
|
| await retry(async () => { |
| expect(await getRedboxTotalErrorCount(browser)).toBe(isReact18 ? 3 : 1) |
| }) |
|
|
| if (isReact18) { |
| await expect(browser).toDisplayRedbox(` |
| [ |
| { |
| "componentStack": "<Page> |
| <p> |
| <span> |
| <span> |
| <span> |
| > <span> |
| > <p>", |
| "description": "Expected server HTML to contain a matching <p> in <span>.", |
| "environmentLabel": null, |
| "label": "Runtime Error", |
| "source": null, |
| "stack": [], |
| }, |
| { |
| "componentStack": "<Page> |
| <p> |
| <span> |
| <span> |
| <span> |
| > <span> |
| > <p>", |
| "description": "Expected server HTML to contain a matching <p> in <span>.", |
| "environmentLabel": null, |
| "label": "Recoverable Error", |
| "source": null, |
| "stack": [], |
| }, |
| { |
| "description": "There was an error while hydrating. Because the error happened outside of a Suspense boundary, the entire root will switch to client rendering.", |
| "environmentLabel": null, |
| "label": "Recoverable Error", |
| "source": null, |
| "stack": [], |
| }, |
| ] |
| `) |
| } else { |
| await expect(browser).toDisplayRedbox(` |
| { |
| "componentStack": "<Root callbacks={[...]}> |
| <Head> |
| <AppContainer> |
| <Container fn={function fn}> |
| <PagesDevOverlayBridge> |
| <PagesDevOverlayErrorBoundary> |
| <PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}> |
| <App pageProps={{}} Component={function Page} err={undefined} router={{sdc:{},sbc:{}, ...}}> |
| <Page> |
| > <p> |
| <span> |
| <span> |
| <span> |
| <span> |
| > <p> |
| ...", |
| "description": "In HTML, <p> cannot be a descendant of <p>. |
| This will cause a hydration error.", |
| "environmentLabel": null, |
| "label": "Recoverable Error", |
| "source": "index.js (3:32) @ Page |
| > 3 | <p><span><span><span><span><p>hello world</p></span></span></span></span></p> |
| | ^", |
| "stack": [ |
| "p <anonymous>", |
| "Page index.js (3:32)", |
| ], |
| } |
| `) |
| } |
| }) |
|
|
| it('should show error if script is directly placed under html instead of body', async () => { |
| await using sandbox = await createSandbox( |
| next, |
| new Map([ |
| [ |
| 'pages/_document.js', |
| outdent` |
| import { Html, Head, Main, NextScript } from 'next/document' |
| import Script from 'next/script' |
| |
| export default function Document() { |
| return ( |
| <Html lang="en"> |
| <Head /> |
| <body> |
| <Main /> |
| <NextScript /> |
| </body> |
| <Script |
| src="https://example.com/script.js" |
| strategy="beforeInteractive" |
| /> |
| </Html> |
| ) |
| } |
| `, |
| ], |
| [ |
| 'index.js', |
| outdent` |
| export default function Page() { |
| return <div>Hello World</div> |
| } |
| `, |
| ], |
| ]) |
| ) |
| const { session } = sandbox |
| |
| await session.assertNoRedbox() |
| }) |
| }) |
|
|