Warn if people mutate children.#7001

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
jimfb merged 1 commit into from
Jun 16, 2016
Merged

Warn if people mutate children. #7001

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions src/isomorphic/classic/element/ReactElement.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -97,6 +97,7 @@ var ReactElement = function(type, key, ref, self, source, owner, props) {
// This can be replaced with a WeakMap once they are implemented in
// commonly used development environments.
element._store = {};
var shadowChildren = Array.isArray(props.children) ? props.children.slice(0) : props.children;

// To make comparing ReactElements easier for testing purposes, we make
// the validation flag non-enumerable (where possible, which should
Expand All@@ -116,6 +117,12 @@ var ReactElement = function(type, key, ref, self, source, owner, props) {
writable: false,
value: self,
});
Object.defineProperty(element, '_shadowChildren', {

@sebmarkbagesebmarkbageJun 14, 2016

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Define this in the non canDefineProperty case too.

@jimfbjimfbJun 15, 2016

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

configurable: false,
enumerable: false,
writable: false,
value: shadowChildren,
});
// Two elements created in two different places should be considered
// equal for testing purposes and therefore we hide it from enumeration.
Object.defineProperty(element, '_source', {
Expand All@@ -127,6 +134,7 @@ var ReactElement = function(type, key, ref, self, source, owner, props) {
} else {
element._store.validated = false;
element._self = self;
element._shadowChildren = shadowChildren;
element._source = source;
}
if (Object.freeze) {
Expand Down
14 changes: 14 additions & 0 deletions src/renderers/dom/shared/ReactDOMComponent.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -713,6 +713,13 @@ ReactDOMComponent.Mixin = {
break;
}

if (__DEV__) {
if (this._debugID) {
var callback = () => ReactInstrumentation.debugTool.onComponentHasMounted(this._debugID);
transaction.getReactMountReady().enqueue(callback, this);
}
}

return mountImage;
},

Expand DownExpand Up@@ -933,6 +940,13 @@ ReactDOMComponent.Mixin = {
// reconciliation
transaction.getReactMountReady().enqueue(postUpdateSelectWrapper, this);
}

if (__DEV__) {
if (this._debugID) {
var callback = () => ReactInstrumentation.debugTool.onComponentHasUpdated(this._debugID);
transaction.getReactMountReady().enqueue(callback, this);
}
}
},

/**
Expand Down
10 changes: 10 additions & 0 deletions src/renderers/shared/ReactDebugTool.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -258,6 +258,14 @@ var ReactDebugTool = {
checkDebugID(debugID);
emitEvent('onHostOperation', debugID, type, payload);
},
onComponentHasMounted(debugID) {
checkDebugID(debugID);
emitEvent('onComponentHasMounted', debugID);
},
onComponentHasUpdated(debugID) {
checkDebugID(debugID);
emitEvent('onComponentHasUpdated', debugID);
},
onSetState() {
emitEvent('onSetState');
},
Expand DownExpand Up@@ -314,9 +322,11 @@ if (__DEV__) {
var ReactInvalidSetStateWarningDevTool = require('ReactInvalidSetStateWarningDevTool');
var ReactHostOperationHistoryDevtool = require('ReactHostOperationHistoryDevtool');
var ReactComponentTreeDevtool = require('ReactComponentTreeDevtool');
var ReactChildrenMutationWarningDevtool = require('ReactChildrenMutationWarningDevtool');
ReactDebugTool.addDevtool(ReactInvalidSetStateWarningDevTool);
ReactDebugTool.addDevtool(ReactComponentTreeDevtool);
ReactDebugTool.addDevtool(ReactHostOperationHistoryDevtool);
ReactDebugTool.addDevtool(ReactChildrenMutationWarningDevtool);
var url = (ExecutionEnvironment.canUseDOM && window.location.href) || '';
if ((/[?&]react_perf\b/).test(url)) {
ReactDebugTool.beginProfiling();
Expand Down
66 changes: 66 additions & 0 deletions src/renderers/shared/devtools/ReactChildrenMutationWarningDevtool.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
/**
* 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.
*
* @providesModule ReactChildrenMutationWarningDevtool
*/

'use strict';

var ReactComponentTreeDevtool = require('ReactComponentTreeDevtool');

var warning = require('warning');

var elements = {};

function handleElement(debugID, element) {
if (element == null) {
return;
}
if (element._shadowChildren === undefined) {
return;
}
if (element._shadowChildren === element.props.children) {
return;
}
var isMutated = false;
if (Array.isArray(element._shadowChildren)) {
if (element._shadowChildren.length === element.props.children.length) {
for (var i = 0; i < element._shadowChildren.length; i++) {
if (element._shadowChildren[i] !== element.props.children[i]) {
isMutated = true;
}
}
} else {
isMutated = true;
}
}
warning(
Array.isArray(element._shadowChildren) && !isMutated,
'Component\'s children should not be mutated.%s',
ReactComponentTreeDevtool.getStackAddendumByID(debugID),
);
}

var ReactDOMUnknownPropertyDevtool = {
onBeforeMountComponent(debugID, element) {
elements[debugID] = element;
},
onBeforeUpdateComponent(debugID, element) {
elements[debugID] = element;
},
onComponentHasMounted(debugID) {
handleElement(debugID, elements[debugID]);
delete elements[debugID];
},
onComponentHasUpdated(debugID) {
handleElement(debugID, elements[debugID]);
delete elements[debugID];
},
};

module.exports = ReactDOMUnknownPropertyDevtool;
14 changes: 14 additions & 0 deletions src/renderers/shared/stack/reconciler/ReactCompositeComponent.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -342,6 +342,13 @@ var ReactCompositeComponentMixin = {
}
}

if (__DEV__) {
if (this._debugID) {
var callback = (component) => ReactInstrumentation.debugTool.onComponentHasMounted(this._debugID);
transaction.getReactMountReady().enqueue(callback, this);
}
}

return markup;
},

Expand DownExpand Up@@ -952,6 +959,13 @@ var ReactCompositeComponentMixin = {
);
}
}

if (__DEV__) {
if (this._debugID) {
var callback = () => ReactInstrumentation.debugTool.onComponentHasUpdated(this._debugID);
transaction.getReactMountReady().enqueue(callback, this);
}
}
},

