[Blueprints] setSiteLanguage step – download the latest RC translations for Nightly and Beta builds of WordPress #1987

bgrgicak · 2024-11-07T12:02:00Z

This PR enables using setSiteLanguage with beta and nightly WordPress versions:

{
	"preferredVersions": {
		"php": "8.0",
		"wp": "beta"
	},
	"steps": [
		{
			"step": "setSiteLanguage",
			"language": "en_GB"
		}
	]
}

Before this PR, the above Blueprint would fetch translations from https://downloads.wordpress.org/translation/core/6.7-RC2/es_ES.zip and fail after a 404 API response from the WordPress.org translations API. The 6.7-RC2 version string in the URL came directly from WordPress's version.php.

The WordPress translations API only offers translations for full, official WordPress releases (e.g. 6.6, 6.6.1)
plus RC translations for each major WordPress version (e.g. 6.6-RC, 6.7-RC). Note that beta and RC versions use the same translations bundle. Also, there is no translation bundle for the development versions so the best we can do is download the latest RC translations.

This PR transforms the raw version string, such as 6.7-RC2 or 6.8-alpha-59341, into one recognized by the API, such as 6.7-RC or 6.8-RC. As a result, the above Blueprint now fetches the translations from https://downloads.wordpress.org/translation/core/6.7-RC/es_ES.zip.

Testing Instructions (or ideally a Blueprint)

CI

Manual testing instructions

Open Nightly in Spanish http://127.0.0.1:5400/website-server/?wp=nightly&language=es_ES&url=%2Fwp-admin%2F
Confirm WP-admin is in Spanish
Open Beta in Spanish http://127.0.0.1:5400/website-server/?wp=beta&language=es_ES&url=%2Fwp-admin%2F
Confirm WP-admin is in Spanish
Open 6.5 in Spanish http://127.0.0.1:5400/website-server/?wp=6.5&language=es_ES&url=%2Fwp-admin%2F
Confirm WP-admin is in Spanish

… builds of WordPress

bgrgicak · 2024-11-07T12:38:20Z

packages/playground/wordpress/src/version-detect.ts

+/**
+ * Returns a WordPress build version string known to Playground
+ * for a given WordPress version string.
+ *
+ * Each released version will be converted to the major.minor format.
+ * For example 6.6.1 will be converted to 6.6.
+ *
+ * Release candidates (RC) and beta releases are converted to the "beta"
+ *
+ * Nightly releases are converted to "nightly".
+ *
+ * @param wpVersionString - A WordPress version string.
+ * @returns A Playground WordPress build version.
+ */


I documented this function as it wasn't fully clear to me what it does.

Lovely, thank you! Let's explain what's "known to Playground" in "build version string known to Playground". Also, the downloads.wordpress.org aspect of this function is relevant – the returned identifier can be interpolated into a URL to download a WordPress release – let's cover that as well similarly to how the docstring inside getWordPressTranslationUrl explains it.

I added a change to explain "build version string known to Playground".

Also, the downloads.wordpress.org aspect of this function is relevant – the returned identifier can be interpolated into a URL to download a WordPress release – let's cover that as well similarly to how the docstring inside getWordPressTranslationUrl explains it.

I'm not sure I understand what you would like to document here.

If we are talking about WordPress releases from wordpress.org.
This function output can't be interpolated to a URL to download a WordPress release.
This is exactly why we had to implement getWordPressTranslationUrl.
WordPress ZIP download URLs are even more different, for example:

nighty: https://wordpress.org/nightly-builds/wordpress-latest.zip

6.6: https://downloads.w.org/release/wordpress-6.6.2.zip

I documented this function as it wasn't fully clear to me what it does.

That function definitely deserved documentation. I'm sorry for not providing it initially. Thank you for catching and fixing it, @bgrgicak!

related thought: I wonder if there would be value in exposing a WP version parsing lib from WP core.

The scheme may be well-documented someplace, but the way I wrote the initial code was simply by sampling version strings from different revisions of wp-includes/versions.php at different points in the release cycle.

Great idea!

adamziel · 2024-11-16T00:05:13Z

packages/playground/wordpress/src/version-detect.ts

 * for a given WordPress version string.
 *
+ * Playground supports the last 4 major.minor versions of WordPress,


