HTML API: Implement TEMPLATE and related support #7046

sirreal · 2024-07-17T11:32:43Z

Adds support for TEMPLATE elements in the HTML Processor.

Add some tag handling from HTML API: Complete missing tags in the IN BODY insertion mode. #6972
implement most of in_head parsing
Implement step_in_template

- Tests: 1527, Assertions: 3166, Skipped: 323.
+ Tests: 1525, Assertions: 3277, Skipped: 233.

From WordPress#6972

This includes template support in body

Extracted from WordPress#6982

From the table support PR

github-actions · 2024-07-17T11:49:11Z

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

The Plugin and Theme Directories cannot be accessed within Playground.
All changes will be lost when closing a tab with a Playground instance.
All changes will be lost when refreshing the page.
A fresh instance is created each time the link below is clicked.
Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

dmsnell

@sirreal I've merged trunk into this and tried to resolve the conflicts accordingly.

was step_in_head() supposed to be in this PR? It's fine if it is, but I didn't know if that was intentional or an artifact of other development.

dmsnell

I've given this a full review. Many new tests are passing that were previously skipped, but I had to update the html5lib test runner to generate the content label and indentation inside TEMPLATE elements.

In a few spots I made small adjustments for clarity, e.g. changing '-' === $tag_name[0] to $is_closer, and replacing array_push() with a single element with $array[] = $single_element.

On the logic side I added in a check for an empty text node. Perhaps that eventually belongs in step() itself, but for now I wanted it in there in case we get all-NULL text nodes.

Additionally I've incorporated as much as I could from step_in_head() from #6006. There's a check in the META for the document encoding which I didn't think was necessary here, so there are two if statements that lack a condition - I'll add that back in once #6006 is ready, unless it merges first.

Please let me know your thoughts @sirreal, also @gziolo or @ockham or @westonruter. Otherwise I'll see if we can't merge this tomorrow (Tuesday, July 30).

github-actions · 2024-07-30T08:25:12Z

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props jonsurrell, dmsnell, westonruter.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

sirreal · 2024-07-30T08:30:59Z

was step_in_head() supposed to be in this PR?

TEMPLATE required parsing following the rules for "in head". I knew that there were other PRs implementing that, so I tried to do just enough for TEMPLATE.

sirreal · 2024-07-30T09:34:30Z

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

@@ -1195,15 +1205,16 @@ private function step_in_head(): bool {

 			/*
 			 * > A start tag whose tag name is "template"
+			 *
+			 * @todo Could the adjusted insertion location be anything other than the current location?


Good question. I've read the spec several times and I don't see how. I'm concerned that means we're missing something subtle 😕

I did check html5ever tree construction, and it does not seem to do any special adjustment which makes me more confident.

sirreal · 2024-07-30T09:42:37Z

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

@@ -1168,6 +1176,8 @@ private function step_in_head(): bool {

 			/*
 			 * > A start tag whose tag name is "script"
+			 *
+			 * @todo Could the adjusted insertion location be anything other than the current location?


In this case, html5ever does account for it, but I still don't see how it behaves differently.

I don't think this should block the PR, but I do want to follow-up.

sirreal · 2024-07-30T12:14:46Z

I've done a careful review. This looks good to me, thanks for your additions @dmsnell 👍

westonruter

LGTM, with one observation.

Also, the title of this PR should be updated to be more broad, as it is definitely more than just TEMPLATE support.

westonruter · 2024-07-30T17:06:48Z

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

+				 * >     tentative, then change the encoding to the resulting encoding.
+				 */
+				$charset = $this->get_attribute( 'charset' );
+				if ( is_string( $charset ) ) {


Shouldn't this only bail if $charset is not UTF-8?

Suggested change

if ( is_string( $charset ) ) {

if ( is_string( $charset ) && ! is_utf8_charset( $charset ) ) {

yeah there's an interplay here with #6977 that's an artifact due to sharing code but not merging everything at once. the test here is whether we support inferring the character set from a META tag, and that only happens if the parser's charset confidence is tentative, but I didn't want to add this code in this PR.

alternatively, we could remove META tag support, but I hope that #6977 merges within the next couple of days, making this all moot

westonruter · 2024-07-30T17:11:06Z

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

+				if (
+					is_string( $http_equiv ) &&
+					is_string( $content ) &&
+					0 === strcasecmp( $http_equiv, 'Content-Type' )


Ditto above. Shouldn't this only bail if the charset is not UTF-8?

I guess this bail is essentially a TODO.

As part of work to add more spec support to the HTML API, this patch adds support for the IN TEMPLATE and IN HEAD insertion modes. These changes are primarily about adding support for TEMPLATE elements in the HTML Processor, but include support for other tags commonly found in the document head, such as LINK, META, SCRIPT, STYLE, and TITLE. Developed in #7046 Discussed in https://core.trac.wordpress.org/ticket/61576 Props: dmsnell, jonsurrell, westonruter. See #61576. git-svn-id: https://develop.svn.wordpress.org/trunk@58833 602fd350-edb4-49c9-b593-d223f7449a82

dmsnell · 2024-07-30T18:46:33Z

Merged in [58833]
dfd1de0

As part of work to add more spec support to the HTML API, this patch adds support for the IN TEMPLATE and IN HEAD insertion modes. These changes are primarily about adding support for TEMPLATE elements in the HTML Processor, but include support for other tags commonly found in the document head, such as LINK, META, SCRIPT, STYLE, and TITLE. Developed in WordPress/wordpress-develop#7046 Discussed in https://core.trac.wordpress.org/ticket/61576 Props: dmsnell, jonsurrell, westonruter. See #61576. Built from https://develop.svn.wordpress.org/trunk@58833 git-svn-id: http://core.svn.wordpress.org/trunk@58229 1a063a9b-81f0-0310-95a4-ce76da25c4cd

As part of work to add more spec support to the HTML API, this patch adds support for the IN TEMPLATE and IN HEAD insertion modes. These changes are primarily about adding support for TEMPLATE elements in the HTML Processor, but include support for other tags commonly found in the document head, such as LINK, META, SCRIPT, STYLE, and TITLE. Developed in WordPress/wordpress-develop#7046 Discussed in https://core.trac.wordpress.org/ticket/61576 Props: dmsnell, jonsurrell, westonruter. See #61576. Built from https://develop.svn.wordpress.org/trunk@58833 git-svn-id: https://core.svn.wordpress.org/trunk@58229 1a063a9b-81f0-0310-95a4-ce76da25c4cd

As part of work to add more spec support to the HTML API, this patch adds support for the IN TEMPLATE and IN HEAD insertion modes. These changes are primarily about adding support for TEMPLATE elements in the HTML Processor, but include support for other tags commonly found in the document head, such as LINK, META, SCRIPT, STYLE, and TITLE. Developed in WordPress#7046 Discussed in https://core.trac.wordpress.org/ticket/61576 Props: dmsnell, jonsurrell, westonruter. See #61576. git-svn-id: https://develop.svn.wordpress.org/trunk@58833 602fd350-edb4-49c9-b593-d223f7449a82

sirreal added 10 commits July 17, 2024 10:59

Add contains method to open elements

d28d9ec

From WordPress#6972

Add at method to open elements

2eb1e01

From WordPress#6972

Add some tag handling from WordPress#6972

724dde1

This includes template support in body

Add insert_marker method

e9b724e

Extracted from WordPress#6982

Add clear_up_to_last_marker method to active formatting

a795983

From the table support PR

implement most of in_head parsing

90e9fb5

Implement step_in_template

e4eb329

lints galore

d36dc65

Add HTML elements to has_element_in_scope handling

bd64072

Implement HTML elements in relevant in scope methods

4e9b640

Remove unsupported element tests

79b3661

sirreal mentioned this pull request Jul 17, 2024

HTML API: Plans for 6.7 WordPress/gutenberg#60396

Closed

19 tasks

Merge branch 'trunk' into html-api/add-template-support

cc4abe5

dmsnell reviewed Jul 29, 2024

View reviewed changes

dmsnell added 5 commits July 29, 2024 16:20

Merge work from WordPress#6977 step_in_head

367d51d

Remove tags from unsupported list

e16bcb6

Fix html5lib tests to account for content label under templates.

6ac3dfa

WPCS

0750ce8

A few small changes

e261998

dmsnell approved these changes Jul 30, 2024

View reviewed changes

sirreal marked this pull request as ready for review July 30, 2024 08:24

sirreal commented Jul 30, 2024

View reviewed changes

westonruter approved these changes Jul 30, 2024

View reviewed changes

dmsnell changed the title ~~HTML API: Implement TEMPLATE support~~ HTML API: Implement TEMPLATE and related support Jul 30, 2024

sirreal mentioned this pull request Jul 30, 2024

HTML API: Add create_full_parser() for non-fragment parsing. #6977

Closed

Merge branch 'trunk' into html-api/add-template-support

4404b91

dmsnell closed this Jul 30, 2024

dmsnell deleted the html-api/add-template-support branch July 30, 2024 18:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

HTML API: Implement TEMPLATE and related support #7046

HTML API: Implement TEMPLATE and related support #7046

Uh oh!

sirreal commented Jul 17, 2024 •

edited by dmsnell

Loading

Uh oh!

github-actions bot commented Jul 17, 2024

Uh oh!

dmsnell left a comment

Uh oh!

dmsnell left a comment

Uh oh!

github-actions bot commented Jul 30, 2024 •

edited

Loading

Uh oh!

sirreal commented Jul 30, 2024

Uh oh!

sirreal Jul 30, 2024

Uh oh!

sirreal Jul 30, 2024

Uh oh!

sirreal commented Jul 30, 2024

Uh oh!

westonruter left a comment

Uh oh!

westonruter Jul 30, 2024

Uh oh!

dmsnell Jul 30, 2024

Uh oh!

westonruter Jul 30, 2024

Uh oh!

dmsnell commented Jul 30, 2024

Uh oh!

Uh oh!

	if ( is_string( $charset ) ) {
	if ( is_string( $charset ) && ! is_utf8_charset( $charset ) ) {

HTML API: Implement TEMPLATE and related support #7046

HTML API: Implement TEMPLATE and related support #7046

Uh oh!

Conversation

sirreal commented Jul 17, 2024 • edited by dmsnell Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jul 17, 2024

Test using WordPress Playground

Some things to be aware of

Uh oh!

dmsnell left a comment

Choose a reason for hiding this comment

Uh oh!

dmsnell left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jul 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sirreal commented Jul 30, 2024

Uh oh!

sirreal Jul 30, 2024

Choose a reason for hiding this comment

Uh oh!

sirreal Jul 30, 2024

Choose a reason for hiding this comment

Uh oh!

sirreal commented Jul 30, 2024

Uh oh!

westonruter left a comment

Choose a reason for hiding this comment

Uh oh!

westonruter Jul 30, 2024

Choose a reason for hiding this comment

Uh oh!

dmsnell Jul 30, 2024

Choose a reason for hiding this comment

Uh oh!

westonruter Jul 30, 2024

Choose a reason for hiding this comment

Uh oh!

dmsnell commented Jul 30, 2024

Uh oh!

Uh oh!

sirreal commented Jul 17, 2024 •

edited by dmsnell

Loading

github-actions bot commented Jul 30, 2024 •

edited

Loading