strip search params from prerenders

Author: lubieowoce

packages/next/src/build/templates/app-page.ts

@@ -83,6 +83,7 @@ export const __next_app__ = {
 
 import * as entryBase from '../../server/app-render/entry-base' with { 'turbopack-transition': 'next-server-utility' }
 import { RedirectStatusCode } from '../../client/components/redirect-status-code'
+import { parseReqUrl } from '../../lib/url'
 
 export * from '../../server/app-render/entry-base' with { 'turbopack-transition': 'next-server-utility' }
 
@@ -424,8 +425,16 @@ export async function handler(
        */
       fallbackRouteParams: FallbackRouteParams | null
     }): Promise<ResponseCacheEntry> => {
+      const isRevalidate = isSSG && !postponed && !isDynamicRSCRequest
+      let queryForRender = query
+      if (isRevalidate) {
+        // search params should never never be included in a prerender.
+        // (this can happen if we're prerendering a page at runtime because of a request that included search params)
+        queryForRender = {}
+        req.url = req.url ? stripQueryParams(req.url) : undefined
+      }
       const context: AppPageRouteHandlerContext = {
-        query,
+        query: queryForRender,
         params,
         page: normalizedSrcPage,
         sharedContext: {
@@ -461,7 +470,7 @@ export async function handler(
 
           dir: routeModule.projectDir,
           isDraftMode,
-          isRevalidate: isSSG && !postponed && !isDynamicRSCRequest,
+          isRevalidate,
           botType,
           isOnDemandRevalidate,
           isPossibleServerAction,
@@ -1208,3 +1217,8 @@ export async function handler(
     throw err
   }
 }
+
+function stripQueryParams(rawUrl: string): string {
+  const parsedUrl = parseReqUrl(rawUrl)!
+  return `${parsedUrl.pathname}${parsedUrl.hash}`
+}

test/e2e/app-dir/segment-cache/search-params/app/search-params/page.tsx

@@ -33,6 +33,21 @@ export default function SearchParamsPage() {
             searchParam=d_full, prefetch=true
           </LinkAccordion>
         </li>
+        <li>
+          with route param
+          <ul>
+            <li>
+              <LinkAccordion href="/search-params/target-page/one?searchParam=e_PPR">
+                param=one, searchParam=e_PPR
+              </LinkAccordion>
+            </li>
+            <li>
+              <LinkAccordion href="/search-params/target-page/one?searchParam=f_PPR">
+                param=one, searchParam=f_PPR
+              </LinkAccordion>
+            </li>
+          </ul>
+        </li>
       </ul>
     </>
   )

test/e2e/app-dir/segment-cache/search-params/app/search-params/target-page/[param]/page.tsx

@@ -0,0 +1,28 @@
+import { Suspense } from 'react'
+
+async function SearchParam({ searchParams }) {
+  const { searchParam } = await searchParams
+  return `Search param: ${searchParam}`
+}
+
+async function Param({ params }) {
+  const { param } = await params
+  return `Param: ${param}`
+}
+
+export default async function Target({ params, searchParams }) {
+  return (
+    <>
+      <Suspense fallback="Loading...">
+        <div id="target-page-with-param">
+          <Param params={params} />
+        </div>
+      </Suspense>
+      <Suspense fallback="Loading...">
+        <div id="target-page-with-search-param">
+          <SearchParam searchParams={searchParams} />
+        </div>
+      </Suspense>
+    </>
+  )
+}

test/e2e/app-dir/segment-cache/search-params/segment-cache-search-params.test.ts

@@ -66,6 +66,68 @@ describe('segment cache (search params)', () => {
     expect(await result.innerText()).toBe('Search param: c_PPR')
   })
 
+  it('when prefetching a lazily generated ISR PPR page, does not include search params in the response', async () => {
+    let act: ReturnType<typeof createRouterAct>
+    const browser = await next.browser('/search-params', {
+      beforePageLoad(page) {
+        act = createRouterAct(page)
+      },
+    })
+
+    // Prefetch a page with param 'one' and search param `e_PPR`.
+    const revealA = await browser.elementByCss(
+      'input[data-link-accordion="/search-params/target-page/one?searchParam=e_PPR"]'
+    )
+    console.log('revealing link (e_PPR)')
+    await act(
+      async () => {
+        await revealA.click()
+      },
+      // The response will include a shell of the page, but nothing that is
+      // based on the search param.
+      {
+        includes: 'e_PPR',
+        block: 'reject',
+      }
+    )
+
+    console.log('revealing link (f_PPR)')
+    // Prefetch the same page but with the search param changed to `f_PPR`.
+    const revealC = await browser.elementByCss(
+      'input[data-link-accordion="/search-params/target-page/one?searchParam=f_PPR"]'
+    )
+    await act(
+      async () => {
+        await revealC.click()
+      },
+      // This should not issue a new request for the page segment, because
+      // search params are not included in the the PPR shell. So we can reuse
+      // the shell we fetched for `searchParam=a`.
+      { includes: 'target-page-with-search-param', block: 'reject' }
+    )
+
+    console.log('navigating to link (f_PPR)')
+    // Navigate to one of the links.
+    const linkC = await browser.elementByCss(
+      'a[href="/search-params/target-page/one?searchParam=f_PPR"]'
+    )
+    await act(
+      async () => {
+        await linkC.click()
+      },
+      // The search param streams in on navigation
+      {
+        includes: 'Search param: f_PPR',
+      }
+    )
+    expect(await browser.elementById('target-page-with-param').text()).toBe(
+      'Param: one'
+    )
+    expect(
+      await browser.elementById('target-page-with-search-param').text()
+    ).toBe('Search param: f_PPR')
+  })
+
   it('when fetching without PPR (e.g. prefetch={true}), includes the search params in the cache key', async () => {
     let act: ReturnType<typeof createRouterAct>
     const browser = await next.browser('/search-params', {