Unverified Commit 00a84328 authored by Jiachi Liu's avatar Jiachi Liu Committed by GitHub

Custom app for server components (#33149)

## Feature

Resolves #30996

- [x] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR.
- [x] Related issues linked using `fixes #number`
- [x] 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`
parent 30ca6b38
...@@ -157,6 +157,7 @@ export function createEntrypoints( ...@@ -157,6 +157,7 @@ export function createEntrypoints(
const isFlight = isFlightPage(config, absolutePagePath) const isFlight = isFlightPage(config, absolutePagePath)
const webServerRuntime = !!config.experimental.concurrentFeatures const webServerRuntime = !!config.experimental.concurrentFeatures
const hasServerComponents = !!config.experimental.serverComponents
if (page.match(MIDDLEWARE_ROUTE)) { if (page.match(MIDDLEWARE_ROUTE)) {
const loaderOpts: MiddlewareLoaderOptions = { const loaderOpts: MiddlewareLoaderOptions = {
...@@ -179,6 +180,7 @@ export function createEntrypoints( ...@@ -179,6 +180,7 @@ export function createEntrypoints(
absolute500Path: pages['/500'] || '', absolute500Path: pages['/500'] || '',
absolutePagePath, absolutePagePath,
isServerComponent: isFlight, isServerComponent: isFlight,
serverComponents: hasServerComponents,
...defaultServerlessOptions, ...defaultServerlessOptions,
} as any)}!`, } as any)}!`,
isServer: false, isServer: false,
......
...@@ -32,7 +32,10 @@ async function parseImportsInfo( ...@@ -32,7 +32,10 @@ async function parseImportsInfo(
imports: Array<string>, imports: Array<string>,
isClientCompilation: boolean, isClientCompilation: boolean,
pageExtensions: string[] pageExtensions: string[]
): Promise<string> { ): Promise<{
source: string
defaultExportName: string
}> {
const { body } = acorn.parse(source, { const { body } = acorn.parse(source, {
ecmaVersion: 11, ecmaVersion: 11,
sourceType: 'module', sourceType: 'module',
...@@ -40,11 +43,12 @@ async function parseImportsInfo( ...@@ -40,11 +43,12 @@ async function parseImportsInfo(
let transformedSource = '' let transformedSource = ''
let lastIndex = 0 let lastIndex = 0
let defaultExportName = 'RSComponent'
for (let i = 0; i < body.length; i++) { for (let i = 0; i < body.length; i++) {
const node = body[i] const node = body[i]
switch (node.type) { switch (node.type) {
case 'ImportDeclaration': case 'ImportDeclaration': {
const importSource = node.source.value const importSource = node.source.value
if (!isClientCompilation) { if (!isClientCompilation) {
...@@ -57,9 +61,9 @@ async function parseImportsInfo( ...@@ -57,9 +61,9 @@ async function parseImportsInfo(
) { ) {
continue continue
} }
transformedSource += source.substr( transformedSource += source.substring(
lastIndex, lastIndex,
node.source.start - lastIndex node.source.start - 1
) )
transformedSource += JSON.stringify(`${node.source.value}?flight`) transformedSource += JSON.stringify(`${node.source.value}?flight`)
} else { } else {
...@@ -83,16 +87,21 @@ async function parseImportsInfo( ...@@ -83,16 +87,21 @@ async function parseImportsInfo(
lastIndex = node.source.end lastIndex = node.source.end
imports.push(`require(${JSON.stringify(importSource)})`) imports.push(`require(${JSON.stringify(importSource)})`)
continue continue
}
case 'ExportDefaultDeclaration': {
defaultExportName = node.declaration.id.name
break
}
default: default:
break break
} }
} }
if (!isClientCompilation) { if (!isClientCompilation) {
transformedSource += source.substr(lastIndex) transformedSource += source.substring(lastIndex)
} }
return transformedSource return { source: transformedSource, defaultExportName }
} }
export default async function transformSource( export default async function transformSource(
...@@ -113,17 +122,32 @@ export default async function transformSource( ...@@ -113,17 +122,32 @@ export default async function transformSource(
} }
const imports: string[] = [] const imports: string[] = []
const transformed = await parseImportsInfo( const { source: transformedSource, defaultExportName } =
source, await parseImportsInfo(
imports, source,
isClientCompilation, imports,
getRawPageExtensions(pageExtensions) isClientCompilation,
) getRawPageExtensions(pageExtensions)
)
const noop = `\nexport const __rsc_noop__=()=>{${imports.join(';')}}`
/**
* Server side component module output:
*
* export default function ServerComponent() { ... }
* + export const __rsc_noop__=()=>{ ... }
* + ServerComponent.__next_rsc__=1;
*
* Client side component module output:
*
* The function body of ServerComponent will be removed
*/
const noop = `export const __rsc_noop__=()=>{${imports.join(';')}}`
const defaultExportNoop = isClientCompilation const defaultExportNoop = isClientCompilation
? `\nexport default function Comp(){}\nComp.__next_rsc__=1` ? `export default function ${defaultExportName}(){}\n${defaultExportName}.__next_rsc__=1;`
: '' : `${defaultExportName}.__next_rsc__=1;`
const transformed = transformedSource + '\n' + noop + '\n' + defaultExportNoop
return transformed + noop + defaultExportNoop return transformed
} }
...@@ -50,7 +50,7 @@ export default async function middlewareSSRLoader(this: any) { ...@@ -50,7 +50,7 @@ export default async function middlewareSSRLoader(this: any) {
buildManifest, buildManifest,
reactLoadableManifest, reactLoadableManifest,
rscManifest, rscManifest,
isServerComponent: ${JSON.stringify(isServerComponent)}, isServerComponent: ${isServerComponent},
restRenderOpts: ${JSON.stringify(restRenderOpts)} restRenderOpts: ${JSON.stringify(restRenderOpts)}
}) })
......
...@@ -629,6 +629,15 @@ function AppContainer({ ...@@ -629,6 +629,15 @@ function AppContainer({
) )
} }
function renderApp(App: AppComponent, appProps: AppProps) {
if (process.env.__NEXT_RSC && (App as any).__next_rsc__) {
const { Component, err: _, router: __, ...props } = appProps
return <Component {...props} />
} else {
return <App {...appProps} />
}
}
const wrapApp = const wrapApp =
(App: AppComponent) => (App: AppComponent) =>
(wrappedAppProps: Record<string, any>): JSX.Element => { (wrappedAppProps: Record<string, any>): JSX.Element => {
...@@ -638,11 +647,7 @@ const wrapApp = ...@@ -638,11 +647,7 @@ const wrapApp =
err: hydrateErr, err: hydrateErr,
router, router,
} }
return ( return <AppContainer>{renderApp(App, appProps)}</AppContainer>
<AppContainer>
<App {...appProps} />
</AppContainer>
)
} }
let RSCComponent: (props: any) => JSX.Element let RSCComponent: (props: any) => JSX.Element
...@@ -957,7 +962,7 @@ function doRender(input: RenderRouteInfo): Promise<any> { ...@@ -957,7 +962,7 @@ function doRender(input: RenderRouteInfo): Promise<any> {
<> <>
<Head callback={onHeadCommit} /> <Head callback={onHeadCommit} />
<AppContainer> <AppContainer>
<App {...appProps} /> {renderApp(App, appProps)}
<Portal type="next-route-announcer"> <Portal type="next-route-announcer">
<RouteAnnouncer /> <RouteAnnouncer />
</Portal> </Portal>
......
...@@ -142,7 +142,7 @@ export function useRouter(): NextRouter { ...@@ -142,7 +142,7 @@ export function useRouter(): NextRouter {
// (do not use following exports inside the app) // (do not use following exports inside the app)
// Create a router and assign it as the singleton instance. // Create a router and assign it as the singleton instance.
// This is used in client side when we are initilizing the app. // This is used in client side when we are initializing the app.
// This should **not** be used inside the server. // This should **not** be used inside the server.
export function createRouter(...args: RouterArgs): Router { export function createRouter(...args: RouterArgs): Router {
singletonRouter.router = new Router(...args) singletonRouter.router = new Router(...args)
......
...@@ -199,6 +199,7 @@ export default abstract class Server { ...@@ -199,6 +199,7 @@ export default abstract class Server {
domainLocales?: DomainLocale[] domainLocales?: DomainLocale[]
distDir: string distDir: string
concurrentFeatures?: boolean concurrentFeatures?: boolean
serverComponents?: boolean
crossOrigin?: string crossOrigin?: string
} }
private compression?: ExpressMiddleware private compression?: ExpressMiddleware
...@@ -291,6 +292,7 @@ export default abstract class Server { ...@@ -291,6 +292,7 @@ export default abstract class Server {
domainLocales: this.nextConfig.i18n?.domains, domainLocales: this.nextConfig.i18n?.domains,
distDir: this.distDir, distDir: this.distDir,
concurrentFeatures: this.nextConfig.experimental.concurrentFeatures, concurrentFeatures: this.nextConfig.experimental.concurrentFeatures,
serverComponents: this.nextConfig.experimental.serverComponents,
crossOrigin: this.nextConfig.crossOrigin crossOrigin: this.nextConfig.crossOrigin
? this.nextConfig.crossOrigin ? this.nextConfig.crossOrigin
: undefined, : undefined,
......
...@@ -532,6 +532,7 @@ export default class HotReloader { ...@@ -532,6 +532,7 @@ export default class HotReloader {
absolute404Path: this.pagesMapping['/404'] || '', absolute404Path: this.pagesMapping['/404'] || '',
absolutePagePath, absolutePagePath,
isServerComponent, isServerComponent,
serverComponents: this.hasServerComponents,
buildId: this.buildId, buildId: this.buildId,
basePath: this.config.basePath, basePath: this.config.basePath,
assetPrefix: this.config.assetPrefix, assetPrefix: this.config.assetPrefix,
......
...@@ -182,6 +182,21 @@ function enhanceComponents( ...@@ -182,6 +182,21 @@ function enhanceComponents(
} }
} }
function renderFlight(
App: AppType,
Component: React.ComponentType,
props: any
) {
const AppServer = (App as any).__next_rsc__
? (App as React.ComponentType)
: React.Fragment
return (
<AppServer>
<Component {...props} />
</AppServer>
)
}
export type RenderOptsPartial = { export type RenderOptsPartial = {
buildId: string buildId: string
canonicalBase: string canonicalBase: string
...@@ -219,6 +234,7 @@ export type RenderOptsPartial = { ...@@ -219,6 +234,7 @@ export type RenderOptsPartial = {
disableOptimizedLoading?: boolean disableOptimizedLoading?: boolean
supportsDynamicHTML?: boolean supportsDynamicHTML?: boolean
concurrentFeatures?: boolean concurrentFeatures?: boolean
serverComponents?: boolean
customServer?: boolean customServer?: boolean
crossOrigin?: string crossOrigin?: string
} }
...@@ -342,6 +358,7 @@ const useRSCResponse = createRSCHook() ...@@ -342,6 +358,7 @@ const useRSCResponse = createRSCHook()
function createServerComponentRenderer( function createServerComponentRenderer(
cachePrefix: string, cachePrefix: string,
transformStream: TransformStream, transformStream: TransformStream,
App: AppType,
OriginalComponent: React.ComponentType, OriginalComponent: React.ComponentType,
serverComponentManifest: NonNullable<RenderOpts['serverComponentManifest']> serverComponentManifest: NonNullable<RenderOpts['serverComponentManifest']>
) { ) {
...@@ -349,7 +366,7 @@ function createServerComponentRenderer( ...@@ -349,7 +366,7 @@ function createServerComponentRenderer(
const ServerComponentWrapper = (props: any) => { const ServerComponentWrapper = (props: any) => {
const id = (React as any).useId() const id = (React as any).useId()
const reqStream = renderToReadableStream( const reqStream = renderToReadableStream(
<OriginalComponent {...props} />, renderFlight(App, OriginalComponent, props),
serverComponentManifest serverComponentManifest
) )
...@@ -363,6 +380,7 @@ function createServerComponentRenderer( ...@@ -363,6 +380,7 @@ function createServerComponentRenderer(
rscCache.delete(id) rscCache.delete(id)
return root return root
} }
const Component = (props: any) => { const Component = (props: any) => {
return ( return (
<React.Suspense fallback={null}> <React.Suspense fallback={null}>
...@@ -441,6 +459,7 @@ export async function renderToHTML( ...@@ -441,6 +459,7 @@ export async function renderToHTML(
? createServerComponentRenderer( ? createServerComponentRenderer(
cachePrefix, cachePrefix,
serverComponentsInlinedTransformStream!, serverComponentsInlinedTransformStream!,
App,
OriginalComponent, OriginalComponent,
serverComponentManifest serverComponentManifest
) )
...@@ -714,11 +733,9 @@ export async function renderToHTML( ...@@ -714,11 +733,9 @@ export async function renderToHTML(
// not be useful. // not be useful.
// https://github.com/facebook/react/pull/22644 // https://github.com/facebook/react/pull/22644
const Noop = () => null const Noop = () => null
const AppContainerWithIsomorphicFiberStructure = ({ const AppContainerWithIsomorphicFiberStructure: React.FC<{
children,
}: {
children: JSX.Element children: JSX.Element
}) => { }> = ({ children }) => {
return ( return (
<> <>
{/* <Head/> */} {/* <Head/> */}
...@@ -1080,7 +1097,10 @@ export async function renderToHTML( ...@@ -1080,7 +1097,10 @@ export async function renderToHTML(
if (renderServerComponentData) { if (renderServerComponentData) {
const stream: ReadableStream = renderToReadableStream( const stream: ReadableStream = renderToReadableStream(
<OriginalComponent {...props.pageProps} {...serverComponentProps} />, renderFlight(App, OriginalComponent, {
...props.pageProps,
...serverComponentProps,
}),
serverComponentManifest serverComponentManifest
) )
const reader = stream.getReader() const reader = stream.getReader()
...@@ -1201,22 +1221,30 @@ export async function renderToHTML( ...@@ -1201,22 +1221,30 @@ export async function renderToHTML(
} else { } else {
let bodyResult let bodyResult
const renderContent = () => {
return ctx.err && ErrorDebug ? (
<Body>
<ErrorDebug error={ctx.err} />
</Body>
) : (
<Body>
<AppContainerWithIsomorphicFiberStructure>
{renderOpts.serverComponents && (App as any).__next_rsc__ ? (
<Component {...props.pageProps} router={router} />
) : (
<App {...props} Component={Component} router={router} />
)}
</AppContainerWithIsomorphicFiberStructure>
</Body>
)
}
if (concurrentFeatures) { if (concurrentFeatures) {
bodyResult = async (suffix: string) => { bodyResult = async (suffix: string) => {
// this must be called inside bodyResult so appWrappers is // this must be called inside bodyResult so appWrappers is
// up to date when getWrappedApp is called // up to date when getWrappedApp is called
const content =
ctx.err && ErrorDebug ? ( const content = renderContent()
<Body>
<ErrorDebug error={ctx.err} />
</Body>
) : (
<Body>
<AppContainerWithIsomorphicFiberStructure>
<App {...props} Component={Component} router={router} />
</AppContainerWithIsomorphicFiberStructure>
</Body>
)
return process.browser return process.browser
? await renderToWebStream( ? await renderToWebStream(
content, content,
...@@ -1226,18 +1254,7 @@ export async function renderToHTML( ...@@ -1226,18 +1254,7 @@ export async function renderToHTML(
: await renderToNodeStream(content, suffix, generateStaticHTML) : await renderToNodeStream(content, suffix, generateStaticHTML)
} }
} else { } else {
const content = const content = renderContent()
ctx.err && ErrorDebug ? (
<Body>
<ErrorDebug error={ctx.err} />
</Body>
) : (
<Body>
<AppContainerWithIsomorphicFiberStructure>
<App {...props} Component={Component} router={router} />
</AppContainerWithIsomorphicFiberStructure>
</Body>
)
// for non-concurrent rendering we need to ensure App is rendered // for non-concurrent rendering we need to ensure App is rendered
// before _document so that updateHead is called/collected before // before _document so that updateHead is called/collected before
// rendering _document's head // rendering _document's head
......
export default function Container({ children }) {
return <div className="container-server">{children}</div>
}
...@@ -25,6 +25,7 @@ const nativeModuleTestAppDir = join(__dirname, '../unsupported-native-module') ...@@ -25,6 +25,7 @@ const nativeModuleTestAppDir = join(__dirname, '../unsupported-native-module')
const distDir = join(__dirname, '../app/.next') const distDir = join(__dirname, '../app/.next')
const documentPage = new File(join(appDir, 'pages/_document.jsx')) const documentPage = new File(join(appDir, 'pages/_document.jsx'))
const appPage = new File(join(appDir, 'pages/_app.js')) const appPage = new File(join(appDir, 'pages/_app.js'))
const appServerPage = new File(join(appDir, 'pages/_app.server.js'))
const error500Page = new File(join(appDir, 'pages/500.js')) const error500Page = new File(join(appDir, 'pages/500.js'))
const documentWithGip = ` const documentWithGip = `
...@@ -47,6 +48,13 @@ Document.getInitialProps = (ctx) => { ...@@ -47,6 +48,13 @@ Document.getInitialProps = (ctx) => {
} }
` `
const rscAppPage = `
import Container from '../components/container.server'
export default function App({children}) {
return <Container>{children}</Container>
}
`
const appWithGlobalCss = ` const appWithGlobalCss = `
import '../styles.css' import '../styles.css'
...@@ -175,6 +183,22 @@ describe('concurrentFeatures - prod', () => { ...@@ -175,6 +183,22 @@ describe('concurrentFeatures - prod', () => {
runBasicTests(context, 'prod') runBasicTests(context, 'prod')
}) })
const customAppPageSuite = {
runTests: (context) => {
it('should render container in app', async () => {
const indexHtml = await renderViaHTTP(context.appPort, '/')
const indexFlight = await renderViaHTTP(context.appPort, '/?__flight__=1')
expect(indexHtml).toContain('container-server')
expect(indexFlight).toContain('container-server')
})
},
before: () => appServerPage.write(rscAppPage),
after: () => appServerPage.delete(),
}
runSuite('Custom App', 'dev', customAppPageSuite)
runSuite('Custom App', 'prod', customAppPageSuite)
describe('concurrentFeatures - dev', () => { describe('concurrentFeatures - dev', () => {
const context = { appDir } const context = { appDir }
......
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