MU WPCOM: Support localizeUrl #38318

arthur791004 · 2024-07-12T08:40:58Z

Fixes https://github.com/Automattic/dotcom-forge/issues/8244

Proposed changes:

Make the localizeUrl function available in the jetpack-mu-wpcom package
Support the alternate data of the post on atomic sites
- The help center uses useSupportArticleAlternatePostKey to get the localised blog and post. However, it doesn't seem to work on atomic sites so the "Block Description" cannot open the help center with the correct document. The ETK plugin has the same issue as well
Bump @automattic/i18n-utils to 1.2.3 to get rid of the i18n-calypso dependency
- There is an issue related to the useLocale inside the help center. It would be fixed by i18n utils: Get rid of i18n-calypso dependency wp-calypso#92631 and then we can also get rid of the i18n-calypso dependency to make it easier to introduce the localizeUrl function

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?

Testing instructions:

Apply changes to your site
Make sure the links related to https://github.com/Automattic/dotcom-forge/issues/8037 are localized
- Block Description
  - Head to Site Editor.
  - Insert a block such as the Image Block or the List Block.
  - Open the Settings panel and select the Block tab.
  - Ensure that the Block Guide link is as shown in the screenshot above.
  - Ensure that clicking the link opens the Help Center.
  - Ensure it displays the correct locale.
- Tags Education
  - Head to the Post Editor.
  - Open the Settings panel, and expand the Tags section.
  - Ensure that the link "Build your audience with tags↗" is available.
  - Ensure it displays the correct locale.
- Documentation Links
  - Head to the Post Editor.
  - Open the Settings panel by clicking the Settings icon in the top bar.
  - Click the Link slug in the Post tab.
  - Ensure it displays the correct locale.

github-actions · 2024-07-12T08:42:03Z

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.

Once your PR is ready for review, check one last time that all required checks appearing at the bottom of this PR are passing or skipped.
Then, add the "[Status] Needs Team Review" label and ask someone from your team review the code. Once reviewed, it can then be merged.
If you need an extra review from someone familiar with the codebase, you can update the labels from "[Status] Needs Team Review" to "[Status] Needs Review", and in that case Jetpack Approvers will do a final review of your PR.

Mu Wpcom plugin:

Next scheduled release: August 6, 2024.
Scheduled code freeze: July 29, 2024.

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

Wpcomsh plugin:

Next scheduled release: August 6, 2024.
Scheduled code freeze: July 29, 2024.

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

github-actions · 2024-07-12T08:42:15Z

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 mu-wpcom/localize-url 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 mu-wpcom/localize-url

bin/jetpack-downloader test jetpack-mu-wpcom-plugin mu-wpcom/localize-url

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

jeherve · 2024-07-12T09:27:10Z

projects/packages/jetpack-mu-wpcom/package.json

@@ -62,6 +66,7 @@
 		"@wordpress/url": "4.2.0",
 		"@wordpress/icons": "10.2.0",
 		"clsx": "2.1.1",
+		"i18n-calypso": "7.0.0",


Would there be a way around bringing the whole of i18n-calypso to the mu-wpcom package? It was nice that we were able to stick to @wordpress/i18n until now, it would be great if we could continue to do so.

I'm not familiar enough with i18n-calypso to know if we could work around that dependency though.

It would be better to get rid of the i18n-calypso dependency from the @automattic/i18n-utils package and use @wordpress/i18n instead.

It seems to be done by just removing the usage of the getLocaleSlug call from the @automattic/i18n-utils package.

I've remove the i18n-calypso dependency from the @automattic/i18n-utils. See Automattic/wp-calypso#92631.

fushar

Tested on:

✅ Simple site
✅ Atomic site

tags-education

Before	After

wpcom-block-description-links

Before	After

wpcom-documentation-links

Before	After

fushar · 2024-07-15T11:48:07Z

@alshakero Could we request a review from you for Help-Center related changes on this PR? Thanks!

alshakero

Tested and all works. But left some code comments.

projects/packages/jetpack-mu-wpcom/src/common/index.php

alshakero · 2024-07-15T13:03:54Z

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