/**
Expand Down
30 changes: 30 additions & 0 deletions src/renderers/shared/stack/reconciler/__tests__/ReactComponent-test.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,10 @@ var React;
var ReactDOM;
var ReactTestUtils;

function normalizeCodeLocInfo(str) {
return str.replace(/\(at .+?:\d+\)/g, '(at **)');
}

describe('ReactComponent', function() {
beforeEach(function() {
React = require('React');
Expand DownExpand Up@@ -45,6 +49,32 @@ describe('ReactComponent', function() {
}).toThrow();
});

it('should warn when children are mutated before render', function() {
spyOn(console, 'error');
var children = [<span key={0} />, <span key={1} />, <span key={2} />];
var element = <div>{children}</div>;
children[1] = <p key={1} />; // Mutation is illegal
ReactTestUtils.renderIntoDocument(element);
expect(console.error.calls.count()).toBe(1);
expect(normalizeCodeLocInfo(console.error.calls.argsFor(0)[0])).toBe(
'Warning: Component\'s children should not be mutated.\n in div (at **)'
);
});

it('should warn when children are mutated', function() {
spyOn(console, 'error');
var children = [<span key={0} />, <span key={1} />, <span key={2} />];
function Wrapper(props) {
props.children[1] = <p key={1} />; // Mutation is illegal
return <div>{props.children}</div>;
}
ReactTestUtils.renderIntoDocument(<Wrapper>{children}</Wrapper>);
expect(console.error.calls.count()).toBe(1);
expect(normalizeCodeLocInfo(console.error.calls.argsFor(0)[0])).toBe(
'Warning: Component\'s children should not be mutated.\n in Wrapper (at **)'
);
});

it('should support refs on owned components', function() {
var innerObj = {};
var outerObj = {};
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Warn if people mutate children.#7001

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

jimfb
merged 1 commit into

from

Jun 16, 2016
 Merged


Warn if people mutate children.
#7001
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


8 changes: 8 additions & 0 deletions
src/isomorphic/classic/element/ReactElement.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -97,6 +97,7 @@ var ReactElement = function(type, key, ref, self, source, owner, props) {
 // This can be replaced with a WeakMap once they are implemented in
 // commonly used development environments.
 element._store = {};
 var shadowChildren = Array.isArray(props.children) ? props.children.slice(0) : props.children;

 // To make comparing ReactElements easier for testing purposes, we make
 // the validation flag non-enumerable (where possible, which should
Expand All@@ -116,6 +117,12 @@ var ReactElement = function(type, key, ref, self, source, owner, props) {
 writable: false,
 value: self,
 });
 Object.defineProperty(element, '_shadowChildren', {
@sebmarkbagesebmarkbageJun 14, 2016

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Define this in the non canDefineProperty case too.
@jimfbjimfbJun 15, 2016

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.
 configurable: false,
 enumerable: false,
 writable: false,
 value: shadowChildren,
 });
 // Two elements created in two different places should be considered
 // equal for testing purposes and therefore we hide it from enumeration.
 Object.defineProperty(element, '_source', {
Expand All@@ -127,6 +134,7 @@ var ReactElement = function(type, key, ref, self, source, owner, props) {
 } else {
 element._store.validated = false;
 element._self = self;
 element._shadowChildren = shadowChildren;
 element._source = source;
 }
 if (Object.freeze) {
Expand Down

14 changes: 14 additions & 0 deletions
src/renderers/dom/shared/ReactDOMComponent.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -713,6 +713,13 @@ ReactDOMComponent.Mixin = {
 break;
 }

 if (__DEV__) {
 if (this._debugID) {
 var callback = () => ReactInstrumentation.debugTool.onComponentHasMounted(this._debugID);
 transaction.getReactMountReady().enqueue(callback, this);
 }
 }

 return mountImage;
 },

Expand DownExpand Up@@ -933,6 +940,13 @@ ReactDOMComponent.Mixin = {
 // reconciliation
 transaction.getReactMountReady().enqueue(postUpdateSelectWrapper, this);
 }

 if (__DEV__) {
 if (this._debugID) {
 var callback = () => ReactInstrumentation.debugTool.onComponentHasUpdated(this._debugID);
 transaction.getReactMountReady().enqueue(callback, this);
 }
 }
 },

 /**
Expand Down

10 changes: 10 additions & 0 deletions
src/renderers/shared/ReactDebugTool.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -258,6 +258,14 @@ var ReactDebugTool = {
 checkDebugID(debugID);
 emitEvent('onHostOperation', debugID, type, payload);
 },
 onComponentHasMounted(debugID) {
 checkDebugID(debugID);
 emitEvent('onComponentHasMounted', debugID);
 },
 onComponentHasUpdated(debugID) {
 checkDebugID(debugID);
 emitEvent('onComponentHasUpdated', debugID);
 },
 onSetState() {
 emitEvent('onSetState');
 },
Expand DownExpand Up@@ -314,9 +322,11 @@ if (__DEV__) {
 var ReactInvalidSetStateWarningDevTool = require('ReactInvalidSetStateWarningDevTool');
 var ReactHostOperationHistoryDevtool = require('ReactHostOperationHistoryDevtool');
 var ReactComponentTreeDevtool = require('ReactComponentTreeDevtool');
 var ReactChildrenMutationWarningDevtool = require('ReactChildrenMutationWarningDevtool');
 ReactDebugTool.addDevtool(ReactInvalidSetStateWarningDevTool);
 ReactDebugTool.addDevtool(ReactComponentTreeDevtool);
 ReactDebugTool.addDevtool(ReactHostOperationHistoryDevtool);
 ReactDebugTool.addDevtool(ReactChildrenMutationWarningDevtool);
 var url = (ExecutionEnvironment.canUseDOM && window.location.href) || '';
 if ((/[?&]react_perf\b/).test(url)) {
 ReactDebugTool.beginProfiling();
Expand Down

66 changes: 66 additions & 0 deletions
src/renderers/shared/devtools/ReactChildrenMutationWarningDevtool.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
/**
 * 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.
 *
 * @providesModule ReactChildrenMutationWarningDevtool
 */

'use strict';

var ReactComponentTreeDevtool = require('ReactComponentTreeDevtool');

var warning = require('warning');

var elements = {};

function handleElement(debugID, element) {
 if (element == null) {
 return;
 }
 if (element._shadowChildren === undefined) {
 return;
 }
 if (element._shadowChildren === element.props.children) {
 return;
 }
 var isMutated = false;
 if (Array.isArray(element._shadowChildren)) {
 if (element._shadowChildren.length === element.props.children.length) {
 for (var i = 0; i < element._shadowChildren.length; i++) {
 if (element._shadowChildren[i] !== element.props.children[i]) {
 isMutated = true;
 }
 }
 } else {
 isMutated = true;
 }
 }
 warning(
 Array.isArray(element._shadowChildren) && !isMutated,
 'Component\'s children should not be mutated.%s',
 ReactComponentTreeDevtool.getStackAddendumByID(debugID),
 );
}

var ReactDOMUnknownPropertyDevtool = {
 onBeforeMountComponent(debugID, element) {
 elements[debugID] = element;
 },
 onBeforeUpdateComponent(debugID, element) {
 elements[debugID] = element;
 },
 onComponentHasMounted(debugID) {
 handleElement(debugID, elements[debugID]);
 delete elements[debugID];
 },
 onComponentHasUpdated(debugID) {
 handleElement(debugID, elements[debugID]);
 delete elements[debugID];
 },
};

module.exports = ReactDOMUnknownPropertyDevtool;

14 changes: 14 additions & 0 deletions
src/renderers/shared/stack/reconciler/ReactCompositeComponent.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -342,6 +342,13 @@ var ReactCompositeComponentMixin = {
 }
 }

 if (__DEV__) {
 if (this._debugID) {
 var callback = (component) => ReactInstrumentation.debugTool.onComponentHasMounted(this._debugID);
 transaction.getReactMountReady().enqueue(callback, this);
 }
 }

 return markup;
 },

