List block: Add migration from v1 to v2 #39799
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
youknowriad
requested review from
oandregal,
ellatrix,
jorgefilipecosta and
ntsekouras
|
Size Change: +455 B (0%) Total Size: 1.22 MB
ℹ️ View Unchanged
|
youknowriad
force-pushed
the
add/listV2-migration
branch
from
64df197
to
59b4b38
Compare
youknowriad
force-pushed
the
add/listV2-migration
branch
from
59b4b38
to
6a608bf
Compare
There was a problem hiding this comment.
I found some issues with migrating blocks that have formats:
This block was created using the old list block:
<!-- wp:list -->
<ul><li>dsfdsf<ul><li>dsfdsf<ul><li>ds<strong>fdsfd</strong>s</li><li>sdfdsdsf<em>dsfds</em><ul><li><em>fdsf</em></li></ul></li></ul></li></ul></li><li>fghfgg<strong>fhgf</strong><ul><li><strong>fdgdf</strong>gdf</li></ul></li></ul>
<!-- /wp:list -->
Gets migrated to (some formats are broken):
<!-- wp:list -->
<ul><!-- wp:list-item -->
<li>dsfdsf<!-- wp:list -->
<ul><!-- wp:list-item -->
<li>dsfdsf<!-- wp:list -->
<ul><!-- wp:list-item -->
<li>ds<strong>fdsfd</strong>s</li>
<!-- /wp:list-item -->
<!-- wp:list-item -->
<li>sdfdsdsf<em>dsfds</em><!-- wp:list -->
<ul><!-- wp:list-item -->
<li><em>fdsf</em></li>
<!-- /wp:list-item --></ul>
<!-- /wp:list --></li>
<!-- /wp:list-item --></ul>
<!-- /wp:list --></li>
<!-- /wp:list-item --></ul>
<!-- /wp:list --></li>
<!-- /wp:list-item -->
<!-- wp:list-item -->
<li>fghfgg<strong>fhgf</strong><!-- wp:list -->
<ul><!-- wp:list-item -->
<li><strong>fdgdf</strong>gdf</li>
<!-- /wp:list-item --></ul>
<!-- /wp:list --></li>
<!-- /wp:list-item --></ul>
<!-- /wp:list -->
For this simple block:
<!-- wp:list -->
<ul><li>1<strong>a</strong></li><li><strong>2</strong>b</li></ul>
<!-- /wp:list -->
We say it is invalid. The issue happens when we add a format that affects two list items.
This one I was not able to reproduce For the first example (the complex one), it should be fixed. |
youknowriad
force-pushed
the
add/listV2-migration
branch
from
88f64c6
to
2a2a894
Compare
ellatrix
reviewed
Mar 30, 2022
| @@ -76,4 +76,4 @@ const v1 = { | |||
| * | |||
| * See block-deprecation.md | |||
| */ | |||
| export default [ v1 ]; | |||
| export default [ v0 ]; | |||
There was a problem hiding this comment.
just a random name for the first deprecated version :P
ellatrix
approved these changes
Mar 30, 2022
|
Looks like there's an e2e test that's failing a bit too often in trunk |
|
Hi @youknowriad I'm noticing a small issue on the migrations:
I get this block:
Notice the added spaces. |
|
@jorgefilipecosta good catch Jorge, I'll take a look. |
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.
closes #39521
What?
This PR adds a function to migrate list block v1 to list block v2 and applies this function in two places:
Why and How ?
Third-party developers can inject block in multiple ways: saved content (post, reusable blocks ...), CPT templates...
1- For the first one, we need a way to migrate from old markup to new markup, the block deprecations are here to solve that
2- For the second one, we don't have a framework API to deal with block format (attributes) migration. This PR solves that by keeping the old attributes in the block definition and running a block migration on first load (edit function).
Testing Instructions
Test also the Post CPT templates, you can do so by pasting this code in
gutenberg.phpfor instance:Now, load a new post editor, you should be able to see a "full" list as a starting point.