forked from vercel/next.js
-
Notifications
You must be signed in to change notification settings - Fork 0
/
view-render.tsx
502 lines (447 loc) · 14.5 KB
/
view-render.tsx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
import type { IncomingMessage, ServerResponse } from 'http'
import type { LoadComponentsReturnType } from './load-components'
import React from 'react'
import { ParsedUrlQuery, stringify as stringifyQuery } from 'querystring'
import { createFromReadableStream } from 'next/dist/compiled/react-server-dom-webpack'
import { renderToReadableStream } from 'next/dist/compiled/react-server-dom-webpack/writer.browser.server'
import { StyleRegistry, createStyleRegistry } from 'styled-jsx'
import { NextParsedUrlQuery } from './request-meta'
import RenderResult from './render-result'
import {
readableStreamTee,
encodeText,
decodeText,
renderToInitialStream,
createBufferedTransformStream,
continueFromInitialStream,
} from './node-web-streams-helper'
import { FlushEffectsContext } from '../shared/lib/flush-effects'
import { isDynamicRoute } from '../shared/lib/router/utils'
import { tryGetPreviewData } from './api-utils/node'
import DefaultRootLayout from '../lib/views-layout'
const ReactDOMServer = process.env.__NEXT_REACT_ROOT
? require('react-dom/server.browser')
: require('react-dom/server')
export type RenderOptsPartial = {
err?: Error | null
dev?: boolean
serverComponentManifest?: any
supportsDynamicHTML?: boolean
runtime?: 'nodejs' | 'edge'
serverComponents?: boolean
reactRoot: boolean
}
export type RenderOpts = LoadComponentsReturnType & RenderOptsPartial
const rscCache = new Map()
// Shadowing check does not work with TypeScript enums
// eslint-disable-next-line no-shadow
const enum RecordStatus {
Pending,
Resolved,
Rejected,
}
type Record = {
status: RecordStatus
value: any
}
function createRecordFromThenable(thenable: Promise<any>) {
const record: Record = {
status: RecordStatus.Pending,
value: thenable,
}
thenable.then(
function (value) {
if (record.status === RecordStatus.Pending) {
const resolvedRecord = record
resolvedRecord.status = RecordStatus.Resolved
resolvedRecord.value = value
}
},
function (err) {
if (record.status === RecordStatus.Pending) {
const rejectedRecord = record
rejectedRecord.status = RecordStatus.Rejected
rejectedRecord.value = err
}
}
)
return record
}
function readRecordValue(record: Record) {
if (record.status === RecordStatus.Resolved) {
return record.value
} else {
throw record.value
}
}
function preloadDataFetchingRecord(
map: Map<string, Record>,
key: string,
fetcher: () => Promise<any> | any
) {
let record = map.get(key)
if (!record) {
const thenable = fetcher()
record = createRecordFromThenable(thenable)
map.set(key, record)
}
return record
}
function createFlightHook() {
return (
writable: WritableStream<Uint8Array>,
id: string,
req: ReadableStream<Uint8Array>,
bootstrap: boolean
) => {
let entry = rscCache.get(id)
if (!entry) {
const [renderStream, forwardStream] = readableStreamTee(req)
entry = createFromReadableStream(renderStream)
rscCache.set(id, entry)
let bootstrapped = false
const forwardReader = forwardStream.getReader()
const writer = writable.getWriter()
function process() {
forwardReader.read().then(({ done, value }) => {
if (bootstrap && !bootstrapped) {
bootstrapped = true
writer.write(
encodeText(
`<script>(self.__next_s=self.__next_s||[]).push(${JSON.stringify(
[0, id]
)})</script>`
)
)
}
if (done) {
rscCache.delete(id)
writer.close()
} else {
writer.write(
encodeText(
`<script>(self.__next_s=self.__next_s||[]).push(${JSON.stringify(
[1, id, decodeText(value)]
)})</script>`
)
)
process()
}
})
}
process()
}
return entry
}
}
const useFlightResponse = createFlightHook()
// Create the wrapper component for a Flight stream.
function createServerComponentRenderer(
ComponentToRender: React.ComponentType,
ComponentMod: any,
{
cachePrefix,
transformStream,
serverComponentManifest,
}: {
cachePrefix: string
transformStream: TransformStream<Uint8Array, Uint8Array>
serverComponentManifest: NonNullable<RenderOpts['serverComponentManifest']>
}
) {
// We need to expose the `__webpack_require__` API globally for
// react-server-dom-webpack. This is a hack until we find a better way.
if (ComponentMod.__next_rsc__) {
// @ts-ignore
globalThis.__webpack_require__ =
ComponentMod.__next_rsc__.__webpack_require__
// @ts-ignore
globalThis.__webpack_chunk_load__ = () => Promise.resolve()
}
const writable = transformStream.writable
const ServerComponentWrapper = (props: any) => {
const id = (React as any).useId()
const reqStream: ReadableStream<Uint8Array> = renderToReadableStream(
<ComponentToRender {...props} />,
serverComponentManifest
)
const response = useFlightResponse(
writable,
cachePrefix + ',' + id,
reqStream,
true
)
const root = response.readRoot()
rscCache.delete(id)
return root
}
return ServerComponentWrapper
}
export async function renderToHTML(
req: IncomingMessage,
res: ServerResponse,
pathname: string,
query: NextParsedUrlQuery,
renderOpts: RenderOpts
): Promise<RenderResult | null> {
// don't modify original query object
query = Object.assign({}, query)
const {
buildManifest,
serverComponentManifest,
supportsDynamicHTML,
runtime,
ComponentMod,
} = renderOpts
const hasConcurrentFeatures = !!runtime
const pageIsDynamic = isDynamicRoute(pathname)
const components = Object.keys(ComponentMod.components)
.sort()
.map((key) => {
const mod = ComponentMod.components[key]()
mod.Component = mod.default || mod
return mod
})
// Reads of this are cached on the `req` object, so this should resolve
// instantly. There's no need to pass this data down from a previous
// invoke, where we'd have to consider server & serverless.
const previewData = tryGetPreviewData(
req,
res,
(renderOpts as any).previewProps
)
const isPreview = previewData !== false
let WrappedComponent: any
let RootLayout: any
const dataCache = new Map<string, Record>()
for (let i = components.length - 1; i >= 0; i--) {
const dataCacheKey = i.toString()
const layout = components[i]
if (i === 0) {
// top-most layout is the root layout that renders
// the html/body tags
RootLayout = layout.Component
continue
}
let fetcher: any
// TODO: pass a shared cache from previous getStaticProps/
// getServerSideProps calls?
if (layout.getServerSideProps) {
fetcher = () =>
Promise.resolve(
layout.getServerSideProps!({
req: req as any,
res: res,
query,
resolvedUrl: (renderOpts as any).resolvedUrl as string,
...(pageIsDynamic
? { params: (renderOpts as any).params as ParsedUrlQuery }
: undefined),
...(isPreview
? { preview: true, previewData: previewData }
: undefined),
locales: (renderOpts as any).locales,
locale: (renderOpts as any).locale,
defaultLocale: (renderOpts as any).defaultLocale,
})
)
}
// TODO: implement layout specific caching for getStaticProps
if (layout.getStaticProps) {
fetcher = () =>
Promise.resolve(
layout.getStaticProps!({
...(pageIsDynamic
? { params: query as ParsedUrlQuery }
: undefined),
...(isPreview
? { preview: true, previewData: previewData }
: undefined),
locales: (renderOpts as any).locales,
locale: (renderOpts as any).locale,
defaultLocale: (renderOpts as any).defaultLocale,
})
)
}
if (fetcher) {
// Kick off data fetching before rendering, this ensures there is no waterfall for layouts as
// all data fetching required to render the page is kicked off simultaneously
preloadDataFetchingRecord(dataCache, dataCacheKey, fetcher)
}
// eslint-disable-next-line no-loop-func
const lastComponent = WrappedComponent
WrappedComponent = () => {
let props: any
if (fetcher) {
// The data fetching was kicked off before rendering (see above)
// if the data was not resolved yet the layout rendering will be suspended
const record = preloadDataFetchingRecord(
dataCache,
dataCacheKey,
fetcher
)
// Result of calling getStaticProps or getServerSideProps. If promise is not resolve yet it will suspend.
const recordValue = readRecordValue(record)
props = recordValue.props
}
return React.createElement(
layout.Component,
props,
React.createElement(lastComponent || React.Fragment, {}, null)
)
}
// TODO: loading state
// const AfterWrap = WrappedComponent
// WrappedComponent = () => {
// return (
// <Suspense fallback={<>Loading...</>}>
// <AfterWrap />
// </Suspense>
// )
// }
}
if (!RootLayout) {
// TODO: fallback to our own root layout?
// throw new Error('invariant RootLayout not loaded')
RootLayout = DefaultRootLayout
}
const headChildren = buildManifest.rootMainFiles.map((src) => (
<script src={'/_next/' + src} async key={src} />
))
let serverComponentsInlinedTransformStream: TransformStream<
Uint8Array,
Uint8Array
> | null = null
serverComponentsInlinedTransformStream = new TransformStream()
const search = stringifyQuery(query)
const Component = createServerComponentRenderer(RootLayout, ComponentMod, {
cachePrefix: pathname + (search ? `?${search}` : ''),
transformStream: serverComponentsInlinedTransformStream,
serverComponentManifest,
})
// const serverComponentProps = query.__props__
// ? JSON.parse(query.__props__ as string)
// : undefined
const jsxStyleRegistry = createStyleRegistry()
const styledJsxFlushEffect = () => {
const styles = jsxStyleRegistry.styles()
jsxStyleRegistry.flush()
return <>{styles}</>
}
let flushEffects: Array<() => React.ReactNode> | null = null
function FlushEffectContainer({ children }: { children: JSX.Element }) {
// If the client tree suspends, this component will be rendered multiple
// times before we flush. To ensure we don't call old callbacks corresponding
// to a previous render, we clear any registered callbacks whenever we render.
flushEffects = null
const flushEffectsImpl = React.useCallback(
(callbacks: Array<() => React.ReactNode>) => {
if (flushEffects) {
throw new Error(
'The `useFlushEffects` hook cannot be used more than once.' +
'\nRead more: https://nextjs.org/docs/messages/multiple-flush-effects'
)
}
flushEffects = callbacks
},
[]
)
return (
<FlushEffectsContext.Provider value={flushEffectsImpl}>
{children}
</FlushEffectsContext.Provider>
)
}
const AppContainer = ({ children }: { children: JSX.Element }) => (
<FlushEffectContainer>
<StyleRegistry registry={jsxStyleRegistry}>{children}</StyleRegistry>
</FlushEffectContainer>
)
const renderServerComponentData = query.__flight__ !== undefined
if (renderServerComponentData) {
return new RenderResult(
renderToReadableStream(
<RootLayout
headChildren={headChildren}
bodyChildren={<WrappedComponent />}
/>,
serverComponentManifest
).pipeThrough(createBufferedTransformStream())
)
}
/**
* Rules of Static & Dynamic HTML:
*
* 1.) We must generate static HTML unless the caller explicitly opts
* in to dynamic HTML support.
*
* 2.) If dynamic HTML support is requested, we must honor that request
* or throw an error. It is the sole responsibility of the caller to
* ensure they aren't e.g. requesting dynamic HTML for an AMP page.
*
* These rules help ensure that other existing features like request caching,
* coalescing, and ISR continue working as intended.
*/
const generateStaticHTML = supportsDynamicHTML !== true
const bodyResult = async () => {
const content = (
<AppContainer>
<Component
headChildren={headChildren}
bodyChildren={<WrappedComponent />}
/>
</AppContainer>
)
const renderStream = await renderToInitialStream({
ReactDOMServer,
element: content,
})
const flushEffectHandler = (): string => {
const allFlushEffects = [styledJsxFlushEffect, ...(flushEffects || [])]
const flushed = ReactDOMServer.renderToString(
<>
{allFlushEffects.map((flushEffect, i) => (
<React.Fragment key={i}>{flushEffect()}</React.Fragment>
))}
</>
)
return flushed
}
// Handle static data for server components.
// async function generateStaticFlightDataIfNeeded() {
// if (serverComponentsPageDataTransformStream) {
// // If it's a server component with the Node.js runtime, we also
// // statically generate the page data.
// let data = ''
// const readable = serverComponentsPageDataTransformStream.readable
// const reader = readable.getReader()
// const textDecoder = new TextDecoder()
// while (true) {
// const { done, value } = await reader.read()
// if (done) {
// break
// }
// data += decodeText(value, textDecoder)
// }
// ;(renderOpts as any).pageData = {
// ...(renderOpts as any).pageData,
// __flight__: data,
// }
// return data
// }
// }
// @TODO: A potential improvement would be to reuse the inlined
// data stream, or pass a callback inside as this doesn't need to
// be streamed.
// Do not use `await` here.
// generateStaticFlightDataIfNeeded()
return await continueFromInitialStream({
renderStream,
suffix: '',
dataStream: serverComponentsInlinedTransformStream?.readable,
generateStaticHTML: generateStaticHTML || !hasConcurrentFeatures,
flushEffectHandler,
})
}
return new RenderResult(await bodyResult())
}