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

Fix useId mismatches on hydration #31102

Merged
merged 2 commits into from Nov 8, 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
43 changes: 39 additions & 4 deletions packages/next/server/render.tsx
Expand Up @@ -513,9 +513,9 @@ export async function renderToHTML(
defaultLocale: renderOpts.defaultLocale,
AppTree: (props: any) => {
return (
<AppContainer>
<AppContainerWithIsomorphicFiberStructure>
<App {...props} Component={Component} router={router} />
</AppContainer>
</AppContainerWithIsomorphicFiberStructure>
)
},
defaultGetInitialProps: async (
Expand Down Expand Up @@ -576,6 +576,41 @@ export async function renderToHTML(
</RouterContext.Provider>
)

// The `useId` API uses the path indexes to generate an ID for each node.
// To guarantee the match of hydration, we need to ensure that the structure
// of wrapper nodes is isomorphic in server and client.
// TODO: With `enhanceApp` and `enhanceComponents` options, this approach may
// not be useful.
// https://github.com/facebook/react/pull/22644
const Noop = () => null
const AppContainerWithIsomorphicFiberStructure = ({
children,
}: {
children: JSX.Element
}) => {
return (
<>
{/* <Head/> */}
<Noop />
<AppContainer>
<>
{/* <ReactDevOverlay/> */}
{dev ? (
<>
{children}
<Noop />
</>
) : (
children
)}
{/* <RouteAnnouncer/> */}
<Noop />
</>
</AppContainer>
</>
)
}

props = await loadGetInitialProps(App, {
AppTree: ctx.AppTree,
Component,
Expand Down Expand Up @@ -940,11 +975,11 @@ export async function renderToHTML(
// opaque component. Wrappers should use context instead.
const InnerApp = () => app
return (
<AppContainer>
<AppContainerWithIsomorphicFiberStructure>
{appWrappers.reduce((innerContent, fn) => {
return fn(innerContent)
}, <InnerApp />)}
</AppContainer>
</AppContainerWithIsomorphicFiberStructure>
)
}

Expand Down
5 changes: 5 additions & 0 deletions test/integration/react-18/app/pages/use-id.js
@@ -0,0 +1,5 @@
import { useId } from 'react'

export default function Page() {
return <div id="id">{useId()}</div>
}
11 changes: 11 additions & 0 deletions test/integration/react-18/test/basics.js
Expand Up @@ -28,4 +28,15 @@ export default (context) => {
expect(content).toBe('rab')
expect(nextData.dynamicIds).toBeUndefined()
})

it('useId() values should match on hydration', async () => {
const html = await renderViaHTTP(context.appPort, '/use-id')
const $ = cheerio.load(html)
const ssrId = $('#id').text()

const browser = await webdriver(context.appPort, '/use-id')
const csrId = await browser.eval('document.getElementById("id").innerText')

expect(ssrId).toEqual(csrId)
})
shuding marked this conversation as resolved.
Show resolved Hide resolved
}