Memoize the getTemplateInfo selector #60200
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] Code Quality
jsnajdr
commented
Mar 26, 2024
| return { | ||
| title: _templateInfo?.title || getEditedPostAttribute( 'title' ), | ||
| modified: getEditedPostAttribute( 'modified' ), | ||
| id: _id, | ||
| templateInfo: __experimentalGetTemplateInfo( _record ), | ||
| templateInfo: _templateInfo, |
There was a problem hiding this comment.
Here the original code looked wrong. Create a _templateInfo variable that is never assigned to, access the _templateInfo?.title field that is never there...
| getEditorSettings( state )?.defaultTemplatePartAreas || []; | ||
| return areas?.map( ( item ) => { | ||
| getEditorSettings( state )?.defaultTemplatePartAreas ?? []; | ||
| return areas.map( ( item ) => { |
There was a problem hiding this comment.
areas is always defaulted to an array, no need for optional ?. operator.
| @@ -1730,7 +1730,7 @@ export const __experimentalGetDefaultTemplateType = createSelector( | |||
| ) ?? EMPTY_OBJECT | |||
| ); | |||
| }, | |||
| ( state, slug ) => [ __experimentalGetDefaultTemplateTypes( state ), slug ] | |||
| ( state ) => [ __experimentalGetDefaultTemplateTypes( state ) ] | |||
There was a problem hiding this comment.
slug is a redundant dependant, because it's a selector parameter. When createSelector stores the memoized values, they are automatically keyed by the parameters.
Having slug there can also defeat the memoization, because there is a "reset the cache when dependants change" logic.
|
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: +9 B (0%) Total Size: 1.72 MB
ℹ️ View Unchanged
|
tyxla
approved these changes
Mar 26, 2024
| return { | ||
| title: _templateInfo?.title || getEditedPostAttribute( 'title' ), | ||
| modified: getEditedPostAttribute( 'modified' ), | ||
| id: _id, | ||
| templateInfo: __experimentalGetTemplateInfo( _record ), | ||
| templateInfo: _templateInfo, |
Comment on lines
+91
to
+92
| { description && <Text>{ description }</Text> } | ||
| { lastEditedText && ( |
There was a problem hiding this comment.
Nice. These are definitely not numbers and 0s won't be displayed, so no need for the boolean conversion.
| @@ -1701,8 +1701,8 @@ export function __experimentalGetDefaultTemplateTypes( state ) { | |||
| export const __experimentalGetDefaultTemplatePartAreas = createSelector( | |||
| ( state ) => { | |||
| const areas = | |||
| getEditorSettings( state )?.defaultTemplatePartAreas || []; | |||
| return areas?.map( ( item ) => { | |||
| getEditorSettings( state )?.defaultTemplatePartAreas ?? []; | |||
There was a problem hiding this comment.
Agreed with the change. TBH I'm not sure why it was treated as a boolean when the relevant filter should always return an array: https://developer.wordpress.org/reference/hooks/default_wp_template_part_areas/
The nullish coalescing makes sense to me, and just to verify, I don't see any non-array usage in the plugin directory: https://wpdirectory.net/search/01HSXFV2V357M8WP7R5AA5NWGE
| @@ -1730,7 +1730,7 @@ export const __experimentalGetDefaultTemplateType = createSelector( | |||
| ) ?? EMPTY_OBJECT | |||
| ); | |||
| }, | |||
| ( state, slug ) => [ __experimentalGetDefaultTemplateTypes( state ), slug ] | |||
| ( state ) => [ __experimentalGetDefaultTemplateTypes( state ) ] | |||
carstingaxion
pushed a commit
to carstingaxion/gutenberg
that referenced
this pull request
Mar 27, 2024
Co-authored-by: jsnajdr <jsnajdr@git.wordpress.org> Co-authored-by: tyxla <tyxla@git.wordpress.org>
cbravobernal
pushed a commit
to garridinsi/gutenberg
that referenced
this pull request
Apr 9, 2024
Co-authored-by: jsnajdr <jsnajdr@git.wordpress.org> Co-authored-by: tyxla <tyxla@git.wordpress.org>
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.
I noticed there is a "The useSelect hook returns different values when called with the same state" warning in the console when the
PostCardPanelcomponent is rendered. Because it calls thegetTemplateInfoselector and that selector is not memoized, returns a newtemplateInfocall on each call.This PR adds the memoization and also adds a few little drive-by fixups in nearby code (see individual comments).
How to test: Start editing "Blog Home" in the Site Editor, and make sure this
PostCardPanelis rendered:Before this PR, you'll see a console warning. After this PR, the warning should disappear.