Skip to content

Commit

Permalink
de-flake prerender-prefetch test (vercel#63739)
Browse files Browse the repository at this point in the history
This test frequently fails, likely because it's possible to navigate
before the revalidation finishes


[x-ref](https://github.com/vercel/next.js/actions/runs/8441089149/job/23119594182#step:27:299)

[x-ref](https://github.com/vercel/next.js/actions/runs/8441133466/job/23119898500?pr=63606#step:27:297)

<!-- 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-2942
  • Loading branch information
ztanner authored Mar 26, 2024
1 parent 9b4a055 commit 8d979b6
Showing 1 changed file with 39 additions and 1 deletion.
40 changes: 39 additions & 1 deletion test/production/prerender-prefetch/index.test.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
import { NextInstance } from 'test/lib/next-modes/base'
import { createNext, FileRef } from 'e2e-utils'
import { check, fetchViaHTTP, renderViaHTTP, waitFor } from 'next-test-utils'
import {
check,
fetchViaHTTP,
renderViaHTTP,
retry,
waitFor,
} from 'next-test-utils'
import { join } from 'path'
import webdriver from 'next-webdriver'
import assert from 'assert'
Expand Down Expand Up @@ -95,6 +101,22 @@ describe('Prerender prefetch', () => {
return next.cliOutput.substring(outputIndex)
}, /revalidating \/blog first/)

// wait for the revalidation to finish by comparing timestamps
await retry(async () => {
const timeRes = await fetchViaHTTP(
next.url,
`/_next/data/${next.buildId}/blog/first.json`,
undefined,
{
headers: {
purpose: 'prefetch',
},
}
)
const updatedTime = (await timeRes.json()).pageProps.now
expect(updatedTime).not.toBe(startTime)
})

// now trigger cache update and navigate again
await browser.eval(
'next.router.prefetch("/blog/first", undefined, { unstable_skipClientCache: true }).finally(() => { window.prefetchDone = "yes" })'
Expand Down Expand Up @@ -142,6 +164,22 @@ describe('Prerender prefetch', () => {
return next.cliOutput.substring(outputIndex)
}, /revalidating \/blog first/)

// wait for the revalidation to finish by comparing timestamps
await retry(async () => {
const timeRes = await fetchViaHTTP(
next.url,
`/_next/data/${next.buildId}/blog/first.json`,
undefined,
{
headers: {
purpose: 'prefetch',
},
}
)
const updatedTime = (await timeRes.json()).pageProps.now
expect(updatedTime).not.toBe(startTime)
})

// now trigger cache update and navigate again
await browser.eval(
'next.router.push("/blog/first", undefined, { unstable_skipClientCache: true }).finally(() => { window.prefetchDone = "yes" })'
Expand Down

0 comments on commit 8d979b6

Please sign in to comment.