Fix latest plugin version not being downloaded consistently #1693

ShyamGadde · 2024-11-22T13:58:48Z

Summary

This is done so that it automatically downloads the latest version

github-actions · 2024-11-22T14:07:15Z

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: ShyamGadde <[email protected]>
Co-authored-by: westonruter <[email protected]>
Co-authored-by: felixarntz <[email protected]>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

westonruter · 2024-11-22T17:49:55Z

plugins/performance-lab/includes/admin/plugins.php

@@ -372,7 +372,9 @@ function perflab_install_and_activate_plugin( string $plugin_slug, array &$proce
 		// Replace new Plugin_Installer_Skin with new Quiet_Upgrader_Skin when output needs to be suppressed.
 		$skin     = new WP_Ajax_Upgrader_Skin( array( 'api' => $plugin_data ) );
 		$upgrader = new Plugin_Upgrader( $skin );
-		$result   = $upgrader->install( $plugin_data['download_link'] );
+		// Remove the version number from the link to download the latest plugin version.
+		$download_link = (string) preg_replace( '#(\/plugin\/[^\/]+)\.\d+\.\d+\.\d+\.zip#', '$1.zip', $plugin_data['download_link'] );


It might be safer to do:

Suggested change

$download_link = (string) preg_replace( '#(\/plugin\/[^\/]+)\.\d+\.\d+\.\d+\.zip#', '$1.zip', $plugin_data['download_link'] );

$download_link = (string) preg_replace( '#(\/plugin\/[^\/]+)\.\d.*.zip#', '$1.zip', $plugin_data['download_link'] );

The reason being that it's possible for plugin versions to have -rc or -beta tagged on.

For example:
https://wordpress.org/plugins/rest-api/
=>
https://downloads.wordpress.org/plugin/rest-api.2.0-beta15.zip

Granted, it's highly unlikely that we'll ever release one of our plugins with such a Stable Tag, and it's not super common across the repo: https://wpdirectory.net/search/01JDAFQMKVDE6ME17SH47V33D9

So I don't feel strongly about this.

Worst case in such a scenario is that the original URL ends up getting used without the version removed, which will likely still work (even if it has the even slighter possibility of downloading a stale version).

Thank you for pointing this out! I hadn’t considered the possibility of version tags like -rc or -beta. That’s an oversight on my part.

However, I believe the regex '#(\/plugin\/[^\/]+)\.\d.*.zip#' might not work as intended because it could capture the plugin name greedily. For instance, in the example provided, the download link might end up being https://downloads.wordpress.org/plugin/rest-api.2.zip instead of https://downloads.wordpress.org/plugin/rest-api.zip.

To address this, one solution could be to simply modify the regex to capture the plugin name non-greedily:

'#(\/plugin\/[^\/]+?)\.\d.*.zip#'

Alternatively, another approach would be to use the following regex:

'#(\/plugin\/[^\/]+)\.\d+\.\d+\.\d+(?:-\w+)?\.zip#'

This pattern accounts for optional tags like -rc or -beta and aligns with the regex used in the versions command, so it seems like a good choice to me.

Note in the example https://downloads.wordpress.org/plugin/rest-api.2.0-beta15.zip there is no patch version either, just a major and minor. So that would need to be optional as well.

This should address the greediness issue, by using \.\d.*?.zip instead of \.\d.*.zip:

$download_link = (string) preg_replace( '#(\/plugin\/[^\/]+)\.\d.*?.zip#', '$1.zip', $plugin_data['download_link'] );

…download links

westonruter · 2024-11-22T22:37:28Z

plugins/performance-lab/includes/admin/plugins.php

@@ -372,7 +372,9 @@ function perflab_install_and_activate_plugin( string $plugin_slug, array &$proce
 		// Replace new Plugin_Installer_Skin with new Quiet_Upgrader_Skin when output needs to be suppressed.
 		$skin     = new WP_Ajax_Upgrader_Skin( array( 'api' => $plugin_data ) );
 		$upgrader = new Plugin_Upgrader( $skin );
-		$result   = $upgrader->install( $plugin_data['download_link'] );
+		// Remove the version number from the link to download the latest plugin version.
+		$download_link = (string) preg_replace( '#(\/plugin\/[^\/]+)\.\d+\.\d+\.\d+(?:-\w+)?\.zip#', '$1.zip', $plugin_data['download_link'] );


Suggested change

$download_link = (string) preg_replace( '#(\/plugin\/[^\/]+)\.\d+\.\d+\.\d+(?:-\w+)?\.zip#', '$1.zip', $plugin_data['download_link'] );

$download_link = (string) preg_replace( '#(\/plugin\/[^\/]+)\.\d.*?.zip#', '$1.zip', $plugin_data['download_link'] );

Or rather, per #1693 (comment)

Suggested change

$download_link = (string) preg_replace( '#(\/plugin\/[^\/]+)\.\d+\.\d+\.\d+(?:-\w+)?\.zip#', '$1.zip', $plugin_data['download_link'] );

$download_link = (string) preg_replace( '#(\/plugin\/[^\/.]+)\..+?\.zip#', '$1.zip', $plugin_data['download_link'] );

Stripping off everything up to the first . makes sense. However, I also noticed that some plugins have their download link as https://downloads.wordpress.org/plugin/<plugin-slug>.zip, particularly those with tags like trunk, such as https://downloads.wordpress.org/plugin/better-search-replace.zip.

Given this, I think we might need a regex like this:

$download_link = (string) preg_replace( '#(\/plugin\/[^\.]+).*\.zip#', '$1.zip', $plugin_data['download_link'] );

This should account for both cases where the version exists (like rest-api.2.0-beta15.zip) and where it doesn't (like better-search-replace.zip).

On second thought, can’t we just construct the download link directly from the slug in the $plugin_data as:

https://downloads.wordpress.org/plugin/<plugin-slug>.zip

This would simplify and remove the need for regex.

Hah. Good point.

westonruter · 2024-11-22T22:47:35Z

Lastly, note that many plugins also use Stable tag: trunk: https://wpdirectory.net/search/01JDB0D3QBVXR8KWR1X9BRYYPB

I haven't seen trunk show up in the download URL, but in theory it might?

Here's another search for plugins using non-standard versions: https://wpdirectory.net/search/01JDB0R6MBNNEMH0A1X8AHKQYC

The WP Umbrella plugin version doesn't begin with a digit:

https://downloads.wordpress.org/plugin/wp-health.v2.16.4.zip

That being said, perhaps we should just strip off everything up to the first . since I don't believe any plugin is allowed to have that as a character in the slug.

westonruter · 2024-11-22T22:49:25Z

Again, this is all likely splitting hairs since none of the plugins we include here should ever use a non-standard version!

felixarntz · 2024-11-23T00:32:46Z

plugins/performance-lab/includes/admin/plugins.php

@@ -372,7 +372,9 @@ function perflab_install_and_activate_plugin( string $plugin_slug, array &$proce
 		// Replace new Plugin_Installer_Skin with new Quiet_Upgrader_Skin when output needs to be suppressed.
 		$skin     = new WP_Ajax_Upgrader_Skin( array( 'api' => $plugin_data ) );
 		$upgrader = new Plugin_Upgrader( $skin );
-		$result   = $upgrader->install( $plugin_data['download_link'] );
+		// Remove the version number from the link to download the latest plugin version.
+		$download_link = (string) preg_replace( '#(\/plugin\/[^\/]+)\.\d+\.\d+\.\d+(?:-\w+)?\.zip#', '$1.zip', $plugin_data['download_link'] );


I'm not a fan of regexing this from the download_link. Is there no externally controlled place (API responses or elsewhere) that exposes the format we want here?

Seeing comments like #1693 (comment) confirms my above concern: Using a regex for this is error-prone. Is there no way to get the actual URL from somewhere?

You’re right; relying on regex for this isn’t ideal. The plugins_api() function, when called with the plugin_information action, provides a versions field in the response that seems to include the URLs in the required format. Here's an example of the response:

{ ... "versions": { "0.1.0": "https://downloads.wordpress.org/plugin/optimization-detective.0.1.0.zip", "0.1.1": "https://downloads.wordpress.org/plugin/optimization-detective.0.1.1.zip", ... "trunk": "https://downloads.wordpress.org/plugin/optimization-detective.zip" }, ... }

We could use the trunk key to get the required URL in most cases. However, there are scenarios where the trunk key doesn’t exist in the versions field. In those cases, the download_link itself is typically already in the desired format without a version or tag.

That said, implementing this approach would require making multiple API calls—one for each plugin—which again might not be ideal.

Don't we only need the plugin download URL if we actually want to download the plugin? I think making an extra request for that purpose makes sense. We shouldn't make all these requests for all the plugins when we cache the information. But for the moment when someone clicks "Activate" and we have to install that plugin, I think it's reasonable to make the request. I think that's even what WordPress Core does to install a plugin.

And even if the plugin also requires dependencies, making individual requests for these should not be an issue since realistically that shouldn't be more than 2-3 plugins.

This solution would be more reliable than us assuming things about the download URL and using a regex.

That makes sense to me.

Replaced transient-cached plugin data with a real-time `plugins_api()` call during installation to avoid installing outdated versions.

…plugin_info()

westonruter

Since we're not using the download_link anymore in the response to perflab_query_plugin_info(), I removed it from being explicitly returned. I also explicitly requested download_link and requires_plugins when installing, although it seems these are all returned by default anyway.

…_and_activate_plugin()

felixarntz

Thanks @ShyamGadde @westonruter, LGTM!

Remove plugin version number from download link

03607c4

This is done so that it automatically downloads the latest version

ShyamGadde marked this pull request as ready for review November 22, 2024 14:07

ShyamGadde requested review from mukeshpanchal27 and felixarntz as code owners November 22, 2024 14:07

westonruter approved these changes Nov 22, 2024

View reviewed changes

westonruter added this to the performance-lab n.e.x.t milestone Nov 22, 2024

westonruter added [Type] Bug An existing feature is broken [Plugin] Performance Lab Issue relates to work in the Performance Lab Plugin only labels Nov 22, 2024

Update regex to handle version tags like -rc and -beta in plugin …

8398cfe

…download links

westonruter reviewed Nov 22, 2024

View reviewed changes

felixarntz reviewed Nov 23, 2024

View reviewed changes

Avoid transient cache for plugin installation to ensure latest version

03b05fd

Replaced transient-cached plugin data with a real-time `plugins_api()` call during installation to avoid installing outdated versions.

ShyamGadde requested review from felixarntz and westonruter November 25, 2024 22:03

westonruter added 2 commits November 25, 2024 15:50

Remove download_link from data explicitly requested in perflab_query_…

cdaf0f4

…plugin_info()

Explicitly request download_link and requires_plugins fields

49424c8

westonruter approved these changes Nov 26, 2024

View reviewed changes

Explain why perflab_query_plugin_info() isn't used in perflab_install…

b59b0d2

…_and_activate_plugin()

felixarntz approved these changes Nov 26, 2024

View reviewed changes

westonruter merged commit d2d5eae into WordPress:trunk Nov 26, 2024
14 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix latest plugin version not being downloaded consistently #1693

Fix latest plugin version not being downloaded consistently #1693

ShyamGadde commented Nov 22, 2024

github-actions bot commented Nov 22, 2024 •

edited

Loading

westonruter Nov 22, 2024

westonruter Nov 22, 2024

westonruter Nov 22, 2024

ShyamGadde Nov 22, 2024 •

edited

Loading

westonruter Nov 22, 2024

westonruter Nov 22, 2024

westonruter Nov 22, 2024

ShyamGadde Nov 25, 2024

ShyamGadde Nov 25, 2024 •

edited

Loading

westonruter Nov 25, 2024

westonruter commented Nov 22, 2024

westonruter commented Nov 22, 2024

felixarntz Nov 23, 2024

felixarntz Nov 25, 2024

ShyamGadde Nov 25, 2024

felixarntz Nov 25, 2024 •

edited

Loading

westonruter Nov 25, 2024

westonruter left a comment

felixarntz left a comment

	$download_link = (string) preg_replace( '#(\/plugin\/[^\/]+)\.\d+\.\d+\.\d+\.zip#', '$1.zip', $plugin_data['download_link'] );
	$download_link = (string) preg_replace( '#(\/plugin\/[^\/]+)\.\d.*.zip#', '$1.zip', $plugin_data['download_link'] );

Fix latest plugin version not being downloaded consistently #1693

Fix latest plugin version not being downloaded consistently #1693

Conversation

ShyamGadde commented Nov 22, 2024

Summary

github-actions bot commented Nov 22, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ShyamGadde Nov 22, 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

ShyamGadde Nov 25, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

westonruter commented Nov 22, 2024

westonruter commented Nov 22, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

felixarntz Nov 25, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

westonruter left a comment

Choose a reason for hiding this comment

felixarntz left a comment

Choose a reason for hiding this comment

github-actions bot commented Nov 22, 2024 •

edited

Loading

ShyamGadde Nov 22, 2024 •

edited

Loading

ShyamGadde Nov 25, 2024 •

edited

Loading

felixarntz Nov 25, 2024 •

edited

Loading