Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for dynamic HTML #28085

Merged
merged 8 commits into from Aug 13, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
162 changes: 137 additions & 25 deletions packages/next/server/render.tsx
Expand Up @@ -63,7 +63,12 @@ import {
Redirect,
} from '../lib/load-custom-routes'
import { DomainLocale } from './config'
import { RenderResult, resultFromChunks, resultToChunks } from './utils'
import {
Observer,
RenderResult,
resultFromChunks,
resultToChunks,
} from './utils'

function noRouter() {
const message =
Expand Down Expand Up @@ -416,6 +421,7 @@ export async function renderToHTML(
previewProps,
basePath,
devOnlyCacheBusterQueryString,
requireStaticHTML,
concurrentFeatures,
} = renderOpts

Expand Down Expand Up @@ -1002,32 +1008,57 @@ export async function renderToHTML(
}
}

// TODO: Support SSR streaming of Suspense.
const renderToString = concurrentFeatures
? (element: React.ReactElement) =>
new Promise<string>((resolve, reject) => {
const stream = new PassThrough()
const buffers: Buffer[] = []
stream.on('data', (chunk) => {
buffers.push(chunk)
})
stream.once('end', () => {
resolve(Buffer.concat(buffers).toString('utf-8'))
})

const {
abort,
startWriting,
} = (ReactDOMServer as any).pipeToNodeWritable(element, stream, {
onError(error: Error) {
const generateStaticHTML = requireStaticHTML || inAmpMode
const renderToStream = (element: React.ReactElement) =>
new Promise<RenderResult>((resolve, reject) => {
const stream = new PassThrough()
let resolved = false
const doResolve = () => {
if (!resolved) {
resolved = true
resolve(({ complete, next }) => {
stream.on('data', (chunk) => {
next(chunk.toString('utf-8'))
})
stream.once('end', () => {
complete()
})

startWriting()
return () => {
abort()
reject(error)
},
onCompleteAll() {
startWriting()
},
}
})
})
}
}

const {
abort,
startWriting,
} = (ReactDOMServer as any).pipeToNodeWritable(element, stream, {
onError(error: Error) {
if (!resolved) {
resolved = true
reject(error)
}
abort()
},
onReadyToStream() {
if (!generateStaticHTML) {
doResolve()
}
},
onCompleteAll() {
doResolve()
},
})
}).then(multiplexResult)

const renderToString = concurrentFeatures
? async (element: React.ReactElement) => {
const result = await renderToStream(element)
return await resultsToString([result])
}
: ReactDOMServer.renderToString

const renderPage: RenderPage = (
Expand Down Expand Up @@ -1285,6 +1316,87 @@ function mergeResults(chunks: Array<RenderResult>): RenderResult {
}
}

function multiplexResult(result: RenderResult): RenderResult {
const chunks: Array<string> = []
const subscribers: Set<Observer<string>> = new Set()
let terminator: ((subscriber: Observer<string>) => void) | null = null

result({
next(chunk) {
chunks.push(chunk)
subscribers.forEach((subscriber) => subscriber.next(chunk))
},
error(error) {
if (!terminator) {
terminator = (subscriber) => subscriber.error(error)
subscribers.forEach(terminator)
subscribers.clear()
}
},
complete() {
if (!terminator) {
terminator = (subscriber) => subscriber.complete()
subscribers.forEach(terminator)
subscribers.clear()
}
},
})

return (innerSubscriber) => {
let completed = false
let cleanup = () => {}
const subscriber: Observer<string> = {
next(chunk) {
if (!completed) {
try {
innerSubscriber.next(chunk)
} catch (err) {
subscriber.error(err)
}
}
},
complete() {
if (!completed) {
cleanup()
try {
innerSubscriber.complete()
} catch {}
}
},
error(err) {
if (!completed) {
cleanup()
try {
innerSubscriber.error(err)
} catch {}
}
},
}
cleanup = () => {
completed = true
subscribers.delete(subscriber)
}

process.nextTick(() => {
for (const chunk of chunks) {
if (completed) {
return
}
subscriber.next(chunk)
}

if (!completed) {
if (!terminator) {
subscribers.add(subscriber)
} else {
terminator(subscriber)
}
}
})
return () => cleanup()
}
}

function errorToJSON(err: Error): Error {
const { name, message, stack } = err
return { name, message, stack }
Expand Down
8 changes: 4 additions & 4 deletions packages/next/server/utils.ts
Expand Up @@ -16,12 +16,12 @@ export function cleanAmpPath(pathname: string): string {
}

export type Disposable = () => void
// TODO: Consider just using an actual Observable here
export type RenderResult = (observer: {
next(chunk: string): void
export type Observer<T> = {
next(chunk: T): void
error(error: Error): void
complete(): void
}) => Disposable
}
export type RenderResult = (observer: Observer<string>) => Disposable

export function resultFromChunks(chunks: string[]): RenderResult {
return ({ next, complete, error }) => {
Expand Down