Unverified Commit 60ad1dee authored by Jiachi Liu's avatar Jiachi Liu Committed by GitHub

Make router able to navigate between rsc pages (#35344)

### Bugfix
Made some changes for the data register buffer flushing in #34631 and #34475 that tried to delete the buffer or flush them only once. But turns out it will break the navigation between RSC pages.


### Enhancements
Simplify the inline response writer and inline response data for the initial render. Since they're only for the initial render, navigations will leverage the serialized data fetched from router and construct the react tree.


## Bug

Fixes #35135

- [x] Related issues linked using `fixes #number`
- [x] Integration tests added
- [x] Errors have helpful link attached, see `contributing.md`
parent 33aa51ab
...@@ -678,51 +678,38 @@ if (process.env.__NEXT_RSC) { ...@@ -678,51 +678,38 @@ if (process.env.__NEXT_RSC) {
} = require('next/dist/compiled/react-server-dom-webpack') } = require('next/dist/compiled/react-server-dom-webpack')
const encoder = new TextEncoder() const encoder = new TextEncoder()
const serverDataBuffer = new Map<string, string[]>() let initialServerDataBuffer: string[] | undefined = undefined
const serverDataWriter = new Map<string, WritableStreamDefaultWriter>() let initialServerDataWriter: WritableStreamDefaultWriter | undefined =
const serverDataCacheKey = getCacheKey() undefined
function nextServerDataCallback(seg: [number, string, string]) { function nextServerDataCallback(seg: [number, string, string]) {
const key = serverDataCacheKey + ',' + seg[1]
if (seg[0] === 0) { if (seg[0] === 0) {
serverDataBuffer.set(key, []) initialServerDataBuffer = []
} else { } else {
const buffer = serverDataBuffer.get(key) if (!initialServerDataBuffer)
if (!buffer)
throw new Error('Unexpected server data: missing bootstrap script.') throw new Error('Unexpected server data: missing bootstrap script.')
const writer = serverDataWriter.get(key) if (initialServerDataWriter) {
if (writer) { initialServerDataWriter.write(encoder.encode(seg[2]))
writer.write(encoder.encode(seg[2]))
} else { } else {
buffer.push(seg[2]) initialServerDataBuffer.push(seg[2])
} }
} }
} }
function nextServerDataRegisterWriter( function nextServerDataRegisterWriter(writer: WritableStreamDefaultWriter) {
key: string, if (initialServerDataBuffer) {
writer: WritableStreamDefaultWriter initialServerDataBuffer.forEach((val) => {
) {
const buffer = serverDataBuffer.get(key)
if (buffer) {
buffer.forEach((val) => {
writer.write(encoder.encode(val)) writer.write(encoder.encode(val))
}) })
buffer.length = 0
// Clean buffer but not deleting the key to mark bootstrap as complete.
// Then `nextServerDataCallback` will be safely skipped in the future renders.
serverDataBuffer.set(key, [])
} }
serverDataWriter.set(key, writer) initialServerDataWriter = writer
} }
// When `DOMContentLoaded`, we can close all pending writers to finish hydration. // When `DOMContentLoaded`, we can close all pending writers to finish hydration.
document.addEventListener( document.addEventListener(
'DOMContentLoaded', 'DOMContentLoaded',
function () { function () {
serverDataWriter.forEach((writer) => { if (initialServerDataWriter && !initialServerDataWriter.closed) {
if (!writer.closed) { initialServerDataWriter.close()
writer.close() }
}
})
}, },
false false
) )
...@@ -748,27 +735,26 @@ if (process.env.__NEXT_RSC) { ...@@ -748,27 +735,26 @@ if (process.env.__NEXT_RSC) {
} }
function useServerResponse(cacheKey: string, serialized?: string) { function useServerResponse(cacheKey: string, serialized?: string) {
const id = (React as any).useId()
let response = rscCache.get(cacheKey) let response = rscCache.get(cacheKey)
if (response) return response if (response) return response
const bufferCacheKey = cacheKey + ',' + router.route + ',' + id if (initialServerDataBuffer) {
if (serverDataBuffer.has(bufferCacheKey)) {
const t = new TransformStream() const t = new TransformStream()
const writer = t.writable.getWriter() const writer = t.writable.getWriter()
response = createFromFetch(Promise.resolve({ body: t.readable })) response = createFromFetch(Promise.resolve({ body: t.readable }))
nextServerDataRegisterWriter(bufferCacheKey, writer) nextServerDataRegisterWriter(writer)
} else { } else {
response = createFromFetch( const fetchPromise = serialized
serialized ? (() => {
? (() => { const t = new TransformStream()
const t = new TransformStream() const writer = t.writable.getWriter()
t.writable.getWriter().write(new TextEncoder().encode(serialized)) writer.ready.then(() => {
return Promise.resolve({ body: t.readable }) writer.write(new TextEncoder().encode(serialized))
})() })
: fetchFlight(getCacheKey()) return Promise.resolve({ body: t.readable })
) })()
: fetchFlight(getCacheKey())
response = createFromFetch(fetchPromise)
} }
rscCache.set(cacheKey, response) rscCache.set(cacheKey, response)
...@@ -778,15 +764,16 @@ if (process.env.__NEXT_RSC) { ...@@ -778,15 +764,16 @@ if (process.env.__NEXT_RSC) {
const ServerRoot = ({ const ServerRoot = ({
cacheKey, cacheKey,
serialized, serialized,
_fresh,
}: { }: {
cacheKey: string cacheKey: string
serialized?: string serialized?: string
_fresh?: boolean
}) => { }) => {
React.useEffect(() => { React.useEffect(() => {
rscCache.delete(cacheKey) rscCache.delete(cacheKey)
}) })
React.useEffect(() => {
initialServerDataBuffer = undefined
}, [])
const response = useServerResponse(cacheKey, serialized) const response = useServerResponse(cacheKey, serialized)
const root = response.readRoot() const root = response.readRoot()
return root return root
...@@ -794,10 +781,10 @@ if (process.env.__NEXT_RSC) { ...@@ -794,10 +781,10 @@ if (process.env.__NEXT_RSC) {
RSCComponent = (props: any) => { RSCComponent = (props: any) => {
const cacheKey = getCacheKey() const cacheKey = getCacheKey()
const { __flight_serialized__, __flight_fresh__ } = props const { __flight_serialized__ } = props
const [, dispatch] = useState({}) const [, dispatch] = useState({})
const startTransition = (React as any).startTransition const startTransition = (React as any).startTransition
const renrender = () => dispatch({}) const rerender = () => dispatch({})
// If there is no cache, or there is serialized data already // If there is no cache, or there is serialized data already
function refreshCache(nextProps: any) { function refreshCache(nextProps: any) {
startTransition(() => { startTransition(() => {
...@@ -807,17 +794,13 @@ if (process.env.__NEXT_RSC) { ...@@ -807,17 +794,13 @@ if (process.env.__NEXT_RSC) {
) )
rscCache.set(currentCacheKey, response) rscCache.set(currentCacheKey, response)
renrender() rerender()
}) })
} }
return ( return (
<RefreshContext.Provider value={refreshCache}> <RefreshContext.Provider value={refreshCache}>
<ServerRoot <ServerRoot cacheKey={cacheKey} serialized={__flight_serialized__} />
cacheKey={cacheKey}
serialized={__flight_serialized__}
_fresh={__flight_fresh__}
/>
</RefreshContext.Provider> </RefreshContext.Provider>
) )
} }
......
import Link from 'next/link'
export default function Nav() {
return (
<>
<div>
<Link href={'/next-api/link'}>
<a id="goto-next-link">next link</a>
</Link>
</div>
<div>
<Link href={'/streaming-rsc'}>
<a id="goto-streaming-rsc">streaming rsc</a>
</Link>
</div>
<div>
<Link href={'/'}>
<a id="goto-home">home</a>
</Link>
</div>
</>
)
}
import Foo from '../components/foo.client' import Foo from '../components/foo.client'
import Link from 'next/link' import Nav from '../components/nav.server'
const envVar = process.env.ENV_VAR_TEST const envVar = process.env.ENV_VAR_TEST
const headerKey = 'x-next-test-client' const headerKey = 'x-next-test-client'
...@@ -14,9 +14,7 @@ export default function Index({ header, router }) { ...@@ -14,9 +14,7 @@ export default function Index({ header, router }) {
<div> <div>
<Foo /> <Foo />
</div> </div>
<Link href={'/'}> <Nav />
<a id="refresh">refresh</a>
</Link>
</div> </div>
) )
} }
......
import Link from 'next/link' import Link from 'next/link'
import Nav from '../../components/nav.server'
export default function LinkPage({ router }) { export default function LinkPage({ router }) {
const { query } = router const { query } = router
...@@ -6,12 +7,12 @@ export default function LinkPage({ router }) { ...@@ -6,12 +7,12 @@ export default function LinkPage({ router }) {
return ( return (
<> <>
<h3 id="query">query:{id}</h3> <h3 id="query">query:{id}</h3>
<Link href={`/next-api/link?id=${id + 1}`}> <div>
<a id="next_id">next id</a> <Link href={`/next-api/link?id=${id + 1}`}>
</Link> <a id="next_id">next id</a>
<Link href={`/`}> </Link>
<a>go home</a> </div>
</Link> <Nav />
</> </>
) )
} }
......
import { Suspense } from 'react' import { Suspense } from 'react'
import Nav from '../components/nav.server'
let result let result
let promise let promise
...@@ -16,9 +17,16 @@ function Data() { ...@@ -16,9 +17,16 @@ function Data() {
export default function Page() { export default function Page() {
return ( return (
<Suspense fallback="next_streaming_fallback"> <div>
<Data /> <div id="content">
</Suspense> <Suspense fallback="next_streaming_fallback">
<Data />
</Suspense>
</div>
<div>
<Nav />
</div>
</div>
) )
} }
......
...@@ -70,9 +70,12 @@ export default function (context, { runtime, env }) { ...@@ -70,9 +70,12 @@ export default function (context, { runtime, env }) {
it('should support next/link in server components', async () => { it('should support next/link in server components', async () => {
const linkHTML = await renderViaHTTP(context.appPort, '/next-api/link') const linkHTML = await renderViaHTTP(context.appPort, '/next-api/link')
const linkText = getNodeBySelector(linkHTML, '#__next > a[href="/"]').text() const linkText = getNodeBySelector(
linkHTML,
'#__next > div > a[href="/"]'
).text()
expect(linkText).toContain('go home') expect(linkText).toContain('home')
const browser = await webdriver(context.appPort, '/next-api/link') const browser = await webdriver(context.appPort, '/next-api/link')
...@@ -92,9 +95,36 @@ export default function (context, { runtime, env }) { ...@@ -92,9 +95,36 @@ export default function (context, { runtime, env }) {
expect(await browser.eval('window.beforeNav')).toBe(1) expect(await browser.eval('window.beforeNav')).toBe(1)
}) })
it('should be able to navigate between rsc pages', async () => {
let content
const browser = await webdriver(context.appPort, '/')
await browser.waitForElementByCss('#goto-next-link').click()
await new Promise((res) => setTimeout(res, 1000))
expect(await browser.url()).toBe(
`http://localhost:${context.appPort}/next-api/link`
)
await browser.waitForElementByCss('#goto-home').click()
await new Promise((res) => setTimeout(res, 1000))
expect(await browser.url()).toBe(`http://localhost:${context.appPort}/`)
content = await browser.elementByCss('#__next').text()
expect(content).toContain('component:index.server')
await browser.waitForElementByCss('#goto-streaming-rsc').click()
await new Promise((res) => setTimeout(res, 1500))
expect(await browser.url()).toBe(
`http://localhost:${context.appPort}/streaming-rsc`
)
content = await browser.elementByCss('#content').text()
expect(content).toContain('next_streaming_data')
})
it('should handle streaming server components correctly', async () => { it('should handle streaming server components correctly', async () => {
const browser = await webdriver(context.appPort, '/streaming-rsc') const browser = await webdriver(context.appPort, '/streaming-rsc')
const content = await browser.eval(`window.document.body.innerText`) const content = await browser.eval(
`document.querySelector('#content').innerText`
)
expect(content).toMatchInlineSnapshot('"next_streaming_data"') expect(content).toMatchInlineSnapshot('"next_streaming_data"')
}) })
...@@ -113,7 +143,7 @@ export default function (context, { runtime, env }) { ...@@ -113,7 +143,7 @@ export default function (context, { runtime, env }) {
it('should refresh correctly with next/link', async () => { it('should refresh correctly with next/link', async () => {
// Select the button which is not hidden but rendered // Select the button which is not hidden but rendered
const selector = '#__next #refresh' const selector = '#__next #goto-next-link'
let hasFlightRequest = false let hasFlightRequest = false
const browser = await webdriver(context.appPort, '/', { const browser = await webdriver(context.appPort, '/', {
beforePageLoad(page) { beforePageLoad(page) {
...@@ -138,7 +168,7 @@ export default function (context, { runtime, env }) { ...@@ -138,7 +168,7 @@ export default function (context, { runtime, env }) {
expect(hasFlightRequest).toBe(true) expect(hasFlightRequest).toBe(true)
} }
const refreshText = await browser.elementByCss(selector).text() const refreshText = await browser.elementByCss(selector).text()
expect(refreshText).toBe('refresh') expect(refreshText).toBe('next link')
}) })
if (env === 'dev') { if (env === 'dev') {
......
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