Changeset 58040 for trunk/tests/phpunit/tests/html-api/wpHtmlTagProcessor-token-scanning.php

Timestamp:

04/24/2024 07:43:02 AM (19 months ago)

Author:

dmsnell

Message:

HTML API: Fix detection of single-length funky comments.

Since [60428] the Tag Processor has been misidentifying single-character
funky comments. It has been asserting that the full token-length for a
funky comment must be at least three characters after the opening (e.g.
</1>), but it has been starting to look for the closing > after
those same three characters. This means that it has been skipping the
actual close of these funky comments and swallowing up the next syntax
until it finds a >, often consuming the next tag in the process.

This patch fixes the detector and restores finding the following token.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/6412
Discussed in https://core.trac.wordpress.org/ticket/60170

Follow-up to [60428].
Fixes #60170.
Props dmsnell, gziolo, jonsurrell.

File:

• trunk/tests/phpunit/tests/html-api/wpHtmlTagProcessor-token-scanning.php (modified) (1 diff)

trunk/tests/phpunit/tests/html-api/wpHtmlTagProcessor-token-scanning.php

@@ -762 +762 @@
 
     /**
+     * Ensures that various funky comments are properly parsed.
+     *
+     * @ticket 60170
+     *
+     * @since 6.6.0
+     *
+     * @covers WP_HTML_Tag_Processor::next_token
+     *
+     * @dataProvider data_various_funky_comments
+     *
+     * @param string $funky_comment_html HTML containing a funky comment.
+     * @param string $modifiable_text    Expected modifiable text of first funky comment in HTML.
+     */
+    public function test_various_funky_comments( $funky_comment_html, $modifiable_text ) {
+        $processor = new WP_HTML_Tag_Processor( $funky_comment_html );
+        while ( '#funky-comment' !== $processor->get_token_type() && $processor->next_token() ) {
+            continue;
+        }
+
+        $this->assertSame(
+            '#funky-comment',
+            $processor->get_token_type(),
+            'Failed to find the expected funky comment.'
+        );
+
+        $this->assertSame(
+            $modifiable_text,
+            $processor->get_modifiable_text(),
+            'Found the wrong modifiable text span inside a funky comment.'
+        );
+    }
+
+    /**
+     * Data provider.
+     *
+     * @return array[].
+     */
+    public static function data_various_funky_comments() {
+        return array(
+            'Space'          => array( '</ >', ' ' ),
+            'Short-bang'     => array( '</!>', '!' ),
+            'Question mark'  => array( '</?>', '?' ),
+            'Short-slash'    => array( '<//>', '/' ),
+            'Bit (no attrs)' => array( '<//wp:post-meta>', '/wp:post-meta' ),
+            'Bit (attrs)'    => array( '<//wp:post-meta key=isbn>', '/wp:post-meta key=isbn' ),
+            'Curly-wrapped'  => array( '</{json}>', '{json}' ),
+            'Before P'       => array( '</1><p>', '1' ),
+            'After P'        => array( '<p></__("Read more")></p>', '__("Read more")' ),
+            'Reference'      => array( '</&gt;>', '&gt;' ),
+        );
+    }
+
+    /**
      * Test helper that wraps a string in double quotes.
      *