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

Use DEWP's new auto-wp-polyfill support #39629

Open
wants to merge 1 commit into
base: trunk
Choose a base branch
from
Open

Use DEWP's new auto-wp-polyfill support #39629

wants to merge 1 commit into from
+322 −139

Conversation

anomiex
Copy link
Contributor

@anomiex anomiex commented Oct 2, 2024

Proposed changes:

@wordpress/dependency-extraction-webpack-plugin has added the ability to detect a magic /* wp:polyfill */ comment and only add wp-polyfill as a dependency if that is found. Since wp-polyfill is just a custom build of core-js, the intention is that babel-plugin-polyfill-corejs3 (maybe via @babel/preset-env) would be used and then a custom Babel plugin would replace the core-js imports with the magic comment.

This updates our Babel config to do just that, and removes the blanket addition of wp-polyfill via injectPolyfill or otherwise.

Effects

Removes unnecessary wp-polyfill from the following:

  • packages/explat
  • packages/forms block view.js
  • packages/jitm
  • packages/plugin-deactivation
  • All Jetpack block view.js except Map, Recurring Payments, Subscriptions, Story, Nextdoor, and Podcast Player.
  • packages/videopress divi-editor/index.js, player-bridge.js, and block view.js

Also it adds wp-polyfill as a dependency for a few things that were missing it before:

  • Boost's inline-liar.js
  • packages/connection scripts
  • packages/forms jetpack-forms-dashboard.js
  • Lots of mu-wpcom scripts:
    • block-inserter-modifications.js
    • newspack-blocks-blog-posts-editor.js
    • newspack-blocks-blog-posts-view.js
    • newspack-blocks-carousel-editor.js
    • tags-education.js
    • verbum-comments.js
    • wpcom-block-description-links.js
    • wpcom-block-editor-nux.js
    • wpcom-blocks-event-countdown-editor.js
    • wpcom-blocks-timeline-editor.js
    • wpcom-global-styles-editor.js
  • js-packages/react-data-sync-client
  • js-packages/svelte-data-sync-client

The following specifically weren't changed:

  • packages/search and packages/wordads still unconditionally include the dep, and also embed core-js directly.

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

Fixes #39452

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

Testing instructions:

  • Verify that using Jetpack blocks other than the ones mentioned doesn't trigger wp-polyfill on the frontend anymore.
  • Other than that, 🤷. There are no real changes in the bundled code here, only the addition or removal of polyfills for older-but-still-supported browsers.

P.S. If building locally to test, you may want to delete any stray .cache/ directories first. Babel seems not to notice changes in the preset and so incorrectly reuses cache entries from older builds.

@anomiex
Use DEWP's new auto-wp-polyfill support
08733b8 
`@wordpress/dependency-extraction-webpack-plugin` has added the ability
to detect a magic `/* wp:polyfill */` comment and only add `wp-polyfill`
as a dependency if that is found. Since `wp-polyfill` is just a custom
build of `core-js`, the intention is that
`babel-plugin-polyfill-corejs3` (maybe via `@babel/preset-env`) would be
used and then a custom Babel plugin would replace the `core-js` imports
with the magic comment.

This updates our Babel config to do just that, and removes the blanket
addition of `wp-polyfill` via `injectPolyfill` or otherwise.
@anomiex anomiex added [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it [Status] Needs Review To request a review from Crew. Label will be renamed soon. [Pri] Normal labels Oct 2, 2024
@anomiex anomiex requested review from simison, sgomes, sirreal and a team October 2, 2024 20:18
@anomiex anomiex self-assigned this Oct 2, 2024
@github-actions github-actions bot added [Plugin] Classic Theme Helper Plugin [Plugin] CRM Issues about the Jetpack CRM plugin [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Plugin] Migration [Plugin] mu wpcom jetpack-mu-wpcom plugin [Plugin] Protect A plugin with features to protect a site: brute force protection, security scanning, and a WAF. [Plugin] Search A plugin to add an instant search modal to your site to help visitors find content faster. [Plugin] Social Issues about the Jetpack Social plugin [Plugin] Starter Plugin [Plugin] VideoPress A standalone plugin to add high-quality VideoPress videos to your site. [Plugin] Wpcomsh Docs RNA labels Oct 2, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 2, 2024

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 Team Review, ...).
  • ✅ 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 🤖

The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.

Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Choose a review path based on your changes:
    • A. Team Review: add the "[Status] Needs Team Review" label
      • For most changes, including minor cross-team impacts.
      • Example: Updating a team-specific component or a small change to a shared library.
    • B. Crew Review: add the "[Status] Needs Review" label
      • For significant changes to core functionality.
      • Example: Major updates to a shared library or complex features.
    • C. Both: Start with Team, then request Crew
      • For complex changes or when you need extra confidence.
      • Example: Refactor affecting multiple systems.
  3. Get at least one approval before merging.

Still unsure? 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 semi-continuously (PCYsg-Jjm-p2).
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for November 5, 2024 (scheduled code freeze on November 4, 2024).

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

