Make setState() callback error message more descriptive

Fixes #6306
This commit is contained in:
Dan Abramov
2016-03-21 21:24:19 +00:00
parent 441d9b65bd
commit 552f00b536
2 changed files with 61 additions and 10 deletions
@@ -22,6 +22,19 @@ function enqueueUpdate(internalInstance) {
ReactUpdates.enqueueUpdate(internalInstance);
}
function formatUnexpectedArgument(arg) {
var type = typeof arg;
if (type !== 'object') {
return type;
}
var displayName = arg.constructor && arg.constructor.name || type;
var keys = Object.keys(arg);
if (keys.length > 0 && keys.length < 20) {
return `${displayName} (keys: ${keys.join(', ')})`;
}
return displayName;
}
function getInternalInstanceReadyForUpdate(publicInstance, callerName) {
var internalInstance = ReactInstanceMap.get(publicInstance);
if (!internalInstance) {
@@ -108,11 +121,10 @@ var ReactUpdateQueue = {
enqueueCallback: function(publicInstance, callback) {
invariant(
typeof callback === 'function',
'enqueueCallback(...): You called `setProps`, `replaceProps`, ' +
'`setState`, `replaceState`, or `forceUpdate` with a callback of type ' +
'%s. A function is expected',
typeof callback === 'object' && Object.keys(callback).length && Object.keys(callback).length < 20 ?
typeof callback + ' (keys: ' + Object.keys(callback) + ')' : typeof callback
'enqueueCallback(...): You called `setState`, `replaceState`, or ' +
'`forceUpdate` with the last argument of type %s. When specified, ' +
'their last `callback` argument is expected to be a function.',
formatUnexpectedArgument(callback)
);
var internalInstance = getInternalInstanceReadyForUpdate(publicInstance);
@@ -140,11 +152,10 @@ var ReactUpdateQueue = {
enqueueCallbackInternal: function(internalInstance, callback) {
invariant(
typeof callback === 'function',
'enqueueCallback(...): You called `setProps`, `replaceProps`, ' +
'`setState`, `replaceState`, or `forceUpdate` with a callback of type ' +
'%s. A function is expected',
typeof callback === 'object' && Object.keys(callback).length && Object.keys(callback).length < 20 ?
typeof callback + ' (keys: ' + Object.keys(callback) + ')' : typeof callback
'enqueueCallback(...): You called `setState`, `replaceState`, or ' +
'`forceUpdate` with the last argument of type %s. When specified, ' +
'their last `callback` argument is expected to be a function.',
formatUnexpectedArgument(callback)
);
if (internalInstance._pendingCallbacks) {
internalInstance._pendingCallbacks.push(callback);
@@ -937,4 +937,44 @@ describe('ReactUpdates', function() {
ReactFeatureFlags.logTopLevelRenders = false;
}
});
it('throws when the update callback is not a function', function() {
function Foo() {
this.a = 1;
this.b = 2;
}
var A = React.createClass({
getInitialState: function() {
return {};
},
render: function() {
return <div />;
},
});
var component = ReactTestUtils.renderIntoDocument(<A />);
var stringMessage =
'enqueueCallback(...): You called `setState`, `replaceState`, or '+
'`forceUpdate` with the last argument of type string. When specified, ' +
'their last `callback` argument is expected to be a function.';
expect(() => component.setState({}, 'no')).toThrow(stringMessage);
expect(() => component.replaceState({}, 'no')).toThrow(stringMessage);
expect(() => component.forceUpdate('no')).toThrow(stringMessage);
var objectMessage =
'enqueueCallback(...): You called `setState`, `replaceState`, or '+
'`forceUpdate` with the last argument of type Object. When specified, ' +
'their last `callback` argument is expected to be a function.';
expect(() => component.setState({}, {})).toThrow(objectMessage);
expect(() => component.replaceState({}, {})).toThrow(objectMessage);
expect(() => component.forceUpdate({})).toThrow(objectMessage);
var fooMessage =
'enqueueCallback(...): You called `setState`, `replaceState`, or '+
'`forceUpdate` with the last argument of type Foo (keys: a, b). When ' +
'specified, their last `callback` argument is expected to be a function.';
expect(() => component.setState({}, new Foo())).toThrow(fooMessage);
expect(() => component.replaceState({}, new Foo())).toThrow(fooMessage);
expect(() => component.forceUpdate(new Foo())).toThrow(fooMessage);
});
});