Changeset 57805 for trunk/tests/phpunit/tests/html-api/wpHtmlTagProcessor.php

Timestamp:

03/11/2024 11:53:07 PM (21 months ago)

Author:

dmsnell

Message:

HTML API: Defer applying attribute updates until necessary.

When making repeated updates to a document, the Tag Processor will end
up copying the entire document once for every update. This can lead to
catastrophic behavior in the worse case.

However, when batch-applying updates it's able to copy chunks of the
document in one thread and only end up copying the entire document once
for the entire batch.

Previously the Tag Processor has been eagerly applying udpates, but in
this patch it defers applying those updates as long as is possible.

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

Props: dmsnell, bernhard-reiter, jonsurrell, westonruter.
Fixes #60697.
Follow-up to [55706], [56941], [57348].

File:

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

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

@@ -2728 +2728 @@
         $this->assertSame( 'test< /A>', $processor->get_modifiable_text(), 'Did not find complete text node.' );
     }
+
+    /**
+     * Ensures that updates which are enqueued in front of the cursor
+     * are applied before moving forward in the document.
+     *
+     * @ticket 60697
+     */
+    public function test_applies_updates_before_proceeding() {
+        $html = '<div><img></div><div><img></div>';
+
+        $subclass = new class( $html ) extends WP_HTML_Tag_Processor {
+            /**
+             * Inserts raw text after the current token.
+             *
+             * @param string $new_html Raw text to insert.
+             */
+            public function insert_after( $new_html ) {
+                $this->set_bookmark( 'here' );
+                $this->lexical_updates[] = new WP_HTML_Text_Replacement(
+                    $this->bookmarks['here']->start + $this->bookmarks['here']->length + 1,
+                    0,
+                    $new_html
+                );
+            }
+        };
+
+        $subclass->next_tag( 'img' );
+        $subclass->insert_after( '<p>snow-capped</p>' );
+
+        $subclass->next_tag();
+        $this->assertSame(
+            'P',
+            $subclass->get_tag(),
+            'Should have matched inserted HTML as next tag.'
+        );
+
+        $subclass->next_tag( 'img' );
+        $subclass->set_attribute( 'alt', 'mountain' );
+
+        $this->assertSame(
+            '<div><img><p>snow-capped</p></div><div><img alt="mountain"></div>',
+            $subclass->get_updated_html(),
+            'Should have properly applied the update from in front of the cursor.'
+        );
+    }
 }