Discontinue doing synchronous validation requests upon activating plugins

[westonruter]

Feature description

Depends on #4719.

Relates to #2069.

In #5100 no longer is a synchronous validation request performed when switching template modes. However, what remains is the synchronous validation request when activating plugins.

The validation errors are obtained in AMP_Validation_Manager::validate_after_plugin_activation() and then displayed via AMP_Validation_Manager::print_plugin_notice().

Instead, upon activating a plugin when the “Plugin activated” notice is displayed:

There should at that point also be an admin notice from the AMP plugin which is accompanied by an enqueued script which does an asynchronous request to check the site for validation issues. A spinner should be shown along with a message saying “checking for AMP compatibility issues”. Then once the results are back, a message can be shown saying there is no validation errors or that there are errors present with those activated plugins, and a link to see what they are.

As it is currently, this admin notice should probably be suppressed if the user doesn't have developer tools enabled.

There could also be a good tie-in here with Plugin Suppression to allow a user to easily deactivate the plugins on AMP responses.

Relates to wizard compatibility scanning in #4795 and #4719.

---

Do not alter or remove anything below. The following sections will be managed by moderators only.

Acceptance criteria

Implementation brief

1. All existing server-side synchronous logic is removed.
2. Upon selecting to activate a plugin, the user is immediately taken to the resulting page with the normal "Plugin activated" notice shown.
3. On the resulting page, another "Plugin scanning" notice is displayed with a loading spinner.
4. REST API requests are initiated to do a site scan (Wizard Step: Plugin compatibility scanning #4719).
5. The plugin sources for unreviewed invalid markup are then aggregated from the REST API responses.
6. If there are plugin sources for unreviewed invalid markup:
   1. Give the notice a warning class.
   2. List out the plugins which are causing unreviewed validation errors.
   3. List out the validated URLs on which the errors occur. (The validated URLs on which a plugin's errors occur should probably be listed under the plugin itself.)
   4. Link to Plugin Suppression screen so user has ability to prevent plugins from running on AMP pages. (It's likely overkill to provide a way to suppress plugins directly from this notice.)
7. If there are no unreviewed validation errors, then the notice should be given a success class.

QA testing instructions

Demo

Changelog entry

[jwold]

Is an initial idea with some concepts. What am I missing?

[johnwatkins0]

This looks right to me.

Side note: This will depend on the PR #5306 that I opened a few weeks ago because I think it will use the ValidationURLProvider created in that PR.

[westonruter]

@jwold Yes, that's right. We may want to provide information about suppressing that plugin from AMP pages as well.

I was able to reproduce the existing warning we have:

Here's the current code that is responsible for that:

amp-wp/includes/validation/class-amp-validation-manager.php

Lines 211 to 220 in 5f42cde

	// Add actions for checking theme support is present to determine plugin compatibility and show validation links in the admin bar.
	// Actions and filters involved in validation.
	add_action(
	'activate_plugin',
	static function() {
	if ( ! has_action( 'shutdown', [ __CLASS__, 'validate_after_plugin_activation' ] ) && self::get_dev_tools_user_access()->is_user_enabled() ) {
	add_action( 'shutdown', [ __CLASS__, 'validate_after_plugin_activation' ] ); // Shutdown so all plugins will have been activated.
	}
	}
	);

amp-wp/includes/validation/class-amp-validation-manager.php

Lines 1972 to 1993 in 5f42cde

	/**
	* Validates the latest published post.
	*
	* @return array|WP_Error The validation errors, or WP_Error.
	*/
	public static function validate_after_plugin_activation() {
	$url = amp_admin_get_preview_permalink();
	if ( ! $url ) {
	return new WP_Error( 'no_published_post_url_available' );
	}
	$validity = self::validate_url_and_store( $url );
	if ( is_wp_error( $validity ) ) {
	return $validity;
	}
	$validation_errors = wp_list_pluck( $validity['results'], 'error' );
	if ( is_array( $validity ) && count( $validation_errors ) > 0 ) { // @todo This should only warn when there are unaccepted validation errors.
	set_transient( self::PLUGIN_ACTIVATION_VALIDATION_ERRORS_TRANSIENT_KEY, $validation_errors, 60 );
	} else {
	delete_transient( self::PLUGIN_ACTIVATION_VALIDATION_ERRORS_TRANSIENT_KEY );
	}
	return $validation_errors;
	}

amp-wp/includes/validation/class-amp-validation-manager.php

Lines 2319 to 2374 in 5f42cde

	/**
	* On activating a plugin, display a notice if a plugin causes an AMP validation error.
	*
	* @return void
	*/
	public static function print_plugin_notice() {
	global $pagenow;
	if ( ( 'plugins.php' === $pagenow ) && ( ! empty( $_GET['activate'] ) || ! empty( $_GET['activate-multi'] ) ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
	$validation_errors = get_transient( self::PLUGIN_ACTIVATION_VALIDATION_ERRORS_TRANSIENT_KEY );
	if ( empty( $validation_errors ) || ! is_array( $validation_errors ) ) {
	return;
	}
	delete_transient( self::PLUGIN_ACTIVATION_VALIDATION_ERRORS_TRANSIENT_KEY );
	$errors = AMP_Validation_Error_Taxonomy::summarize_validation_errors( $validation_errors );
	$invalid_plugins = isset( $errors[ AMP_Validation_Error_Taxonomy::SOURCES_INVALID_OUTPUT ]['plugin'] ) ? array_unique( $errors[ AMP_Validation_Error_Taxonomy::SOURCES_INVALID_OUTPUT ]['plugin'] ) : null;
	if ( isset( $invalid_plugins ) ) {
	$reported_plugins = [];
	$plugin_registry = Services::get( 'plugin_registry' );
	foreach ( $invalid_plugins as $plugin_slug ) {
	$plugin_data = $plugin_registry->get_plugin_from_slug( $plugin_slug );
	$plugin_name = is_array( $plugin_data ) ? $plugin_data['data']['Name'] : $plugin_slug;
	$reported_plugins[] = $plugin_name;
	}
	$more_details_link = sprintf(
	'<a href="%s">%s</a>',
	esc_url(
	add_query_arg(
	'post_type',
	AMP_Validated_URL_Post_Type::POST_TYPE_SLUG,
	admin_url( 'edit.php' )
	)
	),
	__( 'More details', 'amp' )
	);
	printf(
	'<div class="notice notice-warning is-dismissible"><p>%s %s</p><button type="button" class="notice-dismiss"><span class="screen-reader-text">%s</span></button></div>',
	esc_html(
	sprintf(
	/* translators: %s is comma-separated list of one or more plugins */
	_n(
	'Warning: The following plugin may be incompatible with AMP: %s.',
	'Warning: The following plugins may be incompatible with AMP: %s.',
	count( $invalid_plugins ),
	'amp'
	),
	implode( ', ', $reported_plugins ) // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
	)
	),
	$more_details_link, // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
	esc_html__( 'Dismiss this notice.', 'amp' )
	);
	}
	}
	}

[jwold]

@westonruter are you suggesting that we allow users to disable the offending plugin directly from the notice? That could work when a single plugin is throwing errors, but might get messy if multiple plugins are mentioned in the same notice.

[westonruter]

That's true. So we should probably just add a link to go to the Plugin Suppression section so the user can decide which plugins to suppress from there.