Files
Tim NeutkensandGitHub 0c0573fd65 Improve handling of failed nextBuild() calls in test suite (#63717)
## What?

Currently `next build` with Turbopack fails to run in certain tests (as
expected), the problem with that is that the `afterAll()` calls assume
the server was started, which doesn't happen when the build fails, and
then causes a timeout that can't be reported if an error happens. This
change ensures the error around `server['__app']` doesn't happen.

<!-- 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-2933
2024-03-27 19:29:16 +01:00

84 lines
2.7 KiB
TypeScript

import { Server } from 'http'
import {
findPort,
nextBuild,
startStaticServer,
stopApp,
} from 'next-test-utils'
import webdriver from 'next-webdriver'
import { join } from 'path'
describe('bfcache-routing', () => {
let port: number
let app: Server
beforeAll(async () => {
const appDir = __dirname
const exportDir = join(appDir, 'out')
await nextBuild(appDir, undefined, { cwd: appDir })
port = await findPort()
app = await startStaticServer(exportDir, undefined, port)
})
afterAll(() => {
stopApp(app)
})
it('should not suspend indefinitely when page is restored from bfcache after an mpa navigation', async () => {
// bfcache is not currently supported by CDP, so we need to run this particular test in headed mode
// https://bugs.chromium.org/p/chromium/issues/detail?id=1317959
if (!process.env.CI && process.env.HEADLESS) {
console.warn('This test can only run in headed mode. Skipping...')
return
}
const browser = await webdriver(port, '/index.html', { headless: false })
// we overwrite the typical waitUntil: 'load' option here as the event is never being triggered if we hit the bfcache
const bfOptions = { waitUntil: 'commit' }
await browser.elementByCss('a[href="https://example.vercel.sh"]').click()
await browser.waitForCondition(
'window.location.origin === "https://example.vercel.sh"'
)
await browser.back(bfOptions)
await browser.waitForCondition(
'window.location.origin.includes("localhost")'
)
let html = await browser.evalAsync('document.documentElement.innerHTML')
expect(html).toContain('BFCache Test')
await browser.evalAsync(`document.querySelector('button').click()`)
// we should still be on the test page
html = await browser.evalAsync('document.documentElement.innerHTML')
expect(html).toContain('BFCache Test')
await browser.forward(bfOptions)
await browser.back(bfOptions)
await browser.waitForCondition(
'window.location.origin.includes("localhost")'
)
// we should be back on the test page with no errors
html = await browser.evalAsync('document.documentElement.innerHTML')
expect(html).toContain('BFCache Test')
// After restoring from bfcache, a subsequent mpa navigation to the same URL should work
// We trigger the click via `evalAsync` because when restoring from bfcache, our internal
// 'waitForElementByCss' method doesn't think the element is attached to the DOM.
await browser.evalAsync(
`document.querySelector('a[href="https://example.vercel.sh"]').click()`
)
await browser.waitForCondition(
'window.location.origin === "https://example.vercel.sh"'
)
})
})