Fix 'Preferences' and 'Shortcuts' commands in StrictMode #64019
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
Mamaduka
added
[Type] Bug
|
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: 0 B Total Size: 1.76 MB ℹ️ View Unchanged
|
t-hamano
approved these changes
Jul 27, 2024
There was a problem hiding this comment.
LGTM! This change makes sense to me.
If I comment on the logic for "dismissers," the modal opens correctly.
I found an article that said React 18 intentionally remounts components when Strict Mode is on.
Maybe this is related.
Adding
<StrictMode>to a React application adds special behavior (only in DEV mode) to all of components it wraps around. For example, when running in “strict mode“ React will intentionally double-render components for in order to flush out unsafe side effects.
From: Adding Reusable State to StrictMode · reactwg/react-18 · Discussion #19
Yes, it does, to help developers discover potential bugs. The documentation page explains the reasoning behind it pretty well - https://react.dev/reference/react/StrictMode. |
|
I’d wanted to try debugging the effect that George highlighted but I've not been able to reproduce the issue. It seems like React is running in production mode for me and I can’t figure out why. Logging |
|
@stokesman, check if these constants are set to true WP_DEBUG and SCRIPT_DEBUG. Basically, React needs to load in development mode for StrictMode to be active. |
|
Thank you George. That makes sense and now I finally read the instructions where you already mentioned it 🤦. I made a #64075 with what should be a proper fix. |
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?
Closes #64004.
PR fixes a bug where the "Editor Preferences" or "Keyboard shortcuts" modal will close immediately when opening from the command palette. There's no modal flash, so it looks like the commands never run.
Note: While this fix is correct, it still fixes a symptom, not the actual cause. I've included more details below.
Why?
I noticed that
onRequestClosecallbacks are called for both models as soon as they open. This led me to "dismissers" logic in the Modal component, introduced in #51602. If I comment on the logic for "dismissers," the modal opens correctly. It seems that this side effect isn't resilient for the StrictMode.gutenberg/packages/components/src/modal/index.tsx
Lines 152 to 166 in 159d01a
How?
Explicitly close the command palette dialog before opening other models. This matches other
callbackcalls in the file.Testing Instructions
WP_DEBUG = trueandSCRIPT_DEBUG = true.Testing Instructions for Keyboard
Same