Skip to content
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.

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

HTML API: Fix splitting single text node #5976

Conversation

sirreal
Copy link
Member

@sirreal sirreal commented Jan 30, 2024

Fix an issue where a < character will always break a text node.

It should not break a text node if we will not start another node type, i.e. we find < followed by !, /, ? or an ascii alpha character.

Trac ticket: https://core.trac.wordpress.org/ticket/60385


This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

Copy link

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.

@sirreal sirreal marked this pull request as ready for review January 30, 2024 18:02
@sirreal
Copy link
Member Author

sirreal commented Jan 30, 2024

@dmsnell Please take a look at this.

'!' === $next_character ||
'/' === $next_character ||
'?' === $next_character ||
( 'A' <= $next_character && $next_character <= 'z' );
Copy link
Member Author

@sirreal sirreal Jan 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't love this, I think it's doing character code comparison but I couldn't find conclusive docs.

I considered ctype_alpha but apparently that's locale dependent so best avoided. We want ascii alpha.

We could also apply ord and compare (65 <= ord( $char ) <= 122) and comment the magic numbers.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

based on the PHP docs for the comparison operators I think this is valid as-is, as long as we're comparing strings to strings

Copy link
Member

@dmsnell dmsnell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch @sirreal. While this shouldn't have caused any problems in an application, it's more correct combining these. I wanted to re-examine the rules and fallback to the existing "failure to find a tag" but I think having this up-front has its merit.

Did you examine trapping this inside of next_tag() in the case that parse_next_tag() returns false? I'm a bit surprised that this wasn't behaving differently, but I guess that loop runs to the end.

My one big remaining question is whether we expect this to be a normal case or a rare case. That maybe would suggest whether to eagerly re-compute the next character, as we do in this patch, or put it at the end of the loop in parse_next_tag(). We can adjust as we see fit.

@dmsnell
Copy link
Member

dmsnell commented Jan 30, 2024

Merged in [57489]
0b800d7

@dmsnell dmsnell closed this Jan 30, 2024
@dmsnell dmsnell deleted the html-api/fix-breaking-adjacent-text-nodes branch January 30, 2024 22:17
@sirreal
Copy link
Member Author

sirreal commented Jan 31, 2024

I wanted to re-examine the rules and fallback to the existing "failure to find a tag" but I think having this up-front has its merit.

My first thought was that we should find the text node once we've found the start of the next node, but that seemed like a much larger refactor. What I don't like about this approach is that we're effectively identifying the start of the next node in multiple places.

I think it's fine for now, this is a smaller change with the 6.5 release on the horizon and as test coverage increases we can explore larger changes before the next release.

Did you examine trapping this inside of next_tag() in the case that parse_next_tag() returns false?

I did not.

My one big remaining question is whether we expect this to be a normal case or a rare case.

I don't have data to answer that. My gut suggests this is unusual, but I have no idea.

That maybe would suggest whether to eagerly re-compute the next character, as we do in this patch, or put it at the end of the loop in parse_next_tag(). We can adjust as we see fit.

I think you're describing the approach I'd like, but again I think that would be a larger refactor and perhaps best left for the next release cycle.

dmsnell added a commit to WordPress/gutenberg that referenced this pull request Feb 6, 2024
Updates from WordPress/wordpress-develop:
 - From: WordPress/wordpress-develop@54a09a7
 - To: WordPress/wordpress-develop@7a71339

 - Coding style changes.

 - WordPress/wordpress-develop#5762
   Adds support for the "any other tag" sections in the HTML Processor.

 - WordPress/wordpress-develop#5539
   Adds support for list elements in the HTML Processor.

 - WordPress/wordpress-develop#5897
   Adds support for HR elements in the HTML Processor.

 - WordPress/wordpress-develop#5895
   Adds support for the AREA, BR, EMBED, KEYGEN, and WBR elements
   in the HTML Processor.

 - WordPress/wordpress-develop#5903
   Adds support for the PRE and LISTING elements in the HTML Processor.

 - WordPress/wordpress-develop#5913
   Updates "all other tags" support in HTML Processor and updates list
   of void elements.

 - WordPress/wordpress-develop#5906
   Adds support for the PARAM, SOURCE, and TRACK elements in the HTML Processor.

 - WordPress/wordpress-develop#5907
   Adds support for the INPUT element in the HTML Processor

 - WordPress/wordpress-develop#5683
   Provides mechanism to scan all tokens in an HTML document in the Tag Processor.

 - WordPress/wordpress-develop#5976
   Avoids splitting text nodes on "<" character.

 - WordPress/wordpress-develop#5992
   Only recognize true CDATA-lookalike nodes.

 - WordPress/wordpress-develop#5975
   Prevent void tag nesting when calling `next_token()`

 - WordPress/wordpress-develop#6021
   Reset parser state after seeking.

 - https://core.trac.wordpress.org/changeset/57528
   Fix typo in setting token flag.

 - WordPress/wordpress-develop#6041
   Ensure consecutive text is all joined into one text node.

The PHP files in the compatability layer are merged and maintained in
the Core repo and all changes or updates need to happen first in Core
and then be brought over to Gutenberg as built files.

Co-authored-by: sergeybiryukov <sergeybiryukov@git.wordpress.org>
Co-authored-by: sirreal <jonsurrell@git.wordpress.org>
Co-authored-by: dmsnell <dmsnell@git.wordpress.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants