Connection: Load connection JS bundle via connection PHP package

[manzoorwanijk]

Extracted out of #38330

Problem

For publicize (Social), the JS code that gets bundled in Jetpack takes precedence over Social even if Social is the latest version. This is not the case with PHP packages, for which we always load the latest version regardless.

This mismatch of PHP and JS code often results in bugs.

Also, bundled JS code makes it difficult to fix a bug in Jetpack given the monthly release cycle. Thus, we decided to bundle the publicize JS code into publicize package to ensure that the latest version of the publicize JS code is loaded both in Jetpack and Social.

Now, to be able to externalize publicize, we also need to externalize connection js code to avoid it getting bundled into publicize code and fix some API call errors due to duplicate instances of connection bundle both in publicize bundle as well as in the plugins (Jetpack and Social)

Benefits

• JS Code for connection will always be in sync with its PHP package, i.e. the latest version gets loaded.
• Plugins will have smaller js bundles

Proposed changes:

• Bundle connection JS code inside connection PHP package
• Let connection PHP package handle the registration or script for the connection bundle
• Externalize that connection bundle for all the plugins/packages
• The connection bundle will now be available via window.JetpackConnection just like @wordpress/* packages are available via window.wp.*

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

pdrWKz-1Mq-p2

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

Testing instructions:

• Run jetpack build packages/assets packages/connection plugins/jetpack
• Just do a smoke test of the pages that rely on Jetpack connection

[github-actions]

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 daily.
• WoA releases happen weekly.
• Releases to self-hosted sites happen monthly. The next release is scheduled for none scheduled (scheduled code freeze on undefined).

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.

[github-actions]

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 update/load-connection-js-bundle-via-connection-package 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 update/load-connection-js-bundle-via-connection-package
  

  bin/jetpack-downloader test jetpack-mu-wpcom-plugin update/load-connection-js-bundle-via-connection-package
  

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

[manzoorwanijk]

I will fix up versions once this gets an approval to avoid noise in the PR.

[coder-karen]

👋 I gave this a spin, testing different scenarios related to connection. One thing I noticed was that both on disconnecting and connecting Jetpack, with this PR applied the related modals seemed to be missing styling. So it looks like the way CSS styles are applied may be affected in some way via this PR. Examples here:
Connection:

Disconnection (bottom part of modal):

[manzoorwanijk]

Thank you for giving this a test...

👋 I gave this a spin, testing different scenarios related to connection. One thing I noticed was that both on disconnecting and connecting Jetpack, with this PR applied the related modals seemed to be missing styling. So it looks like the way CSS styles are applied may be affected in some way via this PR.

Did you run jetpack build packages/connection plugins/jetpack before loading that page?

[manzoorwanijk]

👋 I gave this a spin, testing different scenarios related to connection. One thing I noticed was that both on disconnecting and connecting Jetpack, with this PR applied the related modals seemed to be missing styling. So it looks like the way CSS styles are applied may be affected in some way via this PR.

I have fixed the issue for connection screen. I assumed that all our scripts are registered via Automattic\Jetpack\Assets::register_script and enqueued via Automattic\Jetpack\Assets::enqueue_script which automatically takes care of loading the styles, but I noticed that it's not the case with admin page styles and thus had to explicitly add connection CSS as a dependency.

[anomiex]

@coder-karen If the issues you found are fixed, I think this is good to go. Do you have time to check it again? Otherwise I'll try to test it.

Issues addressed