import type { BaseNextRequest, BaseNextResponse } from '../base-http' import type { IncomingHttpHeaders } from 'http' import type { RequestStore } from '../app-render/work-unit-async-storage.external' import type { RenderOpts } from '../app-render/types' import type { NextRequest } from '../web/spec-extension/request' import type { __ApiPreviewProps } from '../api-utils' import { FLIGHT_HEADERS } from '../../client/components/app-router-headers' import { HeadersAdapter, type ReadonlyHeaders, } from '../web/spec-extension/adapters/headers' import { MutableRequestCookiesAdapter, RequestCookiesAdapter, responseCookiesToRequestCookies, createCookiesWithMutableAccessCheck, type ReadonlyRequestCookies, } from '../web/spec-extension/adapters/request-cookies' import { ResponseCookies, RequestCookies } from '../web/spec-extension/cookies' import { DraftModeProvider } from './draft-mode-provider' import { splitCookiesString } from '../web/utils' import type { ServerComponentsHmrCache } from '../response-cache' import type { RenderResumeDataCache } from '../resume-data-cache/resume-data-cache' import type { Params } from '../request/params' import type { ImplicitTags } from '../lib/implicit-tags' function getHeaders(headers: Headers | IncomingHttpHeaders): ReadonlyHeaders { const cleaned = HeadersAdapter.from(headers) for (const header of FLIGHT_HEADERS) { cleaned.delete(header.toLowerCase()) } return HeadersAdapter.seal(cleaned) } function getMutableCookies( headers: Headers | IncomingHttpHeaders, onUpdateCookies?: (cookies: string[]) => void ): ResponseCookies { const cookies = new RequestCookies(HeadersAdapter.from(headers)) return MutableRequestCookiesAdapter.wrap(cookies, onUpdateCookies) } export type WrapperRenderOpts = Partial> & { previewProps?: __ApiPreviewProps } type RequestContext = RequestResponsePair & { /** * The URL of the request. This only specifies the pathname and the search * part of the URL. This is only undefined when generating static paths (ie, * there is no request in progress, nor do we know one). */ url: { /** * The pathname of the requested URL. */ pathname: string /** * The search part of the requested URL. If the request did not provide a * search part, this will be an empty string. */ search?: string } phase: RequestStore['phase'] renderOpts?: WrapperRenderOpts isHmrRefresh?: boolean serverComponentsHmrCache?: ServerComponentsHmrCache implicitTags: ImplicitTags } type RequestResponsePair = | { req: BaseNextRequest; res: BaseNextResponse } // for an app page | { req: NextRequest; res: undefined } // in an api route or middleware /** * If middleware set cookies in this request (indicated by `x-middleware-set-cookie`), * then merge those into the existing cookie object, so that when `cookies()` is accessed * it's able to read the newly set cookies. */ function mergeMiddlewareCookies( req: RequestContext['req'], existingCookies: RequestCookies | ResponseCookies ) { if ( 'x-middleware-set-cookie' in req.headers && typeof req.headers['x-middleware-set-cookie'] === 'string' ) { const setCookieValue = req.headers['x-middleware-set-cookie'] const responseHeaders = new Headers() for (const cookie of splitCookiesString(setCookieValue)) { responseHeaders.append('set-cookie', cookie) } const responseCookies = new ResponseCookies(responseHeaders) // Transfer cookies from ResponseCookies to RequestCookies for (const cookie of responseCookies.getAll()) { existingCookies.set(cookie) } } } export function createRequestStoreForRender( req: RequestContext['req'], res: RequestContext['res'], url: RequestContext['url'], rootParams: Params, implicitTags: RequestContext['implicitTags'], onUpdateCookies: RenderOpts['onUpdateCookies'], previewProps: WrapperRenderOpts['previewProps'], isHmrRefresh: RequestContext['isHmrRefresh'], serverComponentsHmrCache: RequestContext['serverComponentsHmrCache'], renderResumeDataCache: RenderResumeDataCache | undefined ): RequestStore { return createRequestStoreImpl( // Pages start in render phase by default 'render', req, res, url, rootParams, implicitTags, onUpdateCookies, renderResumeDataCache, previewProps, isHmrRefresh, serverComponentsHmrCache ) } export function createRequestStoreForAPI( req: RequestContext['req'], url: RequestContext['url'], implicitTags: RequestContext['implicitTags'], onUpdateCookies: RenderOpts['onUpdateCookies'], previewProps: WrapperRenderOpts['previewProps'] ): RequestStore { return createRequestStoreImpl( // API routes start in action phase by default 'action', req, undefined, url, {}, implicitTags, onUpdateCookies, undefined, previewProps, false, undefined ) } function createRequestStoreImpl( phase: RequestStore['phase'], req: RequestContext['req'], res: RequestContext['res'], url: RequestContext['url'], rootParams: Params, implicitTags: RequestContext['implicitTags'], onUpdateCookies: RenderOpts['onUpdateCookies'], renderResumeDataCache: RenderResumeDataCache | undefined, previewProps: WrapperRenderOpts['previewProps'], isHmrRefresh: RequestContext['isHmrRefresh'], serverComponentsHmrCache: RequestContext['serverComponentsHmrCache'] ): RequestStore { function defaultOnUpdateCookies(cookies: string[]) { if (res) { res.setHeader('Set-Cookie', cookies) } } const cache: { headers?: ReadonlyHeaders cookies?: ReadonlyRequestCookies mutableCookies?: ResponseCookies userspaceMutableCookies?: ResponseCookies draftMode?: DraftModeProvider } = {} return { type: 'request', phase, implicitTags, // Rather than just using the whole `url` here, we pull the parts we want // to ensure we don't use parts of the URL that we shouldn't. This also // lets us avoid requiring an empty string for `search` in the type. url: { pathname: url.pathname, search: url.search ?? '' }, rootParams, get headers() { if (!cache.headers) { // Seal the headers object that'll freeze out any methods that could // mutate the underlying data. cache.headers = getHeaders(req.headers) } return cache.headers }, get cookies() { if (!cache.cookies) { // if middleware is setting cookie(s), then include those in // the initial cached cookies so they can be read in render const requestCookies = new RequestCookies( HeadersAdapter.from(req.headers) ) mergeMiddlewareCookies(req, requestCookies) // Seal the cookies object that'll freeze out any methods that could // mutate the underlying data. cache.cookies = RequestCookiesAdapter.seal(requestCookies) } return cache.cookies }, set cookies(value: ReadonlyRequestCookies) { cache.cookies = value }, get mutableCookies() { if (!cache.mutableCookies) { const mutableCookies = getMutableCookies( req.headers, onUpdateCookies || (res ? defaultOnUpdateCookies : undefined) ) mergeMiddlewareCookies(req, mutableCookies) cache.mutableCookies = mutableCookies } return cache.mutableCookies }, get userspaceMutableCookies() { if (!cache.userspaceMutableCookies) { const userspaceMutableCookies = createCookiesWithMutableAccessCheck(this) cache.userspaceMutableCookies = userspaceMutableCookies } return cache.userspaceMutableCookies }, get draftMode() { if (!cache.draftMode) { cache.draftMode = new DraftModeProvider( previewProps, req, this.cookies, this.mutableCookies ) } return cache.draftMode }, renderResumeDataCache: renderResumeDataCache ?? null, isHmrRefresh, serverComponentsHmrCache: serverComponentsHmrCache || (globalThis as any).__serverComponentsHmrCache, } } export function synchronizeMutableCookies(store: RequestStore) { // TODO: does this need to update headers as well? store.cookies = RequestCookiesAdapter.seal( responseCookiesToRequestCookies(store.mutableCookies) ) }