Skip to content

Blocks: Ensure extract_full_block_and_advance() matches parse_blocks() #10774

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sirreal wants to merge 1 commit into
base: 6.9
Choose a base branch
from
+137 −0
Open

Blocks: Ensure extract_full_block_and_advance() matches parse_blocks() #10774

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions src/wp-includes/class-wp-block-processor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1295,6 +1295,17 @@ public function extract_full_block_and_advance(): ?array {
$block['innerBlocks'][] = $inner_block;
$block['innerContent'][] = null;
}

/*
* Because the parser has advanced past the closing block token, it
* may be matched on an HTML span. This needs to be processed before
* moving on to the next token at the start of the next loop iteration.
*/
if ( $this->is_html() ) {
$chunk = $this->get_html_content();
$block['innerHTML'] .= $chunk;
$block['innerContent'][] = $chunk;
}
}

return $block;
Expand Down
126 changes: 126 additions & 0 deletions tests/phpunit/tests/block-processor/wpBlockProcessor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1211,6 +1211,132 @@ public static function data_content_and_delimiter_spans() {
);
}

/**
* Ensures that block extraction matches the behavior of the default block parser.
*
* @ticket 64537
*
* @dataProvider data_various_block_posts
*
* @param string $test_document An HTML document to parse as blocks.
*/
public function test_extracts_equivalent_parses_as_parse_blocks( string $test_document ) {
$processor = new WP_Block_Processor( $test_document );
$blocks = array();

while ( $processor->next_block( '*' ) ) {
$blocks[] = $processor->extract_full_block_and_advance();
}

$this->assertSame(
parse_blocks( $test_document ),
$blocks,
'Failed to properly parse the block structure.'
);
}

/**
* Data provider.
*
* @return Generator
*/
public static function data_various_block_posts() {
yield 'Empty post' => array( '' );

yield 'Void block' => array( '<!-- wp:void /-->' );

yield 'Empty block' => array( '<!-- wp:empty --><!-- /wp:empty -->' );

yield 'Paragraph block' => array( '<!-- wp:paragraph --><p>Test</p><!-- /wp:paragraph -->' );

yield 'Paragraph block with attributes' => array(
'<!-- wp:paragraph {"dropCaps": true} --><p>Test</p><!-- /wp:paragraph -->',
);

yield 'Group with void inner' => array(
'<!-- wp:group --><!-- wp:void /--><!-- /wp:group -->',
);

/*
* @todo There is a hidden bug in here, which is possibly a problem in
* the default parser. There are HTML spans of newlines between
* these block delimiters, and without them, the parse doesn’t
* match `parse_blocks()`. However, `parse_blocks()` is inconsistent
* in its behavior. Whereas it produces an empty text chunk here,
* in the case of a void inner block it produces none. The test is
* being adjusted to step around this issue so that it can be resolved
* separately, and until it’s clear if there is an implementation issue
* with `parse_blocks()` itself.
*/
yield 'Empty columns' => array(
<<<HTML
<!-- wp:columns -->
<!-- wp:column -->
<!-- /wp:column -->
<!-- /wp:columns -->
HTML
,
);

yield 'Contentful columns' => array(
<<<HTML
<!-- wp:columns -->
<ul>
<!-- wp:column -->
<li>A good point.</li>
<!-- wp:column /-->
</ul>
<!-- /wp:columns -->
HTML
,
);

yield 'Group with mixed content' => array(
<<<HTML
<!-- wp:group -->
<div>
<!-- wp:paragraph --><p>Test</p><!-- /wp:paragraph -->
This is freeform.
<!-- wp:void /-->
End
<!-- wp:footer -->
<footer>That&rsquo;s it!</footer>
<!-- /wp:footer -->
<!-- wp:another-void /-->
</div>
<!-- /wp:group -->
HTML
,
);

yield 'Nested blocks' => array(
<<<HTML
<!-- wp:a -->
<div>
<!-- wp:b -->
<span><!-- wp:c /--></span>
<!-- /wp:b -->
</div>
<!-- /wp:a -->
HTML
,
);

yield 'Attributes on nested blocks' => array(
<<<HTML
<!-- wp:b1 -->
<!-- wp:b2 {} -->
<!-- wp:b3 {"id":"going"} -->
<!-- wp:b4 {"id":"down"} -->
<!-- /wp:b4 -->
<!-- /wp:b3 -->
<!-- /wp:b2 -->
<!-- /wp:b1 -->
HTML
,
);
}

//
// Test helpers.
//
Expand Down
Loading