Updating the BlockEditorProvider settings prop should reset the store's settings entirely #51904
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
…'s setting entirely
youknowriad
added
the
[Type] Bug
|
Size Change: +1.31 kB (0%) Total Size: 1.44 MB
ℹ️ View Unchanged
|
getdave
approved these changes
Jun 27, 2023
Comment on lines
38
to
39
| stripExperimentalSettings = false, | ||
| reset = false |
There was a problem hiding this comment.
Suggested change
| stripExperimentalSettings = false, | |
| reset = false | |
| { | |
| stripExperimentalSettings = false, | |
| reset = false | |
| } |
Nit: these positional arguments are growing and require reading the source of the function in order to understand what a given call is doing.
For example what does true do here (I know the answer but only because I'm reviewing this PR)?
__experimentalUpdateSettings(
{
...settings,
__internalIsInitialized: true,
},
stripExperimentalSettings
stripExperimentalSettings,
true
);Perhaps we can consider rewriting to use an object?
There was a problem hiding this comment.
Sure, it's a private action though, we can change our mind at any time.
There was a problem hiding this comment.
Doesn't need to happen now of course.
|
Flaky tests detected in fd15da0. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/5389827490
|
|
Thank you 🥇 |
sethrubenstein
pushed a commit
to pewresearch/gutenberg
that referenced
this pull request
Jul 13, 2023
…'s settings entirely (WordPress#51904) Co-authored-by: Dave Smith <[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.
closes #51489
What?
If you render a block editor provider with a special setting (like template) and then you update your prop and omit that particular setting, you expect that setting to restore to the default value (undefined) instead of retaining the previous prop value. This PR ensures that any change to the
settingsprop ofBlockEditorProvideractually resets the settings entirely.This bug was discovered in #39286 (comment)
Testing Instructions
Switch between "Navigation" and other entities in the site editor (templates). Template locking should remain active when doing so. You should be able to edit top level blocks in the template.