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

Compatibility: move from Post Editor to Site Editor versions of Utilities #42652

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

Conversation

coder-karen
Copy link
Contributor

@coder-karen coder-karen commented Mar 21, 2025

Partially fixes #37713

The remaining changes are made in this Social PR: #42634

Proposed changes:

  • In WordPress 6.6, multiple utilities were moved from @wordpress/edit-post to @wordpress/editor. As we currently ensure compatibility down to WordPress 6.6, the utilities in question can now be used via @wordpress/editor.
  • Prior to this change, console warnings would have been visible, similar to wp.editPost.PluginPrePublishPanel is deprecated since version 6.6. Please use wp.editor.PluginPrePublishPanel instead.

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

Does this pull request change what data or activity we track or use?

No.

Testing instructions:

On a self-hosted test site on trunk, ensure script debug is enabled: define( 'SCRIPT_DEBUG', true ); in wp-config.php. On trunk you can test functionality, and in some cases you can test for the console warnings, for the below features:

Newsletter:

  • Enable Newsletter at /wp-admin/admin.php?page=jetpack#newsletter.
  • Open up a new post.
  • You should see a deprecation warning for PluginSidebar that relates to NewsletterMenu.
  • Also testing the PluginPrePublishPanel, PluginDocumentSettingPanel, and PluginPostPublishPanel here, so that is Newsletter panels in the sidebar pre and post publishing. I couldn't replicate console warnings, but we can check behaviour.

Jetpack Plugin Sidebar:

  • Used by a few panels, just opening up a new post will also result in a deprecation warning for PluginSidebar and one for PluginSidebarMoreMenuItem that relates to JetpackPluginSidebarSlot.
    Premium Content Block:
  • Add the block, then click on either subscriber or guest view. Click on the more (three dots) icon, and scroll down to see the 'Remove block and keep content' link. I couldn't replicate a console warning just here, but ensure this still works as expected.

Blaze:

  • The component relates to the Blaze panel visible on the post-publish panel after publishing a post. Test this still looks as expected. I could also replicate a PluginPostPublishPanel warning for this one, but not every time.

Payments Post Publish Panel:

  • There are steps to test this feature here - Payments: add new Payments post publish panel #23118 - I couldn't replicate the warning.
  • At the same time, check the QR post publish panel, and the SEO post publish panel (if you see one, as well as the SEO pre-publish panel) to check regular behaviour and style.

Yoast Promo:

  • Install Yoast (free version).
  • Create and publish a post. Notice in the pre publish panel a Yoast Pro.

Jetpack AI Assistant:

  • Check both the Jetpack sidebar and pre-publish sidebar AI Assistant panels look as expected. I couldn't replicate warnings for this.

On WoA, this is tricker to test as the console messages aren't very descriptive, so you can't see what may be causing them (opening up a post shows several for example both before and after the change - at least on my test sites). However you can apply the PR for both Jetpack and the Jetpack Mu WPcom plugin using the Jetpack Beta Tester.

On Simple it is the same as with WoA. However I found this easier to test as you can compare console warnings when opening a post before and after applying the changes - on my test site there were none after, and several before. For a sandboxed Simple site, apply the changes using the commands in the generated comment below. With Simple, Newsletter settings seem to be at Settings > Newsletter. And of course, you can't install Yoast ;)

@coder-karen coder-karen added [Type] Bug When a feature is broken and / or not performing as intended [Status] In Progress labels Mar 21, 2025
@coder-karen coder-karen self-assigned this Mar 21, 2025
Copy link
Contributor

github-actions bot commented Mar 21, 2025

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

  • To test on WoA, go to the Plugins menu on a WoA dev site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin (Jetpack or WordPress.com Site Helper), and enable the update/post-editor-utilities-to-site-editor branch.
  • To test on Simple, run the following command on your sandbox:
bin/jetpack-downloader test jetpack update/post-editor-utilities-to-site-editor
bin/jetpack-downloader test jetpack-mu-wpcom-plugin update/post-editor-utilities-to-site-editor

Interested in more tips and information?

  • In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
  • Read more about our development workflow here: PCYsg-eg0-p2
  • Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

Copy link
Contributor

github-actions bot commented Mar 21, 2025

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Review, ...).
  • ✅ Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖


Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Make sure to test your changes on all platforms that it applies to. You're responsible for the quality of the code you ship.
  3. You can use GitHub's Reviewers functionality to request a review.
  4. When it's reviewed and merged, you will be pinged in Slack to deploy the changes to WordPress.com simple once the build is done.

If you have questions about anything, reach out in #jetpack-developers for guidance!


Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

  • WordPress.com Simple releases happen as soon as you deploy your changes after merging this PR (PCYsg-Jjm-p2).
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly:
    • Scheduled release: April 1, 2025
    • Code freeze: March 30, 2025

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

Copy link

Code Coverage Summary

Coverage changed in 1 file.

File Coverage Δ% Δ Uncovered
projects/plugins/jetpack/extensions/plugins/ai-assistant-plugin/components/ai-assistant-plugin-sidebar/index.tsx 0/35 (0.00%) 0.00% 2 ❤️‍🩹

Full summary · PHP report · JS report

@coder-karen coder-karen marked this pull request as ready for review March 21, 2025 19:50
@coder-karen coder-karen added [Status] Needs Review This PR is ready for review. and removed [Status] In Progress labels Mar 21, 2025
@coder-karen coder-karen requested a review from a team March 21, 2025 19:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Block] Paid Content aka Premium Content [Block] Subscriptions [Extension] AI Assistant Plugin [Extension] Payments [Extension] Post Publish QR Post Panel [Extension] SEO [Package] Blaze [Package] Yoast Promo [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Status] Needs Review This PR is ready for review. [Type] Bug When a feature is broken and / or not performing as intended
Projects
None yet
Development

Successfully merging this pull request may close these issues.

WP 6.6: move from Post Editor to Site Editor versions of Utilities
1 participant