Expand DownExpand Up@@ -952,6 +959,13 @@ var ReactCompositeComponentMixin = {
 );
 }
 }

 if (__DEV__) {
 if (this._debugID) {
 var callback = () => ReactInstrumentation.debugTool.onComponentHasUpdated(this._debugID);
 transaction.getReactMountReady().enqueue(callback, this);
 }
 }
 },

 /**
Expand Down

30 changes: 30 additions & 0 deletions
src/renderers/shared/stack/reconciler/__tests__/ReactComponent-test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,10 @@ var React;
var ReactDOM;
var ReactTestUtils;

function normalizeCodeLocInfo(str) {
 return str.replace(/\(at .+?:\d+\)/g, '(at **)');
}

describe('ReactComponent', function() {
 beforeEach(function() {
 React = require('React');
Expand DownExpand Up@@ -45,6 +49,32 @@ describe('ReactComponent', function() {
 }).toThrow();
 });

 it('should warn when children are mutated before render', function() {
 spyOn(console, 'error');
 var children = [<span key={0} />, <span key={1} />, <span key={2} />];
 var element = <div>{children}</div>;
 children[1] = <p key={1} />; // Mutation is illegal
 ReactTestUtils.renderIntoDocument(element);
 expect(console.error.calls.count()).toBe(1);
 expect(normalizeCodeLocInfo(console.error.calls.argsFor(0)[0])).toBe(
 'Warning: Component\'s children should not be mutated.\n in div (at **)'
 );
 });

 it('should warn when children are mutated', function() {
 spyOn(console, 'error');
 var children = [<span key={0} />, <span key={1} />, <span key={2} />];
 function Wrapper(props) {
 props.children[1] = <p key={1} />; // Mutation is illegal
 return <div>{props.children}</div>;
 }
 ReactTestUtils.renderIntoDocument(<Wrapper>{children}</Wrapper>);
 expect(console.error.calls.count()).toBe(1);
 expect(normalizeCodeLocInfo(console.error.calls.argsFor(0)[0])).toBe(
 'Warning: Component\'s children should not be mutated.\n in Wrapper (at **)'
 );
 });

 it('should support refs on owned components', function() {
 var innerObj = {};
 var outerObj = {};
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Warn if people mutate children.#7001

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

jimfb
merged 1 commit into

from

Jun 16, 2016
 Merged


Warn if people mutate children.
#7001
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


8 changes: 8 additions & 0 deletions
src/isomorphic/classic/element/ReactElement.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -97,6 +97,7 @@ var ReactElement = function(type, key, ref, self, source, owner, props) {
 // This can be replaced with a WeakMap once they are implemented in
 // commonly used development environments.
 element._store = {};
 var shadowChildren = Array.isArray(props.children) ? props.children.slice(0) : props.children;

 // To make comparing ReactElements easier for testing purposes, we make
 // the validation flag non-enumerable (where possible, which should
Expand All@@ -116,6 +117,12 @@ var ReactElement = function(type, key, ref, self, source, owner, props) {
 writable: false,
 value: self,
 });
 Object.defineProperty(element, '_shadowChildren', {
@sebmarkbagesebmarkbageJun 14, 2016

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Define this in the non canDefineProperty case too.
@jimfbjimfbJun 15, 2016

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.
 configurable: false,
 enumerable: false,
 writable: false,
 value: shadowChildren,
 });
 // Two elements created in two different places should be considered
 // equal for testing purposes and therefore we hide it from enumeration.
 Object.defineProperty(element, '_source', {
Expand All@@ -127,6 +134,7 @@ var ReactElement = function(type, key, ref, self, source, owner, props) {
 } else {
 element._store.validated = false;
 element._self = self;
 element._shadowChildren = shadowChildren;
 element._source = source;
 }
 if (Object.freeze) {
Expand Down

14 changes: 14 additions & 0 deletions
src/renderers/dom/shared/ReactDOMComponent.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -713,6 +713,13 @@ ReactDOMComponent.Mixin = {
 break;
 }

 if (__DEV__) {
 if (this._debugID) {
 var callback = () => ReactInstrumentation.debugTool.onComponentHasMounted(this._debugID);
 transaction.getReactMountReady().enqueue(callback, this);
 }
 }

 return mountImage;
 },

Expand DownExpand Up@@ -933,6 +940,13 @@ ReactDOMComponent.Mixin = {
 // reconciliation
 transaction.getReactMountReady().enqueue(postUpdateSelectWrapper, this);
 }

 if (__DEV__) {
 if (this._debugID) {
 var callback = () => ReactInstrumentation.debugTool.onComponentHasUpdated(this._debugID);
 transaction.getReactMountReady().enqueue(callback, this);
 }
 }
 },

 /**
Expand Down

10 changes: 10 additions & 0 deletions
src/renderers/shared/ReactDebugTool.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -258,6 +258,14 @@ var ReactDebugTool = {
 checkDebugID(debugID);
 emitEvent('onHostOperation', debugID, type, payload);
 },
 onComponentHasMounted(debugID) {
 checkDebugID(debugID);
 emitEvent('onComponentHasMounted', debugID);
 },
 onComponentHasUpdated(debugID) {
 checkDebugID(debugID);
 emitEvent('onComponentHasUpdated', debugID);
 },
 onSetState() {
 emitEvent('onSetState');
 },
Expand DownExpand Up@@ -314,9 +322,11 @@ if (__DEV__) {
 var ReactInvalidSetStateWarningDevTool = require('ReactInvalidSetStateWarningDevTool');
 var ReactHostOperationHistoryDevtool = require('ReactHostOperationHistoryDevtool');
 var ReactComponentTreeDevtool = require('ReactComponentTreeDevtool');
 var ReactChildrenMutationWarningDevtool = require('ReactChildrenMutationWarningDevtool');
 ReactDebugTool.addDevtool(ReactInvalidSetStateWarningDevTool);
 ReactDebugTool.addDevtool(ReactComponentTreeDevtool);
 ReactDebugTool.addDevtool(ReactHostOperationHistoryDevtool);
 ReactDebugTool.addDevtool(ReactChildrenMutationWarningDevtool);
 var url = (ExecutionEnvironment.canUseDOM && window.location.href) || '';
 if ((/[?&]react_perf\b/).test(url)) {
 ReactDebugTool.beginProfiling();
Expand Down

66 changes: 66 additions & 0 deletions
src/renderers/shared/devtools/ReactChildrenMutationWarningDevtool.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
/**
 * 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.
 *
 * @providesModule ReactChildrenMutationWarningDevtool
 */

'use strict';

var ReactComponentTreeDevtool = require('ReactComponentTreeDevtool');

var warning = require('warning');

var elements = {};

function handleElement(debugID, element) {
 if (element == null) {
 return;
 }
 if (element._shadowChildren === undefined) {
 return;
 }
 if (element._shadowChildren === element.props.children) {
 return;
 }
 var isMutated = false;
 if (Array.isArray(element._shadowChildren)) {
 if (element._shadowChildren.length === element.props.children.length) {
 for (var i = 0; i < element._shadowChildren.length; i++) {
 if (element._shadowChildren[i] !== element.props.children[i]) {
 isMutated = true;
 }
 }
 } else {
 isMutated = true;
 }
 }
 warning(
 Array.isArray(element._shadowChildren) && !isMutated,
 'Component\'s children should not be mutated.%s',
 ReactComponentTreeDevtool.getStackAddendumByID(debugID),
 );
}

var ReactDOMUnknownPropertyDevtool = {
 onBeforeMountComponent(debugID, element) {
 elements[debugID] = element;
 },
 onBeforeUpdateComponent(debugID, element) {
 elements[debugID] = element;
 },
 onComponentHasMounted(debugID) {
 handleElement(debugID, elements[debugID]);
 delete elements[debugID];
 },
 onComponentHasUpdated(debugID) {
 handleElement(debugID, elements[debugID]);
 delete elements[debugID];
 },
};

module.exports = ReactDOMUnknownPropertyDevtool;

14 changes: 14 additions & 0 deletions
src/renderers/shared/stack/reconciler/ReactCompositeComponent.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -342,6 +342,13 @@ var ReactCompositeComponentMixin = {
 }
 }

 if (__DEV__) {
 if (this._debugID) {
 var callback = (component) => ReactInstrumentation.debugTool.onComponentHasMounted(this._debugID);
 transaction.getReactMountReady().enqueue(callback, this);
 }
 }

 return markup;
 },

