Skip to content

Move Hydration Warnings from the DOM Config into the Fiber reconciliation #28476

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.

Sign up for GitHub

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

Merged
sebmarkbage merged 9 commits into from
Mar 26, 2024
Merged

Move Hydration Warnings from the DOM Config into the Fiber reconciliation #28476

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
57cc6c4
Move hydration warnings to the reconciler and use object form instead…
sebmarkbage Feb 27, 2024
02db063
Move instance warnings to Fiber
sebmarkbage Feb 29, 2024
897a7bf
dangerouslySetInnerHTML is an object
sebmarkbage Mar 1, 2024
220c2f9
Fix tests
sebmarkbage Mar 1, 2024
72fd9ff
Throw text mismatches during hydrateTextInstance
sebmarkbage Mar 4, 2024
d68de9a
Change props to be a object-as-a-map
sebmarkbage Mar 4, 2024
4a22791
Move text mismatch throwing to the hydration context too
sebmarkbage Mar 5, 2024
bd39393
Update inert
sebmarkbage Mar 26, 2024
21f7e9d
Fix rebased test
sebmarkbage Mar 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
368 changes: 222 additions & 146 deletions packages/react-dom-bindings/src/client/ReactDOMComponent.js
View file
Open in desktop

Large diffs are not rendered by default.

239 changes: 52 additions & 187 deletions packages/react-dom-bindings/src/client/ReactFiberConfigDOM.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,14 +52,12 @@ import {hasRole} from './DOMAccessibilityRoles';
import {
setInitialProperties,
updateProperties,
hydrateProperties,
hydrateText,
diffHydratedProperties,
getPropsFromElement,
diffHydratedText,
trapClickOnNonInteractiveElement,
checkForUnmatchedText,
warnForDeletedHydratableElement,
warnForDeletedHydratableText,
warnForInsertedHydratedElement,
warnForInsertedHydratedText,
} from './ReactDOMComponent';
import {getSelectionInformation, restoreSelection} from './ReactInputSelection';
import setTextContent from './setTextContent';
Expand Down Expand Up @@ -1342,6 +1340,26 @@ export function getFirstHydratableChildWithinSuspenseInstance(
return getNextHydratable(parentInstance.nextSibling);
}

export function describeHydratableInstanceForDevWarnings(
instance: HydratableInstance,
): string | {type: string, props: $ReadOnly<Props>} {
// Reverse engineer a pseudo react-element from hydratable instnace
if (instance.nodeType === ELEMENT_NODE) {
// Reverse engineer a set of props that can print for dev warnings
return {
type: instance.nodeName.toLowerCase(),
props: getPropsFromElement((instance: any)),
};
} else if (instance.nodeType === COMMENT_NODE) {
return {
type: 'Suspense',
props: {},
};
} else {
return instance.nodeValue;
}
}

