Block Editor: Fix ZoomOutModeInserters dependencies
#61908
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
tyxla
added
[Type] Code Quality
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
|
Size Change: +1 B (0%) Total Size: 1.74 MB
ℹ️ View Unchanged
|
ellatrix
reviewed
May 23, 2024
| @@ -51,8 +51,7 @@ function ZoomOutModeInserters() { | |||
| } | |||
| // reset insertion point when the block order changes | |||
| setInserterIsOpened( true ); | |||
| // eslint-disable-next-line react-hooks/exhaustive-deps | |||
| }, [ blockOrder ] ); | |||
| }, [ blockOrder, setInserterIsOpened ] ); | |||
There was a problem hiding this comment.
I'm pretty sure I added this because it was misbehaving, but I can't remember after all the changes. What happens theoretically when the function changes? We only want to reset it when the order changes, so maybe we have to check that in the effect.
There was a problem hiding this comment.
Will this ever happen? It looks like a stable reference to me, so I don't understand when it will change. Plus we also have the mounted check. Happy to abandon it if I'm missing something of course.
There was a problem hiding this comment.
Right, actions should be safe to list in dependencies. If they're not anymore, we might have a bigger problem 😅
P.S. It would be cool if linter treated Redux actions as state setters, but IIRC that involved a lot of work.
There was a problem hiding this comment.
Sure, if everything works fine. I could swear I added it for a reason 😅
There was a problem hiding this comment.
We don't know it's an action though, it's a setting, right? I don't love these "impure" dependencies that much tbh
There was a problem hiding this comment.
What George said. Thanks for verifying it, folks 🙌
|
Flaky tests detected in 9aa58b8. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/9209487465
|
ellatrix
approved these changes
May 23, 2024
carstingaxion
pushed a commit
to carstingaxion/gutenberg
that referenced
this pull request
Jun 4, 2024
Co-authored-by: tyxla <[email protected]> Co-authored-by: ellatrix <[email protected]> Co-authored-by: Mamaduka <[email protected]>
patil-vipul
pushed a commit
to patil-vipul/gutenberg
that referenced
this pull request
Jun 17, 2024
Co-authored-by: tyxla <[email protected]> Co-authored-by: ellatrix <[email protected]> Co-authored-by: Mamaduka <[email protected]>
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.
What?
This PR fixes the dependencies of one of
ZoomOutModeInserters'suseEffectcalls.Why?
From what I understand, there is no good reason not to provide
setInserterIsOpenedas a dependency:setInserterIsOpenedreference is a stable reference to a block editor store action function.The motivation is resolving an ESLint error that was raised by the React Compiler ESLint plugin in #61788
How?
By adding
setInserterIsOpenedas a dependency and removing the ESLint rule disabling.Testing Instructions
trunk(they look broken btw, but I'm not 100% sure how they are expected to look and work, cc @youknowriad)Testing Instructions for Keyboard
None
Screenshots or screencast
None