Expand DownExpand Up@@ -952,6 +959,13 @@ var ReactCompositeComponentMixin = {
 );
 }
 }

 if (__DEV__) {
 if (this._debugID) {
 var callback = () => ReactInstrumentation.debugTool.onComponentHasUpdated(this._debugID);
 transaction.getReactMountReady().enqueue(callback, this);
 }
 }
 },

 /**
Expand Down

30 changes: 30 additions & 0 deletions
src/renderers/shared/stack/reconciler/__tests__/ReactComponent-test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,10 @@ var React;
var ReactDOM;
var ReactTestUtils;

function normalizeCodeLocInfo(str) {
 return str.replace(/\(at .+?:\d+\)/g, '(at **)');
}

describe('ReactComponent', function() {
 beforeEach(function() {
 React = require('React');
Expand DownExpand Up@@ -45,6 +49,32 @@ describe('ReactComponent', function() {
 }).toThrow();
 });

 it('should warn when children are mutated before render', function() {
 spyOn(console, 'error');
 var children = [<span key={0} />, <span key={1} />, <span key={2} />];
 var element = <div>{children}</div>;
 children[1] = <p key={1} />; // Mutation is illegal
 ReactTestUtils.renderIntoDocument(element);
 expect(console.error.calls.count()).toBe(1);
 expect(normalizeCodeLocInfo(console.error.calls.argsFor(0)[0])).toBe(
 'Warning: Component\'s children should not be mutated.\n in div (at **)'
 );
 });

 it('should warn when children are mutated', function() {
 spyOn(console, 'error');
 var children = [<span key={0} />, <span key={1} />, <span key={2} />];
 function Wrapper(props) {
 props.children[1] = <p key={1} />; // Mutation is illegal
 return <div>{props.children}</div>;
 }
 ReactTestUtils.renderIntoDocument(<Wrapper>{children}</Wrapper>);
 expect(console.error.calls.count()).toBe(1);
 expect(normalizeCodeLocInfo(console.error.calls.argsFor(0)[0])).toBe(
 'Warning: Component\'s children should not be mutated.\n in Wrapper (at **)'
 );
 });

 it('should support refs on owned components', function() {
 var innerObj = {};
 var outerObj = {};
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Warn if people mutate children.#7001

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

jimfb
merged 1 commit into

from

Jun 16, 2016
 Merged


Warn if people mutate children.
#7001
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


8 changes: 8 additions & 0 deletions
src/isomorphic/classic/element/ReactElement.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -97,6 +97,7 @@ var ReactElement = function(type, key, ref, self, source, owner, props) {
 // This can be replaced with a WeakMap once they are implemented in
 // commonly used development environments.
 element._store = {};
 var shadowChildren = Array.isArray(props.children) ? props.children.slice(0) : props.children;

 // To make comparing ReactElements easier for testing purposes, we make
 // the validation flag non-enumerable (where possible, which should
Expand All@@ -116,6 +117,12 @@ var ReactElement = function(type, key, ref, self, source, owner, props) {
 writable: false,
 value: self,
 });
 Object.defineProperty(element, '_shadowChildren', {
@sebmarkbagesebmarkbageJun 14, 2016

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Define this in the non canDefineProperty case too.
@jimfbjimfbJun 15, 2016

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.
 configurable: false,
 enumerable: false,
 writable: false,
 value: shadowChildren,
 });
 // Two elements created in two different places should be considered
 // equal for testing purposes and therefore we hide it from enumeration.
 Object.defineProperty(element, '_source', {
Expand All@@ -127,6 +134,7 @@ var ReactElement = function(type, key, ref, self, source, owner, props) {
 } else {
 element._store.validated = false;
 element._self = self;
 element._shadowChildren = shadowChildren;
 element._source = source;
 }
 if (Object.freeze) {
Expand Down

14 changes: 14 additions & 0 deletions
src/renderers/dom/shared/ReactDOMComponent.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -713,6 +713,13 @@ ReactDOMComponent.Mixin = {
 break;
 }

 if (__DEV__) {
 if (this._debugID) {
 var callback = () => ReactInstrumentation.debugTool.onComponentHasMounted(this._debugID);
 transaction.getReactMountReady().enqueue(callback, this);
 }
 }

 return mountImage;
 },

Expand DownExpand Up@@ -933,6 +940,13 @@ ReactDOMComponent.Mixin = {
 // reconciliation
 transaction.getReactMountReady().enqueue(postUpdateSelectWrapper, this);
 }

 if (__DEV__) {
 if (this._debugID) {
 var callback = () => ReactInstrumentation.debugTool.onComponentHasUpdated(this._debugID);
 transaction.getReactMountReady().enqueue(callback, this);
 }
 }
 },

 /**
Expand Down

10 changes: 10 additions & 0 deletions
src/renderers/shared/ReactDebugTool.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -258,6 +258,14 @@ var ReactDebugTool = {
 checkDebugID(debugID);
 emitEvent('onHostOperation', debugID, type, payload);
 },
 onComponentHasMounted(debugID) {
 checkDebugID(debugID);
 emitEvent('onComponentHasMounted', debugID);
 },
 onComponentHasUpdated(debugID) {
 checkDebugID(debugID);
 emitEvent('onComponentHasUpdated', debugID);
 },
 onSetState() {
 emitEvent('onSetState');
 },
Expand DownExpand Up@@ -314,9 +322,11 @@ if (__DEV__) {
 var ReactInvalidSetStateWarningDevTool = require('ReactInvalidSetStateWarningDevTool');
 var ReactHostOperationHistoryDevtool = require('ReactHostOperationHistoryDevtool');
 var ReactComponentTreeDevtool = require('ReactComponentTreeDevtool');
 var ReactChildrenMutationWarningDevtool = require('ReactChildrenMutationWarningDevtool');
 ReactDebugTool.addDevtool(ReactInvalidSetStateWarningDevTool);
 ReactDebugTool.addDevtool(ReactComponentTreeDevtool);
 ReactDebugTool.addDevtool(ReactHostOperationHistoryDevtool);
 ReactDebugTool.addDevtool(ReactChildrenMutationWarningDevtool);
 var url = (ExecutionEnvironment.canUseDOM && window.location.href) || '';
 if ((/[?&]react_perf\b/).test(url)) {
 ReactDebugTool.beginProfiling();
Expand Down

66 changes: 66 additions & 0 deletions
src/renderers/shared/devtools/ReactChildrenMutationWarningDevtool.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
/**
 * 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.
 *
 * @providesModule ReactChildrenMutationWarningDevtool
 */

'use strict';

var ReactComponentTreeDevtool = require('ReactComponentTreeDevtool');

var warning = require('warning');

var elements = {};

function handleElement(debugID, element) {
 if (element == null) {
 return;
 }
 if (element._shadowChildren === undefined) {
 return;
 }
 if (element._shadowChildren === element.props.children) {
 return;
 }
 var isMutated = false;
 if (Array.isArray(element._shadowChildren)) {
 if (element._shadowChildren.length === element.props.children.length) {
 for (var i = 0; i < element._shadowChildren.length; i++) {
 if (element._shadowChildren[i] !== element.props.children[i]) {
 isMutated = true;
 }
 }
 } else {
 isMutated = true;
 }
 }
 warning(
 Array.isArray(element._shadowChildren) && !isMutated,
 'Component\'s children should not be mutated.%s',
 ReactComponentTreeDevtool.getStackAddendumByID(debugID),
 );
}

var ReactDOMUnknownPropertyDevtool = {
 onBeforeMountComponent(debugID, element) {
 elements[debugID] = element;
 },
 onBeforeUpdateComponent(debugID, element) {
 elements[debugID] = element;
 },
 onComponentHasMounted(debugID) {
 handleElement(debugID, elements[debugID]);
 delete elements[debugID];
 },
 onComponentHasUpdated(debugID) {
 handleElement(debugID, elements[debugID]);
 delete elements[debugID];
 },
};

module.exports = ReactDOMUnknownPropertyDevtool;

14 changes: 14 additions & 0 deletions
src/renderers/shared/stack/reconciler/ReactCompositeComponent.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -342,6 +342,13 @@ var ReactCompositeComponentMixin = {
 }
 }

 if (__DEV__) {
 if (this._debugID) {
 var callback = (component) => ReactInstrumentation.debugTool.onComponentHasMounted(this._debugID);
 transaction.getReactMountReady().enqueue(callback, this);
 }
 }

 return markup;
 },

