Unverified Commit ff366849 authored by Jiachi Liu's avatar Jiachi Liu Committed by GitHub

Make useSearchParams and useParams compatible between app and pages router (#55280)

### `useSearchParams`

server router's query includes both search params and path params, this PR eliminate the path params from `useSearchParams` to make it aligned between app router and pages router

### `useParams`

For pages, we extract the params keys with `getRouteRegex`, and pick them out from `router.query`

Fixes #54242 
Closes NEXT-1536
parent ffc0e541
...@@ -8,6 +8,7 @@ import { ...@@ -8,6 +8,7 @@ import {
import { import {
SearchParamsContext, SearchParamsContext,
PathnameContext, PathnameContext,
PathParamsContext,
} from '../../shared/lib/hooks-client-context.shared-runtime' } from '../../shared/lib/hooks-client-context.shared-runtime'
import { clientHookInServerComponentError } from './client-hook-in-server-component-error' import { clientHookInServerComponentError } from './client-hook-in-server-component-error'
import { getSegmentValue } from './router-reducer/reducers/get-segment-value' import { getSegmentValue } from './router-reducer/reducers/get-segment-value'
...@@ -166,12 +167,16 @@ function getSelectedParams( ...@@ -166,12 +167,16 @@ function getSelectedParams(
*/ */
export function useParams<T extends Params = Params>(): T { export function useParams<T extends Params = Params>(): T {
clientHookInServerComponentError('useParams') clientHookInServerComponentError('useParams')
const globalLayoutRouterContext = useContext(GlobalLayoutRouterContext) const globalLayoutRouter = useContext(GlobalLayoutRouterContext)
if (!globalLayoutRouterContext) { const pathParams = useContext(PathParamsContext)
// This only happens in `pages`. Type is overwritten in navigation.d.ts
return null! // When it's under app router
if (globalLayoutRouter) {
return getSelectedParams(globalLayoutRouter.tree) as T
} }
return getSelectedParams(globalLayoutRouterContext.tree) as T
// When it's under client side pages router
return pathParams as T
} }
// TODO-APP: handle parallel routes // TODO-APP: handle parallel routes
......
...@@ -41,10 +41,14 @@ import { hasBasePath } from './has-base-path' ...@@ -41,10 +41,14 @@ import { hasBasePath } from './has-base-path'
import { AppRouterContext } from '../shared/lib/app-router-context.shared-runtime' import { AppRouterContext } from '../shared/lib/app-router-context.shared-runtime'
import { import {
adaptForAppRouterInstance, adaptForAppRouterInstance,
adaptForPathParams,
adaptForSearchParams, adaptForSearchParams,
PathnameContextProviderAdapter, PathnameContextProviderAdapter,
} from '../shared/lib/router/adapters' } from '../shared/lib/router/adapters'
import { SearchParamsContext } from '../shared/lib/hooks-client-context.shared-runtime' import {
SearchParamsContext,
PathParamsContext,
} from '../shared/lib/hooks-client-context.shared-runtime'
import onRecoverableError from './on-recoverable-error' import onRecoverableError from './on-recoverable-error'
import tracer from './tracing/tracer' import tracer from './tracing/tracer'
import reportToSocket from './tracing/report-to-socket' import reportToSocket from './tracing/report-to-socket'
...@@ -316,17 +320,20 @@ function AppContainer({ ...@@ -316,17 +320,20 @@ function AppContainer({
router={router} router={router}
isAutoExport={self.__NEXT_DATA__.autoExport ?? false} isAutoExport={self.__NEXT_DATA__.autoExport ?? false}
> >
<RouterContext.Provider value={makePublicRouterInstance(router)}> <PathParamsContext.Provider value={adaptForPathParams(router)}>
<HeadManagerContext.Provider value={headManager}> <RouterContext.Provider value={makePublicRouterInstance(router)}>
<ImageConfigContext.Provider <HeadManagerContext.Provider value={headManager}>
value={ <ImageConfigContext.Provider
process.env.__NEXT_IMAGE_OPTS as any as ImageConfigComplete value={
} process.env
> .__NEXT_IMAGE_OPTS as any as ImageConfigComplete
{children} }
</ImageConfigContext.Provider> >
</HeadManagerContext.Provider> {children}
</RouterContext.Provider> </ImageConfigContext.Provider>
</HeadManagerContext.Provider>
</RouterContext.Provider>
</PathParamsContext.Provider>
</PathnameContextProviderAdapter> </PathnameContextProviderAdapter>
</SearchParamsContext.Provider> </SearchParamsContext.Provider>
</AppRouterContext.Provider> </AppRouterContext.Provider>
......
...@@ -89,11 +89,15 @@ import stripAnsi from 'next/dist/compiled/strip-ansi' ...@@ -89,11 +89,15 @@ import stripAnsi from 'next/dist/compiled/strip-ansi'
import { stripInternalQueries } from './internal-utils' import { stripInternalQueries } from './internal-utils'
import { import {
adaptForAppRouterInstance, adaptForAppRouterInstance,
adaptForPathParams,
adaptForSearchParams, adaptForSearchParams,
PathnameContextProviderAdapter, PathnameContextProviderAdapter,
} from '../shared/lib/router/adapters' } from '../shared/lib/router/adapters'
import { AppRouterContext } from '../shared/lib/app-router-context.shared-runtime' import { AppRouterContext } from '../shared/lib/app-router-context.shared-runtime'
import { SearchParamsContext } from '../shared/lib/hooks-client-context.shared-runtime' import {
SearchParamsContext,
PathParamsContext,
} from '../shared/lib/hooks-client-context.shared-runtime'
import { getTracer } from './lib/trace/tracer' import { getTracer } from './lib/trace/tracer'
import { RenderSpan } from './lib/trace/constants' import { RenderSpan } from './lib/trace/constants'
import { ReflectAdapter } from './web/spec-extension/adapters/reflect' import { ReflectAdapter } from './web/spec-extension/adapters/reflect'
...@@ -660,32 +664,36 @@ export async function renderToHTMLImpl( ...@@ -660,32 +664,36 @@ export async function renderToHTMLImpl(
router={router} router={router}
isAutoExport={isAutoExport} isAutoExport={isAutoExport}
> >
<RouterContext.Provider value={router}> <PathParamsContext.Provider value={adaptForPathParams(router)}>
<AmpStateContext.Provider value={ampState}> <RouterContext.Provider value={router}>
<HeadManagerContext.Provider <AmpStateContext.Provider value={ampState}>
value={{ <HeadManagerContext.Provider
updateHead: (state) => { value={{
head = state updateHead: (state) => {
}, head = state
updateScripts: (scripts) => { },
scriptLoader = scripts updateScripts: (scripts) => {
}, scriptLoader = scripts
scripts: initialScripts, },
mountedInstances: new Set(), scripts: initialScripts,
}} mountedInstances: new Set(),
> }}
<LoadableContext.Provider
value={(moduleName) => reactLoadableModules.push(moduleName)}
> >
<StyleRegistry registry={jsxStyleRegistry}> <LoadableContext.Provider
<ImageConfigContext.Provider value={images}> value={(moduleName) =>
{children} reactLoadableModules.push(moduleName)
</ImageConfigContext.Provider> }
</StyleRegistry> >
</LoadableContext.Provider> <StyleRegistry registry={jsxStyleRegistry}>
</HeadManagerContext.Provider> <ImageConfigContext.Provider value={images}>
</AmpStateContext.Provider> {children}
</RouterContext.Provider> </ImageConfigContext.Provider>
</StyleRegistry>
</LoadableContext.Provider>
</HeadManagerContext.Provider>
</AmpStateContext.Provider>
</RouterContext.Provider>
</PathParamsContext.Provider>
</PathnameContextProviderAdapter> </PathnameContextProviderAdapter>
</SearchParamsContext.Provider> </SearchParamsContext.Provider>
</AppRouterContext.Provider> </AppRouterContext.Provider>
......
'use client' 'use client'
import { createContext } from 'react' import { createContext } from 'react'
import type { Params } from '../../shared/lib/router/utils/route-matcher'
export const SearchParamsContext = createContext<URLSearchParams | null>(null) export const SearchParamsContext = createContext<URLSearchParams | null>(null)
export const PathnameContext = createContext<string | null>(null) export const PathnameContext = createContext<string | null>(null)
export const PathParamsContext = createContext<Params | null>(null)
if (process.env.NODE_ENV !== 'production') { if (process.env.NODE_ENV !== 'production') {
SearchParamsContext.displayName = 'SearchParamsContext' SearchParamsContext.displayName = 'SearchParamsContext'
PathnameContext.displayName = 'PathnameContext' PathnameContext.displayName = 'PathnameContext'
PathParamsContext.displayName = 'PathParamsContext'
} }
import type { ParsedUrlQuery } from 'node:querystring'
import React, { useMemo, useRef } from 'react' import React, { useMemo, useRef } from 'react'
import type { import type {
AppRouterInstance, AppRouterInstance,
...@@ -7,6 +6,9 @@ import type { ...@@ -7,6 +6,9 @@ import type {
import { PathnameContext } from '../hooks-client-context.shared-runtime' import { PathnameContext } from '../hooks-client-context.shared-runtime'
import type { NextRouter } from './router' import type { NextRouter } from './router'
import { isDynamicRoute } from './utils' import { isDynamicRoute } from './utils'
import { asPathToSearchParams } from './utils/as-path-to-search-params'
import { Params } from './utils/route-matcher'
import { getRouteRegex } from './utils/route-regex'
/** /**
* adaptForAppRouterInstance implements the AppRouterInstance with a NextRouter. * adaptForAppRouterInstance implements the AppRouterInstance with a NextRouter.
...@@ -39,28 +41,6 @@ export function adaptForAppRouterInstance( ...@@ -39,28 +41,6 @@ export function adaptForAppRouterInstance(
} }
} }
/**
* transforms the ParsedUrlQuery into a URLSearchParams.
*
* @param query the query to transform
* @returns URLSearchParams
*/
function transformQuery(query: ParsedUrlQuery): URLSearchParams {
const params = new URLSearchParams()
for (const [name, value] of Object.entries(query)) {
if (Array.isArray(value)) {
for (const val of value) {
params.append(name, val)
}
} else if (typeof value !== 'undefined') {
params.append(name, value)
}
}
return params
}
/** /**
* adaptForSearchParams transforms the ParsedURLQuery into URLSearchParams. * adaptForSearchParams transforms the ParsedURLQuery into URLSearchParams.
* *
...@@ -68,13 +48,28 @@ function transformQuery(query: ParsedUrlQuery): URLSearchParams { ...@@ -68,13 +48,28 @@ function transformQuery(query: ParsedUrlQuery): URLSearchParams {
* @returns the search params in the URLSearchParams format * @returns the search params in the URLSearchParams format
*/ */
export function adaptForSearchParams( export function adaptForSearchParams(
router: Pick<NextRouter, 'isReady' | 'query'> router: Pick<NextRouter, 'isReady' | 'query' | 'asPath'>
): URLSearchParams { ): URLSearchParams {
if (!router.isReady || !router.query) { if (!router.isReady || !router.query) {
return new URLSearchParams() return new URLSearchParams()
} }
return transformQuery(router.query) return asPathToSearchParams(router.asPath)
}
export function adaptForPathParams(
router: Pick<NextRouter, 'isReady' | 'pathname' | 'query' | 'asPath'>
): Params | null {
if (!router.isReady || !router.query) {
return null
}
const pathParams: Params = {}
const routeRegex = getRouteRegex(router.pathname)
const keys = Object.keys(routeRegex.groups)
for (const key of keys) {
pathParams[key] = router.query[key]!
}
return pathParams
} }
export function PathnameContextProviderAdapter({ export function PathnameContextProviderAdapter({
......
// Convert router.asPath to a URLSearchParams object
// example: /dynamic/[slug]?foo=bar -> { foo: 'bar' }
export function asPathToSearchParams(asPath: string): URLSearchParams {
return new URL(asPath, 'http://n').searchParams
}
'use client'
import { ParamsComponent } from '../../../shared/params-component'
export default ParamsComponent
import React from 'react'
export default function RootLayout({ children }) {
return (
<html>
<body>{children}</body>
</html>
)
}
import { createNextDescribe } from 'e2e-utils'
createNextDescribe(
'app-dir - params hooks compat',
{
files: __dirname,
},
({ next }) => {
it('should only access search params with useSearchParams', async () => {
const browserApp = await next.browser('/app/foobar?q=app')
const appSearchparamsJSON = JSON.parse(
await browserApp.elementByCss('#use-search-params').text()
)
const browserPages = await next.browser('/pages/foobar?q=pages')
const pagesSearchparamsJSON = JSON.parse(
await browserPages.elementByCss('#use-search-params').text()
)
expect(appSearchparamsJSON).toEqual({ q: 'app' })
expect(pagesSearchparamsJSON).toEqual({ q: 'pages' })
})
it('should only access path params with useParams', async () => {
const browserApp = await next.browser('/app/foobar?a=app')
const appParamsJSON = JSON.parse(
await browserApp.elementByCss('#use-params').text()
)
const browserPages = await next.browser('/pages/foobar?a=pages')
const pagesParamsJSON = JSON.parse(
await browserPages.elementByCss('#use-params').text()
)
expect(appParamsJSON).toEqual({ slug: 'foobar' })
expect(pagesParamsJSON).toEqual({ slug: 'foobar' })
})
}
)
import { ParamsComponent } from '../../shared/params-component'
export default ParamsComponent
import React from 'react'
import { useParams, useSearchParams } from 'next/navigation'
export function ParamsComponent() {
const params = useParams()
const searchParams = useSearchParams()
return (
<div>
<h2>useParams()</h2>
<pre id="use-params">{JSON.stringify(params, null, 2)}</pre>
<h2>useSearchParams()</h2>
<pre id="use-search-params">
{JSON.stringify(
Object.fromEntries(searchParams ? searchParams.entries() : []),
null,
2
)}
</pre>
</div>
)
}
'use client'
import { useParams } from 'next/navigation'
export default function Page() {
const params = useParams()
return (
<div>
<div id="params">{JSON.stringify(params)}</div>
</div>
)
}
...@@ -41,11 +41,5 @@ createNextDescribe( ...@@ -41,11 +41,5 @@ createNextDescribe(
expect(await browser.elementByCss('#param-id').text()).toBe('a') expect(await browser.elementByCss('#param-id').text()).toBe('a')
expect(await browser.elementByCss('#param-id2').text()).toBe('b') expect(await browser.elementByCss('#param-id2').text()).toBe('b')
}) })
it('should return null in pages', async () => {
const browser = await next.browser('/use-params-pages')
expect(await browser.elementByCss('#params').text()).toBe('null')
})
} }
) )
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