Unverified Commit 4ea7d7b1 authored by Shu Ding's avatar Shu Ding Committed by GitHub

Refactor the middleware SSR loader (#31508)

Initial step for #31506, to move the adapter logic out of the loader output string so it will be easier to reuse code in the future. Also, more options are passed to the loader to align with the serverless loader.

## Bug

- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Errors have helpful link attached, see `contributing.md`

## Feature

- [ ] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR.
- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Documentation added
- [ ] Telemetry added. In case of a feature if it's used or not.
- [ ] Errors have helpful link attached, see `contributing.md`

## Documentation / Examples

- [ ] Make sure the linting passes by running `yarn lint`
parent 55ab4f06
...@@ -160,14 +160,10 @@ export function createEntrypoints( ...@@ -160,14 +160,10 @@ export function createEntrypoints(
name: '[name].js', name: '[name].js',
value: `next-middleware-ssr-loader?${stringify({ value: `next-middleware-ssr-loader?${stringify({
page, page,
absoluteAppPath: pages['/_app'], absolute500Path: pages['/500'] || '',
absoluteDocumentPath: pages['/_document'],
absoluteErrorPath: pages['/500'] || pages['/_error'],
absolutePagePath, absolutePagePath,
isServerComponent: isFlight, isServerComponent: isFlight,
buildId, ...defaultServerlessOptions,
basePath: config.basePath,
assetPrefix: config.assetPrefix,
} as any)}!`, } as any)}!`,
isServer: false, isServer: false,
isServerWeb: true, isServerWeb: true,
......
...@@ -5,159 +5,61 @@ export default async function middlewareRSCLoader(this: any) { ...@@ -5,159 +5,61 @@ export default async function middlewareRSCLoader(this: any) {
absolutePagePath, absolutePagePath,
absoluteAppPath, absoluteAppPath,
absoluteDocumentPath, absoluteDocumentPath,
absolute500Path,
absoluteErrorPath, absoluteErrorPath,
basePath, isServerComponent,
isServerComponent: isServerComponentQuery, ...restRenderOpts
assetPrefix,
buildId,
} = this.getOptions() } = this.getOptions()
const isServerComponent = isServerComponentQuery === 'true'
const stringifiedAbsolutePagePath = stringifyRequest(this, absolutePagePath) const stringifiedAbsolutePagePath = stringifyRequest(this, absolutePagePath)
const stringifiedAbsoluteAppPath = stringifyRequest(this, absoluteAppPath) const stringifiedAbsoluteAppPath = stringifyRequest(this, absoluteAppPath)
const stringifiedAbsoluteErrorPath = stringifyRequest(this, absoluteErrorPath) const stringifiedAbsolute500PagePath = stringifyRequest(
this,
absolute500Path || absoluteErrorPath
)
const stringifiedAbsoluteDocumentPath = stringifyRequest( const stringifiedAbsoluteDocumentPath = stringifyRequest(
this, this,
absoluteDocumentPath absoluteDocumentPath
) )
const transformed = ` const transformed = `
import { adapter } from 'next/dist/server/web/adapter' import { adapter } from 'next/dist/server/web/adapter'
import { RouterContext } from 'next/dist/shared/lib/router-context' import { RouterContext } from 'next/dist/shared/lib/router-context'
import { renderToHTML } from 'next/dist/server/web/render'
import App from ${stringifiedAbsoluteAppPath}
import App from ${stringifiedAbsoluteAppPath} import Document from ${stringifiedAbsoluteDocumentPath}
import Document from ${stringifiedAbsoluteDocumentPath}
const errorMod = require(${stringifiedAbsoluteErrorPath}) import { getRender } from 'next/dist/build/webpack/loaders/next-middleware-ssr-loader/render'
const { const pageMod = require(${stringifiedAbsolutePagePath})
default: Page, const errorMod = require(${stringifiedAbsolute500PagePath})
config,
getStaticProps, const buildManifest = self.__BUILD_MANIFEST
getServerSideProps, const reactLoadableManifest = self.__REACT_LOADABLE_MANIFEST
getStaticPaths const rscManifest = self.__RSC_MANIFEST
} = require(${stringifiedAbsolutePagePath})
if (typeof pageMod.default !== 'function') {
const buildManifest = self.__BUILD_MANIFEST throw new Error('Your page must export a \`default\` component')
const reactLoadableManifest = self.__REACT_LOADABLE_MANIFEST }
const rscManifest = self.__RSC_MANIFEST
const render = getRender({
if (typeof Page !== 'function') { App,
throw new Error('Your page must export a \`default\` component') Document,
} pageMod,
errorMod,
const Component = Page buildManifest,
reactLoadableManifest,
async function render(request) { rscManifest,
const url = request.nextUrl isServerComponent: ${JSON.stringify(isServerComponent)},
const { pathname, searchParams } = url restRenderOpts: ${JSON.stringify(restRenderOpts)}
const query = Object.fromEntries(searchParams) })
// Preflight request export default function rscMiddleware(opts) {
if (request.method === 'HEAD') { return adapter({
return new Response('OK.', { ...opts,
headers: { 'x-middleware-ssr': '1' } handler: render
}) })
} }`
const renderServerComponentData = ${
isServerComponent ? `query.__flight__ !== undefined` : 'false'
}
delete query.__flight__
const req = { url: pathname }
const renderOpts = {
Component,
pageConfig: config || {},
// Locales are not supported yet.
// locales: i18n?.locales,
// locale: detectedLocale,
// defaultLocale,
// domainLocales: i18n?.domains,
dev: process.env.NODE_ENV !== 'production',
App,
Document,
buildManifest,
getStaticProps,
getServerSideProps,
getStaticPaths,
reactLoadableManifest,
buildId: ${JSON.stringify(buildId)},
assetPrefix: ${JSON.stringify(assetPrefix || '')},
env: process.env,
basePath: ${JSON.stringify(basePath || '')},
supportsDynamicHTML: true,
concurrentFeatures: true,
renderServerComponentData,
serverComponentManifest: ${
isServerComponent ? 'rscManifest' : 'null'
},
}
const transformStream = new TransformStream()
const writer = transformStream.writable.getWriter()
const encoder = new TextEncoder()
let result
let renderError
let statusCode = 200
try {
result = await renderToHTML(
req,
{},
pathname,
query,
renderOpts
)
} catch (err) {
renderError = err
statusCode = 500
}
if (renderError) {
try {
const errorRes = { statusCode, err: renderError }
result = await renderToHTML(
req,
errorRes,
'/_error',
query,
{
...renderOpts,
Component: errorMod.default,
getStaticProps: errorMod.getStaticProps,
getServerSideProps: errorMod.getServerSideProps,
getStaticPaths: errorMod.getStaticPaths,
}
)
} catch (err) {
return new Response(
(err || 'An error occurred while rendering ' + pathname + '.').toString(),
{
status: 500,
headers: { 'x-middleware-ssr': '1' }
}
)
}
}
result.pipe({
write: str => writer.write(encoder.encode(str)),
end: () => writer.close(),
// Not implemented: cork/uncork/on/removeListener
})
return new Response(transformStream.readable, {
headers: { 'x-middleware-ssr': '1' },
status: statusCode
})
}
export default function rscMiddleware(opts) {
return adapter({
...opts,
handler: render
})
}
`
return transformed return transformed
} }
import { NextRequest } from '../../../../server/web/spec-extension/request'
import { renderToHTML } from '../../../../server/web/render'
import RenderResult from '../../../../server/render-result'
export function getRender({
App,
Document,
pageMod,
errorMod,
rscManifest,
buildManifest,
reactLoadableManifest,
isServerComponent,
restRenderOpts,
}: {
App: any
Document: any
pageMod: any
errorMod: any
rscManifest: object
buildManifest: any
reactLoadableManifest: any
isServerComponent: boolean
restRenderOpts: any
}) {
return async function render(request: NextRequest) {
const url = request.nextUrl
const { pathname, searchParams } = url
const query = Object.fromEntries(searchParams)
// Preflight request
if (request.method === 'HEAD') {
return new Response('OK.', {
headers: { 'x-middleware-ssr': '1' },
})
}
const renderServerComponentData = isServerComponent
? query.__flight__ !== undefined
: false
delete query.__flight__
const req = { url: pathname }
const renderOpts = {
...restRenderOpts,
// Locales are not supported yet.
// locales: i18n?.locales,
// locale: detectedLocale,
// defaultLocale,
// domainLocales: i18n?.domains,
dev: process.env.NODE_ENV !== 'production',
App,
Document,
buildManifest,
Component: pageMod.default,
pageConfig: pageMod.config || {},
getStaticProps: pageMod.getStaticProps,
getServerSideProps: pageMod.getServerSideProps,
getStaticPaths: pageMod.getStaticPaths,
reactLoadableManifest,
env: process.env,
supportsDynamicHTML: true,
concurrentFeatures: true,
renderServerComponentData,
serverComponentManifest: isServerComponent ? rscManifest : null,
ComponentMod: null,
}
const transformStream = new TransformStream()
const writer = transformStream.writable.getWriter()
const encoder = new TextEncoder()
let result: RenderResult | null
try {
result = await renderToHTML(
req as any,
{} as any,
pathname,
query,
renderOpts
)
} catch (err: any) {
const errorRes = { statusCode: 500, err }
try {
result = await renderToHTML(
req as any,
errorRes as any,
'/_error',
query,
{
...renderOpts,
Component: errorMod.default,
getStaticProps: errorMod.getStaticProps,
getServerSideProps: errorMod.getServerSideProps,
getStaticPaths: errorMod.getStaticPaths,
}
)
} catch (err2: any) {
return new Response(
(
err2 || 'An error occurred while rendering ' + pathname + '.'
).toString(),
{
status: 500,
headers: { 'x-middleware-ssr': '1' },
}
)
}
}
if (!result) {
return new Response(
'An error occurred while rendering ' + pathname + '.',
{
status: 500,
headers: { 'x-middleware-ssr': '1' },
}
)
}
result.pipe({
write: (str: string) => writer.write(encoder.encode(str)),
end: () => writer.close(),
// Not implemented: cork/uncork/on/removeListener
} as any)
return new Response(transformStream.readable, {
headers: { 'x-middleware-ssr': '1' },
status: 200,
})
}
}
...@@ -529,11 +529,17 @@ export default class HotReloader { ...@@ -529,11 +529,17 @@ export default class HotReloader {
absoluteAppPath: this.pagesMapping['/_app'], absoluteAppPath: this.pagesMapping['/_app'],
absoluteDocumentPath: this.pagesMapping['/_document'], absoluteDocumentPath: this.pagesMapping['/_document'],
absoluteErrorPath: this.pagesMapping['/_error'], absoluteErrorPath: this.pagesMapping['/_error'],
absolute404Path: this.pagesMapping['/404'] || '',
absolutePagePath, absolutePagePath,
isServerComponent, isServerComponent,
buildId: this.buildId, buildId: this.buildId,
basePath: this.config.basePath, basePath: this.config.basePath,
assetPrefix: this.config.assetPrefix, assetPrefix: this.config.assetPrefix,
generateEtags: this.config.generateEtags,
poweredByHeader: this.config.poweredByHeader,
canonicalBase: this.config.amp.canonicalBase,
i18n: this.config.i18n,
previewProps: this.previewProps,
} as any)}!`, } as any)}!`,
isServer: false, isServer: false,
isServerWeb: true, isServerWeb: true,
......
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