Expand DownExpand Up@@ -952,6 +959,13 @@ var ReactCompositeComponentMixin = {
 );
 }
 }

 if (__DEV__) {
 if (this._debugID) {
 var callback = () => ReactInstrumentation.debugTool.onComponentHasUpdated(this._debugID);
 transaction.getReactMountReady().enqueue(callback, this);
 }
 }
 },

 /**
Expand Down

30 changes: 30 additions & 0 deletions
src/renderers/shared/stack/reconciler/__tests__/ReactComponent-test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,10 @@ var React;
var ReactDOM;
var ReactTestUtils;

function normalizeCodeLocInfo(str) {
 return str.replace(/\(at .+?:\d+\)/g, '(at **)');
}

describe('ReactComponent', function() {
 beforeEach(function() {
 React = require('React');
Expand DownExpand Up@@ -45,6 +49,32 @@ describe('ReactComponent', function() {
 }).toThrow();
 });

 it('should warn when children are mutated before render', function() {
 spyOn(console, 'error');
 var children = [<span key={0} />, <span key={1} />, <span key={2} />];
 var element = <div>{children}</div>;
 children[1] = <p key={1} />; // Mutation is illegal
 ReactTestUtils.renderIntoDocument(element);
 expect(console.error.calls.count()).toBe(1);
 expect(normalizeCodeLocInfo(console.error.calls.argsFor(0)[0])).toBe(
 'Warning: Component\'s children should not be mutated.\n in div (at **)'
 );
 });

 it('should warn when children are mutated', function() {
 spyOn(console, 'error');
 var children = [<span key={0} />, <span key={1} />, <span key={2} />];
 function Wrapper(props) {
 props.children[1] = <p key={1} />; // Mutation is illegal
 return <div>{props.children}</div>;
 }
 ReactTestUtils.renderIntoDocument(<Wrapper>{children}</Wrapper>);
 expect(console.error.calls.count()).toBe(1);
 expect(normalizeCodeLocInfo(console.error.calls.argsFor(0)[0])).toBe(
 'Warning: Component\'s children should not be mutated.\n in Wrapper (at **)'
 );
 });

 it('should support refs on owned components', function() {
 var innerObj = {};
 var outerObj = {};
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Warn if people mutate children.#7001

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

jimfb
merged 1 commit into

from

Jun 16, 2016
 Merged


Warn if people mutate children.
#7001
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


8 changes: 8 additions & 0 deletions
src/isomorphic/classic/element/ReactElement.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -97,6 +97,7 @@ var ReactElement = function(type, key, ref, self, source, owner, props) {
 // This can be replaced with a WeakMap once they are implemented in
 // commonly used development environments.
 element._store = {};
 var shadowChildren = Array.isArray(props.children) ? props.children.slice(0) : props.children;

 // To make comparing ReactElements easier for testing purposes, we make
 // the validation flag non-enumerable (where possible, which should
Expand All@@ -116,6 +117,12 @@ var ReactElement = function(type, key, ref, self, source, owner, props) {
 writable: false,
 value: self,
 });
 Object.defineProperty(element, '_shadowChildren', {
@sebmarkbagesebmarkbageJun 14, 2016

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Define this in the non canDefineProperty case too.
@jimfbjimfbJun 15, 2016

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.
 configurable: false,
 enumerable: false,
 writable: false,
 value: shadowChildren,
 });
 // Two elements created in two different places should be considered
 // equal for testing purposes and therefore we hide it from enumeration.
 Object.defineProperty(element, '_source', {
Expand All@@ -127,6 +134,7 @@ var ReactElement = function(type, key, ref, self, source, owner, props) {
 } else {
 element._store.validated = false;
 element._self = self;
 element._shadowChildren = shadowChildren;
 element._source = source;
 }
 if (Object.freeze) {
Expand Down

14 changes: 14 additions & 0 deletions
src/renderers/dom/shared/ReactDOMComponent.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -713,6 +713,13 @@ ReactDOMComponent.Mixin = {
 break;
 }

 if (__DEV__) {
 if (this._debugID) {
 var callback = () => ReactInstrumentation.debugTool.onComponentHasMounted(this._debugID);
 transaction.getReactMountReady().enqueue(callback, this);
 }
 }

 return mountImage;
 },

Expand DownExpand Up@@ -933,6 +940,13 @@ ReactDOMComponent.Mixin = {
 // reconciliation
 transaction.getReactMountReady().enqueue(postUpdateSelectWrapper, this);
 }

 if (__DEV__) {
 if (this._debugID) {
 var callback = () => ReactInstrumentation.debugTool.onComponentHasUpdated(this._debugID);
 transaction.getReactMountReady().enqueue(callback, this);
 }
 }
 },

 /**
Expand Down

10 changes: 10 additions & 0 deletions
src/renderers/shared/ReactDebugTool.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -258,6 +258,14 @@ var ReactDebugTool = {
 checkDebugID(debugID);
 emitEvent('onHostOperation', debugID, type, payload);
 },
 onComponentHasMounted(debugID) {
 checkDebugID(debugID);
 emitEvent('onComponentHasMounted', debugID);
 },
 onComponentHasUpdated(debugID) {
 checkDebugID(debugID);
 emitEvent('onComponentHasUpdated', debugID);
 },
 onSetState() {
 emitEvent('onSetState');
 },
Expand DownExpand Up@@ -314,9 +322,11 @@ if (__DEV__) {
 var ReactInvalidSetStateWarningDevTool = require('ReactInvalidSetStateWarningDevTool');
 var ReactHostOperationHistoryDevtool = require('ReactHostOperationHistoryDevtool');
 var ReactComponentTreeDevtool = require('ReactComponentTreeDevtool');
 var ReactChildrenMutationWarningDevtool = require('ReactChildrenMutationWarningDevtool');
 ReactDebugTool.addDevtool(ReactInvalidSetStateWarningDevTool);
 ReactDebugTool.addDevtool(ReactComponentTreeDevtool);
 ReactDebugTool.addDevtool(ReactHostOperationHistoryDevtool);
 ReactDebugTool.addDevtool(ReactChildrenMutationWarningDevtool);
 var url = (ExecutionEnvironment.canUseDOM && window.location.href) || '';
 if ((/[?&]react_perf\b/).test(url)) {
 ReactDebugTool.beginProfiling();
Expand Down

66 changes: 66 additions & 0 deletions
src/renderers/shared/devtools/ReactChildrenMutationWarningDevtool.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
/**
 * 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.
 *
 * @providesModule ReactChildrenMutationWarningDevtool
 */

'use strict';

var ReactComponentTreeDevtool = require('ReactComponentTreeDevtool');

var warning = require('warning');

var elements = {};

function handleElement(debugID, element) {
 if (element == null) {
 return;
 }
 if (element._shadowChildren === undefined) {
 return;
 }
 if (element._shadowChildren === element.props.children) {
 return;
 }
 var isMutated = false;
 if (Array.isArray(element._shadowChildren)) {
 if (element._shadowChildren.length === element.props.children.length) {
 for (var i = 0; i < element._shadowChildren.length; i++) {
 if (element._shadowChildren[i] !== element.props.children[i]) {
 isMutated = true;
 }
 }
 } else {
 isMutated = true;
 }
 }
 warning(
 Array.isArray(element._shadowChildren) && !isMutated,
 'Component\'s children should not be mutated.%s',
 ReactComponentTreeDevtool.getStackAddendumByID(debugID),
 );
}

var ReactDOMUnknownPropertyDevtool = {
 onBeforeMountComponent(debugID, element) {
 elements[debugID] = element;
 },
 onBeforeUpdateComponent(debugID, element) {
 elements[debugID] = element;
 },
 onComponentHasMounted(debugID) {
 handleElement(debugID, elements[debugID]);
 delete elements[debugID];
 },
 onComponentHasUpdated(debugID) {
 handleElement(debugID, elements[debugID]);
 delete elements[debugID];
 },
};

module.exports = ReactDOMUnknownPropertyDevtool;

14 changes: 14 additions & 0 deletions
src/renderers/shared/stack/reconciler/ReactCompositeComponent.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -342,6 +342,13 @@ var ReactCompositeComponentMixin = {
 }
 }

 if (__DEV__) {
 if (this._debugID) {
 var callback = (component) => ReactInstrumentation.debugTool.onComponentHasMounted(this._debugID);
 transaction.getReactMountReady().enqueue(callback, this);
 }
 }

 return markup;
 },

