Merge branch 'develop' of github.com:ampproject/amp-wp into add/sandboxing-levels

* 'develop' of github.com:ampproject/amp-wp: (41 commits)
  Bump eslint-plugin-jsdoc from 36.1.0 to 36.1.1
  Bump lint-staged from 11.1.2 to 11.2.3
  Use assertContains for array
  Use DependencyInjectedTestCase
  Add test assertions
  Update comments
  Update unit test cases
  Remove unwanted style, Fix notice style in mobile
  Revert some changes and update unit test case
  Bump @babel/core from 7.15.5 to 7.15.8
  Fix grammar in comment
  Bump css-minimizer-webpack-plugin from 3.0.2 to 3.1.1
  Apply suggestions from code review
  Remove changes from .github
  Bump postcss from 8.3.8 to 8.3.9
  Remove template change notice from other pages
  Remove template change notice from other pages
  Add unit test case
  Add data removal notice to plugin description
  Update unit test case
  ...

Author: westonruter

amp.php

@@ -1,7 +1,7 @@
 <?php
 /**
  * Plugin Name: AMP
- * Description: An easier path to great Page Experience for everyone. Powered by AMP.
+ * Description: An easier path to great Page Experience for everyone. Powered by AMP. <em class="amp-deletion-notice"><strong>Uninstall Note:</strong> To control whether all data from this plugin is deleted at uninstallation, first activate the plugin, go to the Other section on the Settings screen, and set the “Delete plugin data at uninstall” toggle.</em>
  * Plugin URI: https://amp-wp.org
  * Author: AMP Project Contributors
  * Author URI: https://github.com/ampproject/amp-wp/graphs/contributors

assets/src/components/options-context-provider/index.js

@@ -42,6 +42,7 @@ export function OptionsContextProvider( { children, optionsRestPath, populateDef
 	const [ savingOptions, setSavingOptions ] = useState( false );
 	const [ didSaveOptions, setDidSaveOptions ] = useState( false );
 	const [ originalOptions, setOriginalOptions ] = useState( {} );
+	const [ modifiedOptions, setModifiedOptions ] = useState( {} );
 
 	const { error, setError } = useContext( ErrorContext );
 	const { setAsyncError } = useAsyncError();
@@ -162,10 +163,12 @@ export function OptionsContextProvider( { children, optionsRestPath, populateDef
 			return;
 		}
 
+		setModifiedOptions( { ...modifiedOptions, ...updates } );
+
 		setUpdates( {} );
 		setDidSaveOptions( true );
 		setSavingOptions( false );
-	}, [ delaySave, hasErrorBoundary, optionsRestPath, setAsyncError, originalOptions, setError, updates ] );
+	}, [ delaySave, hasErrorBoundary, optionsRestPath, setAsyncError, originalOptions, setError, updates, modifiedOptions ] );
 
 	/**
 	 * Updates options in state.
@@ -200,6 +203,7 @@ export function OptionsContextProvider( { children, optionsRestPath, populateDef
 					updateOptions,
 					readerModeWasOverridden,
 					setReaderModeWasOverridden,
+					modifiedOptions,
 				}
 			}
 		>

assets/src/settings-page/delete-data-at-uninstall.js

@@ -0,0 +1,39 @@
+/**
+ * WordPress dependencies
+ */
+import { useContext } from '@wordpress/element';
+import { __ } from '@wordpress/i18n';
+
+/**
+ * Internal dependencies
+ */
+import { AMPSettingToggle } from '../components/amp-setting-toggle';
+import { Options } from '../components/options-context-provider';
+import { Loading } from '../components/loading';
+
+/**
+ * Data deletion at uninstallation toggle on the settings page.
+ */
+export function DeleteDataAtUninstall() {
+	const { editedOptions, fetchingOptions, updateOptions } = useContext( Options );
+
+	if ( fetchingOptions ) {
+		return <Loading />;
+	}
+
+	const deleteDataAtUninstall = editedOptions?.delete_data_at_uninstall;
+	return (
+		<section className="delete-data-at-uninstall">
+			<AMPSettingToggle
+				checked={ true === deleteDataAtUninstall }
+				title={ __( 'Delete plugin data at uninstall', 'amp' ) }
+				onChange={ () => {
+					updateOptions( { delete_data_at_uninstall: ! deleteDataAtUninstall } );
+				} }
+			/>
+			<p>
+				{ __( 'When you uninstall the plugin you have the choice of whether its data should also be deleted. Examples of plugin data include the settings, validated URLs, and transients used to store image dimensions and parsed stylesheets.', 'amp' ) }
+			</p>
+		</section>
+	);
+}

