Remove select() hack from getBlockEditingMode() #51359
Closed
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
noisysocks
added
[Type] Code Quality
noisysocks
force-pushed
the
fix/remove-select-hack-from-getBlockEditingMode
branch
from
328e324
to
41c2532
Compare
|
Size Change: -3 B (0%) Total Size: 1.39 MB
ℹ️ View Unchanged
|
|
Flaky tests detected in e9855d2. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/5218267083
|
jsnajdr
reviewed
Jun 9, 2023
| unlock( store ).registerPrivateActions( privateActions ); | ||
| unlock( store ).registerPrivateSelectors( privateSelectors ); | ||
|
|
||
| register( store ); |
There was a problem hiding this comment.
You need to keep the legacy registerStore here. Otherwise the persist plugin won't be active. It works by overriding the registerStore method of the registry and reading the persist option. If you call register, the plugin won't catch it.
This will be solved once we finish migration of the block-editor store to the preferences package. It's being worked on in #39632.
There was a problem hiding this comment.
Ah, bummer, I see.
I don't think we can remove this workaround yet then because if we do this:
export const store = createReduxStore( STORE_NAME, {
...storeConfig,
persist: [ 'preferences' ],
} );
unlock( store ).registerPrivateActions( privateActions );
unlock( store ).registerPrivateSelectors( privateSelectors );
registerStore( STORE_NAME, {
...storeConfig,
persist: [ 'preferences' ],
} );Then the private selectors are not callable from public selectors as they are not bound to the store that's created by registerStore.
(When I try it I get a Uncaught TypeError: selector.registry is undefined error on load.)
There was a problem hiding this comment.
I suppose we will wait until #39632 is merged!
There was a problem hiding this comment.
I did start looking at #39632 one again. I've rebased it and hope to push some further options this week.
There was a problem hiding this comment.
Then the private selectors are not callable from public selectors as they are not bound to the store that's created by
registerStore.
Oh, there are two gotchas at work here:
- Registering private selectors on the
storeobject is a noop, because the store is not instantiated from that object! It's just a store descriptor object that's exported so that users can pass it to functions likeselect( store )ordispatch( store ). The descriptor has an.instantiatemethod, but it's never called. TheregisterStorefunction creates a second store descriptor fromSTORE_NAMEandstoreConfig, and uses that internal one to actually instantiate the store. But that descriptor doesn't have any private selectors registered. - To get the private selectors pre-bound to the registry, they need to be registered after
createReduxStoreand before the.instantiatefunction is called, butregisterStorecalls them both within one statement:gutenberg/packages/data/src/registry.js
Line 310 in 4d0f303
| state.blockListSettings, | ||
| ] | ||
| export const getBlockEditingMode = createRegistrySelector( ( select ) => | ||
| createSelector( |
There was a problem hiding this comment.
This memoization won't work because createSelector is called again and again on each call of getBlockEditingMode, creating a new instance with its own memoization cache each time.
createRegistrySelector is like:
createRegistrySelector = ( selectorFactory ) => ( ...args ) => selectorFactory( registry.select )( ...args );I don't know how to solve this, maybe we'll need to patch createRegistrySelector to call the "factory" function only once.
jsnajdr
reviewed
Jun 9, 2023
| state.blocks.parents, | ||
| state.settings.templateLock, | ||
| state.blockListSettings, | ||
| ] |
There was a problem hiding this comment.
I'm not sure if memoizing this selector is even a good idea. This particular implementation won't catch changes in select( blockStore ).hasContentRoleAttribute( name ). It's very unlikely that a block's registration properties would change, but still.
The selector doesn't do any very complex calculation, and the return value is a string, which doesn't need an unique identity. Let's just remove the createSelector memoization.
noisysocks
added
the
[Feature] Page Content Focus
noisysocks
deleted the
fix/remove-select-hack-from-getBlockEditingMode
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.
What?
Now that #51051 is merged we can remove a hack that I added in #51148 to work around an issue with private registry selectors (described here: #50985).
Why?
Relying on the global
selectfunction is never ideal asselectmay differ if the selector is ran within a differentRegistryProvidercontext.How?
Use
createRegistrySelectoragain.The way that #51051 is designed means that we have to update
block-editorto register private selectors and actions before it registers the store.Despite the inline comment to the contrary I don't think using
register()instead ofregisterStore()will actually make any difference because both functions result in the same execution ofregisterStoreInstanceinternally.gutenberg/packages/data/src/registry.js
Lines 304 to 313 in f9e405e
gutenberg/packages/data/src/registry.js
Lines 282 to 286 in f9e405e
Testing Instructions
Same as in #50857.