Expand DownExpand Up@@ -952,6 +959,13 @@ var ReactCompositeComponentMixin = {
 );
 }
 }

 if (__DEV__) {
 if (this._debugID) {
 var callback = () => ReactInstrumentation.debugTool.onComponentHasUpdated(this._debugID);
 transaction.getReactMountReady().enqueue(callback, this);
 }
 }
 },

 /**
Expand Down

30 changes: 30 additions & 0 deletions
src/renderers/shared/stack/reconciler/__tests__/ReactComponent-test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,10 @@ var React;
var ReactDOM;
var ReactTestUtils;

function normalizeCodeLocInfo(str) {
 return str.replace(/\(at .+?:\d+\)/g, '(at **)');
}

describe('ReactComponent', function() {
 beforeEach(function() {
 React = require('React');
Expand DownExpand Up@@ -45,6 +49,32 @@ describe('ReactComponent', function() {
 }).toThrow();
 });

 it('should warn when children are mutated before render', function() {
 spyOn(console, 'error');
 var children = [<span key={0} />, <span key={1} />, <span key={2} />];
 var element = <div>{children}</div>;
 children[1] = <p key={1} />; // Mutation is illegal
 ReactTestUtils.renderIntoDocument(element);
 expect(console.error.calls.count()).toBe(1);
 expect(normalizeCodeLocInfo(console.error.calls.argsFor(0)[0])).toBe(
 'Warning: Component\'s children should not be mutated.\n in div (at **)'
 );
 });

 it('should warn when children are mutated', function() {
 spyOn(console, 'error');
 var children = [<span key={0} />, <span key={1} />, <span key={2} />];
 function Wrapper(props) {
 props.children[1] = <p key={1} />; // Mutation is illegal
 return <div>{props.children}</div>;
 }
 ReactTestUtils.renderIntoDocument(<Wrapper>{children}</Wrapper>);
 expect(console.error.calls.count()).toBe(1);
 expect(normalizeCodeLocInfo(console.error.calls.argsFor(0)[0])).toBe(
 'Warning: Component\'s children should not be mutated.\n in Wrapper (at **)'
 );
 });

 it('should support refs on owned components', function() {
 var innerObj = {};
 var outerObj = {};
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Warn if people mutate children.#7001

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

jimfb
merged 1 commit into

from

Jun 16, 2016
 Merged


Warn if people mutate children.
#7001
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


8 changes: 8 additions & 0 deletions
src/isomorphic/classic/element/ReactElement.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -97,6 +97,7 @@ var ReactElement = function(type, key, ref, self, source, owner, props) {
 // This can be replaced with a WeakMap once they are implemented in
 // commonly used development environments.
 element._store = {};
 var shadowChildren = Array.isArray(props.children) ? props.children.slice(0) : props.children;

 // To make comparing ReactElements easier for testing purposes, we make
 // the validation flag non-enumerable (where possible, which should
Expand All@@ -116,6 +117,12 @@ var ReactElement = function(type, key, ref, self, source, owner, props) {
 writable: false,
 value: self,
 });
 Object.defineProperty(element, '_shadowChildren', {
@sebmarkbagesebmarkbageJun 14, 2016

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Define this in the non canDefineProperty case too.
@jimfbjimfbJun 15, 2016

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.
 configurable: false,
 enumerable: false,
 writable: false,
 value: shadowChildren,
 });
 // Two elements created in two different places should be considered
 // equal for testing purposes and therefore we hide it from enumeration.
 Object.defineProperty(element, '_source', {
Expand All@@ -127,6 +134,7 @@ var ReactElement = function(type, key, ref, self, source, owner, props) {
 } else {
 element._store.validated = false;
 element._self = self;
 element._shadowChildren = shadowChildren;
 element._source = source;
 }
 if (Object.freeze) {
Expand Down

14 changes: 14 additions & 0 deletions
src/renderers/dom/shared/ReactDOMComponent.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -713,6 +713,13 @@ ReactDOMComponent.Mixin = {
 break;
 }

 if (__DEV__) {
 if (this._debugID) {
 var callback = () => ReactInstrumentation.debugTool.onComponentHasMounted(this._debugID);
 transaction.getReactMountReady().enqueue(callback, this);
 }
 }

 return mountImage;
 },

Expand DownExpand Up@@ -933,6 +940,13 @@ ReactDOMComponent.Mixin = {
 // reconciliation
 transaction.getReactMountReady().enqueue(postUpdateSelectWrapper, this);
 }

 if (__DEV__) {
 if (this._debugID) {
 var callback = () => ReactInstrumentation.debugTool.onComponentHasUpdated(this._debugID);
 transaction.getReactMountReady().enqueue(callback, this);
 }
 }
 },

 /**
Expand Down

10 changes: 10 additions & 0 deletions
src/renderers/shared/ReactDebugTool.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -258,6 +258,14 @@ var ReactDebugTool = {
 checkDebugID(debugID);
 emitEvent('onHostOperation', debugID, type, payload);
 },
 onComponentHasMounted(debugID) {
 checkDebugID(debugID);
 emitEvent('onComponentHasMounted', debugID);
 },
 onComponentHasUpdated(debugID) {
 checkDebugID(debugID);
 emitEvent('onComponentHasUpdated', debugID);
 },
 onSetState() {
 emitEvent('onSetState');
 },
Expand DownExpand Up@@ -314,9 +322,11 @@ if (__DEV__) {
 var ReactInvalidSetStateWarningDevTool = require('ReactInvalidSetStateWarningDevTool');
 var ReactHostOperationHistoryDevtool = require('ReactHostOperationHistoryDevtool');
 var ReactComponentTreeDevtool = require('ReactComponentTreeDevtool');
 var ReactChildrenMutationWarningDevtool = require('ReactChildrenMutationWarningDevtool');
 ReactDebugTool.addDevtool(ReactInvalidSetStateWarningDevTool);
 ReactDebugTool.addDevtool(ReactComponentTreeDevtool);
 ReactDebugTool.addDevtool(ReactHostOperationHistoryDevtool);
 ReactDebugTool.addDevtool(ReactChildrenMutationWarningDevtool);
 var url = (ExecutionEnvironment.canUseDOM && window.location.href) || '';
 if ((/[?&]react_perf\b/).test(url)) {
 ReactDebugTool.beginProfiling();
Expand Down

66 changes: 66 additions & 0 deletions
src/renderers/shared/devtools/ReactChildrenMutationWarningDevtool.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
/**
 * 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.
 *
 * @providesModule ReactChildrenMutationWarningDevtool
 */

'use strict';

var ReactComponentTreeDevtool = require('ReactComponentTreeDevtool');

var warning = require('warning');

var elements = {};

function handleElement(debugID, element) {
 if (element == null) {
 return;
 }
 if (element._shadowChildren === undefined) {
 return;
 }
 if (element._shadowChildren === element.props.children) {
 return;
 }
 var isMutated = false;
 if (Array.isArray(element._shadowChildren)) {
 if (element._shadowChildren.length === element.props.children.length) {
 for (var i = 0; i < element._shadowChildren.length; i++) {
 if (element._shadowChildren[i] !== element.props.children[i]) {
 isMutated = true;
 }
 }
 } else {
 isMutated = true;
 }
 }
 warning(
 Array.isArray(element._shadowChildren) && !isMutated,
 'Component\'s children should not be mutated.%s',
 ReactComponentTreeDevtool.getStackAddendumByID(debugID),
 );
}

var ReactDOMUnknownPropertyDevtool = {
 onBeforeMountComponent(debugID, element) {
 elements[debugID] = element;
 },
 onBeforeUpdateComponent(debugID, element) {
 elements[debugID] = element;
 },
 onComponentHasMounted(debugID) {
 handleElement(debugID, elements[debugID]);
 delete elements[debugID];
 },
 onComponentHasUpdated(debugID) {
 handleElement(debugID, elements[debugID]);
 delete elements[debugID];
 },
};

module.exports = ReactDOMUnknownPropertyDevtool;

14 changes: 14 additions & 0 deletions
src/renderers/shared/stack/reconciler/ReactCompositeComponent.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -342,6 +342,13 @@ var ReactCompositeComponentMixin = {
 }
 }

 if (__DEV__) {
 if (this._debugID) {
 var callback = (component) => ReactInstrumentation.debugTool.onComponentHasMounted(this._debugID);
 transaction.getReactMountReady().enqueue(callback, this);
 }
 }

 return markup;
 },

