Fix fetching Nav fallback ID flushing Navigation entity cache #52069
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
|
@scruffian @draganescu One problem I have with this is, if you have no Navigation Menus and then you load the Site Editor then the fallback gets requested and then that flushes the cache for It's like what we want is to say "hey there are new records available in state, but don't worry about going back to the network". But we are actually saying "hey there are new records in state but also go to the network and double check for no reason". I wonder if we're "doing it wrong"? |
|
Size Change: -16.4 kB (-1%) Total Size: 1.44 MB
ℹ️ View Unchanged
|
|
It feels like we should just tie the fallback in to the main endpoint - if you fetch all navigations from the API and you don't have any, lets just call the fallback and return it. |
This was discussed in #48698 (see PR description). We decided not to do that because it breaks Rest API paradigm for Post Controller which is what Navigation uses under the hood. |
This comment was marked as resolved.
This comment was marked as resolved.
getdave
commented
Jun 29, 2023
getdave
commented
Jun 29, 2023
getdave
added
Backport to WP 6.7 Beta/RC
…ine whether we should invalidate the recordds
scruffian
approved these changes
Jun 29, 2023
|
I'm happy. @draganescu are you? If so please go ahead and merge 🙏 |
draganescu
approved these changes
Jun 29, 2023
|
Flaky tests detected in dcadb54. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/5410968673
|
scruffian
deleted the
fix/preserve-navigation-entity-cache-sideloading-fallback-id
branch
This comment was marked as off-topic.
This comment was marked as off-topic.
So our problem was that So I don't think that adding cache invalidation to I looked at the If i've misunderstood please let me know. |
tellthemachines
pushed a commit
that referenced
this pull request
Jul 3, 2023
* Only flush the `getEntityRecords` cache if the fallback isn’t already in state * Save the edited entity record to a const and then invert it to determine whether we should invalidate the recordds --------- Co-authored-by: scruffian <ben@scruffian.com>
|
I just cherry-picked this PR to the update/wp6-3-beta3 branch to get it included in the next release: b8229fe |
tellthemachines
removed
the
Backport to WP 6.7 Beta/RC
|
Thanks for explaining the issue @getdave. This PR looks good, yes. |
tellthemachines
added a commit
that referenced
this pull request
Jul 3, 2023
* Footnotes: inscrease selector specificity for anchor (#52179) * Patterns: Include template parts for custom areas in Uncategorized category (#52159) * Fix custom patterns console error (#51947) * Fix error with react list key with new custom patterns list in inserter * Update placeholder key * Add comment to explain the different keys * Patterns: Fix missing custom patterns in patterns explorer (#51889) * Add custom patterns to pattern explorer * show custom patterns in the patterns explorer dialog * remove changes from 51877 * Fix up use of async lists * remove a bit of code duplication by adding a new hook * add 51877 fix back to make testing easier * Just assign the key value in one place * Refactor the custom patterns to use the usePatternsState hook * Fix use of async list * Translate strings and remove unneeded fields from pattern object * Try integrating unsynced patterns directly into pattern selectors (#51955) * Include reusable blocks with an undefined sync status in inserter items * Update docs * Remove change to hover dependencies --------- Co-authored-by: Daniel Richards <daniel.richards@automattic.com> * i18n: Add context to the word "Filters" (#52198) * Update home template icon (#52075) * Centralise all permissions lookup in Link UI and enable (#52166) * BlockRemovalWarningModal: Fix incorrect '_n' usage (#52164) * Fix fetching Nav fallback ID flushing Navigation entity cache (#52069) * Only flush the `getEntityRecords` cache if the fallback isn’t already in state * Save the edited entity record to a const and then invert it to determine whether we should invalidate the recordds --------- Co-authored-by: scruffian <ben@scruffian.com> * Block Editor: Unify texts for Create pattern modal (#52151) * Fix history back after entering edit mode from Patterns (#52112) * Add template part icons to the library grid items (#51963) * Patterns: Fix sidebar tab label (#51953) * Patterns: Fix setting of sync status for fully synced patterns (#51952) * Library: Reinstate manage all template parts page (#51961) * Command Palette: fix incorrect path and snackbar message when template part is deleted (#52034) * Command Center: Fix incorrect navigation when deleting template part * removeTemplate: consider title type * Drop-indicator: remove white border. (#52122) * Make Navigation fallback selector private (#51413) * Move selector to become private * adds basic lock functionality * remove useless lock-unlock file * map private selectors to resolvers * Unlock the other usage * only create one fallback per session * Fix core-data duplicate private opt-in * Data: bind resolvers to selectors individually, support private selectors --------- Co-authored-by: Andrei Draganescu <andrei.draganescu@automattic.com> Co-authored-by: scruffian <ben@scruffian.com> Co-authored-by: Jarda Snajdr <jsnajdr@gmail.com> * Focus Mode: Use the symbol icon if a pattern is being edited (#52031) * Footnotes: register meta field for pages (#52024) * Fix unintentional toggling on of distraction free (#52090) * replace toggle with set preference - because I don't read code properly it seems * remove notification * Revert "Updating social link attributes (#51997)" (#52019) This reverts commit c711e2a. * Update home template name (#52048) * Removes unused call (#51988) * Remove ability for user to toggle sync status after pattern creation (#51998) * Fix disable DFM when opening styles command (#52165) * Update custom patterns label to 'My patterns' (#51949) * rename custom patterns to my patterns * Add my patterns label to inserter and show at the top --------- Co-authored-by: Daniel Richards <daniel.richards@automattic.com> * Library: Add sync status to pattern details screen (#51954) * Patterns: Rename Library to Patterns (#52102) * [Library] Add lock icon for theme patterns (#51990) * Add lock icon for theme patterns * Change to class names * Add aria-description * Change wording * Patterns: Use "detached" copy consistently (#51993) * Editor initrial appender: Zero out margins in constrained layouts. (#52026) * Update pattern creation modal in library (#51946) * Fix missing snackbars in Library (#52021) * Make the entire preview clickable in order to enter "edit" mode in focus mode (#51973) * Page Content Focus: Add welcome guides (#52014) * Page Content Focus: Add welcome guides * Don't show when editor guide is active * Just use regular accent/theme color in all guides * slight copy change page guide * Update components changelog * Disable new guides in E2E tests * Use s.w.org videos --------- Co-authored-by: Saxon Fletcher <saxonafletcher@gmail.com> --------- Co-authored-by: Ella <4710635+ellatrix@users.noreply.github.com> Co-authored-by: Aaron Robertshaw <60436221+aaronrobertshaw@users.noreply.github.com> Co-authored-by: Glen Davies <glendaviesnz@users.noreply.github.com> Co-authored-by: Daniel Richards <daniel.richards@automattic.com> Co-authored-by: Aki Hamano <54422211+t-hamano@users.noreply.github.com> Co-authored-by: James Koster <james@jameskoster.co.uk> Co-authored-by: Dave Smith <getdavemail@gmail.com> Co-authored-by: George Mamadashvili <georgemamadashvili@gmail.com> Co-authored-by: scruffian <ben@scruffian.com> Co-authored-by: Kai Hao <kevin830726@gmail.com> Co-authored-by: Carolina Nymark <myazalea@hotmail.com> Co-authored-by: Joen A <1204802+jasmussen@users.noreply.github.com> Co-authored-by: Andrei Draganescu <andrei.draganescu@automattic.com> Co-authored-by: Jarda Snajdr <jsnajdr@gmail.com> Co-authored-by: Andrei Draganescu <me@andreidraganescu.info> Co-authored-by: Ramon <ramonjd@users.noreply.github.com> Co-authored-by: Nik Tsekouras <ntsekouras@outlook.com> Co-authored-by: Saxon Fletcher <saxonafletcher@gmail.com> Co-authored-by: Rich Tabor <hi@richtabor.com> Co-authored-by: Robert Anderson <robert@noisysocks.com>
|
This was merged in time for GB 16.2 RC 1, so no need for backporting to Gutenberg RC. |
ockham
removed
the
Backport to Gutenberg RC
sethrubenstein
pushed a commit
to pewresearch/gutenberg
that referenced
this pull request
Jul 13, 2023
…ess#52069) * Only flush the `getEntityRecords` cache if the fallback isn’t already in state * Save the edited entity record to a const and then invert it to determine whether we should invalidate the recordds --------- Co-authored-by: scruffian <ben@scruffian.com>
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?
Adds safety catch to
getNavigationFallbackIdresolver to avoid flushing Navigation entities cache if the retrieved fallback post ID is already in state.Co-authored-by: Andrei Draganescu 107534+draganescu@users.noreply.github.com
Co-authored-by: Ben Dwyer 275961+scruffian@users.noreply.github.com
Why?
Currently if a call to
getNavigationFallbackIdwhen there are already Navigation entities will still cause the entire cache forgetEntityRecords('postType','wp_navigation')to be flushed. This triggers an unwanted additional network request to re-fetch the entities when it's not needed.This PR fixes that.
How?
It fixes it by checking whether the post that's returned as the "fallback" already exists in Core Data. If it does, then it doesn't bother invalidating the cache as the record is already there.
If the record is not already in state, then it continues to flush the cache in order that the state is updated with the new sideloaded data.
Testing Instructions
Navigation.wp.data.select('core').getNavigationFallbackId()wp/v2/navigationto get "all" Navigations.Navigation.wp.data.select('core').getNavigationFallbackId()wp/v2/navigationto get "all" Navigations.Testing Instructions for Keyboard
Screenshots or screencast