assets/src/settings-page/index.js

@@ -48,6 +48,7 @@ import { Analytics } from './analytics';
 import { PairedUrlStructure } from './paired-url-structure';
 import { MobileRedirection } from './mobile-redirection';
 import { DeveloperTools } from './developer-tools';
+import { DeleteDataAtUninstall } from './delete-data-at-uninstall';
 
 const { ajaxurl: wpAjaxUrl } = global;
 
@@ -250,6 +251,7 @@ function Root( { appRoot } ) {
 				>
 					<MobileRedirection />
 					<DeveloperTools />
+					<DeleteDataAtUninstall />
 				</AMPDrawer>
 				<SettingsFooter />
 			</form>

assets/src/settings-page/settings-footer.js

@@ -2,6 +2,9 @@
  * External dependencies
  */
 import PropTypes from 'prop-types';
+import {
+	HAS_PAGE_CACHING,
+} from 'amp-settings';
 
 /**
  * WordPress dependencies
@@ -52,7 +55,7 @@ ErrorNotice.propTypes = {
  * The bottom section of the settings page.
  */
 export function SettingsFooter() {
-	const { didSaveOptions, editedOptions, hasOptionsChanges, savingOptions } = useContext( Options );
+	const { didSaveOptions, editedOptions, hasOptionsChanges, savingOptions, modifiedOptions } = useContext( Options );
 	const { downloadingTheme } = useContext( ReaderThemes );
 	const { error } = useContext( ErrorContext );
 	const { didSaveDeveloperToolsOption, hasDeveloperToolsOptionChange, savingDeveloperToolsOption } = useContext( User );
@@ -63,6 +66,8 @@ export function SettingsFooter() {
 	const isBusy = savingOptions || downloadingTheme || savingDeveloperToolsOption;
 	const disabled = ! hasChanges || isBusy || ! themeSupport || ( READER === themeSupport && ! readerTheme );
 
+	const shouldShowPageCacheFlushNotice = ( modifiedOptions?.theme_support || modifiedOptions?.reader_theme );
+
 	return (
 		<section className="amp-settings-nav">
 			<div className="amp-settings-nav__inner">
@@ -79,7 +84,20 @@ export function SettingsFooter() {
 						type={ NOTICE_TYPE_SUCCESS }
 					>
 						<p>
-							{ __( 'Saved', 'amp' ) }
+							{
+								HAS_PAGE_CACHING && shouldShowPageCacheFlushNotice ? (
+									<>
+										{ __( 'Saved. Consider flushing page cache.', 'amp' ) + ' ' }
+										<a
+											href="https://amp-wp.org/documentation/getting-started/amp-site-setup/page-caching-with-amp-and-wordpress/"
+											target="_blank"
+											rel="noreferrer noopener"
+										>
+											{ __( 'Learn More', 'amp' ) }
+										</a>
+									</>
+								) : __( 'Saved', 'amp' )
+							}
 						</p>
 					</AMPNotice>
 				) }

assets/src/settings-page/style.css

@@ -301,11 +301,21 @@ li.error-kept {
 .amp .amp-save-success-notice.amp-notice,
 .amp-error-notice .amp-notice {
 	bottom: 3rem;
+	margin-left: 0.5rem;
 	padding-left: 1.5rem;
-	padding-right: 3rem;
+	padding-right: .5rem;
 	z-index: 99;
 }
 
+@media (min-width: 576px) {
+
+	.amp .amp-save-success-notice.amp-notice,
+	.amp-error-notice .amp-notice {
+		margin-left: 0;
+		padding-right: 3rem;
+	}
+}
+
 .amp-settings-nav .components-button.is-primary {
 	box-shadow: none;
 }
@@ -610,10 +620,6 @@ li.error-kept {
 	margin: 0;
 }
 
-.amp-other-settings .developer-tools h4 {
-	margin-bottom: 0;
-}
-
-.amp-other-settings .developer-tools p {
+.amp-other-settings p {
 	font-size: 0.875rem;
 }

includes/amp-helper-functions.php

@@ -98,6 +98,9 @@ function amp_bootstrap_plugin() {
 	add_action( 'after_setup_theme', 'amp_after_setup_theme', 5 );
 
 	add_action( 'plugins_loaded', '_amp_bootstrap_customizer', 9 ); // Should be hooked before priority 10 on 'plugins_loaded' to properly unhook core panels.
+
+	// @todo Eliminate this once https://core.trac.wordpress.org/ticket/20578 has finally landed.
+	add_filter( 'all_plugins', 'amp_modify_plugin_description' );
 }
 
 /**
@@ -219,6 +222,28 @@ function() {
 	);
 }
 
+/**
+ * When AMP plugin is active remove instruction of plugin data removal steps.
+ *
+ * @since 2.2
+ * @internal
+ *
+ * @param array $meta An array of plugins to display in the list table.
+ * @return array An array of plugins to display in the list table.
+ */
+function amp_modify_plugin_description( $meta ) {
+
+	if ( isset( $meta['amp/amp.php']['Description'] ) ) {
+		$meta['amp/amp.php']['Description'] = preg_replace(
+			':\s*<em class=\"amp-deletion-notice\">.+?</em>:',
+			'',
+			$meta['amp/amp.php']['Description']
+		);
+	}
+
+	return $meta;
+}
+
 /**
  * Set up AMP.
  *

includes/options/class-amp-options-manager.php

@@ -28,15 +28,16 @@ class AMP_Options_Manager {
 	 * @var array
 	 */
 	protected static $defaults = [
-		Option::THEME_SUPPORT           => AMP_Theme_Support::READER_MODE_SLUG,
-		Option::SUPPORTED_POST_TYPES    => [ 'post', 'page' ],
-		Option::ANALYTICS               => [],
-		Option::ALL_TEMPLATES_SUPPORTED => true,
-		Option::SUPPORTED_TEMPLATES     => [ 'is_singular' ],
-		Option::VERSION                 => AMP__VERSION,
-		Option::READER_THEME            => ReaderThemes::DEFAULT_READER_THEME,
-		Option::PAIRED_URL_STRUCTURE    => Option::PAIRED_URL_STRUCTURE_QUERY_VAR,
-		Option::PLUGIN_CONFIGURED       => false,
+		Option::THEME_SUPPORT            => AMP_Theme_Support::READER_MODE_SLUG,
+		Option::SUPPORTED_POST_TYPES     => [ 'post', 'page' ],
+		Option::ANALYTICS                => [],
+		Option::ALL_TEMPLATES_SUPPORTED  => true,
+		Option::SUPPORTED_TEMPLATES      => [ 'is_singular' ],
+		Option::VERSION                  => AMP__VERSION,
+		Option::READER_THEME             => ReaderThemes::DEFAULT_READER_THEME,
+		Option::PAIRED_URL_STRUCTURE     => Option::PAIRED_URL_STRUCTURE_QUERY_VAR,
+		Option::PLUGIN_CONFIGURED        => false,
+		Option::DELETE_DATA_AT_UNINSTALL => true,
 	];
 
 	/**
@@ -320,6 +321,10 @@ public static function validate_options( $new_options ) {
 			$options[ Option::PLUGIN_CONFIGURED ] = (bool) $new_options[ OPTION::PLUGIN_CONFIGURED ];
 		}
 
+		if ( isset( $new_options[ Option::DELETE_DATA_AT_UNINSTALL ] ) ) {
+			$options[ Option::DELETE_DATA_AT_UNINSTALL ] = (bool) $new_options[ OPTION::DELETE_DATA_AT_UNINSTALL ];
+		}
+
 		// Validate analytics.
 		if ( isset( $new_options[ Option::ANALYTICS ] ) && $new_options[ Option::ANALYTICS ] !== $options[ Option::ANALYTICS ] ) {
 			$new_analytics_option = [];

includes/uninstall-functions.php

@@ -175,7 +175,7 @@ function delete_transients() {
 
 	// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching -- Cannot cache result since we're deleting the records.
 	$wpdb->query(
-	// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- See use of prepare in foreach loop above.
+		// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- See use of prepare in foreach loop above.
 		"DELETE FROM $wpdb->options WHERE " . implode( ' OR ', $where_clause )
 	);
 }
@@ -187,10 +187,17 @@ function delete_transients() {
  * @internal
  */
 function remove_plugin_data() {
+	$options = get_option( 'amp-options' );
 
-	delete_options();
-	delete_user_metadata();
-	delete_posts();
-	delete_terms();
-	delete_transients();
+	if (
+		is_array( $options ) && array_key_exists( 'delete_data_at_uninstall', $options )
+			? $options['delete_data_at_uninstall']
+			: true
+	) {
+		delete_options();
+		delete_user_metadata();
+		delete_posts();
+		delete_terms();
+		delete_transients();
+	}
 }