Expand DownExpand Up@@ -952,6 +959,13 @@ var ReactCompositeComponentMixin = {
 );
 }
 }

 if (__DEV__) {
 if (this._debugID) {
 var callback = () => ReactInstrumentation.debugTool.onComponentHasUpdated(this._debugID);
 transaction.getReactMountReady().enqueue(callback, this);
 }
 }
 },

 /**
Expand Down

30 changes: 30 additions & 0 deletions
src/renderers/shared/stack/reconciler/__tests__/ReactComponent-test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,10 @@ var React;
var ReactDOM;
var ReactTestUtils;

function normalizeCodeLocInfo(str) {
 return str.replace(/\(at .+?:\d+\)/g, '(at **)');
}

describe('ReactComponent', function() {
 beforeEach(function() {
 React = require('React');
Expand DownExpand Up@@ -45,6 +49,32 @@ describe('ReactComponent', function() {
 }).toThrow();
 });

 it('should warn when children are mutated before render', function() {
 spyOn(console, 'error');
 var children = [<span key={0} />, <span key={1} />, <span key={2} />];
 var element = <div>{children}</div>;
 children[1] = <p key={1} />; // Mutation is illegal
 ReactTestUtils.renderIntoDocument(element);
 expect(console.error.calls.count()).toBe(1);
 expect(normalizeCodeLocInfo(console.error.calls.argsFor(0)[0])).toBe(
 'Warning: Component\'s children should not be mutated.\n in div (at **)'
 );
 });

 it('should warn when children are mutated', function() {
 spyOn(console, 'error');
 var children = [<span key={0} />, <span key={1} />, <span key={2} />];
 function Wrapper(props) {
 props.children[1] = <p key={1} />; // Mutation is illegal
 return <div>{props.children}</div>;
 }
 ReactTestUtils.renderIntoDocument(<Wrapper>{children}</Wrapper>);
 expect(console.error.calls.count()).toBe(1);
 expect(normalizeCodeLocInfo(console.error.calls.argsFor(0)[0])).toBe(
 'Warning: Component\'s children should not be mutated.\n in Wrapper (at **)'
 );
 });

 it('should support refs on owned components', function() {
 var innerObj = {};
 var outerObj = {};
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Warn if people mutate children.#7001

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

jimfb
merged 1 commit into

from

Jun 16, 2016
 Merged


Warn if people mutate children.
#7001
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


8 changes: 8 additions & 0 deletions
src/isomorphic/classic/element/ReactElement.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -97,6 +97,7 @@ var ReactElement = function(type, key, ref, self, source, owner, props) {
 // This can be replaced with a WeakMap once they are implemented in
 // commonly used development environments.
 element._store = {};
 var shadowChildren = Array.isArray(props.children) ? props.children.slice(0) : props.children;

 // To make comparing ReactElements easier for testing purposes, we make
 // the validation flag non-enumerable (where possible, which should
Expand All@@ -116,6 +117,12 @@ var ReactElement = function(type, key, ref, self, source, owner, props) {
 writable: false,
 value: self,
 });
 Object.defineProperty(element, '_shadowChildren', {
@sebmarkbagesebmarkbageJun 14, 2016

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Define this in the non canDefineProperty case too.
@jimfbjimfbJun 15, 2016

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.
 configurable: false,
 enumerable: false,
 writable: false,
 value: shadowChildren,
 });
 // Two elements created in two different places should be considered
 // equal for testing purposes and therefore we hide it from enumeration.
 Object.defineProperty(element, '_source', {
Expand All@@ -127,6 +134,7 @@ var ReactElement = function(type, key, ref, self, source, owner, props) {
 } else {
 element._store.validated = false;
 element._self = self;
 element._shadowChildren = shadowChildren;
 element._source = source;
 }
 if (Object.freeze) {
Expand Down

14 changes: 14 additions & 0 deletions
src/renderers/dom/shared/ReactDOMComponent.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -713,6 +713,13 @@ ReactDOMComponent.Mixin = {
 break;
 }

 if (__DEV__) {
 if (this._debugID) {
 var callback = () => ReactInstrumentation.debugTool.onComponentHasMounted(this._debugID);
 transaction.getReactMountReady().enqueue(callback, this);
 }
 }

 return mountImage;
 },

Expand DownExpand Up@@ -933,6 +940,13 @@ ReactDOMComponent.Mixin = {
 // reconciliation
 transaction.getReactMountReady().enqueue(postUpdateSelectWrapper, this);
 }

 if (__DEV__) {
 if (this._debugID) {
 var callback = () => ReactInstrumentation.debugTool.onComponentHasUpdated(this._debugID);
 transaction.getReactMountReady().enqueue(callback, this);
 }
 }
 },

 /**
Expand Down

10 changes: 10 additions & 0 deletions
src/renderers/shared/ReactDebugTool.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -258,6 +258,14 @@ var ReactDebugTool = {
 checkDebugID(debugID);
 emitEvent('onHostOperation', debugID, type, payload);
 },
 onComponentHasMounted(debugID) {
 checkDebugID(debugID);
 emitEvent('onComponentHasMounted', debugID);
 },
 onComponentHasUpdated(debugID) {
 checkDebugID(debugID);
 emitEvent('onComponentHasUpdated', debugID);
 },
 onSetState() {
 emitEvent('onSetState');
 },
Expand DownExpand Up@@ -314,9 +322,11 @@ if (__DEV__) {
 var ReactInvalidSetStateWarningDevTool = require('ReactInvalidSetStateWarningDevTool');
 var ReactHostOperationHistoryDevtool = require('ReactHostOperationHistoryDevtool');
 var ReactComponentTreeDevtool = require('ReactComponentTreeDevtool');
 var ReactChildrenMutationWarningDevtool = require('ReactChildrenMutationWarningDevtool');
 ReactDebugTool.addDevtool(ReactInvalidSetStateWarningDevTool);
 ReactDebugTool.addDevtool(ReactComponentTreeDevtool);
 ReactDebugTool.addDevtool(ReactHostOperationHistoryDevtool);
 ReactDebugTool.addDevtool(ReactChildrenMutationWarningDevtool);
 var url = (ExecutionEnvironment.canUseDOM && window.location.href) || '';
 if ((/[?&]react_perf\b/).test(url)) {
 ReactDebugTool.beginProfiling();
Expand Down

66 changes: 66 additions & 0 deletions
src/renderers/shared/devtools/ReactChildrenMutationWarningDevtool.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
/**
 * 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.
 *
 * @providesModule ReactChildrenMutationWarningDevtool
 */

'use strict';

var ReactComponentTreeDevtool = require('ReactComponentTreeDevtool');

var warning = require('warning');

var elements = {};

function handleElement(debugID, element) {
 if (element == null) {
 return;
 }
 if (element._shadowChildren === undefined) {
 return;
 }
 if (element._shadowChildren === element.props.children) {
 return;
 }
 var isMutated = false;
 if (Array.isArray(element._shadowChildren)) {
 if (element._shadowChildren.length === element.props.children.length) {
 for (var i = 0; i < element._shadowChildren.length; i++) {
 if (element._shadowChildren[i] !== element.props.children[i]) {
 isMutated = true;
 }
 }
 } else {
 isMutated = true;
 }
 }
 warning(
 Array.isArray(element._shadowChildren) && !isMutated,
 'Component\'s children should not be mutated.%s',
 ReactComponentTreeDevtool.getStackAddendumByID(debugID),
 );
}

var ReactDOMUnknownPropertyDevtool = {
 onBeforeMountComponent(debugID, element) {
 elements[debugID] = element;
 },
 onBeforeUpdateComponent(debugID, element) {
 elements[debugID] = element;
 },
 onComponentHasMounted(debugID) {
 handleElement(debugID, elements[debugID]);
 delete elements[debugID];
 },
 onComponentHasUpdated(debugID) {
 handleElement(debugID, elements[debugID]);
 delete elements[debugID];
 },
};

module.exports = ReactDOMUnknownPropertyDevtool;

14 changes: 14 additions & 0 deletions
src/renderers/shared/stack/reconciler/ReactCompositeComponent.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -342,6 +342,13 @@ var ReactCompositeComponentMixin = {
 }
 }

 if (__DEV__) {
 if (this._debugID) {
 var callback = (component) => ReactInstrumentation.debugTool.onComponentHasMounted(this._debugID);
 transaction.getReactMountReady().enqueue(callback, this);
 }
 }

 return markup;
 },

