withNotices: Ensure that the callback props are stable. #29491
Merged
Conversation
This file contains 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
|
I tested and it looks good to me, but I'd like to get other opinions. @stokesman would you be able to take a look too? Thanks in advance :-) |
stokesman
reviewed
Mar 3, 2021
stokesman
approved these changes
Mar 3, 2021
retrofox
approved these changes
Mar 3, 2021
|
Tested and it works as expected. Merging since Paul doesn't have access to merge yet. |
youknowriad
added
the
[Type] Code Quality
Closed
3 tasks
pablinos
added a commit
to pablinos/gutenberg
that referenced
this pull request
Mar 5, 2021
The refactor of withNotices in WordPress#28676 introduced a bug where the functions within `noticeOperations` were changing on every render. That meant that if they were present in the dependency array of a useEffect, then the effect would trigger causing an infinite loop. This was partially fixed with WordPress#29491, but there are other instances where the noticeOperations object itself is being listed as a dependency, and so the problem persists. As suggested by @stokesman WordPress#29491 (comment) this change memoizes the whole object.
7 tasks
ntsekouras
pushed a commit
that referenced
this pull request
Mar 5, 2021
The refactor of withNotices in #28676 introduced a bug where the functions within `noticeOperations` were changing on every render. That meant that if they were present in the dependency array of a useEffect, then the effect would trigger causing an infinite loop. This was partially fixed with #29491, but there are other instances where the noticeOperations object itself is being listed as a dependency, and so the problem persists. As suggested by @stokesman #29491 (comment) this change memoizes the whole object.
ntsekouras
pushed a commit
that referenced
this pull request
Mar 5, 2021
ntsekouras
pushed a commit
that referenced
this pull request
Mar 5, 2021
The refactor of withNotices in #28676 introduced a bug where the functions within `noticeOperations` were changing on every render. That meant that if they were present in the dependency array of a useEffect, then the effect would trigger causing an infinite loop. This was partially fixed with #29491, but there are other instances where the noticeOperations object itself is being listed as a dependency, and so the problem persists. As suggested by @stokesman #29491 (comment) this change memoizes the whole object.
youknowriad
added
[Type] Bug
24 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
In #28676
withNoticeswas refactored to as a functional component. In the Jetpack podcast player block, the functions supplied as props were being used within a function calling the API. This essentially meant they became a dependency of theuseEffecthook and caused the API call to happen in a loop.If these are used in hooks elsewhere it would also cause a loop as the function references change on each render.
This change constructs each of the
noticeOperationsusinguseCallbackto memoize them and prevent any unnecessary rerenders.How has this been tested?
This has been tested in conjunction with the latest release of Jetpack. The bug can be seen by inserting a podcast block into a post and setting the podcast feed URL. With this PR the loop is removed.
Screenshots
Types of changes
Bug fix - It makes
withNoticesbehave more as it did before the refactor.Checklist: