Avoid passing incomplete data to perflab_render_plugin_card() and show error when plugin directory API query fails #1175

westonruter · 2024-04-23T19:09:59Z

Summary

When working on Image Prioritizer (#1172), I added the plugin to the perflab_get_standalone_plugin_data() but then I started getting PHPUnit test failures. I also got a bunch of warnings on the Performance screen:

The issue here is that Image Prioritizer is not on WordPress.org yet, so the call to perflab_query_plugin_info() is returning an empty array. Nevertheless, this logic in perflab_render_plugin_card() is not working as expected:

performance/includes/admin/plugins.php

Lines 130 to 134 in cb5a37e

    
           function perflab_render_plugin_card( array $plugin_data ) { 
        
           	// If no plugin data is returned, return. 
        
           	if ( empty( $plugin_data ) ) { 
        
           		return; 
        
           	}

This is because we are merging the response from WordPress.org with our own data from perflab_get_standalone_plugin_data() meaning $plugin_data will never be empty:

performance/includes/admin/plugins.php

Lines 76 to 88 in cb5a37e

    
           foreach ( perflab_get_standalone_plugin_data() as $plugin_slug => $plugin_data ) { 
        
           	$plugin_data = array_merge( 
        
           		$plugin_data, // Data defined within Performance Lab. 
        
           		perflab_query_plugin_info( $plugin_slug ) // Data from wordpress.org. 
        
           	); 
        
           	// Separate experimental plugins so that they're displayed after non-experimental plugins. 
        
           	if ( isset( $plugin_data['experimental'] ) && $plugin_data['experimental'] ) { 
        
           		$experimental_plugins[ $plugin_slug ] = $plugin_data; 
        
           	} else { 
        
           		$plugins[ $plugin_slug ] = $plugin_data; 
        
           	} 
        
           }

This scenario could happen not only if the plugin is not on WordPress.org but also if the query fails due to WordPress.org being down. So with this PR an error is now shown when an error occurs:

This PR also removes the standalone plugin version from being referenced on the Performance screen. It was only referenced in aria-label and data-title attributes.

Lastly, when a WordPress.org Plugins API query fails during installation, an error message is now displayed rather than just a generic error.

Related: #1170

github-actions · 2024-04-23T21:15:36Z

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: westonruter <westonruter@git.wordpress.org>
Co-authored-by: swissspidy <swissspidy@git.wordpress.org>
Co-authored-by: mukeshpanchal27 <mukesh27@git.wordpress.org>

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

…e_plugin_callback()

westonruter · 2024-04-23T23:01:38Z

includes/admin/plugins.php


 	/** This filter is documented in wp-admin/includes/class-wp-plugin-install-list-table.php */
 	$description = apply_filters( 'plugin_install_description', $description, $plugin_data );
-	$version     = $plugin_data['version'];


I didn't see a need for the version to be mentioned among the features, so I removed it.

westonruter · 2024-04-23T23:02:16Z

includes/admin/load.php

 			wp_die(
 				wp_kses(
 					sprintf(
 						/* translators: %s: Support forums URL. */
 						__( 'An unexpected error occurred. Something may be wrong with WordPress.org or this server&#8217;s configuration. If you continue to have problems, please try the <a href="%s">support forums</a>.', 'default' ),
 						__( 'https://wordpress.org/support/forums/', 'default' )
-					),
+					) . ' ' . $api->get_error_message(),


Now the specific error is shown rather than just the generic message.

…_status()

The error message may include markup such as is returned by validate_plugin_requirements().

westonruter · 2024-04-23T23:28:20Z

includes/admin/load.php

@@ -304,7 +304,7 @@ function perflab_install_activate_plugin_callback() {

 	$result = activate_plugin( $plugin_basename );
 	if ( is_wp_error( $result ) ) {
-		wp_die( esc_html( $result->get_error_message() ) );
+		wp_die( wp_kses_post( $result->get_error_message() ) );


This fixes HTML mistakenly being escaped:

Now:

includes/admin/plugins.php

Co-authored-by: Pascal Birchler <pascalb@google.com>

…n-card

mukeshpanchal27 · 2024-04-24T14:59:14Z

includes/admin/plugins.php

-				'short_description' => true,
-				'icons'             => true,
-			),
+			'fields' => array_fill_keys( $fields, true ),


Nice ❤️

westonruter added 3 commits April 23, 2024 11:49

Avoid passing incomplete data to perflab_render_plugin_card()

103161a

Improve readability of PHP templating and remove needless checks

1e4c080

Show error when failed to query WordPress.org

e7db5ac

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

westonruter added this to the performance-lab 3.1.0 milestone Apr 23, 2024

westonruter requested review from joemcgill and mukeshpanchal27 April 23, 2024 19:09

Only short-circuit if there are no plugins nor experimental plugins

7067d9e

Fix array shape for plugin API response

c370906

westonruter mentioned this pull request Apr 23, 2024

WPCS improvement #1168

Merged

westonruter added 2 commits April 23, 2024 15:59

Request only the information needed from plugins API

d2086f8

Fix showing error message when query fails in perflab_install_activat…

c85a7e4

…e_plugin_callback()

westonruter commented Apr 23, 2024

View reviewed changes

westonruter added 2 commits April 23, 2024 16:22

Restore returning version from API request for install_plugin_install…

61c26ed

…_status()

Use Kses to sanitize WP_Error message from activate_plugin()

b1a2f02

The error message may include markup such as is returned by validate_plugin_requirements().

westonruter commented Apr 23, 2024

View reviewed changes

westonruter requested a review from swissspidy April 24, 2024 02:02

swissspidy reviewed Apr 24, 2024

View reviewed changes

includes/admin/plugins.php Outdated Show resolved Hide resolved

Update translation string

2aa906b

Co-authored-by: Pascal Birchler <pascalb@google.com>

swissspidy approved these changes Apr 24, 2024

View reviewed changes

Merge branch 'trunk' into fix/passing-incomplete-data-to-render-plugi…

71a426d

…n-card

mukeshpanchal27 approved these changes Apr 24, 2024

View reviewed changes

mukeshpanchal27 merged commit ae46209 into trunk Apr 24, 2024
14 checks passed

mukeshpanchal27 deleted the fix/passing-incomplete-data-to-render-plugin-card branch April 24, 2024 14:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Avoid passing incomplete data to perflab_render_plugin_card() and show error when plugin directory API query fails #1175

Avoid passing incomplete data to perflab_render_plugin_card() and show error when plugin directory API query fails #1175

westonruter commented Apr 23, 2024 •

edited

github-actions bot commented Apr 23, 2024 •

edited

westonruter Apr 23, 2024

westonruter Apr 23, 2024

westonruter Apr 23, 2024

mukeshpanchal27 Apr 24, 2024

	function perflab_render_plugin_card( array $plugin_data ) {
	// If no plugin data is returned, return.
	if ( empty( $plugin_data ) ) {
	return;
	}

	foreach ( perflab_get_standalone_plugin_data() as $plugin_slug => $plugin_data ) {
	$plugin_data = array_merge(
	$plugin_data, // Data defined within Performance Lab.
	perflab_query_plugin_info( $plugin_slug ) // Data from wordpress.org.
	);

	// Separate experimental plugins so that they're displayed after non-experimental plugins.
	if ( isset( $plugin_data['experimental'] ) && $plugin_data['experimental'] ) {
	$experimental_plugins[ $plugin_slug ] = $plugin_data;
	} else {
	$plugins[ $plugin_slug ] = $plugin_data;
	}
	}

Avoid passing incomplete data to perflab_render_plugin_card() and show error when plugin directory API query fails #1175

Avoid passing incomplete data to perflab_render_plugin_card() and show error when plugin directory API query fails #1175

Conversation

westonruter commented Apr 23, 2024 • edited

Summary

github-actions bot commented Apr 23, 2024 • edited

westonruter Apr 23, 2024

Choose a reason for hiding this comment

westonruter Apr 23, 2024

Choose a reason for hiding this comment

westonruter Apr 23, 2024

Choose a reason for hiding this comment

mukeshpanchal27 Apr 24, 2024

Choose a reason for hiding this comment

westonruter commented Apr 23, 2024 •

edited

github-actions bot commented Apr 23, 2024 •

edited