e169e73b45
## What? As @leerob and I found in-person when opening #57230 the `hasRedBox()` helper was incorrectly passing when it shouldn't pass in both the true and false case. This PR uses a different approach by waiting 7 seconds before checking, this leaves enough room for HMR / reloads to apply, it doesn't meaningfully slow down the test suite and increases reliability of the check as you can see below in the tests that were previously passing that are no longer passing. I've moved these to skipped tests for landing this PR as I want to avoid further issues being introduced while we fix them. @huozhi will investigate these next week 👍 Failing tests that are temporarily skipped: - https://github.com/vercel/next.js/pull/60522/files#diff-513b477050bf1a620697b4d16bc1e6850282cb54e0609bdc5fd34307bfa9e471R9 - https://github.com/vercel/next.js/pull/60522/files#diff-fa7d7c8c40914005c138d852eaf6a69ac0df51ec77bec548cbc5f0bfbdc8ebc5R25 - https://github.com/vercel/next.js/pull/60522/files#diff-6f9f7dc131416cb17938311939a56d8c0e685a8fe6e8fc0cf5cd04939c74f388R41 - https://github.com/vercel/next.js/pull/60522/files#diff-439830e340a320c56645e9d00aaf0fd0b492ddb90b6d7f9db89458ccc5158eb7R8 - https://github.com/vercel/next.js/pull/60522/files#diff-62938bf5cd4d84f96dde8b6bcb2c8e18099e6dfca269c4302229b79175c0250cR18 - https://github.com/vercel/next.js/pull/60522/files#diff-513b477050bf1a620697b4d16bc1e6850282cb54e0609bdc5fd34307bfa9e471R9 <!-- Thanks for opening a PR! Your contribution is much appreciated. To make sure your PR is handled as smoothly as possible we request that you follow the checklist sections below. Choose the right checklist for the change(s) that you're making: ## For Contributors ### Improving Documentation - Run `pnpm prettier-fix` to fix formatting issues before opening the PR. - Read the Docs Contribution Guide to ensure your contribution follows the docs guidelines: https://nextjs.org/docs/community/contribution-guide ### Adding or Updating Examples - The "examples guidelines" are followed from our contributing doc https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md - Make sure the linting passes by running `pnpm build && pnpm lint`. See https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md ### Fixing a bug - Related issues linked using `fixes #number` - Tests added. See: https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs - Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md ### Adding a feature - Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. (A discussion must be opened, see https://github.com/vercel/next.js/discussions/new?category=ideas) - Related issues/discussions are linked using `fixes #number` - e2e tests added (https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs) - Documentation added - Telemetry added. In case of a feature if it's used or not. - Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md ## For Maintainers - Minimal description (aim for explaining to someone not on the team to understand the PR) - When linking to a Slack thread, you might want to share details of the conclusion - Link both the Linear (Fixes NEXT-xxx) and the GitHub issues - Add review comments if necessary to explain to the reviewer the logic behind a change ### What? ### Why? ### How? Closes NEXT- Fixes # --> Closes NEXT-2059
221 lines
8.1 KiB
TypeScript
221 lines
8.1 KiB
TypeScript
import { createNextDescribe } from 'e2e-utils'
|
|
import { check, getRedboxSource, hasRedbox } from 'next-test-utils'
|
|
|
|
createNextDescribe(
|
|
'app-dir root layout',
|
|
{
|
|
files: __dirname,
|
|
skipDeployment: true,
|
|
},
|
|
({ next, isNextDev: isDev }) => {
|
|
if (isDev) {
|
|
// TODO-APP: re-enable after reworking the error overlay.
|
|
describe.skip('Missing required tags', () => {
|
|
it('should error on page load', async () => {
|
|
const browser = await next.browser('/missing-tags', {
|
|
waitHydration: false,
|
|
})
|
|
|
|
expect(await hasRedbox(browser)).toBe(true)
|
|
expect(await getRedboxSource(browser)).toMatchInlineSnapshot(`
|
|
"Please make sure to include the following tags in your root layout: <html>, <body>.
|
|
|
|
Missing required root layout tags: html, body"
|
|
`)
|
|
})
|
|
|
|
it('should error on page navigation', async () => {
|
|
const browser = await next.browser('/has-tags', {
|
|
waitHydration: false,
|
|
})
|
|
await browser.elementByCss('a').click()
|
|
|
|
expect(await hasRedbox(browser)).toBe(true)
|
|
expect(await getRedboxSource(browser)).toMatchInlineSnapshot(`
|
|
"Please make sure to include the following tags in your root layout: <html>, <body>.
|
|
|
|
Missing required root layout tags: html, body"
|
|
`)
|
|
})
|
|
|
|
it('should error on page load on static generation', async () => {
|
|
const browser = await next.browser('/static-missing-tags/slug', {
|
|
waitHydration: false,
|
|
})
|
|
|
|
expect(await hasRedbox(browser)).toBe(true)
|
|
expect(await getRedboxSource(browser)).toMatchInlineSnapshot(`
|
|
"Please make sure to include the following tags in your root layout: <html>, <body>.
|
|
|
|
Missing required root layout tags: html, body"
|
|
`)
|
|
})
|
|
})
|
|
}
|
|
|
|
describe('Should do a mpa navigation when switching root layout', () => {
|
|
it('should work with basic routes', async () => {
|
|
const browser = await next.browser('/basic-route')
|
|
|
|
expect(await browser.elementById('basic-route').text()).toBe(
|
|
'Basic route'
|
|
)
|
|
await browser.eval('window.__TEST_NO_RELOAD = true')
|
|
|
|
// Navigate to page with same root layout
|
|
await browser.elementByCss('a').click()
|
|
expect(
|
|
await browser.waitForElementByCss('#inner-basic-route').text()
|
|
).toBe('Inner basic route')
|
|
expect(await browser.eval('window.__TEST_NO_RELOAD')).toBeTrue()
|
|
|
|
// Navigate to page with different root layout
|
|
await browser.elementByCss('a').click()
|
|
expect(await browser.waitForElementByCss('#route-group').text()).toBe(
|
|
'Route group'
|
|
)
|
|
expect(await browser.eval('window.__TEST_NO_RELOAD')).toBeUndefined()
|
|
})
|
|
|
|
it('should work with route groups', async () => {
|
|
const browser = await next.browser('/route-group')
|
|
|
|
expect(await browser.elementById('route-group').text()).toBe(
|
|
'Route group'
|
|
)
|
|
await browser.eval('window.__TEST_NO_RELOAD = true')
|
|
|
|
// Navigate to page with same root layout
|
|
await browser.elementByCss('a').click()
|
|
expect(
|
|
await browser.waitForElementByCss('#nested-route-group').text()
|
|
).toBe('Nested route group')
|
|
expect(await browser.eval('window.__TEST_NO_RELOAD')).toBeTrue()
|
|
|
|
// Navigate to page with different root layout
|
|
await browser.elementByCss('a').click()
|
|
expect(await browser.waitForElementByCss('#parallel-one').text()).toBe(
|
|
'One'
|
|
)
|
|
expect(await browser.waitForElementByCss('#parallel-two').text()).toBe(
|
|
'Two'
|
|
)
|
|
expect(await browser.eval('window.__TEST_NO_RELOAD')).toBeUndefined()
|
|
})
|
|
|
|
it('should work with parallel routes', async () => {
|
|
const browser = await next.browser('/with-parallel-routes')
|
|
|
|
expect(await browser.elementById('parallel-one').text()).toBe('One')
|
|
expect(await browser.elementById('parallel-two').text()).toBe('Two')
|
|
await browser.eval('window.__TEST_NO_RELOAD = true')
|
|
|
|
// Navigate to page with same root layout
|
|
await check(async () => {
|
|
await browser.elementByCss('a').click()
|
|
expect(
|
|
await browser.waitForElementByCss('#parallel-one-inner').text()
|
|
).toBe('One inner')
|
|
expect(await browser.eval('window.__TEST_NO_RELOAD')).toBeTrue()
|
|
return 'success'
|
|
}, 'success')
|
|
|
|
// Navigate to page with different root layout
|
|
await check(async () => {
|
|
await browser.elementByCss('a').click()
|
|
expect(
|
|
await browser.waitForElementByCss('#dynamic-hello').text()
|
|
).toBe('dynamic hello')
|
|
return 'success'
|
|
}, 'success')
|
|
expect(await browser.eval('window.__TEST_NO_RELOAD')).toBeUndefined()
|
|
})
|
|
|
|
it('should work with dynamic routes', async () => {
|
|
const browser = await next.browser('/dynamic/first')
|
|
|
|
expect(await browser.elementById('dynamic-first').text()).toBe(
|
|
'dynamic first'
|
|
)
|
|
await browser.eval('window.__TEST_NO_RELOAD = true')
|
|
|
|
// Navigate to page with same root layout
|
|
await browser.elementByCss('a').click()
|
|
expect(
|
|
await browser.waitForElementByCss('#dynamic-first-second').text()
|
|
).toBe('dynamic first second')
|
|
expect(await browser.eval('window.__TEST_NO_RELOAD')).toBeTrue()
|
|
|
|
// Navigate to page with different root layout
|
|
await browser.elementByCss('a').click()
|
|
expect(
|
|
await browser.waitForElementByCss('#inner-basic-route').text()
|
|
).toBe('Inner basic route')
|
|
expect(await browser.eval('window.__TEST_NO_RELOAD')).toBeUndefined()
|
|
})
|
|
|
|
it('should work with dynamic catchall routes', async () => {
|
|
const browser = await next.browser('/dynamic-catchall/slug')
|
|
|
|
expect(await browser.elementById('catchall-slug').text()).toBe(
|
|
'catchall slug'
|
|
)
|
|
await browser.eval('window.__TEST_NO_RELOAD = true')
|
|
|
|
// Navigate to page with same root layout
|
|
await browser.elementById('to-next-url').click()
|
|
expect(
|
|
await browser.waitForElementByCss('#catchall-slug-slug').text()
|
|
).toBe('catchall slug slug')
|
|
expect(await browser.eval('window.__TEST_NO_RELOAD')).toBeTrue()
|
|
|
|
// Navigate to page with different root layout
|
|
await browser.elementById('to-dynamic-first').click()
|
|
expect(await browser.elementById('dynamic-first').text()).toBe(
|
|
'dynamic first'
|
|
)
|
|
expect(await browser.eval('window.__TEST_NO_RELOAD')).toBeUndefined()
|
|
})
|
|
|
|
it('should work with static routes', async () => {
|
|
const browser = await next.browser('/static-mpa-navigation/slug1')
|
|
|
|
expect(await browser.elementById('static-slug1').text()).toBe(
|
|
'static slug1'
|
|
)
|
|
await browser.eval('window.__TEST_NO_RELOAD = true')
|
|
|
|
// Navigate to page with same root layout
|
|
await browser.elementByCss('a').click()
|
|
expect(await browser.waitForElementByCss('#static-slug2').text()).toBe(
|
|
'static slug2'
|
|
)
|
|
expect(await browser.eval('window.__TEST_NO_RELOAD')).toBeTrue()
|
|
|
|
// Navigate to page with different root layout
|
|
await browser.elementByCss('a').click()
|
|
expect(await browser.elementById('basic-route').text()).toBe(
|
|
'Basic route'
|
|
)
|
|
expect(await browser.eval('window.__TEST_NO_RELOAD')).toBeUndefined()
|
|
|
|
const res = await next.fetch(
|
|
`${next.url}/static-mpa-navigation/slug-not-existed`
|
|
)
|
|
expect(res.status).toBe(404)
|
|
})
|
|
})
|
|
|
|
it('should correctly handle navigation between multiple root layouts', async () => {
|
|
const browser = await next.browser('/root-layout-a')
|
|
|
|
await browser.waitForElementByCss('#root-a')
|
|
expect(await browser.hasElementByCssSelector('#root-b')).toBeFalse()
|
|
await browser
|
|
.elementById('link-to-b')
|
|
.click()
|
|
.waitForElementByCss('#root-b')
|
|
expect(await browser.hasElementByCssSelector('#root-a')).toBeFalse()
|
|
})
|
|
}
|
|
)
|