Unverified Commit 97ba9109 authored by Tim Neutkens's avatar Tim Neutkens Committed by GitHub

Support passing a relative string to pushState/replaceState (#58438)

Follow-up to #58335.

Fixes
https://github.com/vercel/next.js/discussions/48110#discussioncomment-7565394

As reported in the discussion passing a origin-relative string didn't
work as `new URL` will throw an error. This ensures the `origin`
parameter is provided to `new URL`.
Added tests for the string behavior.

<!-- Thanks for opening a PR! Your contribution is much appreciated.
To make sure your PR is handled as smoothly as possible we request that
you follow the checklist sections below.
Choose the right checklist for the change(s) that you're making:

## For Contributors

### Improving Documentation

- Run `pnpm prettier-fix` to fix formatting issues before opening the
PR.
- Read the Docs Contribution Guide to ensure your contribution follows
the docs guidelines:
https://nextjs.org/docs/community/contribution-guide

### Adding or Updating Examples

- The "examples guidelines" are followed from our contributing doc
https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md
- Make sure the linting passes by running `pnpm build && pnpm lint`. See
https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md

### Fixing a bug

- Related issues linked using `fixes #number`
- Tests added. See:
https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md

### Adding a feature

- Implements an existing feature request or RFC. Make sure the feature
request has been accepted for implementation before opening a PR. (A
discussion must be opened, see
https://github.com/vercel/next.js/discussions/new?category=ideas)
- Related issues/discussions are linked using `fixes #number`
- e2e tests added
(https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs)
- Documentation added
- Telemetry added. In case of a feature if it's used or not.
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md


## For Maintainers

- Minimal description (aim for explaining to someone not on the team to
understand the PR)
- When linking to a Slack thread, you might want to share details of the
conclusion
- Link both the Linear (Fixes NEXT-xxx) and the GitHub issues
- Add review comments if necessary to explain to the reviewer the logic
behind a change

### What?

### Why?

### How?

Closes NEXT-
Fixes #

-->

---------
Co-authored-by: 's avatarkodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
Co-authored-by: 's avatarZack Tanner <zacktanner@gmail.com>
parent 4ba64e2e
...@@ -232,6 +232,7 @@ const originalReplaceState = ...@@ -232,6 +232,7 @@ const originalReplaceState =
: null : null
function copyNextJsInternalHistoryState(data: any) { function copyNextJsInternalHistoryState(data: any) {
if (data == null) data = {}
const currentState = window.history.state const currentState = window.history.state
const __NA = currentState?.__NA const __NA = currentState?.__NA
if (__NA) { if (__NA) {
...@@ -242,6 +243,8 @@ function copyNextJsInternalHistoryState(data: any) { ...@@ -242,6 +243,8 @@ function copyNextJsInternalHistoryState(data: any) {
if (__PRIVATE_NEXTJS_INTERNALS_TREE) { if (__PRIVATE_NEXTJS_INTERNALS_TREE) {
data.__PRIVATE_NEXTJS_INTERNALS_TREE = __PRIVATE_NEXTJS_INTERNALS_TREE data.__PRIVATE_NEXTJS_INTERNALS_TREE = __PRIVATE_NEXTJS_INTERNALS_TREE
} }
return data
} }
/** /**
...@@ -314,7 +317,7 @@ function Router({ ...@@ -314,7 +317,7 @@ function Router({
) { ) {
return return
} }
const url = new URL(addBasePath(href), location.href) const url = new URL(addBasePath(href), window.location.href)
// External urls can't be prefetched in the same way. // External urls can't be prefetched in the same way.
if (isExternalURL(url)) { if (isExternalURL(url)) {
return return
...@@ -404,8 +407,9 @@ function Router({ ...@@ -404,8 +407,9 @@ function Router({
if ( if (
!event.persisted || !event.persisted ||
!window.history.state?.__PRIVATE_NEXTJS_INTERNALS_TREE !window.history.state?.__PRIVATE_NEXTJS_INTERNALS_TREE
) ) {
return return
}
dispatch({ dispatch({
type: ACTION_RESTORE, type: ACTION_RESTORE,
...@@ -456,10 +460,11 @@ function Router({ ...@@ -456,10 +460,11 @@ function Router({
const applyUrlFromHistoryPushReplace = ( const applyUrlFromHistoryPushReplace = (
url: string | URL | null | undefined url: string | URL | null | undefined
) => { ) => {
const href = window.location.href
startTransition(() => { startTransition(() => {
dispatch({ dispatch({
type: ACTION_RESTORE, type: ACTION_RESTORE,
url: new URL(url ?? window.location.href), url: new URL(url ?? href, href),
tree: window.history.state.__PRIVATE_NEXTJS_INTERNALS_TREE, tree: window.history.state.__PRIVATE_NEXTJS_INTERNALS_TREE,
}) })
}) })
...@@ -476,7 +481,7 @@ function Router({ ...@@ -476,7 +481,7 @@ function Router({
_unused: string, _unused: string,
url?: string | URL | null url?: string | URL | null
): void { ): void {
copyNextJsInternalHistoryState(data) data = copyNextJsInternalHistoryState(data)
applyUrlFromHistoryPushReplace(url) applyUrlFromHistoryPushReplace(url)
...@@ -494,7 +499,7 @@ function Router({ ...@@ -494,7 +499,7 @@ function Router({
_unused: string, _unused: string,
url?: string | URL | null url?: string | URL | null
): void { ): void {
copyNextJsInternalHistoryState(data) data = copyNextJsInternalHistoryState(data)
if (url) { if (url) {
applyUrlFromHistoryPushReplace(url) applyUrlFromHistoryPushReplace(url)
......
...@@ -53,6 +53,11 @@ export default function ShallowLayout({ children }) { ...@@ -53,6 +53,11 @@ export default function ShallowLayout({ children }) {
To PushState new pathname To PushState new pathname
</Link> </Link>
</div> </div>
<div>
<Link href="/pushstate-string-url" id="to-pushstate-string-url">
To PushState String Url
</Link>
</div>
<div> <div>
<Link href="/replacestate-data" id="to-replacestate-data"> <Link href="/replacestate-data" id="to-replacestate-data">
To ReplaceState Data To ReplaceState Data
...@@ -74,6 +79,11 @@ export default function ShallowLayout({ children }) { ...@@ -74,6 +79,11 @@ export default function ShallowLayout({ children }) {
To ReplaceState new pathname To ReplaceState new pathname
</Link> </Link>
</div> </div>
<div>
<Link href="/replacestate-string-url" id="to-replacestate-string-url">
To ReplaceState String Url
</Link>
</div>
</div> </div>
{children} {children}
</> </>
......
'use client'
import { useSearchParams } from 'next/navigation'
export default function Page() {
const searchParams = useSearchParams()
return (
<>
<h1 id="pushstate-string-url">PushState String Url</h1>
<pre id="my-data">{searchParams.get('query')}</pre>
<button
onClick={() => {
const previousQuery = new URL(window.location.href).searchParams.get(
'query'
)
const url = `?query=${
previousQuery ? previousQuery + '-added' : 'foo'
}`
window.history.pushState({}, '', url)
}}
id="push-string-url"
>
Push searchParam using string url
</button>
<button
onClick={() => {
const previousQuery = new URL(window.location.href).searchParams.get(
'query'
)
const url = `?query=${
previousQuery ? previousQuery + '-added' : 'foo'
}`
window.history.replaceState(null, '', url)
}}
id="push-string-url-null"
>
Push searchParam with null data param
</button>
<button
onClick={() => {
const previousQuery = new URL(window.location.href).searchParams.get(
'query'
)
const url = `?query=${
previousQuery ? previousQuery + '-added' : 'foo'
}`
window.history.replaceState(undefined, '', url)
}}
id="push-string-url-undefined"
>
Push searchParam with undefined data param
</button>
</>
)
}
'use client'
import { useSearchParams } from 'next/navigation'
export default function Page() {
const searchParams = useSearchParams()
return (
<>
<h1 id="replacestate-string-url">ReplaceState String Url</h1>
<pre id="my-data">{searchParams.get('query')}</pre>
<button
onClick={() => {
const previousQuery = new URL(window.location.href).searchParams.get(
'query'
)
const url = `?query=${
previousQuery ? previousQuery + '-added' : 'foo'
}`
window.history.replaceState({}, '', url)
}}
id="replace-string-url"
>
Replace searchParam using string url
</button>
<button
onClick={() => {
const previousQuery = new URL(window.location.href).searchParams.get(
'query'
)
const url = `?query=${
previousQuery ? previousQuery + '-added' : 'foo'
}`
window.history.replaceState(null, '', url)
}}
id="replace-string-url-null"
>
Replace searchParam with null data param
</button>
<button
onClick={() => {
const previousQuery = new URL(window.location.href).searchParams.get(
'query'
)
const url = `?query=${
previousQuery ? previousQuery + '-added' : 'foo'
}`
window.history.replaceState(undefined, '', url)
}}
id="replace-string-url-undefined"
>
Replace searchParam with undefined data param
</button>
</>
)
}
...@@ -82,6 +82,102 @@ createNextDescribe( ...@@ -82,6 +82,102 @@ createNextDescribe(
`${next.url}/pushstate-new-searchparams?query=foo-added` `${next.url}/pushstate-new-searchparams?query=foo-added`
) )
}) })
it('should support setting a different url using a string', async () => {
const browser = await next.browser('/a')
expect(
await browser
.elementByCss('#to-pushstate-string-url')
.click()
.waitForElementByCss('#pushstate-string-url')
.text()
).toBe('PushState String Url')
await browser.elementByCss('#push-string-url').click()
// Check useSearchParams value is the new searchparam
await check(() => browser.elementByCss('#my-data').text(), 'foo')
// Check current url is the new searchparams
expect(await browser.url()).toBe(
`${next.url}/pushstate-string-url?query=foo`
)
// Same cycle a second time
await browser.elementByCss('#push-string-url').click()
// Check useSearchParams value is the new searchparam
await check(() => browser.elementByCss('#my-data').text(), 'foo-added')
// Check current url is the new searchparams
expect(await browser.url()).toBe(
`${next.url}/pushstate-string-url?query=foo-added`
)
})
it('should work when given a null state value', async () => {
const browser = await next.browser('/a')
expect(
await browser
.elementByCss('#to-pushstate-string-url')
.click()
.waitForElementByCss('#pushstate-string-url')
.text()
).toBe('PushState String Url')
await browser.elementByCss('#push-string-url-null').click()
// Check useSearchParams value is the new searchparam
await check(() => browser.elementByCss('#my-data').text(), 'foo')
// Check current url is the new searchparams
expect(await browser.url()).toBe(
`${next.url}/pushstate-string-url?query=foo`
)
// Same cycle a second time
await browser.elementByCss('#push-string-url-null').click()
// Check useSearchParams value is the new searchparam
await check(() => browser.elementByCss('#my-data').text(), 'foo-added')
// Check current url is the new searchparams
expect(await browser.url()).toBe(
`${next.url}/pushstate-string-url?query=foo-added`
)
})
})
it('should work when given an undefined state value', async () => {
const browser = await next.browser('/a')
expect(
await browser
.elementByCss('#to-pushstate-string-url')
.click()
.waitForElementByCss('#pushstate-string-url')
.text()
).toBe('PushState String Url')
await browser.elementByCss('#push-string-url-undefined').click()
// Check useSearchParams value is the new searchparam
await check(() => browser.elementByCss('#my-data').text(), 'foo')
// Check current url is the new searchparams
expect(await browser.url()).toBe(
`${next.url}/pushstate-string-url?query=foo`
)
// Same cycle a second time
await browser.elementByCss('#push-string-url-undefined').click()
// Check useSearchParams value is the new searchparam
await check(() => browser.elementByCss('#my-data').text(), 'foo-added')
// Check current url is the new searchparams
expect(await browser.url()).toBe(
`${next.url}/pushstate-string-url?query=foo-added`
)
}) })
describe('replaceState', () => { describe('replaceState', () => {
...@@ -159,6 +255,102 @@ createNextDescribe( ...@@ -159,6 +255,102 @@ createNextDescribe(
`${next.url}/replacestate-new-searchparams?query=foo-added` `${next.url}/replacestate-new-searchparams?query=foo-added`
) )
}) })
it('should support setting a different url using a string', async () => {
const browser = await next.browser('/a')
expect(
await browser
.elementByCss('#to-replacestate-string-url')
.click()
.waitForElementByCss('#replacestate-string-url')
.text()
).toBe('ReplaceState String Url')
await browser.elementByCss('#replace-string-url').click()
// Check useSearchParams value is the new searchparam
await check(() => browser.elementByCss('#my-data').text(), 'foo')
// Check current url is the new searchparams
expect(await browser.url()).toBe(
`${next.url}/replacestate-string-url?query=foo`
)
// Same cycle a second time
await browser.elementByCss('#replace-string-url').click()
// Check useSearchParams value is the new searchparam
await check(() => browser.elementByCss('#my-data').text(), 'foo-added')
// Check current url is the new searchparams
expect(await browser.url()).toBe(
`${next.url}/replacestate-string-url?query=foo-added`
)
})
it('should work when given a null state value', async () => {
const browser = await next.browser('/a')
expect(
await browser
.elementByCss('#to-replacestate-string-url')
.click()
.waitForElementByCss('#replacestate-string-url')
.text()
).toBe('ReplaceState String Url')
await browser.elementByCss('#replace-string-url-null').click()
// Check useSearchParams value is the new searchparam
await check(() => browser.elementByCss('#my-data').text(), 'foo')
// Check current url is the new searchparams
expect(await browser.url()).toBe(
`${next.url}/replacestate-string-url?query=foo`
)
// Same cycle a second time
await browser.elementByCss('#replace-string-url-null').click()
// Check useSearchParams value is the new searchparam
await check(() => browser.elementByCss('#my-data').text(), 'foo-added')
// Check current url is the new searchparams
expect(await browser.url()).toBe(
`${next.url}/replacestate-string-url?query=foo-added`
)
})
it('should work when given an undefined state value', async () => {
const browser = await next.browser('/a')
expect(
await browser
.elementByCss('#to-replacestate-string-url')
.click()
.waitForElementByCss('#replacestate-string-url')
.text()
).toBe('ReplaceState String Url')
await browser.elementByCss('#replace-string-url-undefined').click()
// Check useSearchParams value is the new searchparam
await check(() => browser.elementByCss('#my-data').text(), 'foo')
// Check current url is the new searchparams
expect(await browser.url()).toBe(
`${next.url}/replacestate-string-url?query=foo`
)
// Same cycle a second time
await browser.elementByCss('#replace-string-url-undefined').click()
// Check useSearchParams value is the new searchparam
await check(() => browser.elementByCss('#my-data').text(), 'foo-added')
// Check current url is the new searchparams
expect(await browser.url()).toBe(
`${next.url}/replacestate-string-url?query=foo-added`
)
})
}) })
describe('back and forward', () => { describe('back and forward', () => {
......
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