Unverified Commit b251e552 authored by Jiachi Liu's avatar Jiachi Liu Committed by GitHub

Handle dev fouc for layout styling (#38557)

* Handle dev fouc for layout styling

* refactor

* fix renderOpts.dev

* dedupe css loading

* keep css module id in dev
parent 70a53e07
...@@ -75,6 +75,7 @@ const getCacheKey = () => { ...@@ -75,6 +75,7 @@ const getCacheKey = () => {
} }
const encoder = new TextEncoder() const encoder = new TextEncoder()
const loadedCss: Set<string> = new Set()
let initialServerDataBuffer: string[] | undefined = undefined let initialServerDataBuffer: string[] | undefined = undefined
let initialServerDataWriter: ReadableStreamDefaultController | undefined = let initialServerDataWriter: ReadableStreamDefaultController | undefined =
...@@ -146,17 +147,7 @@ function createResponseCache() { ...@@ -146,17 +147,7 @@ function createResponseCache() {
} }
const rscCache = createResponseCache() const rscCache = createResponseCache()
function useInitialServerResponse(cacheKey: string) { async function loadCss(cssChunkInfoJson: string) {
const response = rscCache.get(cacheKey)
if (response) return response
const readable = new ReadableStream({
start(controller) {
nextServerDataRegisterWriter(controller)
},
})
async function loadCss(cssChunkInfoJson: string) {
const data = JSON.parse(cssChunkInfoJson) const data = JSON.parse(cssChunkInfoJson)
await Promise.all( await Promise.all(
data.chunks.map((chunkId: string) => { data.chunks.map((chunkId: string) => {
...@@ -167,13 +158,21 @@ function useInitialServerResponse(cacheKey: string) { ...@@ -167,13 +158,21 @@ function useInitialServerResponse(cacheKey: string) {
// In development mode, import css in dev when it's wrapped by style loader. // In development mode, import css in dev when it's wrapped by style loader.
// In production mode, css are standalone chunk that doesn't need to be imported. // In production mode, css are standalone chunk that doesn't need to be imported.
if (data.id) { if (data.id) {
;(self as any).__next_require__(data.id) return (self as any).__next_require__(data.id)
}
} }
return Promise.resolve()
}
function createLoadFlightCssStream(callback?: () => Promise<void>) {
const cssLoadingPromises: Promise<any>[] = []
const loadCssFromStreamData = (data: string) => { const loadCssFromStreamData = (data: string) => {
if (data.startsWith('CSS:')) { if (data.startsWith('CSS')) {
loadCss(data.slice(4).trim()) const cssJson = data.slice(4).trim()
if (!loadedCss.has(cssJson)) {
loadedCss.add(cssJson)
cssLoadingPromises.push(loadCss(cssJson))
}
} }
} }
...@@ -181,41 +180,70 @@ function useInitialServerResponse(cacheKey: string) { ...@@ -181,41 +180,70 @@ function useInitialServerResponse(cacheKey: string) {
let buffer = '' let buffer = ''
const loadCssFromFlight = new TransformStream({ const loadCssFromFlight = new TransformStream({
transform(chunk, controller) { transform(chunk, controller) {
const process = (buf: string) => {
if (buf) {
if (buf.startsWith('CSS:')) {
loadCssFromStreamData(buf)
} else {
controller.enqueue(new TextEncoder().encode(buf))
}
}
}
const data = new TextDecoder().decode(chunk) const data = new TextDecoder().decode(chunk)
buffer += data buffer += data
let index let index
while ((index = buffer.indexOf('\n')) !== -1) { while ((index = buffer.indexOf('\n')) !== -1) {
const line = buffer.slice(0, index + 1) const line = buffer.slice(0, index + 1)
buffer = buffer.slice(index + 1) buffer = buffer.slice(index + 1)
if (line.startsWith('CSS:')) { process(line)
loadCssFromStreamData(line)
} else {
controller.enqueue(new TextEncoder().encode(line))
}
} }
if (buffer && !buffer.startsWith('CSS:')) { process(buffer)
controller.enqueue(new TextEncoder().encode(buffer))
buffer = '' buffer = ''
}
}, },
flush() { })
loadCssFromStreamData(buffer)
if (process.env.NODE_ENV === 'development') {
Promise.all(cssLoadingPromises).then(() => {
// TODO: find better timing for css injection
setTimeout(() => {
callback?.()
})
})
}
return loadCssFromFlight
}
function useInitialServerResponse(cacheKey: string, onFlightCssLoaded: any) {
const response = rscCache.get(cacheKey)
if (response) return response
const readable = new ReadableStream({
start(controller) {
nextServerDataRegisterWriter(controller)
}, },
}) })
const newResponse = createFromReadableStream( const newResponse = createFromReadableStream(
readable.pipeThrough(loadCssFromFlight) readable.pipeThrough(createLoadFlightCssStream(onFlightCssLoaded))
) )
rscCache.set(cacheKey, newResponse) rscCache.set(cacheKey, newResponse)
return newResponse return newResponse
} }
function ServerRoot({ cacheKey }: { cacheKey: string }) { function ServerRoot({
cacheKey,
onFlightCssLoaded,
}: {
cacheKey: string
onFlightCssLoaded: any
}) {
React.useEffect(() => { React.useEffect(() => {
rscCache.delete(cacheKey) rscCache.delete(cacheKey)
}) })
const response = useInitialServerResponse(cacheKey) const response = useInitialServerResponse(cacheKey, onFlightCssLoaded)
const root = response.readRoot() const root = response.readRoot()
return root return root
} }
...@@ -235,16 +263,16 @@ function Root({ children }: React.PropsWithChildren<{}>): React.ReactElement { ...@@ -235,16 +263,16 @@ function Root({ children }: React.PropsWithChildren<{}>): React.ReactElement {
return children as React.ReactElement return children as React.ReactElement
} }
function RSCComponent() { function RSCComponent(props: any) {
const cacheKey = getCacheKey() const cacheKey = getCacheKey()
return <ServerRoot cacheKey={cacheKey} /> return <ServerRoot {...props} cacheKey={cacheKey} />
} }
export function hydrate() { export function hydrate(opts?: { onFlightCssLoaded?: () => Promise<void> }) {
renderReactElement(appElement!, () => ( renderReactElement(appElement!, () => (
<React.StrictMode> <React.StrictMode>
<Root> <Root>
<RSCComponent /> <RSCComponent onFlightCssLoaded={opts?.onFlightCssLoaded} />
</Root> </Root>
</React.StrictMode> </React.StrictMode>
)) ))
......
import { hydrate, version } from './app-index' import { hydrate, version } from './app-index'
import { displayContent } from './dev/fouc'
// TODO-APP: implement FOUC guard // TODO-APP: implement FOUC guard
...@@ -9,6 +10,6 @@ window.next = { ...@@ -9,6 +10,6 @@ window.next = {
appDir: true, appDir: true,
} }
hydrate() hydrate({ onFlightCssLoaded: displayContent })
// TODO-APP: build indicator // TODO-APP: build indicator
...@@ -49,26 +49,26 @@ function fetchFlight(url: URL, flightRouterStateData: string): ReadableStream { ...@@ -49,26 +49,26 @@ function fetchFlight(url: URL, flightRouterStateData: string): ReadableStream {
let buffer = '' let buffer = ''
const loadCssFromFlight = new TransformStream({ const loadCssFromFlight = new TransformStream({
transform(chunk, controller) { transform(chunk, controller) {
const process = (buf: string) => {
if (buf) {
if (buf.startsWith('CSS:')) {
loadCssFromStreamData(buf)
} else {
controller.enqueue(new TextEncoder().encode(buf))
}
}
}
const data = new TextDecoder().decode(chunk) const data = new TextDecoder().decode(chunk)
buffer += data buffer += data
let index let index
while ((index = buffer.indexOf('\n')) !== -1) { while ((index = buffer.indexOf('\n')) !== -1) {
const line = buffer.slice(0, index + 1) const line = buffer.slice(0, index + 1)
buffer = buffer.slice(index + 1) buffer = buffer.slice(index + 1)
process(line)
if (line.startsWith('CSS:')) {
loadCssFromStreamData(line)
} else {
controller.enqueue(new TextEncoder().encode(line))
}
} }
if (buffer && !buffer.startsWith('CSS:')) { process(buffer)
controller.enqueue(new TextEncoder().encode(buffer))
buffer = '' buffer = ''
}
},
flush() {
loadCssFromStreamData(buffer)
}, },
}) })
......
...@@ -148,13 +148,11 @@ function useFlightResponse( ...@@ -148,13 +148,11 @@ function useFlightResponse(
writer.close() writer.close()
} else { } else {
const responsePartial = decodeText(value) const responsePartial = decodeText(value)
writer.write( const scripts = `<script>(self.__next_s=self.__next_s||[]).push(${htmlEscapeJsonString(
encodeText(
`<script>(self.__next_s=self.__next_s||[]).push(${htmlEscapeJsonString(
JSON.stringify([1, id, responsePartial]) JSON.stringify([1, id, responsePartial])
)})</script>` )})</script>`
)
) writer.write(encodeText(scripts))
process() process()
} }
}) })
...@@ -178,7 +176,8 @@ function createServerComponentRenderer( ...@@ -178,7 +176,8 @@ function createServerComponentRenderer(
transformStream: TransformStream<Uint8Array, Uint8Array> transformStream: TransformStream<Uint8Array, Uint8Array>
serverComponentManifest: NonNullable<RenderOpts['serverComponentManifest']> serverComponentManifest: NonNullable<RenderOpts['serverComponentManifest']>
serverContexts: Array<[ServerContextName: string, JSONValue: any]> serverContexts: Array<[ServerContextName: string, JSONValue: any]>
} },
dev: boolean
) { ) {
// We need to expose the `__webpack_require__` API globally for // We need to expose the `__webpack_require__` API globally for
// react-server-dom-webpack. This is a hack until we find a better way. // react-server-dom-webpack. This is a hack until we find a better way.
...@@ -192,7 +191,11 @@ function createServerComponentRenderer( ...@@ -192,7 +191,11 @@ function createServerComponentRenderer(
globalThis.__next_chunk_load__ = () => Promise.resolve() globalThis.__next_chunk_load__ = () => Promise.resolve()
} }
const cssFlightData = getCssFlightData(ComponentMod, serverComponentManifest) const cssFlightData = getCssFlightData(
ComponentMod,
serverComponentManifest,
dev
)
let RSCStream: ReadableStream<Uint8Array> let RSCStream: ReadableStream<Uint8Array>
const createRSCStream = () => { const createRSCStream = () => {
...@@ -326,8 +329,11 @@ function getSegmentParam(segment: string): { ...@@ -326,8 +329,11 @@ function getSegmentParam(segment: string): {
function getCSSInlinedLinkTags( function getCSSInlinedLinkTags(
ComponentMod: any, ComponentMod: any,
serverComponentManifest: any serverComponentManifest: any,
dev: boolean
) { ) {
if (dev) return []
const importedServerCSSFiles: string[] = const importedServerCSSFiles: string[] =
ComponentMod.__client__?.__next_rsc_css__ || [] ComponentMod.__client__?.__next_rsc_css__ || []
...@@ -344,25 +350,31 @@ function getCSSInlinedLinkTags( ...@@ -344,25 +350,31 @@ function getCSSInlinedLinkTags(
) )
} }
function getCssFlightData(ComponentMod: any, serverComponentManifest: any) { function getCssFlightData(
ComponentMod: any,
serverComponentManifest: any,
dev: boolean
) {
const importedServerCSSFiles: string[] = const importedServerCSSFiles: string[] =
ComponentMod.__client__?.__next_rsc_css__ || [] ComponentMod.__client__?.__next_rsc_css__ || []
const cssFiles = importedServerCSSFiles.map( const cssFiles = importedServerCSSFiles.map(
(css) => serverComponentManifest[css].default (css) => serverComponentManifest[css].default
) )
if (process.env.NODE_ENV === 'development') {
if (dev) {
// Keep `id` in dev mode css flight to require the css module
return cssFiles.map((css) => `CSS:${JSON.stringify(css)}`).join('\n') + '\n' return cssFiles.map((css) => `CSS:${JSON.stringify(css)}`).join('\n') + '\n'
} }
// Multiple css chunks could be merged into one by mini-css-extract-plugin, // Multiple css chunks could be merged into one by mini-css-extract-plugin,
// we use a set here to dedupe the css chunks in production. // we use a set here to dedupe the css chunks in production.
const cssSet = cssFiles.reduce((res, css) => { const cssSet: Set<string> = cssFiles.reduce((res, css) => {
res.add(...css.chunks) res.add(...css.chunks)
return res return res
}, new Set()) }, new Set())
return `CSS:${JSON.stringify({ chunks: [...cssSet] })}\n` return cssSet.size ? `CSS:${JSON.stringify({ chunks: [...cssSet] })}\n` : ''
} }
export async function renderToHTML( export async function renderToHTML(
...@@ -383,6 +395,7 @@ export async function renderToHTML( ...@@ -383,6 +395,7 @@ export async function renderToHTML(
runtime, runtime,
ComponentMod, ComponentMod,
} = renderOpts } = renderOpts
const dev = !!renderOpts.dev
const isFlight = query.__flight__ !== undefined const isFlight = query.__flight__ !== undefined
...@@ -781,7 +794,8 @@ export async function renderToHTML( ...@@ -781,7 +794,8 @@ export async function renderToHTML(
const cssFlightData = getCssFlightData( const cssFlightData = getCssFlightData(
ComponentMod, ComponentMod,
serverComponentManifest serverComponentManifest,
dev
) )
const flightData: FlightData = [ const flightData: FlightData = [
// TODO-APP: change walk to output without '' // TODO-APP: change walk to output without ''
...@@ -807,9 +821,10 @@ export async function renderToHTML( ...@@ -807,9 +821,10 @@ export async function renderToHTML(
// /blog/[slug] /blog/hello-world -> ['children', 'blog', 'children', ['slug', 'hello-world']] // /blog/[slug] /blog/hello-world -> ['children', 'blog', 'children', ['slug', 'hello-world']]
const initialTree = createFlightRouterStateFromLoaderTree(tree) const initialTree = createFlightRouterStateFromLoaderTree(tree)
const initialStylesheets = getCSSInlinedLinkTags( const initialStylesheets: string[] = getCSSInlinedLinkTags(
ComponentMod, ComponentMod,
serverComponentManifest serverComponentManifest,
dev
) )
const { Component: ComponentTree } = createComponentTree({ const { Component: ComponentTree } = createComponentTree({
...@@ -866,7 +881,8 @@ export async function renderToHTML( ...@@ -866,7 +881,8 @@ export async function renderToHTML(
transformStream: serverComponentsInlinedTransformStream, transformStream: serverComponentsInlinedTransformStream,
serverComponentManifest, serverComponentManifest,
serverContexts, serverContexts,
} },
dev
) )
const jsxStyleRegistry = createStyleRegistry() const jsxStyleRegistry = createStyleRegistry()
...@@ -916,6 +932,7 @@ export async function renderToHTML( ...@@ -916,6 +932,7 @@ export async function renderToHTML(
} }
return await continueFromInitialStream(renderStream, { return await continueFromInitialStream(renderStream, {
dev,
dataStream: serverComponentsInlinedTransformStream?.readable, dataStream: serverComponentsInlinedTransformStream?.readable,
generateStaticHTML: generateStaticHTML || !hasConcurrentFeatures, generateStaticHTML: generateStaticHTML || !hasConcurrentFeatures,
flushEffectHandler, flushEffectHandler,
......
...@@ -136,6 +136,33 @@ export function createFlushEffectStream( ...@@ -136,6 +136,33 @@ export function createFlushEffectStream(
}) })
} }
export function createDevScriptTransformStream(): TransformStream<
Uint8Array,
Uint8Array
> {
let injected = false
const foucTags = `<style data-next-hide-fouc>body{display:none}</style>
<noscript data-next-hide-fouc>
<style>body{display:block}</style>
</noscript>`
return new TransformStream({
transform(chunk, controller) {
const content = decodeText(chunk)
let index
if (!injected && (index = content.indexOf('</head')) !== -1) {
injected = true
// head content + fouc tags + </head
const injectedContent =
content.slice(0, index) + foucTags + content.slice(index)
controller.enqueue(encodeText(injectedContent))
} else {
controller.enqueue(chunk)
}
},
})
}
export function renderToInitialStream({ export function renderToInitialStream({
ReactDOMServer, ReactDOMServer,
element, element,
...@@ -151,11 +178,13 @@ export function renderToInitialStream({ ...@@ -151,11 +178,13 @@ export function renderToInitialStream({
export async function continueFromInitialStream( export async function continueFromInitialStream(
renderStream: ReactReadableStream, renderStream: ReactReadableStream,
{ {
dev,
suffix, suffix,
dataStream, dataStream,
generateStaticHTML, generateStaticHTML,
flushEffectHandler, flushEffectHandler,
}: { }: {
dev?: boolean
suffix?: string suffix?: string
dataStream?: ReadableStream<Uint8Array> dataStream?: ReadableStream<Uint8Array>
generateStaticHTML: boolean generateStaticHTML: boolean
...@@ -172,9 +201,10 @@ export async function continueFromInitialStream( ...@@ -172,9 +201,10 @@ export async function continueFromInitialStream(
const transforms: Array<TransformStream<Uint8Array, Uint8Array>> = [ const transforms: Array<TransformStream<Uint8Array, Uint8Array>> = [
createBufferedTransformStream(), createBufferedTransformStream(),
flushEffectHandler ? createFlushEffectStream(flushEffectHandler) : null, flushEffectHandler ? createFlushEffectStream(flushEffectHandler) : null,
suffixUnclosed != null ? createDeferredPrefixStream(suffixUnclosed) : null, suffixUnclosed != null ? createDeferredSuffixStream(suffixUnclosed) : null,
dataStream ? createInlineDataStream(dataStream) : null, dataStream ? createInlineDataStream(dataStream) : null,
suffixUnclosed != null ? createSuffixStream(closeTag) : null, suffixUnclosed != null ? createSuffixStream(closeTag) : null,
dev ? createDevScriptTransformStream() : null,
].filter(nonNullable) ].filter(nonNullable)
return transforms.reduce( return transforms.reduce(
...@@ -198,44 +228,47 @@ export function createSuffixStream( ...@@ -198,44 +228,47 @@ export function createSuffixStream(
export function createPrefixStream( export function createPrefixStream(
prefix: string prefix: string
): TransformStream<Uint8Array, Uint8Array> { ): TransformStream<Uint8Array, Uint8Array> {
let prefixEnqueued = false let prefixFlushed = false
return new TransformStream({ return new TransformStream({
transform(chunk, controller) { transform(chunk, controller) {
if (!prefixEnqueued) { if (!prefixFlushed) {
controller.enqueue(encodeText(prefix)) controller.enqueue(encodeText(prefix))
prefixEnqueued = true prefixFlushed = true
} }
controller.enqueue(chunk) controller.enqueue(chunk)
}, },
}) })
} }
export function createDeferredPrefixStream( // Suffix after main body content - scripts before </body>,
prefix: string // but wait for the major chunks to be enqueued.
export function createDeferredSuffixStream(
suffix: string
): TransformStream<Uint8Array, Uint8Array> { ): TransformStream<Uint8Array, Uint8Array> {
let prefixFlushed = false let suffixFlushed = false
let prefixPrefixFlushFinished: Promise<void> | null = null let suffixFlushTask: Promise<void> | null = null
return new TransformStream({ return new TransformStream({
transform(chunk, controller) { transform(chunk, controller) {
controller.enqueue(chunk) controller.enqueue(chunk)
if (!prefixFlushed && prefix) { if (!suffixFlushed && suffix) {
prefixFlushed = true suffixFlushed = true
prefixPrefixFlushFinished = new Promise((res) => { suffixFlushTask = new Promise((res) => {
// NOTE: streaming flush // NOTE: streaming flush
// Enqueue prefix part before the major chunks are enqueued so that // Enqueue suffix part before the major chunks are enqueued so that
// prefix won't be flushed too early to interrupt the data stream // suffix won't be flushed too early to interrupt the data stream
setTimeout(() => { setTimeout(() => {
controller.enqueue(encodeText(prefix)) controller.enqueue(encodeText(suffix))
res() res()
}) })
}) })
} }
}, },
flush(controller) { flush(controller) {
if (prefixPrefixFlushFinished) return prefixPrefixFlushFinished if (suffixFlushTask) return suffixFlushTask
if (!prefixFlushed && prefix) { if (!suffixFlushed && suffix) {
prefixFlushed = true suffixFlushed = true
controller.enqueue(encodeText(prefix)) controller.enqueue(encodeText(suffix))
} }
}, },
}) })
......
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