This is incorrect, though. There's nothing in this function that limits the returned version to the last 4 major releases.

True, I wanted to explain what supported means with that sentence, but it's actually not relevant.

I removed the mention of support in 0d062ea because it's not relevant.

adamziel · 2024-11-16T00:09:36Z

packages/playground/blueprints/src/lib/steps/set-site-language.ts

+	 * For example translations for WordPress 6.6-BETA1 or 6.6-RC1 are found under
+	 * https://downloads.wordpress.org/translation/core/6.6-RC/en_GB.zip
+	 */
+	const wpVersionString = versionStringToLoadedWordPressVersion(wpVersion);


Note that if wpVersion is "woah-this-is-cool" then wpVersionString will also be "woah-this-is-cool". What would be a sensible fallback here? Perhaps a dedicated version conversion logic would make more sense here?

8cf6394 will default translations to the latest WP version to ensure we can always have a valid URL.

Since this already uses involved patterns, calling versionStringToLoadedWordPressVersion seem to add complexity. What would this look like without that call?

It would look something like this f1f5842

I like this approach more, relying on versionStringToLoadedWordPressVersion could lead to issues if the function is changed, especially without tests.

Lovely, looking good. Thank you!

…lations Uses a major WordPress version to fetch the translations, e.g. https://downloads.wordpress.org/translation/core/6.6-RC/en_US.zip instead of https://downloads.wordpress.org/translation/core/6.6.1-RC/en_US.zip This fixes an issue introduced in #1987 that caused the E2E tests to fail on trunk: ``` ✘ 77 [chromium] › blueprints.spec.ts:438:6 › should translate WP-admin to Spanish for the beta WordPress build (retry #3) (30.2s) ``` The setSiteLanguage step would try to download the translations from https://downloads.wordpress.org/translation/core/6.7.1-RC/es_ES.zip which responded with a 404, instead of https://downloads.wordpress.org/translation/core/6.7-RC/es_ES.zip where the translations are actually available. ## Testing instructions * Confirm the E2E tests pass * Go here and confirm you can see a Spanish version of wp admin: http://localhost:5400/website-server/?language=es_ES&url=%2Fwp-admin%2F&wp=beta&modal=error-report

