Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

pages router: ensure x-middleware-cache is respected #67734

Merged
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
pages router: ensure x-middleware-cache is respected
  • Loading branch information
ztanner committed Jul 13, 2024
commit 875808c95d21e78b05148eec7a6a6c983339127b
6 changes: 5 additions & 1 deletion packages/next/src/shared/lib/router/router.ts
Original file line number Diff line number Diff line change
Expand Up @@ -588,7 +588,11 @@ function fetchNextData({
// without blocking navigation when stale data is available
if (unstable_skipClientCache && persistCache) {
return getData({}).then((data) => {
inflightCache[cacheKey] = Promise.resolve(data)
if (data.response.headers.get('x-middleware-cache') !== 'no-cache') {
// only update cache if not marked as no-cache
inflightCache[cacheKey] = Promise.resolve(data)
}

return data
})
}
Expand Down
13 changes: 13 additions & 0 deletions test/e2e/middleware-rewrites/app/middleware.js
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,19 @@ export async function middleware(request) {
return NextResponse.rewrite(url)
}

if (url.pathname === '/dynamic-no-cache/1') {
const rewriteUrl =
request.headers.get('purpose') === 'prefetch'
? '/dynamic-no-cache/1'
: '/dynamic-no-cache/2'

url.pathname = rewriteUrl

return NextResponse.rewrite(url, {
headers: { 'x-middleware-cache': 'no-cache' },
})
}

if (
url.pathname === '/rewrite-me-without-hard-navigation' ||
url.searchParams.get('path') === 'rewrite-me-without-hard-navigation'
Expand Down
22 changes: 22 additions & 0 deletions test/e2e/middleware-rewrites/app/pages/dynamic-no-cache/[id].js
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
export default function Dynamic({ id }) {
return (
<main id="dynamic-page">
<h1>Page {id}</h1>
</main>
)
}

export const getStaticProps = async ({ params }) => {
return {
props: {
id: params.id,
},
}
}

export const getStaticPaths = async () => {
return {
paths: [{ params: { id: '1' } }, { params: { id: '2' } }],
fallback: false,
}
}
1 change: 1 addition & 0 deletions test/e2e/middleware-rewrites/app/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ export default function Home() {
<Link href="/ssg" id="normal-ssg-link">
normal SSG link
</Link>
<Link href="/dynamic-no-cache/1">/dynamic-no-cache/1</Link>
<div />
<a
href=""
Expand Down
34 changes: 33 additions & 1 deletion test/e2e/middleware-rewrites/test/index.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { NextInstance } from 'e2e-utils'
import { check, fetchViaHTTP, retry } from 'next-test-utils'
import { createNext, FileRef } from 'e2e-utils'
import escapeStringRegexp from 'escape-string-regexp'
import { Request } from 'playwright'
import { Request, Response } from 'playwright'

describe('Middleware Rewrite', () => {
let next: NextInstance
Expand Down Expand Up @@ -363,6 +363,38 @@ describe('Middleware Rewrite', () => {
})

if (!(global as any).isNextDev) {
it('should opt out of prefetch caching for dynamic routes', async () => {
const browser = await webdriver(next.url, '/')
await browser.eval('window.__SAME_PAGE = true')
await browser.waitForIdleNetwork()
let hasResolvedPrefetch = false

browser.on('response', async (res: Response) => {
const req = res.request()
const headers = await req.allHeaders()
if (
headers['purpose'] === 'prefetch' &&
req.url().includes('/dynamic-no-cache/1')
) {
hasResolvedPrefetch = true
}
})

await browser.elementByCss("[href='/dynamic-no-cache/1']").moveTo()

if (!(global as any).isNextDev) {
await retry(async () => {
expect(hasResolvedPrefetch).toBe(true)
})
}

await browser.elementByCss("[href='/dynamic-no-cache/1']").click()

await browser.waitForElementByCss('#dynamic-page')
expect(await browser.elementById('dynamic-page').text()).toBe('Page 2')
expect(await browser.eval('window.__SAME_PAGE')).toBe(true)
})

it('should not prefetch non-SSG routes', async () => {
const browser = await webdriver(next.url, '/')

Expand Down
Loading