export function validateHydratableInstance(
type: string,
props: Props,
Expand All @@ -1361,14 +1379,23 @@ export function hydrateInstance(
props: Props,
hostContext: HostContext,
internalInstanceHandle: Object,
shouldWarnDev: boolean,
): void {
): boolean {
precacheFiberNode(internalInstanceHandle, instance);
// TODO: Possibly defer this until the commit phase where all the events
// get attached.
updateFiberProps(instance, props);

diffHydratedProperties(instance, type, props, shouldWarnDev, hostContext);
return hydrateProperties(instance, type, props, hostContext);
}

// Returns a Map of properties that were different on the server.
export function diffHydratedPropsForDevWarnings(
instance: Instance,
type: string,
props: Props,
hostContext: HostContext,
): null | $ReadOnly<Props> {
return diffHydratedProperties(instance, type, props, hostContext);
}

export function validateHydratableTextInstance(
Expand All @@ -1389,11 +1416,26 @@ export function hydrateTextInstance(
textInstance: TextInstance,
text: string,
internalInstanceHandle: Object,
shouldWarnDev: boolean,
parentInstanceProps: null | Props,
): boolean {
precacheFiberNode(internalInstanceHandle, textInstance);

return diffHydratedText(textInstance, text);
return hydrateText(textInstance, text, parentInstanceProps);
}

// Returns the server text if it differs from the client.
export function diffHydratedTextForDevWarnings(
textInstance: TextInstance,
text: string,
parentProps: null | Props,
): null | string {
if (
parentProps === null ||
parentProps[SUPPRESS_HYDRATION_WARNING] !== true
) {
return diffHydratedText(textInstance, text);
}
return null;
}

export function hydrateSuspenseInstance(
Expand Down Expand Up @@ -1485,183 +1527,6 @@ export function shouldDeleteUnhydratedTailInstances(
return parentType !== 'form' && parentType !== 'button';
}

export function didNotMatchHydratedContainerTextInstance(
parentContainer: Container,
textInstance: TextInstance,
text: string,
shouldWarnDev: boolean,
) {
checkForUnmatchedText(textInstance.nodeValue, text, shouldWarnDev);
}

export function didNotMatchHydratedTextInstance(
parentType: string,
parentProps: Props,
parentInstance: Instance,
textInstance: TextInstance,
text: string,
shouldWarnDev: boolean,
) {
if (parentProps[SUPPRESS_HYDRATION_WARNING] !== true) {
checkForUnmatchedText(textInstance.nodeValue, text, shouldWarnDev);
}
}

export function didNotHydrateInstanceWithinContainer(
parentContainer: Container,
instance: HydratableInstance,
) {
if (__DEV__) {
if (instance.nodeType === ELEMENT_NODE) {
warnForDeletedHydratableElement(parentContainer, (instance: any));
} else if (instance.nodeType === COMMENT_NODE) {
// TODO: warnForDeletedHydratableSuspenseBoundary
} else {
warnForDeletedHydratableText(parentContainer, (instance: any));
}
}
}

export function didNotHydrateInstanceWithinSuspenseInstance(
parentInstance: SuspenseInstance,
instance: HydratableInstance,
) {
if (__DEV__) {
// $FlowFixMe[incompatible-type]: Only Element or Document can be parent nodes.
const parentNode: Element | Document | null = parentInstance.parentNode;
if (parentNode !== null) {
if (instance.nodeType === ELEMENT_NODE) {
warnForDeletedHydratableElement(parentNode, (instance: any));
} else if (instance.nodeType === COMMENT_NODE) {
// TODO: warnForDeletedHydratableSuspenseBoundary
} else {
warnForDeletedHydratableText(parentNode, (instance: any));
}
}
}
}

export function didNotHydrateInstance(
parentType: string,
parentProps: Props,
parentInstance: Instance,
instance: HydratableInstance,
) {
if (__DEV__) {
if (instance.nodeType === ELEMENT_NODE) {
warnForDeletedHydratableElement(parentInstance, (instance: any));
} else if (instance.nodeType === COMMENT_NODE) {
// TODO: warnForDeletedHydratableSuspenseBoundary
} else {
warnForDeletedHydratableText(parentInstance, (instance: any));
}
}
}

export function didNotFindHydratableInstanceWithinContainer(
parentContainer: Container,
type: string,
props: Props,
) {
if (__DEV__) {
warnForInsertedHydratedElement(parentContainer, type, props);
}
}

export function didNotFindHydratableTextInstanceWithinContainer(
parentContainer: Container,
text: string,
) {
if (__DEV__) {
warnForInsertedHydratedText(parentContainer, text);
}
}

export function didNotFindHydratableSuspenseInstanceWithinContainer(
parentContainer: Container,
) {
if (__DEV__) {
// TODO: warnForInsertedHydratedSuspense(parentContainer);
}
}

export function didNotFindHydratableInstanceWithinSuspenseInstance(
parentInstance: SuspenseInstance,
type: string,
props: Props,
) {
if (__DEV__) {
// $FlowFixMe[incompatible-type]: Only Element or Document can be parent nodes.
const parentNode: Element | Document | null = parentInstance.parentNode;
if (parentNode !== null)
warnForInsertedHydratedElement(parentNode, type, props);
}
}

export function didNotFindHydratableTextInstanceWithinSuspenseInstance(
parentInstance: SuspenseInstance,
text: string,
) {
if (__DEV__) {
// $FlowFixMe[incompatible-type]: Only Element or Document can be parent nodes.
const parentNode: Element | Document | null = parentInstance.parentNode;
if (parentNode !== null) warnForInsertedHydratedText(parentNode, text);
}
}

export function didNotFindHydratableSuspenseInstanceWithinSuspenseInstance(
parentInstance: SuspenseInstance,
) {
if (__DEV__) {
// const parentNode: Element | Document | null = parentInstance.parentNode;
// TODO: warnForInsertedHydratedSuspense(parentNode);
}
}

export function didNotFindHydratableInstance(
parentType: string,
parentProps: Props,
parentInstance: Instance,
type: string,
props: Props,
) {
if (__DEV__) {
warnForInsertedHydratedElement(parentInstance, type, props);
}
}

export function didNotFindHydratableTextInstance(
parentType: string,
parentProps: Props,
parentInstance: Instance,
text: string,
) {
if (__DEV__) {
warnForInsertedHydratedText(parentInstance, text);
}
}

export function didNotFindHydratableSuspenseInstance(
parentType: string,
parentProps: Props,
parentInstance: Instance,
) {
if (__DEV__) {
// TODO: warnForInsertedHydratedSuspense(parentInstance);
}
}

export function errorHydratingContainer(parentContainer: Container): void {
if (__DEV__) {
// TODO: This gets logged by onRecoverableError, too, so we should be
// able to remove it.
console.error(
'An error occurred during hydration. The server HTML was replaced with client content in <%s>.',
parentContainer.nodeName.toLowerCase(),
);
}
}

// -------------------
// Test Selectors
// -------------------
Expand Down
8 changes: 4 additions & 4 deletions packages/react-dom/src/__tests__/ReactDOMFizzServer-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2407,8 +2407,8 @@ describe('ReactDOMFizzServer', () => {
]);
}).toErrorDev(
[
'Warning: An error occurred during hydration. The server HTML was replaced with client content in <div>.',
'Warning: Expected server HTML to contain a matching <div> in <div>.\n' +
'Warning: An error occurred during hydration. The server HTML was replaced with client content.',
'Warning: Expected server HTML to contain a matching <div> in the root.\n' +
' in div (at **)\n' +
' in App (at **)',
],
Expand Down Expand Up @@ -2492,7 +2492,7 @@ describe('ReactDOMFizzServer', () => {
}).toErrorDev(
[
'Warning: An error occurred during hydration. The server HTML was replaced with client content',
'Warning: Expected server HTML to contain a matching <div> in <div>.\n' +
'Warning: Expected server HTML to contain a matching <div> in the root.\n' +
' in div (at **)\n' +
' in App (at **)',
],
Expand Down Expand Up @@ -6343,7 +6343,7 @@ describe('ReactDOMFizzServer', () => {
await waitForAll([]);
}).toErrorDev(
[
'Expected server HTML to contain a matching <span> in <div>',
'Expected server HTML to contain a matching <span> in the root',
'An error occurred during hydration',
],
{withoutStack: 1},
Expand Down
14 changes: 7 additions & 7 deletions packages/react-dom/src/__tests__/ReactDOMFizzSuppressHydrationWarning-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ describe('ReactDOMFizzServerHydrationWarning', () => {
}).toErrorDev(
[
'Expected server HTML to contain a matching <span> in <span>',
'An error occurred during hydration. The server HTML was replaced with client content in <div>.',
'An error occurred during hydration. The server HTML was replaced with client content.',
],
{withoutStack: 1},
);
Expand Down Expand Up @@ -337,7 +337,7 @@ describe('ReactDOMFizzServerHydrationWarning', () => {
}).toErrorDev(
[
'Did not expect server HTML to contain the text node "Server" in <span>',
'An error occurred during hydration. The server HTML was replaced with client content in <div>.',
'An error occurred during hydration. The server HTML was replaced with client content.',
],
{withoutStack: 1},
);
Expand Down Expand Up @@ -385,7 +385,7 @@ describe('ReactDOMFizzServerHydrationWarning', () => {
}).toErrorDev(
[
'Expected server HTML to contain a matching text node for "Client" in <span>.',
'An error occurred during hydration. The server HTML was replaced with client content in <div>.',
'An error occurred during hydration. The server HTML was replaced with client content.',
],
{withoutStack: 1},
);
Expand Down Expand Up @@ -436,7 +436,7 @@ describe('ReactDOMFizzServerHydrationWarning', () => {
}).toErrorDev(
[
'Did not expect server HTML to contain the text node "Server" in <span>.',
'An error occurred during hydration. The server HTML was replaced with client content in <div>.',
'An error occurred during hydration. The server HTML was replaced with client content.',
],
{withoutStack: 1},
);
Expand Down Expand Up @@ -485,7 +485,7 @@ describe('ReactDOMFizzServerHydrationWarning', () => {
}).toErrorDev(
[
'Expected server HTML to contain a matching text node for "Client" in <span>.',
'An error occurred during hydration. The server HTML was replaced with client content in <div>.',
'An error occurred during hydration. The server HTML was replaced with client content.',
],
{withoutStack: 1},
);
Expand Down Expand Up @@ -608,7 +608,7 @@ describe('ReactDOMFizzServerHydrationWarning', () => {
}).toErrorDev(
[
'Expected server HTML to contain a matching <p> in <div>.',
'An error occurred during hydration. The server HTML was replaced with client content in <div>.',
'An error occurred during hydration. The server HTML was replaced with client content.',
],
{withoutStack: 1},
);
Expand Down Expand Up @@ -654,7 +654,7 @@ describe('ReactDOMFizzServerHydrationWarning', () => {
}).toErrorDev(
[
'Did not expect server HTML to contain a <p> in <div>.',
'An error occurred during hydration. The server HTML was replaced with client content in <div>.',
'An error occurred during hydration. The server HTML was replaced with client content.',
],
{withoutStack: 1},
);
Expand Down
4 changes: 2 additions & 2 deletions packages/react-dom/src/__tests__/ReactDOMFloat-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6481,7 +6481,7 @@ body {
}).toErrorDev(
[
'Warning: Text content did not match. Server: "server" Client: "client"',
'Warning: An error occurred during hydration. The server HTML was replaced with client content in <#document>.',
'Warning: An error occurred during hydration. The server HTML was replaced with client content.',
],
{withoutStack: 1},
);
Expand Down Expand Up @@ -8271,7 +8271,7 @@ background-color: green;
}).toErrorDev(
[
'Warning: Text content did not match. Server: "server" Client: "client"',
'Warning: An error occurred during hydration. The server HTML was replaced with client content in <#document>.',
'Warning: An error occurred during hydration. The server HTML was replaced with client content.',
],
{withoutStack: 1},
);
Expand Down
Loading