-
Notifications
You must be signed in to change notification settings - Fork 3.9k
[No QA] Implement Why Did You Render #4260
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
c87440b
implement wdyr
luacmartins cbbc75f
update readme
luacmartins 6edc03c
add ReportActionItem
luacmartins e756696
remove env check
luacmartins 14bfee9
track all components by default
luacmartins 901acd2
change defaults
luacmartins File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| // Implements Why Did You Render (WDYR) in Dev | ||
|
|
||
| import React from 'react'; | ||
| import Config from 'react-native-config'; | ||
| import lodashGet from 'lodash/get'; | ||
|
|
||
| const useWDYR = lodashGet(Config, 'USE_WDYR') === 'true'; | ||
|
|
||
| if (useWDYR) { | ||
| const whyDidYouRender = require('@welldone-software/why-did-you-render'); | ||
| whyDidYouRender(React, { | ||
| // Enable tracking in all pure components by default | ||
| trackAllPureComponents: true, | ||
|
|
||
| include: [ | ||
| // Uncomment to enable tracking in all components. Must also uncomment /^Screen/ in exclude. | ||
| // /.*/, | ||
|
|
||
| // Uncomment to enable tracking by displayName, e.g.: | ||
| // /^Avatar/, | ||
| // /^ReportActionItem/, | ||
| // /^ReportActionItemSingle/, | ||
| ], | ||
|
|
||
| exclude: [ | ||
| // Uncomment to enable tracking in all components | ||
| // /^Screen/ | ||
| ], | ||
| }); | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this be
false(the default)? PureComponent seems like the least likely to be re-rendering for bad reasons?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
After doing more research and seeing this comment from one of the creators, it seems that tracking pure components by default is a better idea, as they might control big render trees.
So I will keep that as the default, but I also included a way to enable tracking in all components, as well as examples to enable tracking by component
displayName.Screenmust be excluded when tracking all components to avoid the following error that crashes the app:Uncaught Error: A navigator can only contain 'Screen', 'Group' or 'React.Fragment' as its direct children (found 'WDYRFunctionalComponent' for the screen 'Home'). To render this component in the navigator, pass it in the 'component' prop to 'Screen'.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok that works. Weird about the
Screencomponent. Must have used this last before we added react navigation.