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
@@ -786,9 +787,21 @@ export default abstract class Server<ServerOptions extends Options = Options> {
           if (pageIsDynamic) {
             let params: ParsedUrlQuery | false = {}
 
-            let paramsResult = utils.normalizeDynamicRouteParams(
-              parsedUrl.query
-            )
+            const queryRouteParams: Record<string, string | string[]> = {}
+
+            for (const key of Object.keys(parsedUrl.query)) {
+              const value = parsedUrl.query[key]
+
+              if (key.startsWith(NEXT_QUERY_PARAM_PREFIX) && value) {
+                queryRouteParams[
+                  key.substring(NEXT_QUERY_PARAM_PREFIX.length)
+                ] = value
+                delete parsedUrl.query[key]
+              }
+            }
+
+            let paramsResult =
+              utils.normalizeDynamicRouteParams(queryRouteParams)
 
             // for prerendered ISR paths we attempt parsing the route
             // params from the URL directly as route-matches may not
@@ -859,7 +872,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) {

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

@@ -1,3 +1,4 @@
+import { NEXT_QUERY_PARAM_PREFIX } from '../../../../lib/constants'
 import { escapeStringRegexp } from '../../escape-regexp'
 import { removeTrailingSlash } from './remove-trailing-slash'
 
@@ -88,7 +89,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 +116,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 +142,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

@@ -143,7 +143,7 @@ describe('edge-render-getserversideprops', () => {
           )}/(?<id>[^/]+?)\\.json$`,
           page: '/[id]',
           routeKeys: {
-            id: 'id',
+            nextPrivid: 'nextPrivid',
           },
         },
       ])

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

@@ -49,7 +49,7 @@ const expectedManifestRoutes = () => [
     ),
     page: '/blog/[post]',
     routeKeys: {
-      post: 'post',
+      nextPrivpost: 'nextPrivpost',
     },
   },
   {
@@ -63,8 +63,8 @@ const expectedManifestRoutes = () => [
     ),
     page: '/blog/[post]/[comment]',
     routeKeys: {
-      post: 'post',
-      comment: 'comment',
+      nextPrivpost: 'nextPrivpost',
+      nextPrivcomment: 'nextPrivcomment',
     },
   },
   {
@@ -76,7 +76,7 @@ const expectedManifestRoutes = () => [
     ),
     page: '/catchall/[...path]',
     routeKeys: {
-      path: 'path',
+      nextPrivpath: 'nextPrivpath',
     },
   },
   {
@@ -130,7 +130,7 @@ const expectedManifestRoutes = () => [
     )}/not\\-found/(?<slug>[^/]+?)\\.json$`,
     page: '/not-found/[slug]',
     routeKeys: {
-      slug: 'slug',
+      nextPrivslug: 'nextPrivslug',
     },
   },
   {
@@ -190,7 +190,7 @@ const expectedManifestRoutes = () => [
     ),
     page: '/user/[user]/profile',
     routeKeys: {
-      user: 'user',
+      nextPrivuser: 'nextPrivuser',
     },
   },
 ]