Unverified Commit 270487d7 authored by Tim Neutkens's avatar Tim Neutkens Committed by GitHub

Make sure 404 pages do not get cached by a CDN when using next start (#24983)

Co-authored-by: 's avatarJiachi Liu <inbox@huozhi.im>
Co-authored-by: 's avatarJJ Kasper <jj@jjsweb.site>
parent 138b9ddf
...@@ -344,7 +344,7 @@ export function getPageHandler(ctx: ServerlessHandlerCtx) { ...@@ -344,7 +344,7 @@ export function getPageHandler(ctx: ServerlessHandlerCtx) {
poweredByHeader, poweredByHeader,
}, },
{ {
private: isPreviewMode, private: isPreviewMode || page === '/404',
stateful: !!getServerSideProps, stateful: !!getServerSideProps,
revalidate: renderOpts.revalidate, revalidate: renderOpts.revalidate,
} }
...@@ -385,7 +385,7 @@ export function getPageHandler(ctx: ServerlessHandlerCtx) { ...@@ -385,7 +385,7 @@ export function getPageHandler(ctx: ServerlessHandlerCtx) {
poweredByHeader, poweredByHeader,
}, },
{ {
private: isPreviewMode, private: isPreviewMode || renderOpts.is404Page,
stateful: !!getServerSideProps, stateful: !!getServerSideProps,
revalidate: renderOpts.revalidate, revalidate: renderOpts.revalidate,
} }
......
...@@ -1614,7 +1614,8 @@ export default class Server { ...@@ -1614,7 +1614,8 @@ export default class Server {
const revalidateOptions = !this.renderOpts.dev const revalidateOptions = !this.renderOpts.dev
? { ? {
private: isPreviewMode, // When the page is 404 cache-control should not be added
private: isPreviewMode || is404Page,
stateful: false, // GSP response stateful: false, // GSP response
revalidate: revalidate:
cachedData.curRevalidate !== undefined cachedData.curRevalidate !== undefined
...@@ -1842,7 +1843,7 @@ export default class Server { ...@@ -1842,7 +1843,7 @@ export default class Server {
const revalidateOptions = const revalidateOptions =
!this.renderOpts.dev || (hasServerProps && !isDataReq) !this.renderOpts.dev || (hasServerProps && !isDataReq)
? { ? {
private: isPreviewMode, private: isPreviewMode || is404Page,
stateful: !isSSG, stateful: !isSSG,
revalidate: sprRevalidate, revalidate: sprRevalidate,
} }
......
...@@ -25,6 +25,9 @@ let nextConfigContent ...@@ -25,6 +25,9 @@ let nextConfigContent
let appPort let appPort
let app let app
const getCacheHeader = async (port, pathname) =>
(await fetchViaHTTP(port, pathname)).headers.get('Cache-Control')
const runTests = (mode = 'server') => { const runTests = (mode = 'server') => {
it('should use pages/404', async () => { it('should use pages/404', async () => {
const html = await renderViaHTTP(appPort, '/abc') const html = await renderViaHTTP(appPort, '/abc')
...@@ -108,6 +111,72 @@ describe('404 Page Support', () => { ...@@ -108,6 +111,72 @@ describe('404 Page Support', () => {
runTests('serverless') runTests('serverless')
}) })
it('should not cache for custom 404 page with gssp and revalidate disabled', async () => {
await fs.move(pages404, `${pages404}.bak`)
await fs.writeFile(
pages404,
`
const page = () => 'custom 404 page'
export async function getStaticProps() { return { props: {} } }
export default page
`
)
await nextBuild(appDir)
appPort = await findPort()
app = await nextStart(appDir, appPort)
const cache404 = await getCacheHeader(appPort, '/404')
const cacheNext = await getCacheHeader(appPort, '/_next/abc')
await fs.remove(pages404)
await fs.move(`${pages404}.bak`, pages404)
await killApp(app)
expect(cache404).toBe(
'private, no-cache, no-store, max-age=0, must-revalidate'
)
expect(cacheNext).toBe(
'private, no-cache, no-store, max-age=0, must-revalidate'
)
})
it('should not cache for custom 404 page with gssp and revalidate enabled', async () => {
await fs.move(pages404, `${pages404}.bak`)
await fs.writeFile(
pages404,
`
const page = () => 'custom 404 page'
export async function getStaticProps() { return { props: {}, revalidate: 1 } }
export default page
`
)
await nextBuild(appDir)
appPort = await findPort()
app = await nextStart(appDir, appPort)
const cache404 = await getCacheHeader(appPort, '/404')
const cacheNext = await getCacheHeader(appPort, '/_next/abc')
await fs.remove(pages404)
await fs.move(`${pages404}.bak`, pages404)
await killApp(app)
expect(cache404).toBe(
'private, no-cache, no-store, max-age=0, must-revalidate'
)
expect(cacheNext).toBe(
'private, no-cache, no-store, max-age=0, must-revalidate'
)
})
it('should not cache for custom 404 page without gssp', async () => {
await nextBuild(appDir)
appPort = await findPort()
app = await nextStart(appDir, appPort)
const cache404 = await getCacheHeader(appPort, '/404')
const cacheNext = await getCacheHeader(appPort, '/_next/abc')
await killApp(app)
expect(cache404).toBe(null)
expect(cacheNext).toBe('no-cache, no-store, max-age=0, must-revalidate')
})
it('falls back to _error correctly without pages/404', async () => { it('falls back to _error correctly without pages/404', async () => {
await fs.move(pages404, `${pages404}.bak`) await fs.move(pages404, `${pages404}.bak`)
appPort = await findPort() appPort = await findPort()
......
...@@ -22,9 +22,9 @@ const runTests = () => { ...@@ -22,9 +22,9 @@ const runTests = () => {
let res = await fetchViaHTTP(appPort, '/fallback-blocking/hello') let res = await fetchViaHTTP(appPort, '/fallback-blocking/hello')
let $ = cheerio.load(await res.text()) let $ = cheerio.load(await res.text())
expect(res.headers.get('cache-control')).toBe( const privateCache =
's-maxage=1, stale-while-revalidate' 'private, no-cache, no-store, max-age=0, must-revalidate'
) expect(res.headers.get('cache-control')).toBe(privateCache)
expect(res.status).toBe(404) expect(res.status).toBe(404)
expect(JSON.parse($('#props').text()).notFound).toBe(true) expect(JSON.parse($('#props').text()).notFound).toBe(true)
...@@ -32,9 +32,7 @@ const runTests = () => { ...@@ -32,9 +32,7 @@ const runTests = () => {
res = await fetchViaHTTP(appPort, '/fallback-blocking/hello') res = await fetchViaHTTP(appPort, '/fallback-blocking/hello')
$ = cheerio.load(await res.text()) $ = cheerio.load(await res.text())
expect(res.headers.get('cache-control')).toBe( expect(res.headers.get('cache-control')).toBe(privateCache)
's-maxage=1, stale-while-revalidate'
)
expect(res.status).toBe(404) expect(res.status).toBe(404)
expect(JSON.parse($('#props').text()).notFound).toBe(true) expect(JSON.parse($('#props').text()).notFound).toBe(true)
...@@ -89,7 +87,7 @@ const runTests = () => { ...@@ -89,7 +87,7 @@ const runTests = () => {
let $ = cheerio.load(await res.text()) let $ = cheerio.load(await res.text())
expect(res.headers.get('cache-control')).toBe( expect(res.headers.get('cache-control')).toBe(
's-maxage=1, stale-while-revalidate' 'private, no-cache, no-store, max-age=0, must-revalidate'
) )
expect(res.status).toBe(404) expect(res.status).toBe(404)
expect(JSON.parse($('#props').text()).notFound).toBe(true) expect(JSON.parse($('#props').text()).notFound).toBe(true)
......
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