Changeset 59250

Timestamp:

10/18/2024 01:29:04 PM (22 months ago)

Author:

gziolo

Message:

HTML API: Fix the position update after changing the modifiable text when length differs

There was an edge case detected for updating the text placed without the wrapping HTML tag with set_modifiable_text.

Props gziolo, jonsurrell.
Fixes #62241.

Location:

trunk

Files:

• src/wp-includes/html-api/class-wp-html-tag-processor.php (modified) (1 diff)
• tests/phpunit/tests/html-api/wpHtmlTagProcessorModifiableText.php (modified) (2 diffs)

trunk/src/wp-includes/html-api/class-wp-html-tag-processor.php

@@ -2460 +2460 @@
 
                         // Accumulate shift of the given pointer within this function call.
-                        if ( $diff->start <= $shift_this_point ) {
+                        if ( $diff->start < $shift_this_point ) {
                                 $accumulated_shift_for_given_point += $shift;
                         }

trunk/tests/phpunit/tests/html-api/wpHtmlTagProcessorModifiableText.php

@@ -41 +41 @@
 
         /**
+         * Data provider.
+         *
+         * @return array[]
+         */
+        public static function data_get_modifiable_text_replacements() {
+                return array(
+                        'shorter'     => array( 'just some text', 'shorter text' ),
+                        'same length' => array( 'just some text', 'different text' ),
+                        'longer'      => array( 'just some text', 'a bit longer text' ),
+                );
+        }
+
+        /**
          * Ensures that `get_modifiable_text()` reads enqueued updates when read
          * from after writing; guarantees consistency through writes.
          *
          * @ticket 61617
-         */
-        public function test_get_modifiable_text_is_consistent_after_writes() {
-                $before    = 'just some text';
-                $after     = 'different text';
-                $processor = new WP_HTML_Tag_Processor( $before );
+         * @ticket 62241
+         *
+         * @dataProvider data_get_modifiable_text_replacements
+         *
+         * @param string $initial     Initial text.
+         * @param string $replacement Replacement text.
+         */
+        public function test_get_modifiable_text_is_consistent_after_writes( $initial, $replacement ) {
+                $processor = new WP_HTML_Tag_Processor( $initial );
                 $processor->next_token();
 
@@ -59 +76 @@
 
                 $this->assertSame(
-                        $before,
+                        $initial,
                         $processor->get_modifiable_text(),
                         'Should have found initial test text: check test setup.'
                 );
 
-                $processor->set_modifiable_text( $after );
-                $this->assertSame(
-                        $after,
+                $processor->set_modifiable_text( $replacement );
+                $this->assertSame(
+                        $replacement,
                         $processor->get_modifiable_text(),
                         'Should have found enqueued updated text.'
                 );
-
-                $processor->get_updated_html();
-                $this->assertSame(
-                        $after,
+                $this->assertSame(
+                        $replacement,
+                        $processor->get_updated_html(),
+                        'Should match updated HTML.'
+                );
+                $this->assertSame(
+                        $replacement,
+                        $processor->get_modifiable_text(),
+                        'Should have found updated text.'
+                );
+        }
+
+        /**
+         * Ensures that `get_modifiable_text()` reads enqueued updates when read from
+         * after writing; guarantees consistency through writes after closed tag element.
+         *
+         * @ticket 62241
+         *
+         * @dataProvider data_get_modifiable_text_replacements
+         *
+         * @param string $initial     Initial text.
+         * @param string $replacement Replacement text.
+         */
+        public function test_get_modifiable_text_is_consistent_after_writes_when_text_after_closed_tag_element( $initial, $replacement ) {
+                $html_before = '<p>some content</p>';
+                $processor   = new WP_HTML_Tag_Processor( $html_before . $initial );
+                // Move to the text node after the closing p tag.
+                $processor->next_token();
+                $processor->next_token();
+                $processor->next_token();
+                $processor->next_token();
+
+                $this->assertSame(
+                        '#text',
+                        $processor->get_token_name(),
+                        "Should have found text node but found '{$processor->get_token_name()}' instead: check test setup."
+                );
+
+                $this->assertSame(
+                        $initial,
+                        $processor->get_modifiable_text(),
+                        'Should have found initial test text: check test setup.'
+                );
+
+                $processor->set_modifiable_text( $replacement );
+                $this->assertSame(
+                        $replacement,
+                        $processor->get_modifiable_text(),
+                        'Should have found enqueued updated text.'
+                );
+
+                $this->assertSame(
+                        $html_before . $replacement,
+                        $processor->get_updated_html(),
+                        'Should match updated HTML.'
+                );
+
+                $this->assertSame(
+                        $replacement,
                         $processor->get_modifiable_text(),
                         'Should have found updated text.'