withNotices: Memoize the noticeOperations object #29582
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
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.
Closed
3 tasks
ntsekouras
approved these changes
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
the
[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
The refactor of withNotices in #28676 introduced a bug where the
functions within
noticeOperationswere changing on every render. Thatmeant 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
noticeOperationsobject itself is being listed as adependency, and so the problem persists.
As suggested by @stokesman
#29491 (comment)
this change memoizes the whole object.
How has this been tested?
It's been manually tested in the same way as #29491. With the current release of Jetpack insert a podcast block. Before #29491, the block would be stuck in a loop. With this change it won't be. Similarly, the Instgram Gallery block will get stuck in a loop without this fix, but that has been fixed with Automattic/jetpack#19034
Types of changes
Bug fix - This hopefully makes
withNoticesbehave as before the refactorChecklist: