Edit Site: Fix settings mutation in ScreenBlock#67085
Merged
Merged
Conversation
tyxla
added
[Type] Code Quality
tyxla
requested review from
a team,
Mamaduka,
aaronrobertshaw,
andrewserong,
ramonjd and
youknowriad
|
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. |
Mamaduka
approved these changes
Nov 18, 2024
|
Size Change: +38 B (0%) Total Size: 1.82 MB
ℹ️ View Unchanged
|
Member
Author
|
Failing e2e tests seem related. I'll be taking a look (likely tomorrow). |
tyxla
force-pushed
the
fix/screen-block-settings-mutation
branch
from
9b3e253 to
6e5ee3a
Compare
Member
Author
Actually, fixed, it was a silly bug. @Mamaduka could you take another look when you get a chance? |
|
Flaky tests detected in 6e5ee3a. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/11894960106
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 a mutation that we're performing in
ScreenBlockand updates to use a new object instead.Why?
Mutating objects could lead to subtle bugs.
In this particular case, I'm fixing it to resolve an ESLint error that was raised by the React Compiler ESLint plugin in #61788
How?
Using a new object instead of mutating the existing one.
Since this already memoized object is used in plenty of places, I'm introducing some memoization to preserve the original behavior and have as little performance impact as possible. We're using boolean flags to ensure the change happens only if necessary.
The fix isn't ideal. Ideally, this should be part of the
useSettingsForBlockElement()hook; however, I'm concerned that this hook is used in a few other places, but the workarounds are only in one of them. That's why I chose to do it inline and preserve the pre-existing behavior. I'm planning to monitor performance metrics after shipping.Testing Instructions
Testing Instructions for Keyboard
None
Screenshots or screencast
None