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.

Sign up for GitHub

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

Jump to bottom

19858 WP 6.2 compatibility use React createRoot instead of render #19871

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

19858 WP 6.2 compatibility use React createRoot instead of render #19871

wants to merge 3 commits into from
+244 −71

Conversation

igorschoester
Copy link
Member

Context

  • React 18 is included in WP 6.2. This PR aims to increase compatibility between our plugin and WP 6.2 and WP 6.1.1 (and WP 6.0). By patching window.wp.element to include createRoot if not there while render is available, we make it so we can use the createRoot API. When the time comes to drop < WP 6.2 support, we can remove this WP element patch.

Summary

This PR can be summarized in the following changelog entry:

  • Adds a WP element createRoot "polyfill" to keep using the same API without React 18 support.

Relevant technical choices:

  • Patch wp.element to always have createRoot (if render is present). See context.

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

Relevant test scenarios

  • Changes should be tested with the browser console open
  • Changes should be tested on different posts/pages/taxonomies/custom post types/custom taxonomies
  • Changes should be tested on different editors (Block/Classic/Elementor/other)
  • Changes should be tested on different browsers
  • Changes should be tested on multisite

Test instructions for QA when the code is in the RC

  • QA should use the same steps as above.

QA can test this PR by following these steps:

Impact check

This PR affects the following parts of the plugin, which may require extra testing:

  • Anywhere we use wp.element.createRoot or import it from @wordpress/element.

UI changes

  • This PR changes the UI in the plugin. I have added the 'UI change' label to this PR.

Other environments

  • This PR also affects Shopify. I have added a changelog entry starting with [shopify-seo], added test instructions for Shopify and attached the Shopify label to this PR.

Documentation

  • I have written documentation for this change.

Quality assurance

  • I have tested this code to the best of my abilities.
  • During testing, I had activated all plugins Yoast SEO provides integrations for.
  • I have added unit tests to verify the code works as intended.
  • If any part of the code is behind a feature flag, my test instructions also cover cases where the feature flag is switched off.
  • I have written this PR in accordance with my team's definition of done.

Innovation

  • No innovation project is applicable for this PR.
  • This PR falls under an innovation project. I have attached the innovation label and noted the work hours.

Fixes #19858

@igorschoester
Add createRoot "polyfill" to WP element
b360c17 
In React 18 `render` is deprecated and `createRoot` should be used instead.
WP 6.2 upgrades React to 18, via `@wordpress/element` (5.0.0).
Therefor, we have to support both `render` and `createRoot`.

This patch makes it so that we can always use `createRoot` in our code:
* If you are on < WP 6.2 you will use `render` via this patch.
* If you are on >= WP 6.2 you will use the normal `createRoot`.

This patch can be removed once the lowest supported WP version is 6.2.
@igorschoester
Upgrade WP element to 5.3.1
45bd567 
Upgrade the peer dependencies of React and React DOM to either 16, 17 or 18

Note that we do not bundle these scripts anyway. We rely on whatever is on the window object.
Which in WP 6.2 will be WP element 5.3.1 and React 18.2.0
@igorschoester
Replace render with createRoot
c81fc8b 
Add element safety checks in the helpers
@igorschoester igorschoester added the changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog label Feb 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

WP 6.2 compatibility: use React createRoot
1 participant
@igorschoester