Unverified Commit d3492216 authored by Zack Tanner's avatar Zack Tanner Committed by GitHub

de-flake custom-error integration test (#63994)

- Ensures we clean up the inserted file 
- Retries the HMR check since there's a delta between writing to the
filesystem & HMR building the page.

<!-- 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 #

-->
parent 3e449b23
......@@ -9,6 +9,7 @@ import {
nextStart,
killApp,
launchApp,
retry,
} from 'next-test-utils'
const appDir = join(__dirname, '..')
......@@ -16,13 +17,6 @@ const page404 = join(appDir, 'pages/404.js')
let appPort
let app
const runTests = () => {
it('renders custom _error successfully', async () => {
const html = await renderViaHTTP(appPort, '/')
expect(html).toMatch(/Custom error/)
})
}
const customErrNo404Match =
/You have added a custom \/_error page without a custom \/404 page/
......@@ -41,12 +35,18 @@ describe('Custom _error', () => {
afterAll(() => killApp(app))
it('should not warn with /_error and /404 when rendering error first', async () => {
stderr = ''
await fs.writeFile(page404, 'export default <h1>')
const html = await renderViaHTTP(appPort, '/404')
await fs.remove(page404)
expect(html).toContain('Unexpected eof')
expect(stderr).not.toMatch(customErrNo404Match)
try {
stderr = ''
await fs.writeFile(page404, 'export default <h1>')
await retry(async () => {
// retry because the page might not be built yet
const html = await renderViaHTTP(appPort, '/404')
expect(html).toContain('Unexpected eof')
expect(stderr).not.toMatch(customErrNo404Match)
})
} finally {
await fs.remove(page404)
}
})
})
......@@ -65,11 +65,17 @@ describe('Custom _error', () => {
it('should not warn with /_error and /404', async () => {
stderr = ''
await fs.writeFile(page404, `export default () => 'not found...'`)
const html = await renderViaHTTP(appPort, '/404')
await fs.remove(page404)
expect(html).toContain('not found...')
expect(stderr).not.toMatch(customErrNo404Match)
try {
await fs.writeFile(page404, `export default () => 'not found...'`)
await retry(async () => {
// retry because the page might not be built yet
const html = await renderViaHTTP(appPort, '/404')
expect(html).toContain('not found...')
expect(stderr).not.toMatch(customErrNo404Match)
})
} finally {
await fs.remove(page404)
}
})
it('should warn on custom /_error without custom /404', async () => {
......@@ -100,7 +106,10 @@ describe('Custom _error', () => {
expect(buildOutput).not.toMatch(/ƒ .*?\/_error/)
})
runTests()
it('renders custom _error successfully', async () => {
const html = await renderViaHTTP(appPort, '/')
expect(html).toMatch(/Custom error/)
})
}
)
})
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