Move localizeUrl to new i18n-utils package

[lsl]

Changes proposed in this Pull Request

• Moves lib/i18n-utils' localizeUrl function to a new package in packages/i18n-utils

Testing instructions

localizeUrl tests were included in the move:

yarn test-client client/lib/i18n-utils
yarn workspace @automattic/i18n-utils test

Manual testing involves checking localizeUrl usage still works as expected for example:

• Set locale to german or french using the account settings page http://calypso.localhost:3000/me/account
• Navigate to http://calypso.localhost:3000/me/privacy
• The link to https://automattic.com/privacy should be localized (e.g. https://automattic.com/fr/privacy) but should point to the original english url for any other language.

---

• Partially fixes Gutenboarding: i18n #37665 - introduces / exposes localizeUrl for use in apps/packages.
• Enables a fix for Localize Support URL for HSTS Tooltip in Domain Picker #45610

[matticbot]

Test live: https://calypso.live/?branch=add/i18n-utils-package

[matticbot]

Caution: This PR affects files in the Editing Toolkit Plugin on WordPress.com
Please ensure your changes work on WordPress.com before merging.

D52130-code has been created so you can easily test it on your sandbox. See this FieldGuide page about developing the Editing Toolkit Plugin for more info: PCYsg-ly5-p2

[matticbot]

Here is how your PR affects size of JS and CSS bundles shipped to the user's browser:

App Entrypoints (~345 bytes added 📈 [gzipped])

name                   parsed_size           gzip_size
entry-main                  +291 B  (+0.0%)     +103 B  (+0.0%)
entry-login                 +291 B  (+0.0%)      +90 B  (+0.0%)
entry-gutenboarding         +291 B  (+0.0%)      +70 B  (+0.0%)
entry-domains-landing       +291 B  (+0.1%)      +82 B  (+0.1%)

Common code that is always downloaded and parsed every time the app is loaded, no matter which route is used.

Legend

What is parsed and gzip size?

Parsed Size: Uncompressed size of the JS and CSS files. This much code needs to be parsed and stored in memory.
Gzip Size: Compressed size of the JS and CSS files. This much data needs to be downloaded over network.

Generated by performance advisor bot at iscalypsofastyet.com.

[lsl]

@yuliyan / @scinos

Parts of this i18n-utils package make more sense to be part of packages/languages: e.g. getLanguage( langSlug ) just performs a lookup on the language data with a fallback to parent locale if available, and isTranslatedIncompletely just returns a value of the language looked up by getLanguage

The remaining parts make more sense to be part of package/i18n-calypso. e.g. canBeTranslated, translationExists, isMagnificentLocale are all very a8c specific or depend on i18n-calypso to get the current locale (like localizeUrl)

My thinking is maybe to split i18n-utils up between the two existing packages and drop the notion of a new one. Does this sound ok or is there still a push to drop i18n-calypso in favor of @wordpress/i18n? In which case it may be wise to keep i18n-utils in play with some/none of it moved into languages. It would still depend on i18n-calypso but that can be dropped as soon as there is a replacement solution for getLocaleSlug (the only problematic dep.)

[lsl]

@scinos I copy and pasted most of these config files / settings from elsewhere and have only looked into a handful of what each thing does so I very much appreciate the audit! 🍻

Most of your comments were on code from the other PR #46709 so I've fixed there and rebased here. Thanks!

[yuliyan]

Parts of this i18n-utils package make more sense to be part of packages/languages: e.g. getLanguage( langSlug ) just performs a lookup on the language data with a fallback to parent locale if available, and isTranslatedIncompletely just returns a value of the language looked up by getLanguage

That makes sense and I think moving them into @automattic/languages is fine. As for the remaining helpers, I like the idea of having them separate from i18n-calypso better. With @wordpress/i18n we would be forced to have them in a separate package anyway, so I think it will make the transition more smooth.

[p-jackson]

Looks good so far. I realise it's still a WIP, just left a couple notes. Let me know if there's anything I can help with.

[p-jackson]

I haven't quite finished my review yet: I can't seem to build calypso locally, and it also looks like there's a change where the new package isn't doing some sort of lazy load of something out of the config and I want to get to the bottom of that.

[wp-desktop]

WordPress Desktop CI Failure for job "wp-desktop-mac".

@lsl please inspect this job's build steps for breaking changes at this link. For temporal failures, you may try to "Rerun Workflow from Failed".

Please also ensure this branch is rebased off latest Calypso.

wp-desktop ci passing, closing review

[p-jackson]

Looks good 👍

[lsl]

This sort of non-side-by-side refactor is quite hard to do safely, caught a sloppy copy paste bug testing random links in the UI: 59dd2bc (#46998), and it just so happened that we were missing test coverage for the scenario that was introduced!

[yuliyan]

Are #localizeUrl unit tests in lib/i18n-utils now redundant? If so, let's remove them in a follow-up PR before they start failing.

Edit: Please ignore my comment above, I was looking at an outdated version of the file.