Backup plugin:

  • Next scheduled release: none scheduled.

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

Boost plugin:

  • Next scheduled release: none scheduled.

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

Search plugin:

  • Next scheduled release: none scheduled.

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

Social plugin:

  • Next scheduled release: none scheduled.

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

Starter Plugin plugin:

  • Next scheduled release: none scheduled.

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

Protect plugin:

  • Next scheduled release: none scheduled.

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

Videopress plugin:

  • Next scheduled release: none scheduled.

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

Migration plugin:

  • Next scheduled release: none scheduled.

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

Mu Wpcom plugin:

  • Next scheduled release: WordPress.com Simple releases happen semi-continuously (PCYsg-Jjm-p2).

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

Wpcomsh plugin:

  • Next scheduled release: Atomic deploys happen twice daily on weekdays (p9o2xV-2EN-p2).

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

Automattic For agencies client plugin:

  • Next scheduled release: none scheduled.

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

Classic Theme helper plugin plugin:

  • Next scheduled release: none scheduled.

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

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 2, 2024 •
edited
Loading

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 WordPress.com Simple 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, and enable the add/dependency-extraction-auto-polyfill branch.

    • For jetpack-mu-wpcom changes, also add define( 'JETPACK_MU_WPCOM_LOAD_VIA_BETA_PLUGIN', true ); to your wp-config.php file.

  • To test on Simple, run the following command on your sandbox:

    bin/jetpack-downloader test jetpack add/dependency-extraction-auto-polyfill

    bin/jetpack-downloader test jetpack-mu-wpcom-plugin add/dependency-extraction-auto-polyfill

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

@simison
Copy link
Member

simison commented Oct 3, 2024 •
edited
Loading

Amazing!

verbum-comments.js

This one is a bummer, because it'll force wp-polyfill to frontend of many sites on each post. cc @automattic/vertex in case anything could be done about it. Not a blocker at all for this PR.

@sgomes
Copy link
Contributor

sgomes commented Oct 3, 2024 •
edited
Loading

verbum-comments.js

This one is a bummer, because it'll force wp-polyfill to frontend of many sites on each post.

@simison I believe verbum-comments.js is loaded dynamically, not statically enqueued, so this shouldn't be a problem. The polyfills should simply be another dependency that gets lazily loaded immediately before verbum-comments.js itself.

@anomiex
Copy link
Contributor Author

anomiex commented Oct 3, 2024

If we want Verbum not to check for polyfills, it looks like it's already set up so we would just have to change

jetpack/projects/packages/jetpack-mu-wpcom/verbum.webpack.config.js

Line 17 in 08733b8

presets: [ [ '@automattic/jetpack-webpack-config/babel/preset' ] ],

to do [ '@automattic/jetpack-webpack-config/babel/preset', { autoWpPolyfill: false } ] instead. Looking back at #34993 it wasn't clear to me whether dropping injectPolyfill in 69dd842 was intentional or accidental.

P.S. wp-polyfill is being triggered for Verbum because of use of URLSearchParams to polyfill has, delete, and size. Which may not even be used, I think the polyfiller does it "just in case" when it sees URLSearchParams being used at all instead of trying to do a deep static analysis. Or even just URL in case its .searchParams gets used somewhere.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@simison simison Awaiting requested review from simison

@sgomes sgomes Awaiting requested review from sgomes

@sirreal sirreal Awaiting requested review from sirreal

Assignees

@anomiex anomiex

Labels
Docs [Feature] Contact Form [Feature] Masterbar WordPress.com Toolbar and Dashboard customizations [Feature] Theme Tools [JS Package] Webpack Config [Package] Ad aka WordAds [Package] Backup [Package] Blaze [Package] Classic Theme Helper [Package] Explat [Package] Forms [Package] Jetpack mu wpcom WordPress.com Features [Package] Jitm [Package] Masterbar [Package] My Jetpack [Package] Plugin Deactivation [Package] Search Contains core Search functionality for Jetpack and Search plugins [Package] VideoPress [Package] Yoast Promo [Plugin] Automattic For Agencies Client [Plugin] Backup A plugin that allows users to save every change and get back online quickly with one-click restores. [Plugin] Boost A feature to speed up the site and improve performance. [Plugin] Classic Theme Helper Plugin [Plugin] CRM Issues about the Jetpack CRM plugin [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Plugin] Migration [Plugin] mu wpcom jetpack-mu-wpcom plugin [Plugin] Protect A plugin with features to protect a site: brute force protection, security scanning, and a WAF. [Plugin] Search A plugin to add an instant search modal to your site to help visitors find content faster. [Plugin] Social Issues about the Jetpack Social plugin [Plugin] Starter Plugin [Plugin] VideoPress A standalone plugin to add high-quality VideoPress videos to your site. [Plugin] Wpcomsh [Pri] Normal RNA [Status] Needs Review To request a review from Crew. Label will be renamed soon. [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Blocks: require wp-polyfill only when really needed
3 participants
@anomiex @simison @sgomes