Unverified Commit c7f7de96 authored by JJ Kasper's avatar JJ Kasper Committed by GitHub

Ensure pages/500 handles cache-control as expected (#72050) (#72110)

When `pages/500` uses `getStaticProps` we can honor statically
generating the page but we can't send a `Cache-Control` with
`stale-while-revalidate` as we shouldn't be caching errored pages ever.
This ensures we handle that case and add a regression test for it.

<!-- 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 fc088130
......@@ -2671,6 +2671,8 @@ export default abstract class Server<ServerOptions extends Options = Options> {
const notFoundRevalidate = getRequestMeta(req, 'notFoundRevalidate')
revalidate =
typeof notFoundRevalidate === 'undefined' ? 0 : notFoundRevalidate
} else if (is500Page) {
revalidate = 0
}
// If the cache entry has a revalidate value that's a number, use it.
......
......@@ -120,6 +120,50 @@ describe('500 Page Support', () => {
;(process.env.TURBOPACK_DEV ? describe.skip : describe)(
'production mode 2',
() => {
it('should have correct cache control for 500 page with getStaticProps', async () => {
const orig500 = await fs.readFile(pages500, 'utf8')
try {
await fs.writeFile(
pages500,
`
export default function Page() {
return (
<p>custom 500</p>
)
}
export function getStaticProps() {
return {
props: {
now: Date.now(),
}
}
}
`
)
await fs.remove(join(appDir, '.next'))
const { code } = await nextBuild(appDir, [], {
stderr: true,
stdout: true,
})
expect(code).toBe(0)
const appPort = await findPort()
const app = await nextStart(appDir, appPort)
const res = await fetchViaHTTP(appPort, '/err')
await killApp(app)
expect(res.status).toBe(500)
expect(res.headers.get('cache-control')).toBe(
'private, no-cache, no-store, max-age=0, must-revalidate'
)
} finally {
await fs.writeFile(pages500, orig500)
}
})
it('does not build 500 statically with getInitialProps in _app', async () => {
await fs.writeFile(
pagesApp,
......
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