…lations (#2017) Uses a major WordPress version to fetch the translations, e.g. `https://downloads.wordpress.org/translation/core/6.6-RC/en_US.zip` instead of `https://downloads.wordpress.org/translation/core/6.6.1-RC/en_US.zip` This fixes an issue introduced in #1987 that caused the E2E tests to fail on trunk: ``` ✘ 77 [chromium] › blueprints.spec.ts:438:6 › should translate WP-admin to Spanish for the beta WordPress build (retry #3) (30.2s) ``` The setSiteLanguage step would try to download the translations from https://downloads.wordpress.org/translation/core/6.7.1-RC/es_ES.zip which responded with a 404, instead of https://downloads.wordpress.org/translation/core/6.7-RC/es_ES.zip where the translations are actually available. ## Testing instructions * Confirm the E2E tests pass * Go here and confirm you can see a Spanish version of wp admin: http://localhost:5400/website-server/?language=es_ES&url=%2Fwp-admin%2F&wp=beta&modal=error-report

adamziel · 2024-11-25T16:04:28Z

This PR created a dependency between the Blueprints package and the WordPress builds package. @bgrgicak let's pull the WordPress version details from api.wordpress.org/core/version-check/1.7?channel=beta instead of using the version of the latest minified web build the web as a proxy for the latest WordPress version.

adamziel · 2024-11-25T16:05:27Z

The resolveWPRelease CLI function might be ripe for reuse in the Blueprints library. That's one less Playground CLI-specific code path.

@swissspidy

… of assuming it's the same as the last minified build (#2027) #1987 created a dependency between the `@wp-playground/blueprints` package and the `@wp-playground/wordpress-builds` package breaking `@wp-playground/cli` – see #2026 This PR updates the setSiteLanguage step to pull the latest/best WordPress version details from api.wordpress.org/core/version-check/1.7?channel=beta instead of implicitly assuming the latest version is the same as that of the latest minified web build. It reuses the Playground CLI resolveWordPressRelease function, bringing us closer to having zero CLI-specific logic. ## Follow-up work Invent an ESLint rule to prevent further dependencies on `@wp-playground/wordpress-builds` ## Testing instructions * CI tests * Run Playground CLI via `bun packages/playground/cli/src/cli.ts server` and confirm WordPress is still being downloaded without errors. cc @swissspidy @bgrgicak

bgrgicak added 3 commits November 7, 2024 12:16

[Blueprints] Download the latest RC translations for Nightly and Beta…

367e32b

… builds of WordPress

Document released version translation fetching

b28ea9d

Document released version translations

0b975df

bgrgicak self-assigned this Nov 7, 2024

bgrgicak added [Type] Bug An existing feature does not function as intended [Package][@wp-playground] Blueprints labels Nov 7, 2024

bgrgicak requested a review from a team November 7, 2024 12:05

bgrgicak commented Nov 7, 2024

View reviewed changes

bgrgicak and others added 6 commits November 7, 2024 13:52

Add language translation E2E tests

317671b

Merge branch 'trunk' into fix/rc-and-nigtly-translation-fetching

c9590cf

Switch WP version in tests

fc73235

Update test names

848fe8c

Update docstrings

8660c14

Merge branch 'trunk' into fix/rc-and-nigtly-translation-fetching

df4d543

adamziel reviewed Nov 16, 2024

View reviewed changes

bgrgicak added 2 commits November 18, 2024 08:02

Remove mention of supported versions

0d062ea

Default to latest version for translations

8cf6394

bgrgicak requested a review from adamziel November 18, 2024 07:28

bgrgicak added 3 commits November 18, 2024 08:28

Merge branch 'trunk' into fix/rc-and-nigtly-translation-fetching

a339b9a

Update docblock

57658e6

Replace versionStringToLoadedWordPressVersion with a regex and add tests

f1f5842

adamziel changed the title ~~[Blueprints] Download the latest RC translations for Nightly and Beta builds of WordPress~~ [Blueprints] setSiteLanguage step – download the latest RC translations for Nightly and Beta builds of WordPress Nov 19, 2024

adamziel merged commit 3a3f2b6 into trunk Nov 19, 2024
10 checks passed

adamziel deleted the fix/rc-and-nigtly-translation-fetching branch November 19, 2024 13:03

adamziel mentioned this pull request Nov 22, 2024

Blueprints: Use the major WordPress version to download RC/beta translations #2017

Merged

adamziel mentioned this pull request Nov 25, 2024

Cannot find package @wp-playground/wordpress-builds #2026

Closed

adamziel mentioned this pull request Nov 25, 2024

Blueprints: Resolve the latest WordPress version from the API instead of assuming it's the same as the last minified build #2027

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Blueprints] setSiteLanguage step – download the latest RC translations for Nightly and Beta builds of WordPress #1987

[Blueprints] setSiteLanguage step – download the latest RC translations for Nightly and Beta builds of WordPress #1987

bgrgicak commented Nov 7, 2024 •

edited by adamziel

Loading

bgrgicak Nov 7, 2024

adamziel Nov 13, 2024

bgrgicak Nov 14, 2024

brandonpayton Dec 2, 2024 •

edited

Loading

brandonpayton Dec 2, 2024

adamziel Dec 3, 2024

adamziel Nov 16, 2024

bgrgicak Nov 18, 2024

bgrgicak Nov 18, 2024

adamziel Nov 16, 2024

bgrgicak Nov 18, 2024

adamziel Nov 18, 2024

bgrgicak Nov 18, 2024

adamziel Nov 19, 2024

adamziel commented Nov 25, 2024

adamziel commented Nov 25, 2024

[Blueprints] setSiteLanguage step – download the latest RC translations for Nightly and Beta builds of WordPress #1987

[Blueprints] setSiteLanguage step – download the latest RC translations for Nightly and Beta builds of WordPress #1987

Conversation

bgrgicak commented Nov 7, 2024 • edited by adamziel Loading

Testing Instructions (or ideally a Blueprint)

Manual testing instructions

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

brandonpayton Dec 2, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adamziel commented Nov 25, 2024

adamziel commented Nov 25, 2024

bgrgicak commented Nov 7, 2024 •

edited by adamziel

Loading

brandonpayton Dec 2, 2024 •

edited

Loading