Unverified Commit a29d8c9e authored by Kyle Marshall's avatar Kyle Marshall Committed by GitHub

Ensure locale key not duplicated when navigating back to root path with a query…

Ensure locale key not duplicated when navigating back to root path with a query or hash value (#24323)

This ensures that a duplicate locale key is not prepended to the path when navigating back (using browsers back button) to the root path containing query parameters or a hash value.

Current behaviour:
* `/fr?value=1` -> `/fr/another` -> click browser back button -> `/fr/fr?value=1`
* `/fr?value=1` -> `/fr?value=2` -> click browser back button -> `/fr/fr?value=1`
* `/fr#section` -> `/fr/another` -> click browser back button -> `/fr/fr#section`
* `/fr#section` -> `/fr#another` -> click browser back button -> `/fr/fr#section`

Fix:
Remove query string or hash value from path before determining whether to add the locale to the path in `addLocale` function.

## Bug

- [x] Related issues linked using `fixes #number`
- [x] Integration tests added

Fixes: #24287 
parent 2979f300
......@@ -113,7 +113,8 @@ export function addLocale(
defaultLocale?: string
) {
if (process.env.__NEXT_I18N_SUPPORT) {
const pathLower = path.toLowerCase()
const pathname = pathNoQueryHash(path)
const pathLower = pathname.toLowerCase()
const localeLower = locale && locale.toLowerCase()
return locale &&
......
......@@ -53,6 +53,84 @@ export function runTests(ctx) {
expect(await res.text()).toContain('index page')
})
it('should not add duplicate locale key when navigating back to root path with query params', async () => {
const basePath = ctx.basePath || ''
const queryKey = 'query'
const queryValue = '1'
const browser = await webdriver(
ctx.appPort,
`${basePath}/fr?${queryKey}=${queryValue}`
)
expect(await browser.eval(() => document.location.pathname)).toBe(
`${basePath}/fr`
)
expect(await browser.elementByCss('#router-pathname').text()).toBe('/')
expect(
JSON.parse(await browser.elementByCss('#router-query').text())
).toEqual({ [queryKey]: queryValue })
expect(await browser.elementByCss('#router-locale').text()).toBe('fr')
await browser
.elementByCss('#to-another')
.click()
.waitForElementByCss('#another')
expect(await browser.eval(() => document.location.pathname)).toBe(
`${basePath}/fr/another`
)
expect(await browser.elementByCss('#router-pathname').text()).toBe(
'/another'
)
expect(await browser.elementByCss('#router-locale').text()).toBe('fr')
await browser.back().waitForElementByCss('#index')
expect(await browser.eval(() => document.location.pathname)).toBe(
`${basePath}/fr`
)
expect(await browser.elementByCss('#router-pathname').text()).toBe('/')
expect(
JSON.parse(await browser.elementByCss('#router-query').text())
).toEqual({ [queryKey]: queryValue })
expect(await browser.elementByCss('#router-locale').text()).toBe('fr')
})
it('should not add duplicate locale key when navigating back to root path with hash', async () => {
const basePath = ctx.basePath || ''
const hashValue = '#anchor-1'
const browser = await webdriver(ctx.appPort, `${basePath}/fr${hashValue}`)
expect(await browser.eval(() => document.location.pathname)).toBe(
`${basePath}/fr`
)
expect(await browser.eval(() => document.location.hash)).toBe(hashValue)
expect(await browser.elementByCss('#router-pathname').text()).toBe('/')
expect(await browser.elementByCss('#router-locale').text()).toBe('fr')
await browser
.elementByCss('#to-another')
.click()
.waitForElementByCss('#another')
expect(await browser.eval(() => document.location.pathname)).toBe(
`${basePath}/fr/another`
)
expect(await browser.elementByCss('#router-pathname').text()).toBe(
'/another'
)
expect(await browser.elementByCss('#router-locale').text()).toBe('fr')
await browser.back().waitForElementByCss('#index')
expect(await browser.eval(() => document.location.pathname)).toBe(
`${basePath}/fr`
)
expect(await browser.eval(() => document.location.hash)).toBe(hashValue)
expect(await browser.elementByCss('#router-pathname').text()).toBe('/')
expect(await browser.elementByCss('#router-locale').text()).toBe('fr')
})
it('should handle navigating back to different casing of locale', async () => {
const browser = await webdriver(
ctx.appPort,
......
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