(edit-post)(preferences)(workaround) Keep openPanels and inactivePanels preferences in the core/edit-post` scope to satisfy existing consumers
#57988
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
…ences in the `core/edit-post` scope for backwards compatibility
fullofcaffeine
added
the
[Type] Bug
|
Size Change: +7 B (0%) Total Size: 1.7 MB
ℹ️ View Unchanged
|
|
Flaky tests detected in 56d7e5f. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/7577237840
|
|
Heads up for @carolinan @afercia @aristath on the yoast side of things! |
andrewserong
approved these changes
Jan 19, 2024
There was a problem hiding this comment.
Thanks for getting this PR up so quickly @fullofcaffeine!
I imagine there's a couple of contributing factors to Yoast breaking in this way:
- The assumption that consumers would be using the isEditorPanelOpened selector instead of accessing the preferences store directly. It looks like Editor: Move the panel visibility state from the edit-post to the editor package #57012 from @youknowriad was intended to ensure backwards compat for that selector, so it sounds like we've been assuming that's what consumers were using?
- That Yoast wasn't using optional chaining in its handling, whereas Gutenberg uses
openPanels?.includes( panelName );
It'd be good to confirm with @youknowriad about what the right approach for consumers should be here. But for now, this PR resolves the issue for me while running Yoast, and updating the open panels preferences is still working nicely, so this LGTM for now. I suspect Yoast will still need to update their code to ensure things work smoothly in the future.
I'll just CC @talldan here, too, since he's done a lot of work on preferences.
| Before | After |
|---|---|
 |
 |
|
I'm not sure about this fix, as while it stops the fatal error happening, the plugin is still broken and they won't necessarily know there's something wrong until they discover the user facing issue. (edit: though I guess if something needs to ship quickly this would be ok as a short term solution that we remove later) @andrewserong makes some good points. A recommendation to yoast would be to use the In terms of remediation for the backwards compatibility, I have mixed feelings about it. One solution would be to add some kind of proxy in place so that |
|
Here's a quickly thrown together branch showing the idea, I haven't tested whether it works or anything, but it shows how the API might work from a code point of view: One issue is that not every preference has been migrated, so for some of them it doesn't make sense to proxy. I'm not sure if the plan is to migrate every preference for 6.5. If not, this is probably where my idea might fall short. We could make the API granular enough so that it's per-preference, but that starts getting more complicated. |
|
Interesting, I didn't think that this was necessary but folks are apparently accessing these preferences directly. I kind agree with @talldan that this is not the right fix, we should instead make sure that |
fullofcaffeine
changed the title
openPanels and inactivePanels preferences in the core/edit-post` scope to satisfy existing consumersopenPanels and inactivePanels preferences in the core/edit-post` scope to satisfy existing consumers
Thanks for the feedback! That's a good point. I knew this smelled in this sense, but I didn't know enough about the change and code around it to get a proper fix up. Hence why I added this part to the description: |
|
Closed in favor of #58016. |
This was referenced Jan 19, 2024
Merged
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?
Keep the
openPanelsandinactivePanelspreferences in thecore/edit-postscope - in addition to thecorescope (to which they were moved in #57529) to keep the old interface that some consumers expect.Why?
Consumers might still expect these preferences to be found in
core/edit-postscope. If the setting is not found, it could cause an unhandled exception and break the functionality. This is the case with Yoast - it consumes theopenPanelspreference like this:Since
select('core/preferences').get('core/edit-post', 'openPanels')returnsundefinedafter the recent changes, the.includes('yoast-seo/document-panel')call leads to aTypeError, disrupting the code flow and causing issues with the Yoast metabox rendering (since nothing is guarding against that, i.e optional chaining). See the screenshot down below.How?
This workaround keeps the
openPanelsproperty in the object passed as an argument to thedispatch( preferencesStore ).setDefaults( 'core/edit-post', ... )call. @andrewserong also suggested defining the relatedinactivePanelsproperty too.This PR is meant to illustrate a temporary workaround that fixes the Yoast issue and also to trigger a discussion about a definitive solution. Some questions come to mind:
corescope incore/edit-post? See editorMode and hiddenBlockTypes.Testing Instructions
trunkand build Gutenberg from it, install/sync this version to the site;Screenshots or screencast
trunk