-
Notifications
You must be signed in to change notification settings - Fork 47.2k
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
Add component stack info to key validation warnings #6799
Changes from 5 commits
9d4e2ff
53d8ca3
3f112af
af4a32a
14dbe15
570fe38
5e1c16d
7274283
1a0f6ca
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -72,10 +72,11 @@ function validateExplicitKey(element, parentType) { | |
warning( | ||
false, | ||
'Each child in an array or iterator should have a unique "key" prop.' + | ||
'%s%s%s', | ||
'%s%s%s%s', | ||
addenda.parentOrOwner || '', | ||
addenda.childOwner || '', | ||
addenda.url || '' | ||
addenda.url || '', | ||
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. We shouldn't need these other addenda now since the stack should cover it. Can you remove the code for them? We still will want to dedupe the warnings based on owner though as we're currently doing. |
||
ReactComponentTreeDevtool.getCurrentStackAddendum(element) | ||
); | ||
} | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -19,6 +19,10 @@ var ReactDOM; | |
var ReactTestUtils; | ||
|
||
describe('ReactElementValidator', function() { | ||
function normalizeCodeLocInfo(str) { | ||
return str.replace(/\(at .+?:\d+\)/g, '(at **)'); | ||
} | ||
|
||
var ComponentClass; | ||
|
||
beforeEach(function() { | ||
|
@@ -95,9 +99,10 @@ describe('ReactElementValidator', function() { | |
ReactTestUtils.renderIntoDocument(<Anonymous>{divs}</Anonymous>); | ||
|
||
expect(console.error.argsForCall.length).toBe(1); | ||
expect(console.error.argsForCall[0][0]).toBe( | ||
expect(normalizeCodeLocInfo(console.error.argsForCall[0][0])).toBe( | ||
'Warning: Each child in an array or iterator should have a unique ' + | ||
'"key" prop. See https://fb.me/react-warning-keys for more information.' | ||
'"key" prop. See https://fb.me/react-warning-keys for more information.\n' + | ||
' in div (at **)' | ||
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. It would be nice if this had both the parent component (Anonymous, or "Unknown" as we'll know it as in the devtools) and the child (div) here. Is that possible? I guess we would probably have to make getCurrentStackAddendum take both elements as arguments. |
||
); | ||
}); | ||
|
||
|
@@ -111,10 +116,46 @@ describe('ReactElementValidator', function() { | |
ReactTestUtils.renderIntoDocument(<div>{divs}</div>); | ||
|
||
expect(console.error.argsForCall.length).toBe(1); | ||
expect(console.error.argsForCall[0][0]).toBe( | ||
expect(normalizeCodeLocInfo(console.error.argsForCall[0][0])).toBe( | ||
'Warning: Each child in an array or iterator should have a unique ' + | ||
'"key" prop. Check the top-level render call using <div>. See ' + | ||
'https://fb.me/react-warning-keys for more information.' | ||
'https://fb.me/react-warning-keys for more information.\n' + | ||
' in div (at **)' | ||
); | ||
}); | ||
|
||
it('warns for keys with component stack info', function() { | ||
spyOn(console, 'error'); | ||
|
||
var Component = React.createClass({ | ||
render: function() { | ||
return <div>{[<div />, <div />]}</div>; | ||
}, | ||
}); | ||
|
||
var Parent = React.createClass({ | ||
render: function() { | ||
return React.cloneElement(this.props.child); | ||
}, | ||
}); | ||
|
||
var GrandParent = React.createClass({ | ||
render: function() { | ||
return <Parent child={<Component />} />; | ||
}, | ||
}); | ||
|
||
ReactTestUtils.renderIntoDocument(<GrandParent />); | ||
|
||
expect(console.error.argsForCall.length).toBe(1); | ||
expect(normalizeCodeLocInfo(console.error.argsForCall[0][0])).toBe( | ||
'Warning: Each child in an array or iterator should have a unique ' + | ||
'"key" prop. Check the render method of `Component`. See ' + | ||
'https://fb.me/react-warning-keys for more information.\n' + | ||
' in div (at **)\n' + | ||
' in Component (at **)\n' + | ||
' in Parent (at **)\n' + | ||
' in GrandParent (at **)' | ||
); | ||
}); | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -13,22 +13,24 @@ | |
|
||
var ReactReconciler = require('ReactReconciler'); | ||
|
||
var ReactComponentTreeDevtool = require('ReactComponentTreeDevtool'); | ||
var instantiateReactComponent = require('instantiateReactComponent'); | ||
var KeyEscapeUtils = require('KeyEscapeUtils'); | ||
var shouldUpdateReactComponent = require('shouldUpdateReactComponent'); | ||
var traverseAllChildren = require('traverseAllChildren'); | ||
var warning = require('warning'); | ||
|
||
function instantiateChild(childInstances, child, name) { | ||
function instantiateChild(childInstances, child, name, selfDebugID) { | ||
// We found a component instance. | ||
var keyUnique = (childInstances[name] === undefined); | ||
if (__DEV__) { | ||
warning( | ||
keyUnique, | ||
'flattenChildren(...): Encountered two children with the same key, ' + | ||
'`%s`. Child keys must be unique; when two children share a key, only ' + | ||
'the first child will be used.', | ||
KeyEscapeUtils.unescape(name) | ||
'the first child will be used.%s', | ||
KeyEscapeUtils.unescape(name), | ||
ReactComponentTreeDevtool.getStackAddendumByID(selfDebugID) | ||
); | ||
} | ||
if (child != null && keyUnique) { | ||
|
@@ -50,12 +52,31 @@ var ReactChildReconciler = { | |
* @return {?object} A set of child instances. | ||
* @internal | ||
*/ | ||
instantiateChildren: function(nestedChildNodes, transaction, context) { | ||
instantiateChildren: function( | ||
nestedChildNodes, | ||
transaction, | ||
context, | ||
selfDebugID // __DEV__ only | ||
) { | ||
if (nestedChildNodes == null) { | ||
return null; | ||
} | ||
var childInstances = {}; | ||
traverseAllChildren(nestedChildNodes, instantiateChild, childInstances); | ||
|
||
if (__DEV__) { | ||
traverseAllChildren( | ||
nestedChildNodes, | ||
(childInsts, child, name) => instantiateChild( | ||
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. I tried to put 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. Yeah, this seems fine to me. (I think calling it 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. Hmm, I thought about this; |
||
childInsts, | ||
child, | ||
name, | ||
selfDebugID | ||
), | ||
childInstances | ||
); | ||
} else { | ||
traverseAllChildren(nestedChildNodes, instantiateChild, childInstances); | ||
} | ||
return childInstances; | ||
}, | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
/** | ||
* Copyright 2013-present, Facebook, Inc. | ||
* All rights reserved. | ||
* | ||
* This source code is licensed under the BSD-style license found in the | ||
* LICENSE file in the root directory of this source tree. An additional grant | ||
* of patent rights can be found in the PATENTS file in the same directory. | ||
* | ||
* @emails react-core | ||
*/ | ||
|
||
// NOTE: We're explicitly not using JSX here. This is intended to test | ||
// the current stack addendum without having source location added by babel. | ||
|
||
'use strict'; | ||
|
||
var React; | ||
var ReactTestUtils; | ||
|
||
describe('ReactChildReconciler', function() { | ||
function normalizeCodeLocInfo(str) { | ||
return str.replace(/\(at .+?:\d+\)/g, '(at **)'); | ||
} | ||
|
||
beforeEach(function() { | ||
jest.resetModuleRegistry(); | ||
|
||
React = require('React'); | ||
ReactTestUtils = require('ReactTestUtils'); | ||
}); | ||
|
||
it('warns for duplicated keys', function() { | ||
spyOn(console, 'error'); | ||
|
||
var Component = React.createClass({ | ||
render() { | ||
return <div>{[<div key="1" />, <div key="1" />]}</div>; | ||
}, | ||
}); | ||
|
||
ReactTestUtils.renderIntoDocument(<Component />); | ||
|
||
expect(console.error.argsForCall.length).toBe(1); | ||
expect(console.error.argsForCall[0][0]).toContain( | ||
'Child keys must be unique; when two children share a key, only the first child will be used.' | ||
); | ||
}); | ||
|
||
it('warns for duplicated keys with component stack info', function() { | ||
spyOn(console, 'error'); | ||
|
||
var Component = React.createClass({ | ||
render: function() { | ||
return <div>{[<div key="1" />, <div key="1" />]}</div>; | ||
}, | ||
}); | ||
|
||
var Parent = React.createClass({ | ||
render: function() { | ||
return React.cloneElement(this.props.child); | ||
}, | ||
}); | ||
|
||
var GrandParent = React.createClass({ | ||
render: function() { | ||
return <Parent child={<Component />} />; | ||
}, | ||
}); | ||
|
||
ReactTestUtils.renderIntoDocument(<GrandParent />); | ||
|
||
expect(console.error.argsForCall.length).toBe(1); | ||
expect(normalizeCodeLocInfo(console.error.argsForCall[0][0])).toBe( | ||
'Warning: flattenChildren(...): ' + | ||
'Encountered two children with the same key, `1`. ' + | ||
'Child keys must be unique; when two children share a key, ' + | ||
'only the first child will be used.\n' + | ||
' in div (at **)\n' + | ||
' in Component (at **)\n' + | ||
' in Parent (at **)\n' + | ||
' in GrandParent (at **)' | ||
); | ||
}); | ||
}); |
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.
@spicyj what's a good way to get and feed
debugID
toflattenChildren
here? The only place that callsReactTransitionChildMapping.getChildMapping
(syntactic sugar forflattenChildren
) is here: https://github.com/facebook/react/blob/master/src/addons/transitions/ReactTransitionGroup.js#L41. In other words, how do I/can I get a debugID from a component?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.
Also, seems like the only other place we use
flattenChildren
is inReactMultiChild
and there's already a test for that inReactMultiChild-test
. Interestingly, whenReactChildReconciler
finds duplicated keys, the error message talks about "flattenChildren" (which is also test covered in the newReactChildReconciler-test
file).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.
should work. Maybe someday we'll have a public API to get this that anyone could use but for now I think it's okay for us to get the internal instance for this here.