Update search params/route params handling on deploy

packages/next/src/build/index.ts

@@ -244,7 +244,7 @@ function generateClientSsgManifest(
 }
 
 function pageToRoute(page: string) {
-  const routeRegex = getNamedRouteRegex(page)
+  const routeRegex = getNamedRouteRegex(page, true)
   return {
     page,
     regex: normalizeRouteRegex(routeRegex.re.source),
@@ -2116,7 +2116,8 @@ export default async function build(
 
           if (isDynamicRoute(page)) {
             const routeRegex = getNamedRouteRegex(
-              dataRoute.replace(/\.json$/, '')
+              dataRoute.replace(/\.json$/, ''),
+              true
             )
 
             dataRouteRegex = normalizeRouteRegex(

packages/next/src/lib/constants.ts

@@ -1,5 +1,7 @@
 import type { ServerRuntime } from '../../types'
 
+export const NEXT_QUERY_PARAM_PREFIX = 'nextPriv'
+
 // in seconds
 export const CACHE_ONE_YEAR = 31536000
 

packages/next/src/server/base-server.ts

@@ -101,6 +101,7 @@ import { RouteKind } from './future/route-kind'
 import { handleInternalServerErrorResponse } from './future/route-modules/helpers/response-handlers'
 import { parseNextReferrerFromHeaders } from './lib/parse-next-referrer'
 import { fromNodeHeaders, toNodeHeaders } from './web/utils'
+import { NEXT_QUERY_PARAM_PREFIX } from '../lib/constants'
 
 export type FindComponentsResult = {
   components: LoadComponentsReturnType
@@ -781,6 +782,21 @@ export default abstract class Server<ServerOptions extends Options = Options> {
             addRequestMeta(req, '_nextRewroteUrl', parsedUrl.pathname!)
             addRequestMeta(req, '_nextDidRewrite', true)
           }
+          const routeParamKeys = new Set<string>()
+
+          for (const key of Object.keys(parsedUrl.query)) {
+            const value = parsedUrl.query[key]
+
+            if (key.startsWith(NEXT_QUERY_PARAM_PREFIX)) {
+              const normalizedKey = key.substring(
+                NEXT_QUERY_PARAM_PREFIX.length
+              )
+              parsedUrl.query[normalizedKey] = value
+
+              routeParamKeys.add(normalizedKey)
+              delete parsedUrl.query[key]
+            }
+          }
 
           // interpolate dynamic params and normalize URL if needed
           if (pageIsDynamic) {
@@ -859,7 +875,6 @@ export default abstract class Server<ServerOptions extends Options = Options> {
               matchedPath = utils.interpolateDynamicPath(srcPathname, params)
               req.url = utils.interpolateDynamicPath(req.url!, params)
             }
-            Object.assign(parsedUrl.query, params)
           }
 
           if (pageIsDynamic || didRewrite) {
@@ -868,6 +883,9 @@ export default abstract class Server<ServerOptions extends Options = Options> {
               ...Object.keys(utils.defaultRouteRegex?.groups || {}),
             ])
           }
+          for (const key of routeParamKeys) {
+            delete parsedUrl.query[key]
+          }
           parsedUrl.pathname = `${this.nextConfig.basePath || ''}${
             matchedPath === '/' && this.nextConfig.basePath ? '' : matchedPath
           }`

packages/next/src/server/server-utils.ts

@@ -23,6 +23,7 @@ import { TEMPORARY_REDIRECT_STATUS } from '../shared/lib/constants'
 import { addRequestMeta } from './request-meta'
 import { removeTrailingSlash } from '../shared/lib/router/utils/remove-trailing-slash'
 import { normalizeRscPath } from '../shared/lib/router/utils/app-paths'
+import { NEXT_QUERY_PARAM_PREFIX } from '../lib/constants'
 
 export function normalizeVercelUrl(
   req: BaseNextRequest | IncomingMessage,
@@ -37,8 +38,13 @@ export function normalizeVercelUrl(
     const _parsedUrl = parseUrl(req.url!, true)
     delete (_parsedUrl as any).search
 
-    for (const param of paramKeys || Object.keys(defaultRouteRegex.groups)) {
-      delete _parsedUrl.query[param]
+    for (const key of Object.keys(_parsedUrl.query)) {
+      if (
+        key.startsWith(NEXT_QUERY_PARAM_PREFIX) ||
+        (paramKeys || Object.keys(defaultRouteRegex.groups)).includes(key)
+      ) {
+        delete _parsedUrl.query[key]
+      }
     }
     req.url = formatUrl(_parsedUrl)
   }

packages/next/src/shared/lib/router/utils/route-regex.ts

@@ -1,6 +1,8 @@
 import { escapeStringRegexp } from '../../escape-regexp'
 import { removeTrailingSlash } from './remove-trailing-slash'
 
+const NEXT_QUERY_PARAM_PREFIX = 'nextPriv'
+
 export interface Group {
   pos: number
   repeat: boolean
@@ -88,7 +90,7 @@ function buildGetSafeRouteKey() {
   }
 }
 
-function getNamedParametrizedRoute(route: string) {
+function getNamedParametrizedRoute(route: string, prefixRouteKeys?: boolean) {
   const segments = removeTrailingSlash(route).slice(1).split('/')
   const getSafeRouteKey = buildGetSafeRouteKey()
   const routeKeys: { [named: string]: string } = {}
@@ -115,7 +117,13 @@ function getNamedParametrizedRoute(route: string) {
             cleanedKey = getSafeRouteKey()
           }
 
-          routeKeys[cleanedKey] = key
+          if (prefixRouteKeys) {
+            cleanedKey = `${NEXT_QUERY_PARAM_PREFIX}${cleanedKey}`
+            routeKeys[cleanedKey] = `${NEXT_QUERY_PARAM_PREFIX}${key}`
+          } else {
+            routeKeys[cleanedKey] = `${key}`
+          }
+
           return repeat
             ? optional
               ? `(?:/(?<${cleanedKey}>.+?))?`
@@ -135,8 +143,11 @@ function getNamedParametrizedRoute(route: string) {
  * each group is named along with a routeKeys object that indexes the assigned
  * named group with its corresponding key.
  */
-export function getNamedRouteRegex(normalizedRoute: string) {
-  const result = getNamedParametrizedRoute(normalizedRoute)
+export function getNamedRouteRegex(
+  normalizedRoute: string,
+  prefixRouteKey?: boolean
+) {
+  const result = getNamedParametrizedRoute(normalizedRoute, prefixRouteKey)
   return {
     ...getRouteRegex(normalizedRoute),
     namedRegex: `^${result.namedParameterizedRoute}(?:/)?$`,

test/e2e/app-dir/app/app/dynamic-client/[category]/[id]/page.js

@@ -1,5 +1,7 @@
 'use client'
 
+import { useSearchParams } from 'next/navigation'
+
 export default function IdPage({ children, params }) {
   return (
     <>
@@ -8,6 +10,10 @@ export default function IdPage({ children, params }) {
         <span id="id-page-params">{JSON.stringify(params)}</span>
       </p>
       {children}
+
+      <p id="search-params">
+        {JSON.stringify(Object.fromEntries(useSearchParams()))}
+      </p>
     </>
   )
 }

test/e2e/app-dir/app/app/dynamic/[category]/[id]/page.js

@@ -1,11 +1,13 @@
-export default function IdPage({ children, params }) {
+export default function IdPage({ children, params, searchParams }) {
   return (
     <>
       <p>
         Id Page. Params:{' '}
         <span id="id-page-params">{JSON.stringify(params)}</span>
       </p>
       {children}
+
+      <p id="search-params">{JSON.stringify(searchParams)}</p>
     </>
   )
 }

test/e2e/app-dir/app/index.test.ts

@@ -10,6 +10,35 @@ createNextDescribe(
     files: __dirname,
   },
   ({ next, isNextDev: isDev, isNextStart, isNextDeploy }) => {
+    it('should have correct searchParams and params (server)', async () => {
+      const html = await next.render('/dynamic/category-1/id-2?query1=value2')
+      const $ = cheerio.load(html)
+
+      expect(JSON.parse($('#id-page-params').text())).toEqual({
+        category: 'category-1',
+        id: 'id-2',
+      })
+      expect(JSON.parse($('#search-params').text())).toEqual({
+        query1: 'value2',
+      })
+    })
+
+    it('should have correct searchParams and params (client)', async () => {
+      const browser = await next.browser(
+        '/dynamic-client/category-1/id-2?query1=value2'
+      )
+      const html = await browser.eval('document.documentElement.innerHTML')
+      const $ = cheerio.load(html)
+
+      expect(JSON.parse($('#id-page-params').text())).toEqual({
+        category: 'category-1',
+        id: 'id-2',
+      })
+      expect(JSON.parse($('#search-params').text())).toEqual({
+        query1: 'value2',
+      })
+    })
+
     if (!isDev) {
       it('should successfully detect app route during prefetch', async () => {
         const browser = await next.browser('/')

test/e2e/app-dir/parallel-routes-and-interception/parallel-routes-and-interception.test.ts

@@ -5,6 +5,8 @@ createNextDescribe(
   'parallel-routes-and-interception',
   {
     files: __dirname,
+    // TODO: remove after deployment handling is updated
+    skipDeployment: true,
   },
   ({ next }) => {
     describe('parallel routes', () => {

test/e2e/edge-render-getserversideprops/index.test.ts

@@ -140,10 +140,10 @@ describe('edge-render-getserversideprops', () => {
           ),
           namedDataRouteRegex: `^/_next/data/${escapeStringRegexp(
             next.buildId
-          )}/(?<id>[^/]+?)\\.json$`,
+          )}/(?<nextPrivid>[^/]+?)\\.json$`,
           page: '/[id]',
           routeKeys: {
-            id: 'id',
+            nextPrivid: 'nextPrivid',
           },
         },
       ])

test/e2e/getserversideprops/test/index.test.ts

@@ -43,40 +43,40 @@ const expectedManifestRoutes = () => [
   {
     namedDataRouteRegex: `^/_next/data/${escapeRegex(
       buildId
-    )}/blog/(?<post>[^/]+?)\\.json$`,
+    )}/blog/(?<nextPrivpost>[^/]+?)\\.json$`,
     dataRouteRegex: normalizeRegEx(
       `^\\/_next\\/data\\/${escapeRegex(buildId)}\\/blog\\/([^\\/]+?)\\.json$`
     ),
     page: '/blog/[post]',
     routeKeys: {
-      post: 'post',
+      nextPrivpost: 'nextPrivpost',
     },
   },
   {
     namedDataRouteRegex: `^/_next/data/${escapeRegex(
       buildId
-    )}/blog/(?<post>[^/]+?)/(?<comment>[^/]+?)\\.json$`,
+    )}/blog/(?<nextPrivpost>[^/]+?)/(?<nextPrivcomment>[^/]+?)\\.json$`,
     dataRouteRegex: normalizeRegEx(
       `^\\/_next\\/data\\/${escapeRegex(
         buildId
       )}\\/blog\\/([^\\/]+?)\\/([^\\/]+?)\\.json$`
     ),
     page: '/blog/[post]/[comment]',
     routeKeys: {
-      post: 'post',
-      comment: 'comment',
+      nextPrivpost: 'nextPrivpost',
+      nextPrivcomment: 'nextPrivcomment',
     },
   },
   {
     namedDataRouteRegex: `^/_next/data/${escapeRegex(
       buildId
-    )}/catchall/(?<path>.+?)\\.json$`,
+    )}/catchall/(?<nextPrivpath>.+?)\\.json$`,
     dataRouteRegex: normalizeRegEx(
       `^\\/_next\\/data\\/${escapeRegex(buildId)}\\/catchall\\/(.+?)\\.json$`
     ),
     page: '/catchall/[...path]',
     routeKeys: {
-      path: 'path',
+      nextPrivpath: 'nextPrivpath',
     },
   },
   {
@@ -127,10 +127,10 @@ const expectedManifestRoutes = () => [
     )}\\/not\\-found\\/([^\\/]+?)\\.json$`,
     namedDataRouteRegex: `^/_next/data/${escapeRegex(
       buildId
-    )}/not\\-found/(?<slug>[^/]+?)\\.json$`,
+    )}/not\\-found/(?<nextPrivslug>[^/]+?)\\.json$`,
     page: '/not-found/[slug]',
     routeKeys: {
-      slug: 'slug',
+      nextPrivslug: 'nextPrivslug',
     },
   },
   {
@@ -182,15 +182,15 @@ const expectedManifestRoutes = () => [
   {
     namedDataRouteRegex: `^/_next/data/${escapeRegex(
       buildId
-    )}/user/(?<user>[^/]+?)/profile\\.json$`,
+    )}/user/(?<nextPrivuser>[^/]+?)/profile\\.json$`,
     dataRouteRegex: normalizeRegEx(
       `^\\/_next\\/data\\/${escapeRegex(
         buildId
       )}\\/user\\/([^\\/]+?)\\/profile\\.json$`
     ),
     page: '/user/[user]/profile',
     routeKeys: {
-      user: 'user',
+      nextPrivuser: 'nextPrivuser',
     },
   },
 ]