i18n loader script: load script in the footer and defer it. #38929

jeherve · 2024-08-16T12:36:12Z

Proposed changes:

Let's load that script in the footer of the page to improve performance.

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

Related conversation: p55Cj4-3qL-p2

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

No

Testing instructions:

Start by switching your site's language to French in Settings > General.
Go to Dashboard > Updates and ensure that there are no pending translation updates.
Go to Jetpack > Dashboard > My Plans
Purchase a Jetpack Search Plan
Back on the site, go to Jetpack > Settings > Performance
Enable Search and Instant Search
Go to Appearance > Editor
Add a Search block somewhere on your homepage.
Load your site's frontend.
Click on the search field and launch a search.
The Instant Search modal should pop up.
The different UI elements in the modal should be in French.
Now check the site's source code, and search for wp-jp-i18n-loader
The script should be loaded close to the footer of the page.

To test the changes to react-jsx-runtime, you'll need to run through the testing instructions in #38428.

Related conversation: p55Cj4-3qL-p2

github-actions · 2024-08-16T12:37:22Z

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/i18n-loader-footer 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/i18n-loader-footer

bin/jetpack-downloader test jetpack-mu-wpcom-plugin update/i18n-loader-footer

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

github-actions · 2024-08-16T12:37:45Z

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:

Ensure all required checks appearing at the bottom of this PR are passing.
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.
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 September 3, 2024 (scheduled code freeze on September 2, 2024).

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

anomiex

This works, although it doesn't look like there's much point to the "defer" part since the existence of an "after" script will always disable it.

anomiex

Also, it might be worth doing similarly for the 'react-jsx-runtime' registered just below this.

anomiex · 2024-08-16T14:14:57Z

projects/packages/assets/tests/php/test-assets.php

@@ -729,7 +729,7 @@ function ( $v ) {

 		// @phan-suppress-next-line PhanDeprecatedFunction -- Keep using setMethods until we drop PHP 7.0 support.
 		$mock = $this->getMockBuilder( \stdClass::class )
-			->setMethods( array( 'add', 'add_inline_script' ) )
+			->setMethods( array( 'add', 'add_inline_script', 'add_data' ) )


Should we add some $mock->expects( ... )->method( 'add_data' ) to check that the proper calls were made for that too?

Sure thing, good idea. Done in 1503ba4

It won't be needed: #38929 (review)

See #38929 (review) Co-authored-by: Brad Jorsch <[email protected]>

See #38929 (comment)

jeherve · 2024-08-16T14:56:08Z

It doesn't look like there's much point to the "defer" part since the existence of an "after" script will always disable it.

Good point. Removed in ec10133

Also, it might be worth doing similarly for the 'react-jsx-runtime' registered just below this.

👍 Done in 82fb0aa

anomiex · 2024-08-16T15:53:54Z

projects/packages/assets/changelog/update-i18n-loader-footer

+Significance: patch
+Type: changed
+
+i18n loader script: load script in the footer and defer it.


Update this?

Good point. 2c1de55

* i18n loader script: load script in the footer and defer it. Related conversation: p55Cj4-3qL-p2 * Add 'add_data' mock * Remove defer strategy It won't be needed: Automattic/jetpack#38929 (review) * Also add react-jsx-runtime to be loaded in footer See Automattic/jetpack#38929 (review) Co-authored-by: Brad Jorsch <[email protected]> * Add test to ensure add_data is being called See Automattic/jetpack#38929 (comment) * Update changelog --------- Co-authored-by: Brad Jorsch <[email protected]> Committed via a GitHub action: https://github.com/Automattic/jetpack/actions/runs/10469831354 Upstream-Ref: Automattic/jetpack@63cd636

* i18n loader script: load script in the footer and defer it. Related conversation: p55Cj4-3qL-p2 * Add 'add_data' mock * Remove defer strategy It won't be needed: #38929 (review) * Also add react-jsx-runtime to be loaded in footer See #38929 (review) Co-authored-by: Brad Jorsch <[email protected]> * Add test to ensure add_data is being called See #38929 (comment) * Update changelog --------- Co-authored-by: Brad Jorsch <[email protected]>

i18n loader script: load script in the footer and defer it.

8ab6558

Related conversation: p55Cj4-3qL-p2

jeherve requested review from sgomes and anomiex August 16, 2024 12:36

jeherve self-assigned this Aug 16, 2024

github-actions bot added the [Package] Assets label Aug 16, 2024

Add 'add_data' mock

b744b31

github-actions bot added the [Tests] Includes Tests label Aug 16, 2024

anomiex previously approved these changes Aug 16, 2024

View reviewed changes

anomiex reviewed Aug 16, 2024

View reviewed changes

jeherve and others added 3 commits August 16, 2024 16:48

Remove defer strategy

ec10133

It won't be needed: #38929 (review)

Also add react-jsx-runtime to be loaded in footer

82fb0aa

See #38929 (review) Co-authored-by: Brad Jorsch <[email protected]>

Add test to ensure add_data is being called

1503ba4

See #38929 (comment)

jeherve dismissed anomiex’s stale review via 1503ba4 August 16, 2024 14:54

jeherve added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. and removed [Status] In Progress labels Aug 16, 2024

anomiex reviewed Aug 16, 2024

View reviewed changes

Update changelog

2c1de55

anomiex approved these changes Aug 16, 2024

View reviewed changes

jeherve merged commit 63cd636 into trunk Aug 20, 2024
73 checks passed

jeherve deleted the update/i18n-loader-footer branch August 20, 2024 10:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

i18n loader script: load script in the footer and defer it. #38929

i18n loader script: load script in the footer and defer it. #38929

jeherve commented Aug 16, 2024 •

edited

Loading

github-actions bot commented Aug 16, 2024 •

edited

Loading

github-actions bot commented Aug 16, 2024

anomiex left a comment

anomiex left a comment

anomiex Aug 16, 2024

jeherve Aug 16, 2024

jeherve commented Aug 16, 2024

anomiex Aug 16, 2024

jeherve Aug 16, 2024

i18n loader script: load script in the footer and defer it. #38929

i18n loader script: load script in the footer and defer it. #38929

Conversation

jeherve commented Aug 16, 2024 • edited Loading

Proposed changes:

Other information:

Jetpack product discussion

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

Testing instructions:

github-actions bot commented Aug 16, 2024 • edited Loading

github-actions bot commented Aug 16, 2024

anomiex left a comment

Choose a reason for hiding this comment

anomiex left a comment

Choose a reason for hiding this comment

anomiex Aug 16, 2024

Choose a reason for hiding this comment

jeherve Aug 16, 2024

Choose a reason for hiding this comment

jeherve commented Aug 16, 2024

anomiex Aug 16, 2024

Choose a reason for hiding this comment

jeherve Aug 16, 2024

Choose a reason for hiding this comment

jeherve commented Aug 16, 2024 •

edited

Loading

github-actions bot commented Aug 16, 2024 •

edited

Loading