Skip to content

Don't call componentDidUpdate() in shallow renderer #10372

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
merged 3 commits into from
Aug 3, 2017
Merged

Don't call componentDidUpdate() in shallow renderer #10372

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
62fd178
Don't call componentDidUpdate() in shallow renderer
gaearon Aug 3, 2017
e84052d
Lint
gaearon Aug 3, 2017
6450c9c
Consistent comments
gaearon Aug 3, 2017
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
19 changes: 4 additions & 15 deletions src/renderers/testing/ReactShallowRendererEntry.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,17 +136,12 @@ class ReactShallowRenderer {
}

this._rendered = this._instance.render();

// Calling cDU might lead to problems with host component references.
// Since our components aren't really mounted, refs won't be available.
// if (typeof this._instance.componentDidMount === 'function') {
// this._instance.componentDidMount();
// }
// Intentionally do not call componentDidMount()
// because DOM refs are not available.
}

_updateClassComponent(props, context) {
const oldProps = this._instance.props;
const oldState = this._instance.state;

if (
oldProps !== props &&
Expand Down Expand Up @@ -180,14 +175,8 @@ class ReactShallowRenderer {
this._instance.state = state;

this._rendered = this._instance.render();

// The 15.x shallow renderer triggered cDU for setState() calls only.
if (
oldState !== state &&
typeof this._instance.componentDidUpdate === 'function'
) {
this._instance.componentDidUpdate(oldProps, oldState);
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: Might be nice to leave a placeholder comment referencing why we decided not to call cDU

// Intentionally do not call componentDidUpdate()
// because DOM refs are not available.
}
}

Expand Down
9 changes: 2 additions & 7 deletions src/renderers/testing/__tests__/ReactShallowRenderer-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,7 @@ describe('ReactShallowRenderer', () => {
const instance = shallowRenderer.getMountedInstance();
instance.setState({});

// The previous shallow renderer triggered cDU for setState() calls.
expect(logs).toEqual([
'shouldComponentUpdate',
'componentWillUpdate',
'componentDidUpdate',
]);
expect(logs).toEqual(['shouldComponentUpdate', 'componentWillUpdate']);

logs.splice(0);

Expand Down Expand Up @@ -407,7 +402,7 @@ describe('ReactShallowRenderer', () => {
updatedState,
updatedContext,
]);
expect(componentDidUpdateParams).toEqual([initialProp, initialState]);
expect(componentDidUpdateParams).toEqual([]);
});

it('can shallowly render components with ref as function', () => {
Expand Down