Unverified Commit 99e10a07 authored by JJ Kasper's avatar JJ Kasper Committed by GitHub

Ensure data prefetch for default locale is correct (#19085)

This makes sure SSG data is correctly prefetched for the default locale and other locales on the same page. Tests for this behavior have been added for catch-all and normal pages. 

Closes: https://github.com/vercel/next.js/issues/19048
parent ab0e2744
...@@ -52,8 +52,13 @@ function prefetch( ...@@ -52,8 +52,13 @@ function prefetch(
throw err throw err
} }
}) })
const curLocale =
options && typeof options.locale !== 'undefined'
? options.locale
: router && router.locale
// Join on an invalid URI character // Join on an invalid URI character
prefetched[href + '%' + as] = true prefetched[href + '%' + as + (curLocale ? '%' + curLocale : '')] = true
} }
function isModifiedEvent(event: React.MouseEvent) { function isModifiedEvent(event: React.MouseEvent) {
...@@ -251,11 +256,13 @@ function Link(props: React.PropsWithChildren<LinkProps>) { ...@@ -251,11 +256,13 @@ function Link(props: React.PropsWithChildren<LinkProps>) {
) )
useEffect(() => { useEffect(() => {
const shouldPrefetch = isVisible && p && isLocalURL(href) const shouldPrefetch = isVisible && p && isLocalURL(href)
const isPrefetched = prefetched[href + '%' + as] const curLocale =
typeof locale !== 'undefined' ? locale : router && router.locale
const isPrefetched =
prefetched[href + '%' + as + (curLocale ? '%' + curLocale : '')]
if (shouldPrefetch && !isPrefetched) { if (shouldPrefetch && !isPrefetched) {
prefetch(router, href, as, { prefetch(router, href, as, {
locale: locale: curLocale,
typeof locale !== 'undefined' ? locale : router && router.locale,
}) })
} }
}, [as, href, isVisible, locale, p, router]) }, [as, href, isVisible, locale, p, router])
......
import Link from 'next/link'
import { useRouter } from 'next/router'
export default function Page(props) {
const router = useRouter()
return (
<>
<p id="links">links page</p>
<p id="props">{JSON.stringify(props)}</p>
<p id="router-locale">{router.locale}</p>
<p id="router-default-locale">{router.defaultLocale}</p>
<p id="router-locales">{JSON.stringify(router.locales)}</p>
<p id="router-query">{JSON.stringify(router.query)}</p>
<p id="router-pathname">{router.pathname}</p>
<p id="router-as-path">{router.asPath}</p>
<Link href="/gsp" locale="en-US">
<a id="to-gsp-en-us">to /gsp</a>
</Link>
<br />
<Link href="/gsp" locale="nl-NL">
<a id="to-gsp-nl-nl">to /gsp</a>
</Link>
<br />
<Link href="/gsp" locale="fr">
<a id="to-gsp-fr">to /gsp</a>
</Link>
</>
)
}
...@@ -15,6 +15,16 @@ export default function Page(props) { ...@@ -15,6 +15,16 @@ export default function Page(props) {
<p id="router-pathname">{router.pathname}</p> <p id="router-pathname">{router.pathname}</p>
<p id="router-as-path">{router.asPath}</p> <p id="router-as-path">{router.asPath}</p>
<Link href="/" locale="en-US">
<a id="to-def-locale-index">to /</a>
</Link>
<br />
<Link href="/another" locale="en-US">
<a id="to-def-locale-another">to /another</a>
</Link>
<br />
<Link href="/" locale="nl-NL"> <Link href="/" locale="nl-NL">
<a id="to-locale-index">to /nl-nl</a> <a id="to-locale-index">to /nl-nl</a>
</Link> </Link>
...@@ -24,6 +34,16 @@ export default function Page(props) { ...@@ -24,6 +34,16 @@ export default function Page(props) {
<a id="to-locale-another">to /nl-nl/another</a> <a id="to-locale-another">to /nl-nl/another</a>
</Link> </Link>
<br /> <br />
<Link href="/" locale="fr">
<a id="to-fr-locale-index">to /fr</a>
</Link>
<br />
<Link href="/another" locale="fr">
<a id="to-fr-locale-another">to /fr/another</a>
</Link>
<br />
</> </>
) )
} }
......
/* eslint-env jest */ /* eslint-env jest */
import assert from 'assert'
import http from 'http' import http from 'http'
import qs from 'querystring' import qs from 'querystring'
import fs from 'fs-extra' import fs from 'fs-extra'
...@@ -188,6 +188,43 @@ function runTests(isDev) { ...@@ -188,6 +188,43 @@ function runTests(isDev) {
defaultLocale: 'en-US', defaultLocale: 'en-US',
}) })
}) })
if (!isDev) {
it('should preload data correctly', async () => {
const browser = await webdriver(appPort, '/')
await browser.eval(`(function() {
document.querySelector('#to-def-locale-index').scrollIntoView()
document.querySelector('#to-def-locale-another').scrollIntoView()
document.querySelector('#to-locale-index').scrollIntoView()
document.querySelector('#to-locale-another').scrollIntoView()
document.querySelector('#to-fr-locale-another').scrollIntoView()
document.querySelector('#to-fr-locale-index').scrollIntoView()
})()`)
await check(async () => {
const hrefs = await browser.eval(`Object.keys(window.next.router.sdc)`)
hrefs.sort()
console.log({ hrefs })
assert.deepEqual(
hrefs.map((href) =>
new URL(href).pathname.replace(/^\/_next\/data\/[^/]+/, '')
),
[
'/en-US.json',
'/en-US/another.json',
'/fr.json',
'/fr/another.json',
'/nl-NL.json',
'/nl-NL/another.json',
]
)
return 'yes'
}, 'yes')
})
}
} }
describe('i18n Support Root Catch-all', () => { describe('i18n Support Root Catch-all', () => {
......
import Link from 'next/link'
import { useRouter } from 'next/router'
export default function Page(props) {
const router = useRouter()
return (
<>
<p id="links">links page</p>
<p id="props">{JSON.stringify(props)}</p>
<p id="router-locale">{router.locale}</p>
<p id="router-default-locale">{router.defaultLocale}</p>
<p id="router-locales">{JSON.stringify(router.locales)}</p>
<p id="router-query">{JSON.stringify(router.query)}</p>
<p id="router-pathname">{router.pathname}</p>
<p id="router-as-path">{router.asPath}</p>
<Link href="/gsp" locale="en-US">
<a id="to-gsp-en-us">to /gsp</a>
</Link>
<br />
<Link href="/gsp" locale="nl-NL">
<a id="to-gsp-nl-nl">to /gsp</a>
</Link>
<br />
<Link href="/gsp" locale="fr">
<a id="to-gsp-fr">to /gsp</a>
</Link>
</>
)
}
...@@ -38,6 +38,31 @@ export function runTests(ctx) { ...@@ -38,6 +38,31 @@ export function runTests(ctx) {
'`redirect` and `notFound` can not both be returned from getStaticProps at the same time. Page: /gsp/fallback/[slug]' '`redirect` and `notFound` can not both be returned from getStaticProps at the same time. Page: /gsp/fallback/[slug]'
) )
}) })
} else {
it('should preload all locales data correctly', async () => {
const browser = await webdriver(ctx.appPort, `${ctx.basePath}/mixed`)
await browser.eval(`(function() {
document.querySelector('#to-gsp-en-us').scrollIntoView()
document.querySelector('#to-gsp-nl-nl').scrollIntoView()
document.querySelector('#to-gsp-fr').scrollIntoView()
})()`)
await check(async () => {
const hrefs = await browser.eval(`Object.keys(window.next.router.sdc)`)
hrefs.sort()
assert.deepEqual(
hrefs.map((href) =>
new URL(href).pathname
.replace(ctx.basePath, '')
.replace(/^\/_next\/data\/[^/]+/, '')
),
['/en-US/gsp.json', '/fr/gsp.json', '/nl-NL/gsp.json']
)
return 'yes'
}, 'yes')
})
} }
it('should have correct values for non-prefixed path', async () => { it('should have correct values for non-prefixed path', async () => {
......
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