Fix classic menu fallback race condition #48811
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
When there are no navigation or classic menus, there is a fallback to use the page list of the navigation menu. This works well, but it isn't waiting to make sure the request for classic menus has completed before deciding if it should use the classic menu conversion process or fallback to the page list. This commit adds hasResolvedClassicMenu to the useEffect hook and early return to ensure we don't check for which menu to use until we have our classic menu request.
|
Size Change: +10 B (0%) Total Size: 1.34 MB
ℹ️ View Unchanged
|
talldan
requested review from
MaggieCabrera,
getdave,
draganescu,
scruffian and
ajlende
talldan
added
[Type] Bug
|
@jeryj First up, great work tracking this down 👏 Question: is this bug also in evidence on the
|
MaggieCabrera
approved these changes
Mar 7, 2023
scruffian
approved these changes
Mar 7, 2023
|
Nice one! Glad to know that the flaky test represents an actual bug rather than just a false positive 😅. |
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.
When there are no navigation or classic menus, there is a fallback to use the page list of the navigation menu. This works well, but our check for if we have classic menus isn't waiting until the request for classic menus has completed before deciding if it should use the classic menu conversion process or fallback to the page list.
What?
Adds a check to address a race condition in finding menu fallbacks
Why?
When adding a navigation block to a post, there is inconsistent behavior based on a race condition around menu fallbacks.
How?
This PR adds
hasResolvedClassicMenuto theuseEffecthook and early return to ensure we don't check for which classic menu to use as a fallback until our classic menu request has completed.Testing Instructions
1. Switch to a theme with classic menus
2. Delete all navigation post types so we will need a fallback
/wp-admin/edit.php?post_type=wp_navigationand delete all navigations./wp-admin/edit.php?post_status=trash&post_type=wp_navigationand permanently delete all navigations.3. Create one classic menu
4. Test the PR
5. e2e tests
This PR fixes the understandably flaky e2e tests #48482. This test is only flaky on a slower connection that will emphasize the race condition, so we need to slow down the e2e test.
In
/playwright.config.tsadd this within theusesection to slow down the e2e tests:Now, you can run the e2e test 20x in a row. All should pass. On
trunk, they pass about 50% of the time.