Unverified Commit 2e68ff7d authored by JJ Kasper's avatar JJ Kasper Committed by GitHub

Revert "Route Module Cleanup" (#51322)

x-ref: [slack
thread](https://vercel.slack.com/archives/C04MEB9L9RQ/p1686788708114089?thread_ts=1686770561.895939&cid=C04MEB9L9RQ)

Reverts vercel/next.js#50936
parent 38d1f169
...@@ -11,7 +11,11 @@ import type { NextConfig, NextConfigComplete } from './config-shared' ...@@ -11,7 +11,11 @@ import type { NextConfig, NextConfigComplete } from './config-shared'
import type { NextParsedUrlQuery, NextUrlWithParsedQuery } from './request-meta' import type { NextParsedUrlQuery, NextUrlWithParsedQuery } from './request-meta'
import type { ParsedUrlQuery } from 'querystring' import type { ParsedUrlQuery } from 'querystring'
import type { RenderOpts, RenderOptsPartial } from './render' import type { RenderOpts, RenderOptsPartial } from './render'
import type { ResponseCacheBase, ResponseCacheEntry } from './response-cache' import type {
ResponseCacheBase,
ResponseCacheEntry,
ResponseCacheValue,
} from './response-cache'
import type { UrlWithParsedQuery } from 'url' import type { UrlWithParsedQuery } from 'url'
import { import {
NormalizeError, NormalizeError,
...@@ -1777,7 +1781,9 @@ export default abstract class Server<ServerOptions extends Options = Options> { ...@@ -1777,7 +1781,9 @@ export default abstract class Server<ServerOptions extends Options = Options> {
result = await module.render( result = await module.render(
(req as NodeNextRequest).originalRequest, (req as NodeNextRequest).originalRequest,
(res as NodeNextResponse).originalResponse, (res as NodeNextResponse).originalResponse,
{ page: pathname, params: match.params, query, renderOpts } pathname,
query,
renderOpts
) )
} else { } else {
// If we didn't match a page, we should fallback to using the legacy // If we didn't match a page, we should fallback to using the legacy
...@@ -1829,40 +1835,23 @@ export default abstract class Server<ServerOptions extends Options = Options> { ...@@ -1829,40 +1835,23 @@ export default abstract class Server<ServerOptions extends Options = Options> {
throw err throw err
} }
// Based on the metadata, we can determine what kind of cache result we let value: ResponseCacheValue | null
// should return.
// Handle `isNotFound`.
if (metadata.isNotFound) { if (metadata.isNotFound) {
return { value: null, revalidate: metadata.revalidate } value = null
} } else if (metadata.isRedirect) {
value = { kind: 'REDIRECT', props: metadata.pageData }
// Handle `isRedirect`. } else {
if (metadata.isRedirect) { if (result.isNull()) {
return { return null
value: {
kind: 'REDIRECT',
props: metadata.pageData,
},
revalidate: metadata.revalidate,
} }
} value = {
// Handle `isNull`.
if (result.isNull()) {
return { value: null, revalidate: metadata.revalidate }
}
// We now have a valid HTML result that we can return to the user.
return {
value: {
kind: 'PAGE', kind: 'PAGE',
html: result, html: result,
pageData: metadata.pageData, pageData: metadata.pageData,
headers, headers,
}, }
revalidate: metadata.revalidate,
} }
return { revalidate: metadata.revalidate, value }
} }
const cacheEntry = await this.responseCache.get( const cacheEntry = await this.responseCache.get(
......
...@@ -32,6 +32,11 @@ export class RouteHandlerManager { ...@@ -32,6 +32,11 @@ export class RouteHandlerManager {
this.moduleLoader this.moduleLoader
) )
// Setup the handler. It is the responsibility of the module to ensure that
// this is only called once. If this is in development mode, the require
// cache will be cleared and the module will be re-created.
module.setup()
// Convert the BaseNextRequest to a NextRequest. // Convert the BaseNextRequest to a NextRequest.
const request = NextRequestAdapter.fromBaseNextRequest(req) const request = NextRequestAdapter.fromBaseNextRequest(req)
......
...@@ -187,6 +187,27 @@ export class AppRouteRouteModule extends RouteModule< ...@@ -187,6 +187,27 @@ export class AppRouteRouteModule extends RouteModule<
) )
} }
} }
}
/**
* When true, indicates that the global interfaces have been patched via the
* `patch()` method.
*/
private hasSetup: boolean = false
/**
* Validates the userland module to ensure the exported methods and properties
* are valid.
*/
public async setup() {
// If we've already setup, then return.
if (this.hasSetup) return
// Mark the module as setup. The following warnings about the userland
// module will run if we're in development. If the module files are modified
// when in development, then the require cache will be busted for it and
// this method will be called again (resetting the `hasSetup` flag).
this.hasSetup = true
// We only warn in development after here, so return if we're not in // We only warn in development after here, so return if we're not in
// development. // development.
......
...@@ -11,11 +11,7 @@ import type { NextParsedUrlQuery } from '../../../request-meta' ...@@ -11,11 +11,7 @@ import type { NextParsedUrlQuery } from '../../../request-meta'
import type { RenderOpts } from '../../../render' import type { RenderOpts } from '../../../render'
import type RenderResult from '../../../render-result' import type RenderResult from '../../../render-result'
import { import { RouteModule, type RouteModuleOptions } from '../route-module'
RouteModule,
type RouteModuleHandleContext,
type RouteModuleOptions,
} from '../route-module'
import { renderToHTML } from '../../../render' import { renderToHTML } from '../../../render'
/** /**
...@@ -50,29 +46,6 @@ export type PagesUserlandModule = { ...@@ -50,29 +46,6 @@ export type PagesUserlandModule = {
readonly getServerSideProps?: GetServerSideProps readonly getServerSideProps?: GetServerSideProps
} }
/**
* AppRouteRouteHandlerContext is the context that is passed to the route
* handler for app routes.
*/
export interface PagesRouteHandlerContext extends RouteModuleHandleContext {
/**
* The page for the given route.
*/
page: string
/**
* The parsed URL query for the given request.
*/
query: NextParsedUrlQuery
/**
* The RenderOpts for the given request which include the specific modules to
* use for rendering.
*/
// TODO: (wyattjoh) break this out into smaller parts, it currently includes the userland components
renderOpts: RenderOpts
}
export type PagesRouteModuleOptions = RouteModuleOptions< export type PagesRouteModuleOptions = RouteModuleOptions<
PagesRouteDefinition, PagesRouteDefinition,
PagesUserlandModule PagesUserlandModule
...@@ -82,22 +55,23 @@ export class PagesRouteModule extends RouteModule< ...@@ -82,22 +55,23 @@ export class PagesRouteModule extends RouteModule<
PagesRouteDefinition, PagesRouteDefinition,
PagesUserlandModule PagesUserlandModule
> { > {
public setup(): Promise<void> {
throw new Error('Method not implemented.')
}
public handle(): Promise<Response> { public handle(): Promise<Response> {
throw new Error('Method not implemented.') throw new Error('Method not implemented.')
} }
public render( public async render(
req: IncomingMessage, req: IncomingMessage,
res: ServerResponse, res: ServerResponse,
context: PagesRouteHandlerContext pathname: string,
query: NextParsedUrlQuery,
renderOpts: RenderOpts
): Promise<RenderResult> { ): Promise<RenderResult> {
return renderToHTML( const result = await renderToHTML(req, res, pathname, query, renderOpts)
req, return result
res,
context.page,
context.query,
context.renderOpts
)
} }
} }
......
...@@ -45,6 +45,13 @@ export abstract class RouteModule< ...@@ -45,6 +45,13 @@ export abstract class RouteModule<
*/ */
public readonly definition: Readonly<D> public readonly definition: Readonly<D>
/**
* Setup will setup the route handler. This could patch any globals or perform
* validation of the userland module. It is the responsibility of the module
* to ensure that this is only called once.
*/
public abstract setup(): Promise<void>
/** /**
* Handle will handle the request and return a response. * Handle will handle the request and return a response.
*/ */
......
...@@ -12,15 +12,13 @@ export type RenderResultMetadata = { ...@@ -12,15 +12,13 @@ export type RenderResultMetadata = {
isRedirect?: boolean isRedirect?: boolean
} }
type RenderResultResponse = string | ReadableStream<Uint8Array> | null
export default class RenderResult { export default class RenderResult {
private readonly _response: RenderResultResponse private readonly _response: string | ReadableStream<Uint8Array> | null
private readonly _contentType: ContentTypeOption private readonly _contentType: ContentTypeOption
private readonly _metadata: RenderResultMetadata private readonly _metadata: RenderResultMetadata
constructor( constructor(
response: RenderResultResponse, response: string | ReadableStream<Uint8Array> | null,
{ {
contentType, contentType,
...metadata ...metadata
...@@ -33,10 +31,6 @@ export default class RenderResult { ...@@ -33,10 +31,6 @@ export default class RenderResult {
this._metadata = metadata this._metadata = metadata
} }
get body(): Readonly<RenderResultResponse> {
return this._response
}
get metadata(): Readonly<RenderResultMetadata> { get metadata(): Readonly<RenderResultMetadata> {
return this._metadata return this._metadata
} }
......
...@@ -75,6 +75,7 @@ import { ...@@ -75,6 +75,7 @@ import {
streamFromArray, streamFromArray,
streamToString, streamToString,
chainStreams, chainStreams,
createBufferedTransformStream,
renderToInitialStream, renderToInitialStream,
continueFromInitialStream, continueFromInitialStream,
} from './stream-utils/node-web-streams-helper' } from './stream-utils/node-web-streams-helper'
...@@ -1175,6 +1176,8 @@ export async function renderToHTML( ...@@ -1175,6 +1176,8 @@ export async function renderToHTML(
return inAmpMode ? children : <div id="__next">{children}</div> return inAmpMode ? children : <div id="__next">{children}</div>
} }
// Always disable streaming for pages rendering
const generateStaticHTML = true
const renderDocument = async () => { const renderDocument = async () => {
// For `Document`, there are two cases that we don't support: // For `Document`, there are two cases that we don't support:
// 1. Using `Document.getInitialProps` in the Edge runtime. // 1. Using `Document.getInitialProps` in the Edge runtime.
...@@ -1312,7 +1315,7 @@ export async function renderToHTML( ...@@ -1312,7 +1315,7 @@ export async function renderToHTML(
return continueFromInitialStream(initialStream, { return continueFromInitialStream(initialStream, {
suffix, suffix,
dataStream: serverComponentsInlinedTransformStream?.readable, dataStream: serverComponentsInlinedTransformStream?.readable,
generateStaticHTML: true, generateStaticHTML,
getServerInsertedHTML, getServerInsertedHTML,
serverInsertedHTMLToHead: false, serverInsertedHTMLToHead: false,
}) })
...@@ -1535,9 +1538,18 @@ export async function renderToHTML( ...@@ -1535,9 +1538,18 @@ export async function renderToHTML(
const postOptimize = (html: string) => const postOptimize = (html: string) =>
postProcessHTML(pathname, html, renderOpts, { inAmpMode, hybridAmp }) postProcessHTML(pathname, html, renderOpts, { inAmpMode, hybridAmp })
const html = await streamToString(chainStreams(streams)) if (generateStaticHTML) {
const optimizedHtml = await postOptimize(html) const html = await streamToString(chainStreams(streams))
return new RenderResult(optimizedHtml, renderResultMeta) const optimizedHtml = await postOptimize(html)
return new RenderResult(optimizedHtml, renderResultMeta)
}
return new RenderResult(
chainStreams(streams).pipeThrough(
createBufferedTransformStream(postOptimize)
),
renderResultMeta
)
} }
export type RenderToHTMLResult = typeof renderToHTML export type RenderToHTMLResult = typeof renderToHTML
...@@ -7,10 +7,10 @@ export function setRevalidateHeaders( ...@@ -7,10 +7,10 @@ export function setRevalidateHeaders(
options: PayloadOptions options: PayloadOptions
) { ) {
if (options.private || options.stateful) { if (options.private || options.stateful) {
if (options.private || !res.hasHeader('Cache-Control')) { if (options.private || !res.getHeader('Cache-Control')) {
res.setHeader( res.setHeader(
'Cache-Control', 'Cache-Control',
'private, no-cache, no-store, max-age=0, must-revalidate' `private, no-cache, no-store, max-age=0, must-revalidate`
) )
} }
} else if (typeof options.revalidate === 'number') { } else if (typeof options.revalidate === 'number') {
...@@ -25,6 +25,6 @@ export function setRevalidateHeaders( ...@@ -25,6 +25,6 @@ export function setRevalidateHeaders(
`s-maxage=${options.revalidate}, stale-while-revalidate` `s-maxage=${options.revalidate}, stale-while-revalidate`
) )
} else if (options.revalidate === false) { } else if (options.revalidate === false) {
res.setHeader('Cache-Control', 's-maxage=31536000, stale-while-revalidate') res.setHeader('Cache-Control', `s-maxage=31536000, stale-while-revalidate`)
} }
} }
...@@ -28,10 +28,8 @@ export async function sendResponse( ...@@ -28,10 +28,8 @@ export async function sendResponse(
for (const cookie of splitCookiesString(value)) { for (const cookie of splitCookiesString(value)) {
res.appendHeader(name, cookie) res.appendHeader(name, cookie)
} }
} else if (res.hasHeader(name)) {
res.appendHeader(name, value)
} else { } else {
res.setHeader(name, value) res.appendHeader(name, value)
} }
}) })
......
...@@ -62,6 +62,10 @@ export class EdgeRouteModuleWrapper { ...@@ -62,6 +62,10 @@ export class EdgeRouteModuleWrapper {
} }
private async handler(request: NextRequest): Promise<Response> { private async handler(request: NextRequest): Promise<Response> {
// Setup the handler if it hasn't been setup yet. It is the responsibility
// of the module to ensure that this is only called once.
this.routeModule.setup()
// Get the pathname for the matcher. Pathnames should not have trailing // Get the pathname for the matcher. Pathnames should not have trailing
// slashes for matching. // slashes for matching.
const pathname = removeTrailingSlash(new URL(request.url).pathname) const pathname = removeTrailingSlash(new URL(request.url).pathname)
......
...@@ -8,7 +8,8 @@ import { NextRequest } from '../request' ...@@ -8,7 +8,8 @@ import { NextRequest } from '../request'
export class NextRequestAdapter { export class NextRequestAdapter {
public static fromBaseNextRequest(request: BaseNextRequest): NextRequest { public static fromBaseNextRequest(request: BaseNextRequest): NextRequest {
if (request.constructor.name === 'WebNextRequest') { // TODO: look at refining this check
if ('request' in request && (request as WebNextRequest).request) {
return NextRequestAdapter.fromWebNextRequest(request as WebNextRequest) return NextRequestAdapter.fromWebNextRequest(request as WebNextRequest)
} }
...@@ -29,14 +30,9 @@ export class NextRequestAdapter { ...@@ -29,14 +30,9 @@ export class NextRequestAdapter {
} else { } else {
// Grab the full URL from the request metadata. // Grab the full URL from the request metadata.
const base = getRequestMeta(request, '__NEXT_INIT_URL') const base = getRequestMeta(request, '__NEXT_INIT_URL')
if (!base || !base.startsWith('http')) { if (!base) throw new Error('Invariant: missing url on request')
// Because the URL construction relies on the fact that the URL provided
// is absolute, we need to provide a base URL. We can't use the request url = new URL(request.url, base)
// URL because it's relative, so we use a dummy URL instead.
url = new URL(request.url, 'http://n')
} else {
url = new URL(request.url, base)
}
} }
return new NextRequest(url, { return new NextRequest(url, {
......
...@@ -11,10 +11,6 @@ function Hi() { ...@@ -11,10 +11,6 @@ function Hi() {
) )
} }
Hi.getInitialProps = () => ({ Hi.getInitialProps = () => ({})
// To prevent the warning related to an empty object from getInitialProps, we
// need to return something.
foo: 'bar',
})
export default Hi export default Hi
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment