Unverified Commit f942d9e8 authored by JJ Kasper's avatar JJ Kasper Committed by GitHub

Include additional query values when interpolating href (#16878)

Co-authored-by: 's avatarkodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
parent 2058c9f8
...@@ -216,7 +216,7 @@ export default class PageLoader { ...@@ -216,7 +216,7 @@ export default class PageLoader {
const isDynamic: boolean = isDynamicRoute(route) const isDynamic: boolean = isDynamicRoute(route)
const interpolatedRoute = isDynamic const interpolatedRoute = isDynamic
? interpolateAs(hrefPathname, asPathname, query) ? interpolateAs(hrefPathname, asPathname, query).result
: '' : ''
return isDynamic return isDynamic
......
...@@ -98,8 +98,10 @@ export function interpolateAs( ...@@ -98,8 +98,10 @@ export function interpolateAs(
query query
interpolatedRoute = route interpolatedRoute = route
const params = Object.keys(dynamicGroups)
if ( if (
!Object.keys(dynamicGroups).every((param) => { !params.every((param) => {
let value = dynamicMatches[param] || '' let value = dynamicMatches[param] || ''
const { repeat, optional } = dynamicGroups[param] const { repeat, optional } = dynamicGroups[param]
...@@ -129,7 +131,21 @@ export function interpolateAs( ...@@ -129,7 +131,21 @@ export function interpolateAs(
// n.b. We ignore this error because we handle warning for this case in // n.b. We ignore this error because we handle warning for this case in
// development in the `<Link>` component directly. // development in the `<Link>` component directly.
} }
return interpolatedRoute return {
params,
result: interpolatedRoute,
}
}
function omitParmsFromQuery(query: ParsedUrlQuery, params: string[]) {
const filteredQuery: ParsedUrlQuery = {}
Object.keys(query).forEach((key) => {
if (!params.includes(key)) {
filteredQuery[key] = query[key]
}
})
return filteredQuery
} }
/** /**
...@@ -157,11 +173,16 @@ export function resolveHref( ...@@ -157,11 +173,16 @@ export function resolveHref(
) { ) {
const query = searchParamsToUrlQuery(finalUrl.searchParams) const query = searchParamsToUrlQuery(finalUrl.searchParams)
interpolatedAs = interpolateAs( const { result, params } = interpolateAs(
finalUrl.pathname, finalUrl.pathname,
finalUrl.pathname, finalUrl.pathname,
query query
) )
interpolatedAs = formatWithValidation({
pathname: result,
hash: finalUrl.hash,
query: omitParmsFromQuery(query, params),
})
} }
// if the origin didn't change, it means we received a relative href // if the origin didn't change, it means we received a relative href
...@@ -608,7 +629,9 @@ export default class Router implements BaseRouter { ...@@ -608,7 +629,9 @@ export default class Router implements BaseRouter {
resolvedAs = delBasePath(resolvedAs) resolvedAs = delBasePath(resolvedAs)
if (isDynamicRoute(route)) { if (isDynamicRoute(route)) {
const { pathname: asPathname } = parseRelativeUrl(resolvedAs) const parsedAs = parseRelativeUrl(resolvedAs)
const asPathname = parsedAs.pathname
const routeRegex = getRouteRegex(route) const routeRegex = getRouteRegex(route)
const routeMatch = getRouteMatcher(routeRegex)(asPathname) const routeMatch = getRouteMatcher(routeRegex)(asPathname)
if (!routeMatch) { if (!routeMatch) {
...@@ -632,7 +655,13 @@ export default class Router implements BaseRouter { ...@@ -632,7 +655,13 @@ export default class Router implements BaseRouter {
) )
} }
} else if (route === asPathname) { } else if (route === asPathname) {
as = interpolateAs(route, asPathname, query) const { result, params } = interpolateAs(route, asPathname, query)
as = formatWithValidation(
Object.assign({}, parsedAs, {
pathname: result,
query: omitParmsFromQuery(query, params),
})
)
} else { } else {
// Merge params into `query`, overwriting any specified in search // Merge params into `query`, overwriting any specified in search
Object.assign(query, routeMatch) Object.assign(query, routeMatch)
......
...@@ -95,7 +95,7 @@ describe('Build Output', () => { ...@@ -95,7 +95,7 @@ describe('Build Output', () => {
expect(indexSize.endsWith('B')).toBe(true) expect(indexSize.endsWith('B')).toBe(true)
// should be no bigger than 60.2 kb // should be no bigger than 60.2 kb
expect(parseFloat(indexFirstLoad) - 60.2).toBeLessThanOrEqual(0) expect(parseFloat(indexFirstLoad) - 60.3).toBeLessThanOrEqual(0)
expect(indexFirstLoad.endsWith('kB')).toBe(true) expect(indexFirstLoad.endsWith('kB')).toBe(true)
expect(parseFloat(err404Size) - 3.5).toBeLessThanOrEqual(0) expect(parseFloat(err404Size) - 3.5).toBeLessThanOrEqual(0)
...@@ -104,7 +104,7 @@ describe('Build Output', () => { ...@@ -104,7 +104,7 @@ describe('Build Output', () => {
expect(parseFloat(err404FirstLoad) - 63.4).toBeLessThanOrEqual(0) expect(parseFloat(err404FirstLoad) - 63.4).toBeLessThanOrEqual(0)
expect(err404FirstLoad.endsWith('kB')).toBe(true) expect(err404FirstLoad.endsWith('kB')).toBe(true)
expect(parseFloat(sharedByAll) - 59.9).toBeLessThanOrEqual(0) expect(parseFloat(sharedByAll) - 60).toBeLessThanOrEqual(0)
expect(sharedByAll.endsWith('kB')).toBe(true) expect(sharedByAll.endsWith('kB')).toBe(true)
if (_appSize.endsWith('kB')) { if (_appSize.endsWith('kB')) {
......
...@@ -3,7 +3,12 @@ import { useRouter } from 'next/router' ...@@ -3,7 +3,12 @@ import { useRouter } from 'next/router'
const Page = () => { const Page = () => {
const router = useRouter() const router = useRouter()
const { query } = router const { query } = router
return <p id="asdf">This is {query.name}</p> return (
<>
<p id="asdf">This is {query.name}</p>
<p id="query">{JSON.stringify(query)}</p>
</>
)
} }
Page.getInitialProps = () => ({}) Page.getInitialProps = () => ({})
......
...@@ -31,6 +31,17 @@ const Page = () => { ...@@ -31,6 +31,17 @@ const Page = () => {
<a id="view-post-1-interpolated">View post 1 (interpolated)</a> <a id="view-post-1-interpolated">View post 1 (interpolated)</a>
</Link> </Link>
<br /> <br />
<Link
href={{
pathname: '/[name]',
query: { name: 'post-1', another: 'value' },
}}
>
<a id="view-post-1-interpolated-more-query">
View post 1 (interpolated additional query)
</a>
</Link>
<br />
<Link href="/[name]/comments" as="/post-1/comments"> <Link href="/[name]/comments" as="/post-1/comments">
<a id="view-post-1-comments">View post 1 comments</a> <a id="view-post-1-comments">View post 1 comments</a>
</Link> </Link>
......
...@@ -153,7 +153,9 @@ function runTests(dev) { ...@@ -153,7 +153,9 @@ function runTests(dev) {
.elementByCss('#view-post-1-interpolated') .elementByCss('#view-post-1-interpolated')
.getAttribute('href') .getAttribute('href')
expect(url.parse(href).pathname).toBe('/post-1') const parsedHref = url.parse(href, true)
expect(parsedHref.pathname).toBe('/post-1')
expect(parsedHref.query).toEqual({})
await browser.elementByCss('#view-post-1-interpolated').click() await browser.elementByCss('#view-post-1-interpolated').click()
await browser.waitForElementByCss('#asdf') await browser.waitForElementByCss('#asdf')
...@@ -167,6 +169,38 @@ function runTests(dev) { ...@@ -167,6 +169,38 @@ function runTests(dev) {
} }
}) })
it('should navigate to a dynamic page successfully interpolated with additional query values', async () => {
let browser
try {
browser = await webdriver(appPort, '/')
await browser.eval('window.beforeNav = 1')
const href = await browser
.elementByCss('#view-post-1-interpolated-more-query')
.getAttribute('href')
const parsedHref = url.parse(href, true)
expect(parsedHref.pathname).toBe('/post-1')
expect(parsedHref.query).toEqual({ another: 'value' })
await browser.elementByCss('#view-post-1-interpolated-more-query').click()
await browser.waitForElementByCss('#asdf')
expect(await browser.eval('window.beforeNav')).toBe(1)
const text = await browser.elementByCss('#asdf').text()
expect(text).toMatch(/this is.*?post-1/i)
const query = JSON.parse(await browser.elementByCss('#query').text())
expect(query).toEqual({
name: 'post-1',
another: 'value',
})
} finally {
if (browser) await browser.close()
}
})
it('should allow calling Router.push on mount successfully', async () => { it('should allow calling Router.push on mount successfully', async () => {
const browser = await webdriver(appPort, '/post-1/on-mount-redir') const browser = await webdriver(appPort, '/post-1/on-mount-redir')
try { try {
......
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