2018-12-13 00:00:46 +00:00
|
|
|
import {IncomingMessage, ServerResponse} from 'http'
|
|
|
|
|
import { ParsedUrlQuery } from 'querystring'
|
|
|
|
|
import React from 'react'
|
|
|
|
|
import { renderToString, renderToStaticMarkup } from 'react-dom/server'
|
2019-01-14 14:41:09 +00:00
|
|
|
import Router from '../lib/router/router'
|
2018-12-13 00:00:46 +00:00
|
|
|
import { loadGetInitialProps, isResSent } from '../lib/utils'
|
|
|
|
|
import Head, { defaultHead } from '../lib/head'
|
|
|
|
|
import Loadable from '../lib/loadable'
|
|
|
|
|
import LoadableCapture from '../lib/loadable-capture'
|
2018-12-18 16:12:49 +00:00
|
|
|
import {getDynamicImportBundles, Manifest as ReactLoadableManifest, ManifestItem} from './get-dynamic-import-bundles'
|
|
|
|
|
import {getPageFiles, BuildManifest} from './get-page-files'
|
2018-12-13 00:00:46 +00:00
|
|
|
|
|
|
|
|
type Enhancer = (Component: React.ComponentType) => React.ComponentType
|
|
|
|
|
type ComponentsEnhancer = {enhanceApp?: Enhancer, enhanceComponent?: Enhancer}|Enhancer
|
|
|
|
|
|
|
|
|
|
function enhanceComponents(options: ComponentsEnhancer, App: React.ComponentType, Component: React.ComponentType): {
|
|
|
|
|
App: React.ComponentType,
|
2019-02-08 10:57:29 +00:00
|
|
|
Component: React.ComponentType,
|
2018-12-13 00:00:46 +00:00
|
|
|
} {
|
|
|
|
|
// For backwards compatibility
|
2019-02-08 10:57:29 +00:00
|
|
|
if (typeof options === 'function') {
|
2018-12-13 00:00:46 +00:00
|
|
|
return {
|
2019-02-08 10:57:29 +00:00
|
|
|
App,
|
|
|
|
|
Component: options(Component),
|
2018-12-13 00:00:46 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return {
|
|
|
|
|
App: options.enhanceApp ? options.enhanceApp(App) : App,
|
2019-02-08 10:57:29 +00:00
|
|
|
Component: options.enhanceComponent ? options.enhanceComponent(Component) : Component,
|
2018-12-13 00:00:46 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
function render(renderElementToString: (element: React.ReactElement<any>) => string, element: React.ReactElement<any>): {html: string, head: any} {
|
|
|
|
|
let html
|
|
|
|
|
let head
|
|
|
|
|
|
|
|
|
|
try {
|
|
|
|
|
html = renderElementToString(element)
|
|
|
|
|
} finally {
|
|
|
|
|
head = Head.rewind() || defaultHead()
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return { html, head }
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
type RenderOpts = {
|
|
|
|
|
staticMarkup: boolean,
|
|
|
|
|
buildId: string,
|
|
|
|
|
runtimeConfig?: {[key: string]: any},
|
|
|
|
|
assetPrefix?: string,
|
|
|
|
|
err?: Error|null,
|
|
|
|
|
nextExport?: boolean,
|
2018-12-18 16:12:49 +00:00
|
|
|
dev?: boolean,
|
2018-12-26 19:58:17 +00:00
|
|
|
buildManifest: BuildManifest,
|
2018-12-18 16:12:49 +00:00
|
|
|
reactLoadableManifest: ReactLoadableManifest,
|
|
|
|
|
Component: React.ComponentType,
|
|
|
|
|
Document: React.ComponentType,
|
|
|
|
|
App: React.ComponentType,
|
2019-02-08 10:57:29 +00:00
|
|
|
ErrorDebug?: React.ComponentType<{error: Error}>,
|
2018-12-13 00:00:46 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
function renderDocument(Document: React.ComponentType, {
|
|
|
|
|
props,
|
|
|
|
|
docProps,
|
|
|
|
|
pathname,
|
|
|
|
|
query,
|
|
|
|
|
buildId,
|
|
|
|
|
assetPrefix,
|
|
|
|
|
runtimeConfig,
|
|
|
|
|
nextExport,
|
|
|
|
|
dynamicImportsIds,
|
|
|
|
|
err,
|
|
|
|
|
dev,
|
|
|
|
|
staticMarkup,
|
|
|
|
|
devFiles,
|
|
|
|
|
files,
|
|
|
|
|
dynamicImports,
|
|
|
|
|
}: RenderOpts & {
|
|
|
|
|
props: any,
|
|
|
|
|
docProps: any,
|
|
|
|
|
pathname: string,
|
|
|
|
|
query: ParsedUrlQuery,
|
|
|
|
|
dynamicImportsIds: string[],
|
|
|
|
|
dynamicImports: ManifestItem[],
|
|
|
|
|
files: string[]
|
|
|
|
|
devFiles: string[],
|
|
|
|
|
}): string {
|
|
|
|
|
return '<!DOCTYPE html>' + renderToStaticMarkup(
|
|
|
|
|
<Document
|
|
|
|
|
__NEXT_DATA__={{
|
|
|
|
|
props, // The result of getInitialProps
|
|
|
|
|
page: pathname, // The rendered page
|
|
|
|
|
query, // querystring parsed / passed by the user
|
|
|
|
|
buildId, // buildId is used to facilitate caching of page bundles, we send it to the client so that pageloader knows where to load bundles
|
|
|
|
|
assetPrefix: assetPrefix === '' ? undefined : assetPrefix, // send assetPrefix to the client side when configured, otherwise don't sent in the resulting HTML
|
|
|
|
|
runtimeConfig, // runtimeConfig if provided, otherwise don't sent in the resulting HTML
|
|
|
|
|
nextExport, // If this is a page exported by `next export`
|
|
|
|
|
dynamicIds: dynamicImportsIds.length === 0 ? undefined : dynamicImportsIds,
|
2019-02-08 10:57:29 +00:00
|
|
|
err: (err) ? serializeError(dev, err) : undefined, // Error if one happened, otherwise don't sent in the resulting HTML
|
2018-12-13 00:00:46 +00:00
|
|
|
}}
|
|
|
|
|
staticMarkup={staticMarkup}
|
|
|
|
|
devFiles={devFiles}
|
|
|
|
|
files={files}
|
|
|
|
|
dynamicImports={dynamicImports}
|
|
|
|
|
assetPrefix={assetPrefix}
|
2018-12-17 15:09:23 +00:00
|
|
|
{...docProps}
|
2019-02-08 10:57:29 +00:00
|
|
|
/>,
|
2018-12-13 00:00:46 +00:00
|
|
|
)
|
|
|
|
|
}
|
|
|
|
|
|
2019-02-08 10:57:29 +00:00
|
|
|
export async function renderToHTML(req: IncomingMessage, res: ServerResponse, pathname: string, query: ParsedUrlQuery, renderOpts: RenderOpts): Promise<string|null> {
|
2018-12-13 00:00:46 +00:00
|
|
|
const {
|
|
|
|
|
err,
|
|
|
|
|
dev = false,
|
2018-12-18 16:12:49 +00:00
|
|
|
staticMarkup = false,
|
|
|
|
|
App,
|
|
|
|
|
Document,
|
|
|
|
|
Component,
|
|
|
|
|
buildManifest,
|
|
|
|
|
reactLoadableManifest,
|
2019-02-08 10:57:29 +00:00
|
|
|
ErrorDebug,
|
2018-12-13 00:00:46 +00:00
|
|
|
} = renderOpts
|
2018-12-18 16:12:49 +00:00
|
|
|
|
2018-12-13 00:00:46 +00:00
|
|
|
await Loadable.preloadAll() // Make sure all dynamic imports are loaded
|
|
|
|
|
|
2018-12-17 15:09:23 +00:00
|
|
|
if (dev) {
|
|
|
|
|
const { isValidElementType } = require('react-is')
|
|
|
|
|
if (!isValidElementType(Component)) {
|
|
|
|
|
throw new Error(`The default export is not a React Component in page: "${pathname}"`)
|
|
|
|
|
}
|
|
|
|
|
|
2018-12-17 16:42:40 +00:00
|
|
|
if (!isValidElementType(App)) {
|
|
|
|
|
throw new Error(`The default export is not a React Component in page: "/_app"`)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (!isValidElementType(Document)) {
|
|
|
|
|
throw new Error(`The default export is not a React Component in page: "/_document"`)
|
|
|
|
|
}
|
|
|
|
|
}
|
2018-12-13 00:00:46 +00:00
|
|
|
|
|
|
|
|
const asPath = req.url
|
|
|
|
|
const ctx = { err, req, res, pathname, query, asPath }
|
|
|
|
|
const router = new Router(pathname, query, asPath)
|
|
|
|
|
const props = await loadGetInitialProps(App, {Component, router, ctx})
|
|
|
|
|
|
2018-12-17 15:09:23 +00:00
|
|
|
// the response might be finished on the getInitialProps call
|
2018-12-13 00:00:46 +00:00
|
|
|
if (isResSent(res)) return null
|
|
|
|
|
|
|
|
|
|
const devFiles = buildManifest.devFiles
|
|
|
|
|
const files = [
|
|
|
|
|
...new Set([
|
|
|
|
|
...getPageFiles(buildManifest, pathname),
|
|
|
|
|
...getPageFiles(buildManifest, '/_app'),
|
2019-02-08 10:57:29 +00:00
|
|
|
]),
|
2018-12-13 00:00:46 +00:00
|
|
|
]
|
|
|
|
|
|
|
|
|
|
const reactLoadableModules: string[] = []
|
|
|
|
|
const renderPage = (options: ComponentsEnhancer = {}): {html: string, head: any} => {
|
|
|
|
|
const renderElementToString = staticMarkup ? renderToStaticMarkup : renderToString
|
|
|
|
|
|
2019-02-08 10:57:29 +00:00
|
|
|
if (err && ErrorDebug) {
|
2018-12-13 00:00:46 +00:00
|
|
|
return render(renderElementToString, <ErrorDebug error={err} />)
|
|
|
|
|
}
|
|
|
|
|
|
2018-12-18 16:12:49 +00:00
|
|
|
const {App: EnhancedApp, Component: EnhancedComponent} = enhanceComponents(options, App, Component)
|
|
|
|
|
|
2018-12-17 15:09:23 +00:00
|
|
|
return render(renderElementToString,
|
2018-12-13 00:00:46 +00:00
|
|
|
<LoadableCapture report={(moduleName) => reactLoadableModules.push(moduleName)}>
|
2019-01-14 14:41:09 +00:00
|
|
|
<EnhancedApp
|
|
|
|
|
Component={EnhancedComponent}
|
|
|
|
|
router={router}
|
|
|
|
|
{...props}
|
|
|
|
|
/>
|
2019-02-08 10:57:29 +00:00
|
|
|
</LoadableCapture>,
|
2018-12-13 00:00:46 +00:00
|
|
|
)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
const docProps = await loadGetInitialProps(Document, { ...ctx, renderPage })
|
2019-01-02 19:21:57 +00:00
|
|
|
// the response might be finished on the getInitialProps call
|
2018-12-13 00:00:46 +00:00
|
|
|
if (isResSent(res)) return null
|
|
|
|
|
|
|
|
|
|
const dynamicImports = [...getDynamicImportBundles(reactLoadableManifest, reactLoadableModules)]
|
|
|
|
|
const dynamicImportsIds: any = dynamicImports.map((bundle) => bundle.id)
|
|
|
|
|
|
|
|
|
|
return renderDocument(Document, {
|
|
|
|
|
...renderOpts,
|
|
|
|
|
props,
|
|
|
|
|
docProps,
|
|
|
|
|
pathname,
|
|
|
|
|
query,
|
|
|
|
|
dynamicImportsIds,
|
|
|
|
|
dynamicImports,
|
|
|
|
|
files,
|
2019-02-08 10:57:29 +00:00
|
|
|
devFiles,
|
2018-12-13 00:00:46 +00:00
|
|
|
})
|
|
|
|
|
}
|
|
|
|
|
|
2019-02-08 10:57:29 +00:00
|
|
|
function errorToJSON(err: Error): Error {
|
2018-12-13 00:00:46 +00:00
|
|
|
const { name, message, stack } = err
|
|
|
|
|
return { name, message, stack }
|
|
|
|
|
}
|
|
|
|
|
|
2019-02-08 10:57:29 +00:00
|
|
|
function serializeError(dev: boolean|undefined, err: Error): Error & {statusCode?: number} {
|
2018-12-13 00:00:46 +00:00
|
|
|
if (dev) {
|
|
|
|
|
return errorToJSON(err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return { name: 'Internal Server Error.', message: '500 - Internal Server Error.', statusCode: 500 }
|
|
|
|
|
}
|
