-
Notifications
You must be signed in to change notification settings - Fork 46.5k
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
Warn if using React.unmountComponentAtNode on a different React instance's tree. #7456
Merged
Merged
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -206,6 +206,45 @@ function hasNonRootReactChild(container) { | |
} | ||
} | ||
|
||
/** | ||
* True if the supplied DOM node is a React DOM element and | ||
* it has been rendered by a different React instance. | ||
* | ||
* @param {?DOMElement} node The candidate DOM node. | ||
* @return {boolean} True if the DOM has been rendered by a different React instance | ||
* @internal | ||
*/ | ||
function nodeIsRenderedByOtherInstance(container) { | ||
var rootEl = getReactRootElementInContainer(container); | ||
return !!(rootEl && isReactNode(rootEl) && !ReactDOMComponentTree.getInstanceFromNode(rootEl)); | ||
} | ||
|
||
/** | ||
* True if the supplied DOM node is a valid node element. | ||
* | ||
* @param {?DOMElement} node The candidate DOM node. | ||
* @return {boolean} True if the DOM is a valid DOM node. | ||
* @internal | ||
*/ | ||
function isNodeElement(node) { | ||
return !!(node && ( | ||
node.nodeType === ELEMENT_NODE_TYPE || | ||
node.nodeType === DOC_NODE_TYPE || | ||
node.nodeType === DOCUMENT_FRAGMENT_NODE_TYPE | ||
)); | ||
} | ||
|
||
/** | ||
* True if the supplied DOM node is a valid React node element. | ||
* | ||
* @param {?DOMElement} node The candidate DOM node. | ||
* @return {boolean} True if the DOM is a valid React DOM node. | ||
* @internal | ||
*/ | ||
function isReactNode(node) { | ||
return isNodeElement(node) && (node.hasAttribute(ROOT_ATTR_NAME) || node.hasAttribute(ATTR_NAME)); | ||
} | ||
|
||
function getHostRootInstanceInContainer(container) { | ||
var rootEl = getReactRootElementInContainer(container); | ||
var prevHostInstance = | ||
|
@@ -329,11 +368,7 @@ var ReactMount = { | |
); | ||
|
||
invariant( | ||
container && ( | ||
container.nodeType === ELEMENT_NODE_TYPE || | ||
container.nodeType === DOC_NODE_TYPE || | ||
container.nodeType === DOCUMENT_FRAGMENT_NODE_TYPE | ||
), | ||
isNodeElement(container), | ||
'_registerComponent(...): Target container is not a DOM element.' | ||
); | ||
|
||
|
@@ -546,14 +581,18 @@ var ReactMount = { | |
); | ||
|
||
invariant( | ||
container && ( | ||
container.nodeType === ELEMENT_NODE_TYPE || | ||
container.nodeType === DOC_NODE_TYPE || | ||
container.nodeType === DOCUMENT_FRAGMENT_NODE_TYPE | ||
), | ||
isNodeElement(container), | ||
'unmountComponentAtNode(...): Target container is not a DOM element.' | ||
); | ||
|
||
if (__DEV__) { | ||
warning( | ||
!nodeIsRenderedByOtherInstance(container), | ||
'unmountComponentAtNode(): The node you\'re attempting to unmount ' + | ||
'was rendered by another React instance.' | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit: let's do "another copy of React" |
||
); | ||
} | ||
|
||
var prevComponent = getTopLevelWrapperInContainer(container); | ||
if (!prevComponent) { | ||
// Check if the node being unmounted was rendered by React, but isn't a | ||
|
@@ -599,11 +638,7 @@ var ReactMount = { | |
transaction | ||
) { | ||
invariant( | ||
container && ( | ||
container.nodeType === ELEMENT_NODE_TYPE || | ||
container.nodeType === DOC_NODE_TYPE || | ||
container.nodeType === DOCUMENT_FRAGMENT_NODE_TYPE | ||
), | ||
isNodeElement(container), | ||
'mountComponentIntoNode(...): Target container is not valid.' | ||
); | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -229,6 +229,34 @@ describe('ReactMount', function() { | |
); | ||
}); | ||
|
||
it('should warn if the unmounted node was rendered by another instance', function() { | ||
jest.resetModuleRegistry(); | ||
var ReactDOMOther = require('ReactDOM'); | ||
var container = document.createElement('container'); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
||
class Component extends React.Component { | ||
render() { | ||
return <div><div /></div>; | ||
} | ||
} | ||
|
||
ReactDOM.render(<Component />, container); | ||
// Make sure ReactDOM and ReactDOMOther are different instances | ||
expect(ReactDOM).not.toEqual(ReactDOMOther); | ||
|
||
spyOn(console, 'error'); | ||
ReactDOMOther.unmountComponentAtNode(container); | ||
expect(console.error.calls.count()).toBe(1); | ||
expect(console.error.calls.argsFor(0)[0]).toBe( | ||
'Warning: unmountComponentAtNode(): The node you\'re attempting to unmount ' + | ||
'was rendered by another React instance.' | ||
); | ||
|
||
// Don't throw a warning if the correct React instance unmounts the node | ||
ReactDOM.unmountComponentAtNode(container); | ||
expect(console.error.calls.count()).toBe(1); | ||
}); | ||
|
||
it('passes the correct callback context', function() { | ||
var container = document.createElement('div'); | ||
var calls = 0; | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we call this isValidContainer?