Migrate interface enableItems data to preferences package
#39449
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
talldan
added
[Type] Enhancement
18 tasks
|
Size Change: -882 B (0%) Total Size: 1.21 MB
ℹ️ View Unchanged
|
talldan
force-pushed
the
migrate/interface-enable-items-to-preferences-package
branch
2 times, most recently
from
c4c4de7
to
2e201bb
Compare
talldan
commented
Mar 17, 2022
| export const disableComplementaryArea = ( scope ) => ( { registry } ) => { | ||
| registry | ||
| .dispatch( preferencesStore ) | ||
| .set( scope, 'complementaryArea', null ); |
There was a problem hiding this comment.
Looking at the diff, this might seem like I'm changing the value from undefined to null, but the reducer for setSingleEnableItem was coercing the undefined into null, so the new code is equivalent.
It's a shame that null has to be used because it will be serialized to local storage, but the complementary areas use the difference between null and undefined to determine if the sidebar has never been opened and whether it should open by default:
gutenberg/packages/interface/src/components/complementary-area/index.js
Lines 131 to 135 in 79cacc5
|
This should be ready for review now. |
talldan
commented
Mar 17, 2022
| @@ -10,5 +10,5 @@ | |||
| */ | |||
| export function get( state, scope, name ) { | |||
| const value = state.preferences[ scope ]?.[ name ]; | |||
| return value ?? state.defaults[ scope ]?.[ name ]; | |||
| return value !== undefined ? value : state.defaults[ scope ]?.[ name ]; | |||
There was a problem hiding this comment.
This is unfortunately needed because of how complementaryAreas rely on null and undefined being distinct values.
| @@ -1,7 +1,7 @@ | |||
| /** | |||
| * External dependencies | |||
| */ | |||
| import { merge, isPlainObject } from 'lodash'; | |||
| import { merge, isPlainObject, reduce } from 'lodash'; | |||
There was a problem hiding this comment.
wasn't there a push to use native methods when available instead of lodash?
There was a problem hiding this comment.
I'll see if I can remove it 👍
| * }, | ||
| * } | ||
| * ``` | ||
| * |
There was a problem hiding this comment.
Thanks for the clear documentation 🎉
| // merged. | ||
| const sourceComplementaryAreas = | ||
| sourceEnableItems?.singleEnableItems?.complementaryArea; | ||
| const convertedComplementaryAreas = reduce( |
There was a problem hiding this comment.
Complementary Area seems like a strange description, out of interest do you know what is meant by 'Complementary' in this instance?
There was a problem hiding this comment.
There are some docs - https://github.com/WordPress/gutenberg/tree/trunk/packages/interface#complementary-areas.
I agree, I don't think it's the best name. I think the problem is that most people (myself included) won't know what it means for it to be complementary. Even after I've read the docs I have a hard time remembering or understanding.
It might be better if it were just called area or interfaceArea. Then the action would be showItemInArea, which is a lot clearer to me.
There are a few public APIs with this naming now so it's a little hard to roll back on.
There was a problem hiding this comment.
hmm, yeh, I would need to go back and re-read that description each time as well - but not critical enough to warrant a public API change.
|
This tested well for me, in both the post editor using the suggested steps, and also in the site editor with the global styles panel setting. I have left a couple of comments, both questions for my own interest mostly, happy to approve if I am mistaken about |
… instead of unsetting the preference
talldan
force-pushed
the
migrate/interface-enable-items-to-preferences-package
branch
from
51e05d4
to
f5d48c2
Compare
talldan
deleted the
migrate/interface-enable-items-to-preferences-package
branch
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.
Part of #31965
What?
Removes the final piece of
persistedStatefrom the interface package by migrating theenableItemsdata to the preferences store.This feature was implemented in an interesting way, using some reducers called
singleEnableItems(forcomplementaryAreastate) andmultipleEnableItems(forpinnedItemstate) and it seems like the intention might have been for theinterfacepackage to be an abstract way of handling the state of different types of UI. In this PR I remove that abstraction and just store the data aspinnedItemsandcomplementaryArea😄Why?
As outlined in #31965, the goal is to move persisted data out of our various stores to a centralized preferences store.
To explain a bit more about why I removed the
singleEnableItemsandmultipleEnableItemsconcepts. I thinkpreferencesis already a generic data store, and so these abstractions no longer seem required. Other interfaces that need to persist state can do so by using the preferences store directly. It also simplifies how these features work.How?
Uses a migration function to migrate the persisted
localStoragedata. The selectors now select from and actions dispatch to the preferences store.The
interfacepackage no longer has a reducer for its store, which is a bit weird, but the selectors and actions need to be kept around for backwards compatibility.Testing Instructions
I found the easiest way to test it to use my test environment and enable the 'Gutenberg Test Plugin, Plugins API' plugin. Then:
trunk