Refactor the site editor URLs for better backward compatibility #48063
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
youknowriad
added
[Type] Enhancement
youknowriad
requested review from
jameskoster,
jorgefilipecosta and
ntsekouras
youknowriad
requested review from
kevin940726,
ntwb,
nerrad and
ajitbohra
as code owners
|
Size Change: +119 B (0%) Total Size: 1.33 MB
ℹ️ View Unchanged
|
|
Flaky tests detected in 558a900. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/4183686050
|
|
I can't speak about the code, but everything seems to be working just fine on this branch. |
youknowriad
force-pushed
the
refactor/site-editor-url
branch
from
1f19b45
to
558a900
Compare
jorgefilipecosta
approved these changes
Feb 15, 2023
| @@ -128,12 +128,9 @@ export default function NewTemplate( { | |||
| setCanvasMode( 'edit' ); | |||
|
|
|||
| // Navigate to the created template editor. | |||
| window.queueMicrotask( () => { | |||
There was a problem hiding this comment.
Any idea of why we were using window.queueMicrotask and not it is not needed?
There was a problem hiding this comment.
These were needed previously because we had two synchronous changes causing effects in hooks that update the URL (canvas change and template navigation) and these two changes to the "history" path were overriding each other, the micro task ensured that they were done one after the other.
Now that the url is the source of truth of everything, it's way simpler.
This was referenced Feb 19, 2023
ntsekouras
pushed a commit
that referenced
this pull request
Feb 20, 2023
|
I just cherry-picked this PR to the wp/6.2 branch to get it included in the next release: 5719ffb |
ntsekouras
removed
the
Backport to WP 6.6 Beta/RC
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?
This PR refactors how we deal with URLs in the site editor to avoid the duplication between "path", "postId" and "postType" URLs.
In trunk, for a given postType/postId couple to load in the site editor we'd need both of these in the URL and also a path=/navigation/postType/postId otherwise, the path is considered wrong and the post doesn't load, this PR simplifies that by inverting the source of truth.
1- The URL is the actual source of truth. If there's a postId and postType in the URL, there's no need to provide a "path". It's automatically generated from these arguments.
2- If one of these is missing, it means we need to provide a "path" to avoid ambiguity.
3- The useSyncPathFromURL makes sure to compute the right path based on the url params to initialize the sidebar navigation properly.
Why?
This ensures the URLs don't change between WP 6.1 and WP 6.2 and also avoids race conditions between hooks updated the URL.
Testing Instructions
1- Navigate all the different pages and flows of the site editor.