@@ -49,6 +48,10 @@ module.exports = [
 		},
 		resolve: {
 			...jetpackWebpackConfig.resolve,
+			alias: {
+				...jetpackWebpackConfig.resolve.alias,
+				'@automattic/calypso-config': '@automattic/calypso-config/src/client.js',


Just curious, why do we need that?

The default entry has server-side code (e.g.: path) and it causes the error during the build. As a result, we have to specify the client.js manually

...ackages/jetpack-mu-wpcom/src/features/wpcom-documentation-links/wpcom-documentation-links.ts

fushar

Retested and it still works.

arthur791004 self-assigned this Jul 12, 2024

github-actions bot added [mu wpcom Feature] Tags Education [mu wpcom Feature] Wpcom Documentation Links [mu wpcom Feature] Wpcom Block Description Links [Package] Jetpack mu wpcom WordPress.com Features labels Jul 12, 2024

github-actions bot added the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Jul 12, 2024

jeherve reviewed Jul 12, 2024

View reviewed changes

arthur791004 mentioned this pull request Jul 12, 2024

i18n utils: Get rid of i18n-calypso dependency Automattic/wp-calypso#92631

Merged

7 tasks

arthur791004 requested a review from a team July 12, 2024 10:44

arthur791004 added [Status] Needs Team Review and removed [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! labels Jul 12, 2024

github-actions bot added the [mu wpcom Feature] Help Center label Jul 15, 2024

arthur791004 requested review from a team and alshakero and removed request for a team July 15, 2024 08:05

fushar previously approved these changes Jul 15, 2024

View reviewed changes

alshakero reviewed Jul 15, 2024

View reviewed changes

arthur791004 added 6 commits July 16, 2024 10:55

MU WPCOM: Support localizeUrl

36e6ae8

changelog

fb71576

Bump @automattic/i18n-utils to 1.2.3 and simplify the build

c785ea4

Help Center: Support the alternate data of the post on atomic sites

5f443e9

Clean up

3bf96f2

Address feedback

d99f8dc

arthur791004 dismissed fushar’s stale review via d99f8dc July 16, 2024 02:55

arthur791004 force-pushed the mu-wpcom/localize-url branch from dce85c6 to d99f8dc Compare July 16, 2024 02:55

Fix versions

22f952e

github-actions bot added the [Plugin] mu wpcom jetpack-mu-wpcom plugin label Jul 16, 2024

github-actions bot added the [Plugin] Wpcomsh label Jul 16, 2024

fushar approved these changes Jul 16, 2024

View reviewed changes

arthur791004 merged commit 376356a into trunk Jul 16, 2024
70 of 72 checks passed

arthur791004 deleted the mu-wpcom/localize-url branch July 16, 2024 08:29

github-actions bot removed the [Status] Needs Team Review label Jul 16, 2024

fushar added a commit that referenced this pull request Jul 23, 2024

Revert "MU WPCOM: Support localizeUrl (#38318)"

4aa07f7

fushar added a commit that referenced this pull request Jul 23, 2024

Revert "MU WPCOM: Support localizeUrl (#38318)"

2034f4c

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

MU WPCOM: Support localizeUrl #38318

MU WPCOM: Support localizeUrl #38318

arthur791004 commented Jul 12, 2024 •

edited

Loading

github-actions bot commented Jul 12, 2024 •

edited

Loading

github-actions bot commented Jul 12, 2024 •

edited

Loading

jeherve Jul 12, 2024

arthur791004 Jul 12, 2024

arthur791004 Jul 15, 2024

fushar left a comment

fushar commented Jul 15, 2024

alshakero left a comment

alshakero Jul 15, 2024

arthur791004 Jul 16, 2024

fushar left a comment

MU WPCOM: Support localizeUrl #38318

MU WPCOM: Support localizeUrl #38318

Conversation

arthur791004 commented Jul 12, 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 Jul 12, 2024 • edited Loading

github-actions bot commented Jul 12, 2024 • edited Loading

jeherve Jul 12, 2024

Choose a reason for hiding this comment

arthur791004 Jul 12, 2024

Choose a reason for hiding this comment

arthur791004 Jul 15, 2024

Choose a reason for hiding this comment

fushar left a comment

Choose a reason for hiding this comment

tags-education

wpcom-block-description-links

wpcom-documentation-links

fushar commented Jul 15, 2024

alshakero left a comment

Choose a reason for hiding this comment

alshakero Jul 15, 2024

Choose a reason for hiding this comment

arthur791004 Jul 16, 2024

Choose a reason for hiding this comment

fushar left a comment

Choose a reason for hiding this comment

arthur791004 commented Jul 12, 2024 •

edited

Loading

github-actions bot commented Jul 12, 2024 •

edited

Loading

github-actions bot commented Jul 12, 2024 •

edited

Loading