From 3a4db8ab5d5cfdc4ca5fd3cffdaafe4a6c34dd0a Mon Sep 17 00:00:00 2001 From: Tim Neutkens Date: Wed, 28 Sep 2022 13:18:37 +0200 Subject: [PATCH] Rename flight parameters to rsc/next (#40979) Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com> --- .../client/components/app-router.client.tsx | 12 ++++++------ packages/next/server/app-render.tsx | 14 +++++++------- packages/next/server/base-server.ts | 4 ++-- packages/next/server/internal-utils.ts | 6 +++--- packages/next/server/next-server.ts | 2 +- packages/next/server/web/adapter.ts | 6 +++--- test/e2e/app-dir/app/middleware.js | 2 +- test/e2e/app-dir/index.test.ts | 4 ++-- test/e2e/app-dir/rsc-basic.test.ts | 18 +++++++++--------- test/e2e/switchable-runtime/index.test.ts | 4 ++-- 10 files changed, 36 insertions(+), 36 deletions(-) diff --git a/packages/next/client/components/app-router.client.tsx b/packages/next/client/components/app-router.client.tsx index f933f4d1bb0b3..a317f35455f1f 100644 --- a/packages/next/client/components/app-router.client.tsx +++ b/packages/next/client/components/app-router.client.tsx @@ -44,18 +44,18 @@ export async function fetchServerResponse( prefetch?: true ): Promise<[FlightData: FlightData, canonicalUrlOverride: URL | undefined]> { const headers: { - __flight__: '1' - __flight_router_state_tree__: string - __flight_prefetch__?: '1' + __rsc__: '1' + __next_router_state_tree__: string + __next_router_prefetch__?: '1' } = { // Enable flight response - __flight__: '1', + __rsc__: '1', // Provide the current router state - __flight_router_state_tree__: JSON.stringify(flightRouterState), + __next_router_state_tree__: JSON.stringify(flightRouterState), } if (prefetch) { // Enable prefetch response - headers.__flight_prefetch__ = '1' + headers.__next_router_prefetch__ = '1' } const res = await fetch(url.toString(), { diff --git a/packages/next/server/app-render.tsx b/packages/next/server/app-render.tsx index df2c0bf075198..e40fba4b7ab55 100644 --- a/packages/next/server/app-render.tsx +++ b/packages/next/server/app-render.tsx @@ -582,9 +582,9 @@ function getScriptNonceFromHeader(cspHeaderValue: string): string | undefined { } const FLIGHT_PARAMETERS = [ - '__flight__', - '__flight_router_state_tree__', - '__flight_prefetch__', + '__rsc__', + '__next_router_state_tree__', + '__next_router_prefetch__', ] as const function headersWithoutFlight(headers: IncomingHttpHeaders) { @@ -653,8 +653,8 @@ export async function renderToHTMLOrFlight( // don't modify original query object query = Object.assign({}, query) - const isFlight = req.headers.__flight__ !== undefined - const isPrefetch = req.headers.__flight_prefetch__ !== undefined + const isFlight = req.headers.__rsc__ !== undefined + const isPrefetch = req.headers.__next_router_prefetch__ !== undefined // Handle client-side navigation to pages directory if (isFlight && isPagesDir) { @@ -688,8 +688,8 @@ export async function renderToHTMLOrFlight( * Router state provided from the client-side router. Used to handle rendering from the common layout down. */ const providedFlightRouterState: FlightRouterState = isFlight - ? req.headers.__flight_router_state_tree__ - ? JSON.parse(req.headers.__flight_router_state_tree__ as string) + ? req.headers.__next_router_state_tree__ + ? JSON.parse(req.headers.__next_router_state_tree__ as string) : {} : undefined diff --git a/packages/next/server/base-server.ts b/packages/next/server/base-server.ts index 04b0f0b63878c..4aafc39b8a821 100644 --- a/packages/next/server/base-server.ts +++ b/packages/next/server/base-server.ts @@ -1028,9 +1028,9 @@ export default abstract class Server { ) } - // Don't delete query.__flight__ yet, it still needs to be used in renderToHTML later + // Don't delete query.__rsc__ yet, it still needs to be used in renderToHTML later const isFlightRequest = Boolean( - this.serverComponentManifest && req.headers.__flight__ + this.serverComponentManifest && req.headers.__rsc__ ) // we need to ensure the status code if /404 is visited directly diff --git a/packages/next/server/internal-utils.ts b/packages/next/server/internal-utils.ts index 1dbfef90cd923..76f41fc0cecbe 100644 --- a/packages/next/server/internal-utils.ts +++ b/packages/next/server/internal-utils.ts @@ -6,10 +6,10 @@ const INTERNAL_QUERY_NAMES = [ '__nextDefaultLocale', '__nextIsNotFound', // RSC - '__flight__', + '__rsc__', // Routing - '__flight_router_state_tree__', - '__flight_prefetch__', + '__next_router_state_tree__', + '__next_router_prefetch__', ] as const const EXTENDED_INTERNAL_QUERY_NAMES = ['__nextDataReq'] as const diff --git a/packages/next/server/next-server.ts b/packages/next/server/next-server.ts index e04669a71dab9..aad6254ece23c 100644 --- a/packages/next/server/next-server.ts +++ b/packages/next/server/next-server.ts @@ -828,7 +828,7 @@ export default class NextNodeServer extends BaseServer { if ( this.nextConfig.experimental.appDir && - (renderOpts.isAppPath || req.headers.__flight__) + (renderOpts.isAppPath || req.headers.__rsc__) ) { const isPagesDir = !renderOpts.isAppPath return appRenderToHTMLOrFlight( diff --git a/packages/next/server/web/adapter.ts b/packages/next/server/web/adapter.ts index c808a2b02f823..5e6721f9d8be2 100644 --- a/packages/next/server/web/adapter.ts +++ b/packages/next/server/web/adapter.ts @@ -36,9 +36,9 @@ class NextRequestHint extends NextRequest { } const FLIGHT_PARAMETERS = [ - '__flight__', - '__flight_router_state_tree__', - '__flight_prefetch__', + '__rsc__', + '__next_router_state_tree__', + '__next_router_prefetch__', ] as const export async function adapter(params: { diff --git a/test/e2e/app-dir/app/middleware.js b/test/e2e/app-dir/app/middleware.js index 8057bba59bfa1..458cfd5ffa323 100644 --- a/test/e2e/app-dir/app/middleware.js +++ b/test/e2e/app-dir/app/middleware.js @@ -19,7 +19,7 @@ export function middleware(request) { ? 'rewrite' : 'redirect' - const internal = ['__flight__', '__flight_router_state_tree__'] + const internal = ['__rsc__', '__next_router_state_tree__'] if (internal.some((name) => request.headers.has(name))) { return NextResponse[method](new URL('/internal/failure', request.url)) } diff --git a/test/e2e/app-dir/index.test.ts b/test/e2e/app-dir/index.test.ts index ce4969f8d2f61..24470ecca6683 100644 --- a/test/e2e/app-dir/index.test.ts +++ b/test/e2e/app-dir/index.test.ts @@ -42,7 +42,7 @@ describe('app dir', () => { {}, { headers: { - __flight__: '1', + __rsc__: '1', }, } ) @@ -56,7 +56,7 @@ describe('app dir', () => { {}, { headers: { - __flight__: '1', + __rsc__: '1', }, } ) diff --git a/test/e2e/app-dir/rsc-basic.test.ts b/test/e2e/app-dir/rsc-basic.test.ts index b0757936bf378..5d0e0dff026e9 100644 --- a/test/e2e/app-dir/rsc-basic.test.ts +++ b/test/e2e/app-dir/rsc-basic.test.ts @@ -91,9 +91,9 @@ describe('app dir - react server components', () => { '__nextLocale', '__nextDefaultLocale', '__nextIsNotFound', - '__flight__', - '__flight_router_state_tree__', - '__flight_prefetch__', + '__rsc__', + '__next_router_state_tree__', + '__next_router_prefetch__', ] const hasNextInternalQuery = inlineFlightContents.some((content) => @@ -111,9 +111,9 @@ describe('app dir - react server components', () => { requestsCount++ return request.allHeaders().then((headers) => { if ( - headers.__flight__ === '1' && - // Prefetches also include `__flight__` - headers.__flight_prefetch__ !== '1' + headers.__rsc__ === '1' && + // Prefetches also include `__rsc__` + headers.__next_router_prefetch__ !== '1' ) { hasFlightRequest = true } @@ -197,8 +197,8 @@ describe('app dir - react server components', () => { page.on('request', (request) => { return request.allHeaders().then((headers) => { if ( - headers.__flight__ === '1' && - headers.__flight_prefetch__ !== '1' + headers.__rsc__ === '1' && + headers.__next_router_prefetch__ !== '1' ) { hasFlightRequest = true } @@ -337,7 +337,7 @@ describe('app dir - react server components', () => { {}, { headers: { - __flight__: '1', + __rsc__: '1', }, } ).then(async (response) => { diff --git a/test/e2e/switchable-runtime/index.test.ts b/test/e2e/switchable-runtime/index.test.ts index 153cc5abde65f..59504dc20b3b1 100644 --- a/test/e2e/switchable-runtime/index.test.ts +++ b/test/e2e/switchable-runtime/index.test.ts @@ -120,7 +120,7 @@ describe('Switchable runtime', () => { beforePageLoad(page) { page.on('request', (request) => { return request.allHeaders().then((headers) => { - if (headers.__flight__ === '1') { + if (headers.__rsc__ === '1') { flightRequest = request.url() } }) @@ -680,7 +680,7 @@ describe('Switchable runtime', () => { beforePageLoad(page) { page.on('request', (request) => { request.allHeaders().then((headers) => { - if (headers.__flight__ === '1') { + if (headers.__rsc__ === '1') { flightRequest = request.url() } })