/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @emails react-core
*/
'use strict';
const {COMMENT_NODE} = require('react-dom-bindings/src/client/HTMLNodeType');
let React;
let ReactDOM;
let ReactDOMServer;
let ReactTestUtils;
describe('ReactMount', () => {
beforeEach(() => {
jest.resetModules();
React = require('react');
ReactDOM = require('react-dom');
ReactDOMServer = require('react-dom/server');
ReactTestUtils = require('react-dom/test-utils');
});
describe('unmountComponentAtNode', () => {
it('throws when given a non-node', () => {
const nodeArray = document.getElementsByTagName('div');
expect(() => {
ReactDOM.unmountComponentAtNode(nodeArray);
}).toThrowError(
'unmountComponentAtNode(...): Target container is not a DOM element.',
);
});
it('returns false on non-React containers', () => {
const d = document.createElement('div');
d.innerHTML = '<b>hellooo</b>';
expect(ReactDOM.unmountComponentAtNode(d)).toBe(false);
expect(d.textContent).toBe('hellooo');
});
it('returns true on React containers', () => {
const d = document.createElement('div');
ReactDOM.render(<b>hellooo</b>, d);
expect(d.textContent).toBe('hellooo');
expect(ReactDOM.unmountComponentAtNode(d)).toBe(true);
expect(d.textContent).toBe('');
});
});
it('warns when given a factory', () => {
class Component extends React.Component {
render() {
return <div />;
}
}
expect(() => ReactTestUtils.renderIntoDocument(Component)).toErrorDev(
'Functions are not valid as a React child. ' +
'This may happen if you return a Component instead of <Component /> from render. ' +
'Or maybe you meant to call this function rather than return it.',
{withoutStack: true},
);
});
it('should render different components in same root', () => {
const container = document.createElement('container');
document.body.appendChild(container);
ReactDOM.render(<div />, container);
expect(container.firstChild.nodeName).toBe('DIV');
ReactDOM.render(<span />, container);
expect(container.firstChild.nodeName).toBe('SPAN');
});
it('should unmount and remount if the key changes', () => {
const container = document.createElement('container');
const mockMount = jest.fn();
const mockUnmount = jest.fn();
class Component extends React.Component {
componentDidMount = mockMount;
componentWillUnmount = mockUnmount;
render() {
return <span>{this.props.text}</span>;
}
}
expect(mockMount).toHaveBeenCalledTimes(0);
expect(mockUnmount).toHaveBeenCalledTimes(0);
ReactDOM.render(<Component text="orange" key="A" />, container);
expect(container.firstChild.innerHTML).toBe('orange');
expect(mockMount).toHaveBeenCalledTimes(1);
expect(mockUnmount).toHaveBeenCalledTimes(0);
// If we change the key, the component is unmounted and remounted
ReactDOM.render(<Component text="green" key="B" />, container);
expect(container.firstChild.innerHTML).toBe('green');
expect(mockMount).toHaveBeenCalledTimes(2);
expect(mockUnmount).toHaveBeenCalledTimes(1);
// But if we don't change the key, the component instance is reused
ReactDOM.render(<Component text="blue" key="B" />, container);
expect(container.firstChild.innerHTML).toBe('blue');
expect(mockMount).toHaveBeenCalledTimes(2);
expect(mockUnmount).toHaveBeenCalledTimes(1);
});
it('should reuse markup if rendering to the same target twice', () => {
const container = document.createElement('container');
const instance1 = ReactDOM.render(<div />, container);
const instance2 = ReactDOM.render(<div />, container);
expect(instance1 === instance2).toBe(true);
});
it('does not warn if mounting into left padded rendered markup', () => {
const container = document.createElement('container');
container.innerHTML = ReactDOMServer.renderToString(<div />) + ' ';
// This should probably ideally warn but we ignore extra markup at the root.
ReactDOM.hydrate(<div />, container);
});
it('should warn if mounting into right padded rendered markup', () => {
const container = document.createElement('container');
container.innerHTML = ' ' + ReactDOMServer.renderToString(<div />);
expect(() => ReactDOM.hydrate(<div />, container)).toErrorDev(
'Did not expect server HTML to contain the text node " " in <container>.',
);
});
it('should not warn if mounting into non-empty node', () => {
const container = document.createElement('container');
container.innerHTML = '<div></div>';
ReactDOM.render(<div />, container);
});
it('should warn when mounting into document.body', () => {
const iFrame = document.createElement('iframe');
document.body.appendChild(iFrame);
if (gate(flags => flags.enableHostSingletons)) {
// HostSingletons make the warning for document.body unecessary
ReactDOM.render(<div />, iFrame.contentDocument.body);
} else {
expect(() =>
ReactDOM.render(<div />, iFrame.contentDocument.body),
).toErrorDev(
'Rendering components directly into document.body is discouraged',
{withoutStack: true},
);
}
});
it('should account for escaping on a checksum mismatch', () => {
const div = document.createElement('div');
const markup = ReactDOMServer.renderToString(
<div>This markup contains an nbsp entity: server text</div>,
);
div.innerHTML = markup;
expect(() =>
ReactDOM.hydrate(
<div>This markup contains an nbsp entity: client text</div>,
div,
),
).toErrorDev(
'Server: "This markup contains an nbsp entity: server text" ' +
'Client: "This markup contains an nbsp entity: client text"',
);
});
it('should warn if render removes React-rendered children', () => {
const container = document.createElement('container');
class Component extends React.Component {
render() {
return (
<div>
<div />
</div>
);
}
}
ReactDOM.render(<Component />, container);
// Test that blasting away children throws a warning
const rootNode = container.firstChild;
expect(() => ReactDOM.render(<span />, rootNode)).toErrorDev(
'Warning: render(...): Replacing React-rendered children with a new ' +
'root component. If you intended to update the children of this node, ' +
'you should instead have the existing children update their state and ' +
'render the new components instead of calling ReactDOM.render.',
{withoutStack: true},
);
});
it('should warn if the unmounted node was rendered by another copy of React', () => {
jest.resetModules();
const ReactDOMOther = require('react-dom');
const container = document.createElement('div');
class Component extends React.Component {
render() {
return (
<div>
<div />
</div>
);
}
}
ReactDOM.render(<Component />, container);
// Make sure ReactDOM and ReactDOMOther are different copies
expect(ReactDOM).not.toEqual(ReactDOMOther);
expect(() => ReactDOMOther.unmountComponentAtNode(container)).toErrorDev(
"Warning: unmountComponentAtNode(): The node you're attempting to unmount " +
'was rendered by another copy of React.',
{withoutStack: true},
);
// Don't throw a warning if the correct React copy unmounts the node
ReactDOM.unmountComponentAtNode(container);
});
it('passes the correct callback context', () => {
const container = document.createElement('div');
let calls = 0;
ReactDOM.render(<div />, container, function () {
expect(this.nodeName).toBe('DIV');
calls++;
});
// Update, no type change
ReactDOM.render(<div />, container, function () {
expect(this.nodeName).toBe('DIV');
calls++;
});
// Update, type change
ReactDOM.render(<span />, container, function () {
expect(this.nodeName).toBe('SPAN');
calls++;
});
// Batched update, no type change
ReactDOM.unstable_batchedUpdates(function () {
ReactDOM.render(<span />, container, function () {
expect(this.nodeName).toBe('SPAN');
calls++;
});
});
// Batched update, type change
ReactDOM.unstable_batchedUpdates(function () {
ReactDOM.render(<article />, container, function () {
expect(this.nodeName).toBe('ARTICLE');
calls++;
});
});
expect(calls).toBe(5);
});
it('initial mount of legacy root is sync inside batchedUpdates, as if it were wrapped in flushSync', () => {
const container1 = document.createElement('div');
const container2 = document.createElement('div');
class Foo extends React.Component {
state = {active: false};
componentDidMount() {
this.setState({active: true});
}
render() {
return (
<div>{this.props.children + (this.state.active ? '!' : '')}</div>
);
}
}
ReactDOM.render(<div>1</div>, container1);
ReactDOM.unstable_batchedUpdates(() => {
// Update. Does not flush yet.
ReactDOM.render(<div>2</div>, container1);
expect(container1.textContent).toEqual('1');
// Initial mount on another root. Should flush immediately.
ReactDOM.render(<Foo>a</Foo>, container2);
// The earlier update also flushed, since flushSync flushes all pending
// sync work across all roots.
expect(container1.textContent).toEqual('2');
// Layout updates are also flushed synchronously
expect(container2.textContent).toEqual('a!');
});
expect(container1.textContent).toEqual('2');
expect(container2.textContent).toEqual('a!');
});
describe('mount point is a comment node', () => {
let containerDiv;
let mountPoint;
beforeEach(() => {
containerDiv = document.createElement('div');
containerDiv.innerHTML = 'A<!-- react-mount-point-unstable -->B';
mountPoint = containerDiv.childNodes[1];
expect(mountPoint.nodeType).toBe(COMMENT_NODE);
});
it('renders at a comment node', () => {
function Char(props) {
return props.children;
}
function list(chars) {
return chars.split('').map(c => <Char key={c}>{c}</Char>);
}
ReactDOM.render(list('aeiou'), mountPoint);
expect(containerDiv.innerHTML).toBe(
'Aaeiou<!-- react-mount-point-unstable -->B',
);
ReactDOM.render(list('yea'), mountPoint);
expect(containerDiv.innerHTML).toBe(
'Ayea<!-- react-mount-point-unstable -->B',
);
ReactDOM.render(list(''), mountPoint);
expect(containerDiv.innerHTML).toBe(
'A<!-- react-mount-point-unstable -->B',
);
});
});
});