Unverified Commit 8a067804 authored by JJ Kasper's avatar JJ Kasper Committed by GitHub

Ensure providing only query on dynamic route works as expected (#25469)

parent d836ebb2
......@@ -211,19 +211,15 @@ function Link(props: React.PropsWithChildren<LinkProps>) {
}
}
const p = props.prefetch !== false
const router = useRouter()
const pathname = (router && router.asPath) || '/'
const { href, as } = React.useMemo(() => {
const [resolvedHref, resolvedAs] = resolveHref(pathname, props.href, true)
const [resolvedHref, resolvedAs] = resolveHref(router, props.href, true)
return {
href: resolvedHref,
as: props.as
? resolveHref(pathname, props.as)
: resolvedAs || resolvedHref,
as: props.as ? resolveHref(router, props.as) : resolvedAs || resolvedHref,
}
}, [pathname, props.href, props.as])
}, [router, props.href, props.as])
let { children, replace, shallow, scroll, locale } = props
......
......@@ -173,7 +173,8 @@ export function delBasePath(path: string): string {
*/
export function isLocalURL(url: string): boolean {
// prevent a hydration mismatch on href for url with anchor refs
if (url.startsWith('/') || url.startsWith('#')) return true
if (url.startsWith('/') || url.startsWith('#') || url.startsWith('?'))
return true
try {
// absolute urls can be local if they are on the same origin
const locationOrigin = getLocationOrigin()
......@@ -266,21 +267,24 @@ function omitParmsFromQuery(query: ParsedUrlQuery, params: string[]) {
* Preserves absolute urls.
*/
export function resolveHref(
currentPath: string,
router: NextRouter,
href: Url,
resolveAs?: boolean
): string {
// we use a dummy base url for relative urls
let base: URL
const urlAsString =
typeof href === 'string' ? href : formatWithValidation(href)
try {
base = new URL(currentPath, 'http://n')
base = new URL(
urlAsString.startsWith('#') ? router.asPath : router.pathname,
'http://n'
)
} catch (_) {
// fallback to / for invalid asPath values e.g. //
base = new URL('/', 'http://n')
}
const urlAsString =
typeof href === 'string' ? href : formatWithValidation(href)
// Return because it cannot be routed by the Next.js router
if (!isLocalURL(urlAsString)) {
return (resolveAs ? [urlAsString] : urlAsString) as string
......@@ -335,7 +339,7 @@ function stripOrigin(url: string) {
function prepareUrlAs(router: NextRouter, url: Url, as?: Url) {
// If url and as provided as an object representation,
// we'll format them into the string version here.
let [resolvedHref, resolvedAs] = resolveHref(router.asPath, url, true)
let [resolvedHref, resolvedAs] = resolveHref(router, url, true)
const origin = getLocationOrigin()
const hrefHadOrigin = resolvedHref.startsWith(origin)
const asHadOrigin = resolvedAs && resolvedAs.startsWith(origin)
......@@ -345,7 +349,7 @@ function prepareUrlAs(router: NextRouter, url: Url, as?: Url) {
const preparedUrl = hrefHadOrigin ? resolvedHref : addBasePath(resolvedHref)
const preparedAs = as
? stripOrigin(resolveHref(router.asPath, as))
? stripOrigin(resolveHref(router, as))
: resolvedAs || resolvedHref
return {
......
......@@ -14,6 +14,53 @@ const Page = () => {
<a id="dynamic-route-only-hash-obj">Dynamic route only hash object</a>
</Link>
<br />
<Link href="?name=post-2">
<a id="dynamic-route-only-query">Dynamic route only query</a>
</Link>
<br />
<Link href="?name=post-3&another=value">
<a id="dynamic-route-only-query-extra">
Dynamic route only query extra
</a>
</Link>
<br />
<Link href={{ query: { name: 'post-4' } }}>
<a id="dynamic-route-only-query-obj">Dynamic route only query object</a>
</Link>
<br />
<Link href={{ query: { name: 'post-5', another: 'value' } }}>
<a id="dynamic-route-only-query-obj-extra">
Dynamic route only query object extra
</a>
</Link>
<br />
<Link href="?name=post-2#hash-too">
<a id="dynamic-route-query-hash">Dynamic route query and hash</a>
</Link>
<br />
<Link href="?name=post-3&another=value#hash-again">
<a id="dynamic-route-query-extra-hash">
Dynamic route query extra and hash
</a>
</Link>
<br />
<Link href={{ query: { name: 'post-4' }, hash: 'hash-too' }}>
<a id="dynamic-route-query-hash-obj">
Dynamic route query and hash object
</a>
</Link>
<br />
<Link
href={{
query: { name: 'post-5', another: 'value' },
hash: 'hash-again',
}}
>
<a id="dynamic-route-query-obj-extra-hash">
Dynamic route query and hash object extra
</a>
</Link>
<br />
<p id="asdf">This is {query.name}</p>
<p id="query">{JSON.stringify(query)}</p>
</>
......
......@@ -30,23 +30,117 @@ const appDir = join(__dirname, '../')
const buildIdPath = join(appDir, '.next/BUILD_ID')
function runTests(dev) {
it('should handle only query on dynamic route', async () => {
const browser = await webdriver(appPort, '/post-1')
for (const expectedValues of [
{
id: 'dynamic-route-only-query',
pathname: '/post-2',
query: {},
hash: '',
navQuery: { name: 'post-2' },
},
{
id: 'dynamic-route-only-query-extra',
pathname: '/post-3',
query: { another: 'value' },
hash: '',
navQuery: { name: 'post-3', another: 'value' },
},
{
id: 'dynamic-route-only-query-obj',
pathname: '/post-4',
query: {},
hash: '',
navQuery: { name: 'post-4' },
},
{
id: 'dynamic-route-only-query-obj-extra',
pathname: '/post-5',
query: { another: 'value' },
hash: '',
navQuery: { name: 'post-5', another: 'value' },
},
{
id: 'dynamic-route-query-hash',
pathname: '/post-2',
query: {},
hash: '#hash-too',
navQuery: { name: 'post-2' },
},
{
id: 'dynamic-route-query-extra-hash',
pathname: '/post-3',
query: { another: 'value' },
hash: '#hash-again',
navQuery: { name: 'post-3', another: 'value' },
},
{
id: 'dynamic-route-query-hash-obj',
pathname: '/post-4',
query: {},
hash: '#hash-too',
navQuery: { name: 'post-4' },
},
{
id: 'dynamic-route-query-obj-extra-hash',
pathname: '/post-5',
query: { another: 'value' },
hash: '#hash-again',
navQuery: { name: 'post-5', another: 'value' },
},
]) {
const { id, pathname, query, hash, navQuery } = expectedValues
const parsedHref = url.parse(
await browser.elementByCss(`#${id}`).getAttribute('href'),
true
)
expect(parsedHref.pathname).toBe(pathname)
expect(parsedHref.query || {}).toEqual(query)
expect(parsedHref.hash || '').toBe(hash)
await browser.eval('window.beforeNav = 1')
await browser.elementByCss(`#${id}`).click()
await check(() => browser.eval('window.location.pathname'), pathname)
expect(JSON.parse(await browser.elementByCss('#query').text())).toEqual(
navQuery
)
expect(await browser.eval('window.location.pathname')).toBe(pathname)
expect(await browser.eval('window.location.hash')).toBe(hash)
expect(
Object.fromEntries(
new URLSearchParams(await browser.eval('window.location.search'))
)
).toEqual(query)
expect(await browser.eval('window.beforeNav')).toBe(1)
}
})
it('should handle only hash on dynamic route', async () => {
const browser = await webdriver(appPort, '/post-1')
const parsedHref = url.parse(
await browser
.elementByCss('#dynamic-route-only-hash')
.getAttribute('href')
.getAttribute('href'),
true
)
expect(parsedHref.pathname).toBe('/post-1')
expect(parsedHref.hash).toBe('#only-hash')
expect(parsedHref.query || {}).toEqual({})
const parsedHref2 = url.parse(
await browser
.elementByCss('#dynamic-route-only-hash-obj')
.getAttribute('href')
.getAttribute('href'),
true
)
expect(parsedHref2.pathname).toBe('/post-1')
expect(parsedHref2.hash).toBe('#only-hash-obj')
expect(parsedHref2.query || {}).toEqual({})
expect(await browser.eval('window.location.hash')).toBe('')
await browser.elementByCss('#dynamic-route-only-hash').click()
......
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