Add option to keep AMP data upon uninstalling of plugin

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>Deletion Note:</strong> To delete all plugin data with uninstallation, first activate the plugin, <strong>Go to Settings screen > Scroll to “Other” section in Advanced settings > Enable “Delete plugin data upon uninstall” toggle</strong> (if you haven't done so already).</em>
  * Plugin URI: https://amp-wp.org
  * Author: AMP Project Contributors
  * Author URI: https://github.com/ampproject/amp-wp/graphs/contributors

assets/src/settings-page/data-removal.js

@@ -0,0 +1,40 @@
+/**
+ * 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';
+
+/**
+ * Developer tools section of the settings page.
+ */
+export function DataRemoval() {
+	const { editedOptions, fetchingOptions, updateOptions } = useContext( Options );
+
+	const keepAmpData = editedOptions?.keep_amp_data;
+
+	if ( fetchingOptions ) {
+		return <Loading />;
+	}
+
+	return (
+		<section className="developer-tools">
+			<AMPSettingToggle
+				checked={ true === keepAmpData }
+				title={ __( 'Keep my data', 'amp' ) }
+				onChange={ () => {
+					updateOptions( { keep_amp_data: ! keepAmpData } );
+				} }
+			/>
+			<p>
+				{ __( 'When you delete the plugin you have the choice to have the data remain or removed.', '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 { DataRemoval } from './data-removal';
 
 const { ajaxurl: wpAjaxUrl } = global;
 
@@ -250,6 +251,7 @@ function Root( { appRoot } ) {
 				>
 					<MobileRedirection />
 					<DeveloperTools />
+					<DataRemoval />
 				</AMPDrawer>
 				<SettingsFooter />
 			</form>

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,22 @@ function() {
 	);
 }
 
+/**
+ * When AMP plugin is active remove instruction of plugin data removal steps.
+ *
+ * @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

@@ -37,6 +37,7 @@ class AMP_Options_Manager {
 		Option::READER_THEME            => ReaderThemes::DEFAULT_READER_THEME,
 		Option::PAIRED_URL_STRUCTURE    => Option::PAIRED_URL_STRUCTURE_QUERY_VAR,
 		Option::PLUGIN_CONFIGURED       => false,
+		Option::KEEP_AMP_DATA           => false,
 	];
 
 	/**
@@ -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::KEEP_AMP_DATA ] ) ) {
+			$options[ Option::KEEP_AMP_DATA ] = (bool) $new_options[ OPTION::KEEP_AMP_DATA ];
+		}
+
 		// Validate analytics.
 		if ( isset( $new_options[ Option::ANALYTICS ] ) && $new_options[ Option::ANALYTICS ] !== $options[ Option::ANALYTICS ] ) {
 			$new_analytics_option = [];

includes/uninstall-functions.php

@@ -188,9 +188,13 @@ function delete_transients() {
  */
 function remove_plugin_data() {
 
-	delete_options();
-	delete_user_metadata();
-	delete_posts();
-	delete_terms();
-	delete_transients();
+	$keep_amp_data = \AMP_Options_Manager::get_option( Option::KEEP_AMP_DATA );
+
+	if ( true !== $keep_amp_data ) {
+		delete_options();
+		delete_user_metadata();
+		delete_posts();
+		delete_terms();
+		delete_transients();
+	}
 }

src/Option.php

@@ -159,6 +159,13 @@ interface Option {
 	 */
 	const PLUGIN_CONFIGURED = 'plugin_configured';
 
+	/**
+	 * The key of the option storing whether the to delete AMP data upon uninstalling of plugin or not.
+	 *
+	 * @var string
+	 */
+	const KEEP_AMP_DATA = 'keep_amp_data';
+
 	/**
 	 * Cached slug when it is defined late.
 	 *

src/OptionsRESTController.php

@@ -335,6 +335,10 @@ public function get_item_schema() {
 					Option::ANALYTICS               => [
 						'type' => 'object',
 					],
+					Option::KEEP_AMP_DATA           => [
+						'type'    => 'boolean',
+						'default' => false,
+					],
 					self::SUPPORTABLE_POST_TYPES    => [
 						'type'     => 'array',
 						'readonly' => true,

tests/php/src/OptionsRESTControllerTest.php

@@ -71,6 +71,7 @@ public function test_get_items() {
 				'mobile_redirect',
 				'plugin_configured',
 				'all_templates_supported',
+				'keep_amp_data',
 				'suppressed_plugins',
 				'supported_templates',
 				'supported_post_types',

tests/php/test-amp-helper-functions.php

@@ -127,6 +127,7 @@ public function test_amp_bootstrap_plugin() {
 
 		$this->assertEquals( PHP_INT_MAX, has_filter( 'script_loader_tag', 'amp_filter_script_loader_tag' ) );
 		$this->assertEquals( 10, has_filter( 'style_loader_tag', 'amp_filter_font_style_loader_tag_with_crossorigin_anonymous' ) );
+		$this->assertEquals( 10, has_filter( 'all_plugins', 'amp_modify_plugin_description' ) );
 	}
 
 	/** @covers ::amp_bootstrap_plugin() */
@@ -2417,6 +2418,27 @@ public function test_amp_has_paired_endpoint_passed( $paired_url_structure, $suf
 		$this->assertEquals( $is_amp, amp_has_paired_endpoint( $url ) );
 	}
 
+	/**
+	 * @covers amp_modify_plugin_description
+	 */
+	public function test_amp_modify_plugin_description() {
+
+		$input = [
+			'amp/amp.php' => [
+				'Description' => 'An easier path to great Page Experience for everyone. Powered by AMP. <em class="amp-deletion-notice"><strong>Deletion Note:</strong> To delete all plugin data with uninstallation, first activate the plugin, <strong>Go to Settings screen > Scroll to “Other” section in Advanced settings > Enable “Delete plugin data upon uninstall” toggle</strong> (if you haven\'t done so already).</em>',
+			],
+		];
+
+		$expected = [
+			'amp/amp.php' => [
+				'Description' => 'An easier path to great Page Experience for everyone. Powered by AMP.',
+			],
+		];
+
+		$this->assertEquals( $expected, amp_modify_plugin_description( $input ) );
+
+	}
+
 	/**
 	 * Get a mock publisher logo URL, to test that the filter works as expected.
 	 *

tests/php/test-class-amp-options-manager.php

@@ -119,6 +119,7 @@ public function test_get_and_set_options() {
 				Option::PLUGIN_CONFIGURED       => false,
 				Option::PAIRED_URL_STRUCTURE    => Option::PAIRED_URL_STRUCTURE_QUERY_VAR,
 				Option::LATE_DEFINED_SLUG       => null,
+				Option::KEEP_AMP_DATA           => false,
 			],
 			AMP_Options_Manager::get_options()
 		);
@@ -264,19 +265,23 @@ public function test_get_options_changing_plugin_configured_default() {
 			[
 				Option::VERSION           => AMP__VERSION,
 				Option::PLUGIN_CONFIGURED => false,
+				Option::KEEP_AMP_DATA     => false,
 			]
 		);
 		$this->assertFalse( AMP_Options_Manager::get_option( Option::PLUGIN_CONFIGURED ) );
+		$this->assertFalse( AMP_Options_Manager::get_option( Option::KEEP_AMP_DATA ) );
 
 		// Ensure plugin_configured is false when explicitly set as such in the DB.
 		update_option(
 			AMP_Options_Manager::OPTION_NAME,
 			[
 				Option::VERSION           => AMP__VERSION,
 				Option::PLUGIN_CONFIGURED => true,
+				Option::KEEP_AMP_DATA     => true,
 			]
 		);
 		$this->assertTrue( AMP_Options_Manager::get_option( Option::PLUGIN_CONFIGURED ) );
+		$this->assertTrue( AMP_Options_Manager::get_option( Option::KEEP_AMP_DATA ) );
 	}
 
 	/** @return array */

tests/php/test-uninstall.php

@@ -110,11 +110,23 @@ public function test_uninstall_php() {
 			define( 'WP_UNINSTALL_PLUGIN', 'Yes' );
 		}
 
+		// Test 1: With option to keep AMP data ON.
+		AMP_Options_Manager::update_option( \AmpProject\AmpWP\Option::KEEP_AMP_DATA, true );
+
+		require AMP__DIR__ . '/uninstall.php';
+
+		$this->flush_cache();
+
+		$this->assertNotEmpty( get_option( AMP_Options_Manager::OPTION_NAME, false ) );
+
+		// Test 2: With option to keep AMP data OFF.
+		AMP_Options_Manager::update_option( \AmpProject\AmpWP\Option::KEEP_AMP_DATA, false );
+
 		require AMP__DIR__ . '/uninstall.php';
 
 		$this->flush_cache();
 
-		$this->assertEmpty( get_option( 'amp-option', false ) );
+		$this->assertEmpty( get_option( AMP_Options_Manager::OPTION_NAME, false ) );
 		$this->assertEmpty( get_post( $amp_validated_post->ID ) );
 		$this->assertEmpty( get_term( $amp_error_term->term_id ) );