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

Refactor: Rewrite convert_smilies to avoid catastrophic runtime performance. #6762

Draft
wants to merge 2 commits into
base: trunk
Choose a base branch
from

Conversation

dmsnell
Copy link
Member

@dmsnell dmsnell commented Jun 9, 2024

Todo

  • Find catastrophic case and demonstrate it not crashing.
  • Benchmark typical performance.
  • Perform string replacement in the HTML API without having to decode? This would help make the existing tests pass and could minimize the string changes that need to be applied to a document.
  • Respond to changes in $wpsmiliestrans - it currently assumes that filtering of that list only occurs once at bootup, but some code directly modifies the global.
  • Separate wp_find_whitespace_span() into separate patch?

Summary

In some cases, the search for smilies to replace can introduce catastrophic backtracking in the PCRE pattern built to find them.

In this patch the function is rewritten using the HTML API and the WP_Token_Map, and all PCRE methods have been replaced with hand-written single-pass parsers where applicable.

The new approach should avoid memory allocation and catastrophic runtimes and crashes.

Copy link

github-actions bot commented Jun 9, 2024

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.

…rmance.

In some cases, the search for smilies to replace can introduce
catastrophic backtracking in the PCRE pattern built to find them.

In this patch the function is rewritten using the HTML API and the
`WP_Token_Map`, and all PCRE methods have been replaced with
hand-written single-pass parsers where applicable.

The new approach should avoid memory allocation and catastrophic
runtimes and crashes.
@dmsnell dmsnell force-pushed the refactor/convert-smilies-without-blowing-up branch from ac4366b to 28ea6b1 Compare July 10, 2024 06:08
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.

1 participant