Commit fbc7684e authored by Luke Sandberg's avatar Luke Sandberg Committed by Luke Sandberg

Scope Safari ?ts= cache-buster to CSS/font assets only (Pages Router) (#92580)

### What?

Refactors the Safari `?ts=` cache-busting workaround in the Pages Router so it **only appears on CSS and font URLs**, not on script tags or script preload links.

### Why?

The `?ts=` timestamp was originally added to all preloaded assets as a workaround for a [Safari caching bug](https://bugs.webkit.org/show_bug.cgi?id=187726) (see [#5860](https://github.com/vercel/next.js/issues/5860)). When it appears on `<script>` tags, the Turbopack runtime's `getAssetSuffixFromScriptSrc()` reads the executing script's query string and infers it as the `ASSET_SUFFIX`, which then leaks onto all static asset URLs — including images. This causes `next/image` validation errors because the image URL gets an unexpected `?ts=` parameter.

Fixes #92118

### How?

Instead of maintaining parallel `assetQueryString` (with `?ts=`) and `scriptAssetQueryString` (without `?ts=`) paths, this PR:

1. **`assetQueryString`** carries only the deployment token (`?dpl=...`) and is used for all script-related URLs (script tags, script preloads)
2. **`safariCacheBuster`** is a new, separate field (`?ts=<timestamp>` or `""`) that is only combined with `assetQueryString` at the 3 CSS/font URL sites via a `joinQueryStrings()` helper
3. Removes the `scriptAssetQueryString` / `scriptMutableAssetQueryString` / `cssAssetQueryString` fields entirely

The Safari cache-buster is computed the same way as before (dev server only, Safari user-agent check) — it just no longer contaminates the base query string.

### Test plan

- [x] Updated existing test in `test/e2e/app-document/rendering.test.ts` to assert `?ts=` appears only on `<link rel="preload" as="style">` and `<link rel="preload" as="font">`, and does NOT appear on `<script>` or `<link rel="preload" as="script">`
- [x] `pnpm --filter=next types` passes

<!-- NEXT_JS_LLM_PR -->
parent 805d758d
...@@ -384,7 +384,7 @@ export class Head extends React.Component<HeadProps> { ...@@ -384,7 +384,7 @@ export class Head extends React.Component<HeadProps> {
getCssLinks(files: DocumentFiles): JSX.Element[] | null { getCssLinks(files: DocumentFiles): JSX.Element[] | null {
const { const {
assetPrefix, assetPrefix,
assetQueryString, cssAssetQueryString,
dynamicImports, dynamicImports,
dynamicCssManifest, dynamicCssManifest,
crossOrigin, crossOrigin,
...@@ -422,7 +422,7 @@ export class Head extends React.Component<HeadProps> { ...@@ -422,7 +422,7 @@ export class Head extends React.Component<HeadProps> {
rel="preload" rel="preload"
href={`${assetPrefix}/_next/${encodeURIPath( href={`${assetPrefix}/_next/${encodeURIPath(
file file
)}${assetQueryString}`} )}${cssAssetQueryString}`}
as="style" as="style"
crossOrigin={this.props.crossOrigin || crossOrigin} crossOrigin={this.props.crossOrigin || crossOrigin}
/> />
...@@ -436,7 +436,7 @@ export class Head extends React.Component<HeadProps> { ...@@ -436,7 +436,7 @@ export class Head extends React.Component<HeadProps> {
rel="stylesheet" rel="stylesheet"
href={`${assetPrefix}/_next/${encodeURIPath( href={`${assetPrefix}/_next/${encodeURIPath(
file file
)}${assetQueryString}`} )}${cssAssetQueryString}`}
crossOrigin={this.props.crossOrigin || crossOrigin} crossOrigin={this.props.crossOrigin || crossOrigin}
data-n-g={isUnmanagedFile ? undefined : isSharedFile ? '' : undefined} data-n-g={isUnmanagedFile ? undefined : isSharedFile ? '' : undefined}
data-n-p={ data-n-p={
...@@ -589,7 +589,7 @@ export class Head extends React.Component<HeadProps> { ...@@ -589,7 +589,7 @@ export class Head extends React.Component<HeadProps> {
optimizeCss, optimizeCss,
assetPrefix, assetPrefix,
nextFontManifest, nextFontManifest,
assetQueryString, cssAssetQueryString,
} = this.context } = this.context
const disableRuntimeJS = unstable_runtimeJS === false const disableRuntimeJS = unstable_runtimeJS === false
...@@ -659,7 +659,7 @@ export class Head extends React.Component<HeadProps> { ...@@ -659,7 +659,7 @@ export class Head extends React.Component<HeadProps> {
nextFontManifest, nextFontManifest,
dangerousAsPath, dangerousAsPath,
assetPrefix, assetPrefix,
assetQueryString cssAssetQueryString
) )
const tracingMetadata = getTracedMetadata( const tracingMetadata = getTracedMetadata(
......
...@@ -67,8 +67,6 @@ export type AppPageRenderResultMetadata = { ...@@ -67,8 +67,6 @@ export type AppPageRenderResultMetadata = {
export type PagesRenderResultMetadata = { export type PagesRenderResultMetadata = {
pageData?: any pageData?: any
cacheControl?: CacheControl cacheControl?: CacheControl
assetQueryString?: string
mutableAssetQueryString?: string
isNotFound?: boolean isNotFound?: boolean
isRedirect?: boolean isRedirect?: boolean
} }
......
...@@ -254,7 +254,6 @@ export type RenderOptsPartial = { ...@@ -254,7 +254,6 @@ export type RenderOptsPartial = {
optimizeCss: any optimizeCss: any
nextConfigOutput?: 'standalone' | 'export' nextConfigOutput?: 'standalone' | 'export'
nextScriptWorkers: any nextScriptWorkers: any
assetQueryString?: string
resolvedUrl?: string resolvedUrl?: string
resolvedAsPath?: string resolvedAsPath?: string
setIsrStatus?: (key: string, value: boolean | undefined) => void setIsrStatus?: (key: string, value: boolean | undefined) => void
...@@ -445,6 +444,16 @@ function serializeError( ...@@ -445,6 +444,16 @@ function serializeError(
} }
} }
function getSafariCacheBusterQueryString(req: IncomingMessage): string {
if (process.env.__NEXT_DEV_SERVER) {
const userAgent = (req.headers['user-agent'] || '').toLowerCase()
if (userAgent.includes('safari') && !userAgent.includes('chrome')) {
return `?ts=${Date.now()}`
}
}
return ''
}
export async function renderToHTMLImpl( export async function renderToHTMLImpl(
req: IncomingMessage, req: IncomingMessage,
res: ServerResponse, res: ServerResponse,
...@@ -458,35 +467,30 @@ export async function renderToHTMLImpl( ...@@ -458,35 +467,30 @@ export async function renderToHTMLImpl(
// Adds support for reading `cookies` in `getServerSideProps` when SSR. // Adds support for reading `cookies` in `getServerSideProps` when SSR.
setLazyProp({ req: req as any }, 'cookies', getCookieParser(req.headers)) setLazyProp({ req: req as any }, 'cookies', getCookieParser(req.headers))
let baseAssetQueryString = // cssCacheBuster is a workaround for a Safari bug
(process.env.__NEXT_DEV_SERVER && renderOpts.assetQueryString) || '' // (https://bugs.webkit.org/show_bug.cgi?id=187726) where preloaded CSS
// resources are cached and not re-fetched on HMR. It must only be applied
if (process.env.__NEXT_DEV_SERVER && !baseAssetQueryString) { // to CSS and font assets — not to script tags — because the Turbopack
const userAgent = (req.headers['user-agent'] || '').toLowerCase() // runtime infers ASSET_SUFFIX from the executing script's query string and
if (userAgent.includes('safari') && !userAgent.includes('chrome')) { // leaks it onto all static asset URLs (including images), causing
// In dev we invalidate the cache by appending a timestamp to the resource URL. // next/image validation errors.
// This is a workaround to fix https://github.com/vercel/next.js/issues/5860 // See https://github.com/vercel/next.js/issues/92118.
// TODO: remove this workaround when https://bugs.webkit.org/show_bug.cgi?id=187726 is fixed. const cssCacheBuster = getSafariCacheBusterQueryString(req)
// Note: The workaround breaks breakpoints on reload since the script url always changes,
// so we only apply it to Safari. const mutableAssetQueryString = sharedContext.deploymentId
baseAssetQueryString = `?ts=${Date.now()}` ? `?dpl=${sharedContext.deploymentId}`
} : ''
} const assetQueryString = sharedContext.clientAssetToken
? `?dpl=${sharedContext.clientAssetToken}`
const mutableAssetQueryString = : ''
baseAssetQueryString + // cssAssetQueryString is assetQueryString with the cacheBuster prepended.
(sharedContext.deploymentId // Use this for CSS and font URLs; use assetQueryString for script URLs.
? `${baseAssetQueryString ? '&' : '?'}dpl=${sharedContext.deploymentId}` const cssAssetQueryString =
: '') cssCacheBuster +
const assetQueryString =
baseAssetQueryString +
(sharedContext.clientAssetToken (sharedContext.clientAssetToken
? `${baseAssetQueryString ? '&' : '?'}dpl=${sharedContext.clientAssetToken}` ? `${cssCacheBuster ? '&' : '?'}dpl=${sharedContext.clientAssetToken}`
: '') : '')
const metadata: PagesRenderResultMetadata = { const metadata: PagesRenderResultMetadata = {}
assetQueryString,
mutableAssetQueryString,
}
// don't modify original query object // don't modify original query object
query = Object.assign({}, query) query = Object.assign({}, query)
...@@ -1530,8 +1534,9 @@ export async function renderToHTMLImpl( ...@@ -1530,8 +1534,9 @@ export async function renderToHTMLImpl(
? pageConfig.unstable_runtimeJS ? pageConfig.unstable_runtimeJS
: undefined, : undefined,
unstable_JsPreload: pageConfig.unstable_JsPreload, unstable_JsPreload: pageConfig.unstable_JsPreload,
assetQueryString: assetQueryString || '', assetQueryString,
mutableAssetQueryString: mutableAssetQueryString || '', cssAssetQueryString,
mutableAssetQueryString,
scriptLoader, scriptLoader,
locale, locale,
disableOptimizedLoading, disableOptimizedLoading,
......
...@@ -31,6 +31,11 @@ export type HtmlProps = { ...@@ -31,6 +31,11 @@ export type HtmlProps = {
unstable_JsPreload?: false unstable_JsPreload?: false
assetQueryString: string assetQueryString: string
mutableAssetQueryString: string mutableAssetQueryString: string
/**
* Asset query string for CSS and font assets.
* See https://github.com/vercel/next.js/issues/92118.
*/
cssAssetQueryString: string
scriptLoader: { scriptLoader: {
afterInteractive?: string[] afterInteractive?: string[]
beforeInteractive?: any[] beforeInteractive?: any[]
......
...@@ -81,19 +81,35 @@ describe('Document and App - Rendering via HTTP', () => { ...@@ -81,19 +81,35 @@ describe('Document and App - Rendering via HTTP', () => {
}) })
if (isNextDev) { if (isNextDev) {
// This is a workaround to fix https://github.com/vercel/next.js/issues/5860 // The ?ts= timestamp is a workaround for a Safari preload cache bug:
// TODO: remove this workaround when https://bugs.webkit.org/show_bug.cgi?id=187726 is fixed. // https://github.com/vercel/next.js/issues/5860
it('adds a timestamp to link tags with preload attribute to invalidate the cache in dev', async () => { // https://bugs.webkit.org/show_bug.cgi?id=187726
// It must only appear on CSS/font resources, not on script tags, because
// the Turbopack runtime reads ASSET_SUFFIX from the executing script's
// query string and would leak it onto image URLs.
it('adds a timestamp only to CSS/font link tags to invalidate the cache in dev', async () => {
const $ = await next.render$('/', undefined, { const $ = await next.render$('/', undefined, {
headers: { 'user-agent': 'Safari' }, headers: { 'user-agent': 'Safari' },
}) })
$('link[rel=preload]').each((index, element) => { // CSS preload links must have ?ts= for Safari cache busting
$('link[rel=preload][as=style]').each((index, element) => {
const href = $(element).attr('href') const href = $(element).attr('href')
expect(href).toMatch(/^[^?]+\?ts=\d+$/) expect(href).toMatch(/^[^?]+\?ts=\d+$/)
}) })
// Font preload links must have ?ts= for Safari cache busting
$('link[rel=preload][as=font]').each((index, element) => {
const href = $(element).attr('href')
expect(href).toMatch(/^[^?]+\?ts=\d+$/)
})
// Script preload links must NOT have ?ts= (Turbopack ASSET_SUFFIX bug)
$('link[rel=preload][as=script]').each((index, element) => {
const src = $(element).attr('href')
expect(src).not.toMatch(/[?&]ts=/)
})
// Script tags must NOT have ?ts= (Turbopack ASSET_SUFFIX bug)
$('script[src]').each((index, element) => { $('script[src]').each((index, element) => {
const src = $(element).attr('src') const src = $(element).attr('src')
expect(src).toMatch(/^[^?]+\?ts=\d+$/) expect(src).not.toMatch(/[?&]ts=/)
}) })
}) })
} }
......
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