SlotFill: replace valtio with custom ObservableMap #60879
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
jsnajdr
added
[Type] Enhancement
|
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: -2.15 kB (0%) Total Size: 1.74 MB
ℹ️ View Unchanged
|
|
This makes the select block/focus metric 20-30% faster! Thank you so much for this change! |
youknowriad
approved these changes
Apr 19, 2024
|
Wow, nice! |
tyxla
approved these changes
Apr 19, 2024
| }; | ||
| } | ||
|
|
||
| export function useObservableValue< K, V >( |
There was a problem hiding this comment.
I'm not particularly convinced this belongs here, but if we don't need it outside of the component for now, that should be fine.
| subscribe( name: K, listener: () => void ): () => void; | ||
| }; | ||
|
|
||
| export function observableMap< K, V >(): ObservableMap< K, V > { |
There was a problem hiding this comment.
Maybe it would be nice to add some inline docs and/or some tests.
ellatrix
reviewed
Apr 19, 2024
| [ map, name ] | ||
| ); | ||
| return useSyncExternalStore( subscribe, getValue ); | ||
| } |
There was a problem hiding this comment.
I wonder if we could use this for block refs too: https://github.com/WordPress/gutenberg/blob/trunk/packages/block-editor/src/components/block-list/use-block-props/use-block-refs.js
And maybe there are more places?
There was a problem hiding this comment.
Let me figure out what useBlockRefs does 🙂
ellatrix
reviewed
Apr 19, 2024
| }, | ||
| subscribe( name, listener ) { | ||
| const list = listeners.get( name ) || []; | ||
| listeners.set( name, [ ...list, listener ] ); |
There was a problem hiding this comment.
Is it bad to mutate the array?
There was a problem hiding this comment.
I think this is for getValue to return a different array. Otherwise, useSyncExternalStore won't know that data has changed.
There was a problem hiding this comment.
I just replaced the array with a Set, doing .add and .delete operations on it.
There was a problem hiding this comment.
I think this is for
getValueto return a different array.
It would be OK if the listeners map contained an array that is mutated with .push and .splice. Instead of creating and setting a new immutable array with ... and .filter. But when I looked around at other event emitter implementation in Gutenberg, I found that using a Set is best.
ellatrix
reviewed
Apr 19, 2024
| } | ||
| list.add( listener ); | ||
|
|
||
| return unsubscribe( name, listener ); |
There was a problem hiding this comment.
Wouldn't it be possible to avoid having to get the list again if it's inlined? Or can it disappear/change some other way?
There was a problem hiding this comment.
Good idea, will do in a followup 👍
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.
This PR removes usage of the
valtiolibrary from theSlotFillregistry and replaces it with our ownObservableMapobject. It's a map where each entry (keyed by slotname) can be individually and independently observed for changes by calling asubscribe( name, listener )function. AuseObservableValue( name )then observes just thenameslot in the registry and is unaffected by others.It was always unclear that this is actually what
valtiois doing and one was left wondering what other magic is going on there.@Mamaduka and @jeryj has some questions recently (#59884 (comment)) about
SlotFilldetails, hopefully this answers them at least partially.