Add Inlined React Runtime check for React 19 incompatibilities#1380
Open
gunjanjaswal wants to merge 2 commits into
Open
Add Inlined React Runtime check for React 19 incompatibilities#1380gunjanjaswal wants to merge 2 commits into
gunjanjaswal wants to merge 2 commits into
Conversation
Adds a static check that scans a plugin's JavaScript files for a bundled, outdated React runtime that breaks once WordPress upgrades to React 19. The primary, high-confidence signal is `Symbol.for( 'react.element' )`, which is only emitted by an inlined pre-React 19 JSX runtime (React 19 uses the `react.transitional.element` marker). The warning is suppressed when the runtime is externalized, detected via a `window.ReactJSXRuntime` reference or a `react-jsx-runtime` dependency in the sibling `*.asset.php` file. Usage of React APIs removed in React 19 (unmountComponentAtNode, findDOMNode, ReactCurrentOwner) is reported as a secondary signal. Registers the check, adds PHPUnit tests with passing/failing fixtures, and documents it in docs/checks.md and the changelog. Fixes WordPress#1356
gunjanjaswal
requested review from
adamsilverstein,
felixarntz,
joemcgill,
mukeshpanchal27,
swissspidy and
westonruter
as code owners
|
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 If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
PHPMD flagged $matched as an undefined variable in look_for_removed_react_apis since it was only created via the by-reference argument. Initialize it first.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #1356.
This adds a check (
inlined_react_runtime) for plugins that bundle their own copy of the React JSX runtime. WordPress is going to React 19 at some point, and the usual reason a plugin breaks across that jump isn't some exotic API, it's that the build inlinedreact/jsx-runtimeinto the bundle instead of loading it from WordPress. React 19 changed the shape of the element object, so anything an old bundled runtime creates gets rejected. The plugin runs fine today and then falls over the day WordPress updates, so the point is to catch it ahead of time.The detection is pretty crude, honestly: it greps the plugin's JS for
Symbol.for('react.element'), which only shows up when a pre-19 runtime got bundled in. React 19 switched that marker toreact.transitional.element, so anyone externalizing the runtime properly won't trip it. And if the runtime is externalized there's nothing to warn about, so it stays quiet when it spotswindow.ReactJSXRuntimein the file orreact-jsx-runtimelisted in the matching*.asset.php. On top of that it flags a few APIs that got dropped in 19 (unmountComponentAtNode,findDOMNode,ReactCurrentOwner). Everything's a warning, nothing errors out. It's wired intoDefault_Check_Repositorywith the usual docs and changelog entries.Inlined_React_Runtime_Check_Testscovers both sides: the-with-errorsfixture throws two warnings (inlined_jsx_runtimeon index.js,react_removed_apion legacy.js), and the-without-errorsone stays clean because the runtime's externalized there, once throughindex.asset.phpand once throughwindow.ReactJSXRuntime. I'm not married to the category or severity if you'd rather scope it differently.