Expand DownExpand Up@@ -952,6 +959,13 @@ var ReactCompositeComponentMixin = {
 );
 }
 }

 if (__DEV__) {
 if (this._debugID) {
 var callback = () => ReactInstrumentation.debugTool.onComponentHasUpdated(this._debugID);
 transaction.getReactMountReady().enqueue(callback, this);
 }
 }
 },

 /**
Expand Down

30 changes: 30 additions & 0 deletions
src/renderers/shared/stack/reconciler/__tests__/ReactComponent-test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,10 @@ var React;
var ReactDOM;
var ReactTestUtils;

function normalizeCodeLocInfo(str) {
 return str.replace(/\(at .+?:\d+\)/g, '(at **)');
}

describe('ReactComponent', function() {
 beforeEach(function() {
 React = require('React');
Expand DownExpand Up@@ -45,6 +49,32 @@ describe('ReactComponent', function() {
 }).toThrow();
 });

 it('should warn when children are mutated before render', function() {
 spyOn(console, 'error');
 var children = [<span key={0} />, <span key={1} />, <span key={2} />];
 var element = <div>{children}</div>;
 children[1] = <p key={1} />; // Mutation is illegal
 ReactTestUtils.renderIntoDocument(element);
 expect(console.error.calls.count()).toBe(1);
 expect(normalizeCodeLocInfo(console.error.calls.argsFor(0)[0])).toBe(
 'Warning: Component\'s children should not be mutated.\n in div (at **)'
 );
 });

 it('should warn when children are mutated', function() {
 spyOn(console, 'error');
 var children = [<span key={0} />, <span key={1} />, <span key={2} />];
 function Wrapper(props) {
 props.children[1] = <p key={1} />; // Mutation is illegal
 return <div>{props.children}</div>;
 }
 ReactTestUtils.renderIntoDocument(<Wrapper>{children}</Wrapper>);
 expect(console.error.calls.count()).toBe(1);
 expect(normalizeCodeLocInfo(console.error.calls.argsFor(0)[0])).toBe(
 'Warning: Component\'s children should not be mutated.\n in Wrapper (at **)'
 );
 });

 it('should support refs on owned components', function() {
 var innerObj = {};
 var outerObj = {};
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Warn if people mutate children.#7001

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

jimfb
merged 1 commit into

from

Jun 16, 2016
 Merged


Warn if people mutate children.
#7001
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


8 changes: 8 additions & 0 deletions
src/isomorphic/classic/element/ReactElement.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -97,6 +97,7 @@ var ReactElement = function(type, key, ref, self, source, owner, props) {
 // This can be replaced with a WeakMap once they are implemented in
 // commonly used development environments.
 element._store = {};
 var shadowChildren = Array.isArray(props.children) ? props.children.slice(0) : props.children;

 // To make comparing ReactElements easier for testing purposes, we make
 // the validation flag non-enumerable (where possible, which should
Expand All@@ -116,6 +117,12 @@ var ReactElement = function(type, key, ref, self, source, owner, props) {
 writable: false,
 value: self,
 });
 Object.defineProperty(element, '_shadowChildren', {
@sebmarkbagesebmarkbageJun 14, 2016

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Define this in the non canDefineProperty case too.
@jimfbjimfbJun 15, 2016

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.
 configurable: false,
 enumerable: false,
 writable: false,
 value: shadowChildren,
 });
 // Two elements created in two different places should be considered
 // equal for testing purposes and therefore we hide it from enumeration.
 Object.defineProperty(element, '_source', {
Expand All@@ -127,6 +134,7 @@ var ReactElement = function(type, key, ref, self, source, owner, props) {
 } else {
 element._store.validated = false;
 element._self = self;
 element._shadowChildren = shadowChildren;
 element._source = source;
 }
 if (Object.freeze) {
Expand Down

14 changes: 14 additions & 0 deletions
src/renderers/dom/shared/ReactDOMComponent.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -713,6 +713,13 @@ ReactDOMComponent.Mixin = {
 break;
 }

 if (__DEV__) {
 if (this._debugID) {
 var callback = () => ReactInstrumentation.debugTool.onComponentHasMounted(this._debugID);
 transaction.getReactMountReady().enqueue(callback, this);
 }
 }

 return mountImage;
 },

Expand DownExpand Up@@ -933,6 +940,13 @@ ReactDOMComponent.Mixin = {
 // reconciliation
 transaction.getReactMountReady().enqueue(postUpdateSelectWrapper, this);
 }

 if (__DEV__) {
 if (this._debugID) {
 var callback = () => ReactInstrumentation.debugTool.onComponentHasUpdated(this._debugID);
 transaction.getReactMountReady().enqueue(callback, this);
 }
 }
 },

 /**
Expand Down

10 changes: 10 additions & 0 deletions
src/renderers/shared/ReactDebugTool.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -258,6 +258,14 @@ var ReactDebugTool = {
 checkDebugID(debugID);
 emitEvent('onHostOperation', debugID, type, payload);
 },
 onComponentHasMounted(debugID) {
 checkDebugID(debugID);
 emitEvent('onComponentHasMounted', debugID);
 },
 onComponentHasUpdated(debugID) {
 checkDebugID(debugID);
 emitEvent('onComponentHasUpdated', debugID);
 },
 onSetState() {
 emitEvent('onSetState');
 },
Expand DownExpand Up@@ -314,9 +322,11 @@ if (__DEV__) {
 var ReactInvalidSetStateWarningDevTool = require('ReactInvalidSetStateWarningDevTool');
 var ReactHostOperationHistoryDevtool = require('ReactHostOperationHistoryDevtool');
 var ReactComponentTreeDevtool = require('ReactComponentTreeDevtool');
 var ReactChildrenMutationWarningDevtool = require('ReactChildrenMutationWarningDevtool');
 ReactDebugTool.addDevtool(ReactInvalidSetStateWarningDevTool);
 ReactDebugTool.addDevtool(ReactComponentTreeDevtool);
 ReactDebugTool.addDevtool(ReactHostOperationHistoryDevtool);
 ReactDebugTool.addDevtool(ReactChildrenMutationWarningDevtool);
 var url = (ExecutionEnvironment.canUseDOM && window.location.href) || '';
 if ((/[?&]react_perf\b/).test(url)) {
 ReactDebugTool.beginProfiling();
Expand Down

66 changes: 66 additions & 0 deletions
src/renderers/shared/devtools/ReactChildrenMutationWarningDevtool.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
/**
 * 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.
 *
 * @providesModule ReactChildrenMutationWarningDevtool
 */

'use strict';

var ReactComponentTreeDevtool = require('ReactComponentTreeDevtool');

var warning = require('warning');

var elements = {};

function handleElement(debugID, element) {
 if (element == null) {
 return;
 }
 if (element._shadowChildren === undefined) {
 return;
 }
 if (element._shadowChildren === element.props.children) {
 return;
 }
 var isMutated = false;
 if (Array.isArray(element._shadowChildren)) {
 if (element._shadowChildren.length === element.props.children.length) {
 for (var i = 0; i < element._shadowChildren.length; i++) {
 if (element._shadowChildren[i] !== element.props.children[i]) {
 isMutated = true;
 }
 }
 } else {
 isMutated = true;
 }
 }
 warning(
 Array.isArray(element._shadowChildren) && !isMutated,
 'Component\'s children should not be mutated.%s',
 ReactComponentTreeDevtool.getStackAddendumByID(debugID),
 );
}

var ReactDOMUnknownPropertyDevtool = {
 onBeforeMountComponent(debugID, element) {
 elements[debugID] = element;
 },
 onBeforeUpdateComponent(debugID, element) {
 elements[debugID] = element;
 },
 onComponentHasMounted(debugID) {
 handleElement(debugID, elements[debugID]);
 delete elements[debugID];
 },
 onComponentHasUpdated(debugID) {
 handleElement(debugID, elements[debugID]);
 delete elements[debugID];
 },
};

module.exports = ReactDOMUnknownPropertyDevtool;

14 changes: 14 additions & 0 deletions
src/renderers/shared/stack/reconciler/ReactCompositeComponent.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -342,6 +342,13 @@ var ReactCompositeComponentMixin = {
 }
 }

 if (__DEV__) {
 if (this._debugID) {
 var callback = (component) => ReactInstrumentation.debugTool.onComponentHasMounted(this._debugID);
 transaction.getReactMountReady().enqueue(callback, this);
 }
 }

 return markup;
 },

Expand DownExpand Up@@ -952,6 +959,13 @@ var ReactCompositeComponentMixin = {
 );
 }
 }

 if (__DEV__) {
 if (this._debugID) {
 var callback = () => ReactInstrumentation.debugTool.onComponentHasUpdated(this._debugID);
 transaction.getReactMountReady().enqueue(callback, this);
 }
 }
 },

 /**
Expand Down

30 changes: 30 additions & 0 deletions
src/renderers/shared/stack/reconciler/__tests__/ReactComponent-test.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,10 @@ var React;
var ReactDOM;
var ReactTestUtils;

function normalizeCodeLocInfo(str) {
 return str.replace(/\(at .+?:\d+\)/g, '(at **)');
}

describe('ReactComponent', function() {
 beforeEach(function() {
 React = require('React');
Expand DownExpand Up@@ -45,6 +49,32 @@ describe('ReactComponent', function() {
 }).toThrow();
 });

 it('should warn when children are mutated before render', function() {
 spyOn(console, 'error');
 var children = [<span key={0} />, <span key={1} />, <span key={2} />];
 var element = <div>{children}</div>;
 children[1] = <p key={1} />; // Mutation is illegal
 ReactTestUtils.renderIntoDocument(element);
 expect(console.error.calls.count()).toBe(1);
 expect(normalizeCodeLocInfo(console.error.calls.argsFor(0)[0])).toBe(
 'Warning: Component\'s children should not be mutated.\n in div (at **)'
 );
 });

 it('should warn when children are mutated', function() {
 spyOn(console, 'error');
 var children = [<span key={0} />, <span key={1} />, <span key={2} />];
 function Wrapper(props) {
 props.children[1] = <p key={1} />; // Mutation is illegal
 return <div>{props.children}</div>;
 }
 ReactTestUtils.renderIntoDocument(<Wrapper>{children}</Wrapper>);
 expect(console.error.calls.count()).toBe(1);
 expect(normalizeCodeLocInfo(console.error.calls.argsFor(0)[0])).toBe(
 'Warning: Component\'s children should not be mutated.\n in Wrapper (at **)'
 );
 });

 it('should support refs on owned components', function() {
 var innerObj = {};
 var outerObj = {};
Expand Down