SEO: Report which conflicting SEO plugin owns the output (#53872)

* SEO: Report which conflicting SEO plugin owns the output

The SEO module now names the plugin it steps aside for through a new
jetpack_seo_conflicting_plugin filter, and the dashboard's Overview and
Settings payloads carry that name so the screens can say who owns the output.

* SEO: Name the conflicting plugin only while Jetpack steps aside

Report the name only when jetpack_disable_seo_tools is on, so it can't
contradict live output, and list paid editions before the free plugins they
run alongside so the first match names the right one.

Author: haqadn

projects/packages/seo/_inc/data/overview-types.ts

@@ -33,6 +33,8 @@ export interface OverviewResponse {
 	plan: {
 		seo_enabled_for_site: boolean;
 	};
+	// See `SettingsResponse['conflicting_seo_plugin']`.
+	conflicting_seo_plugin: string;
 	// Whether the site-verification module can be switched on this site. False on
 	// WordPress.com Simple, which ships no Jetpack modules and reports every one of
 	// them active, so the Settings tab hides that toggle.

projects/packages/seo/_inc/data/settings-types.ts

@@ -25,6 +25,9 @@ export interface SettingsResponse {
 	// Server-owned conflict state. False keeps saved formats visible but read-only
 	// and prevents them from being included in a save payload.
 	title_formats_editable: boolean;
+	// Name of the SEO plugin Jetpack stepped aside for, or '' when none is active.
+	// Read-only, never sent back.
+	conflicting_seo_plugin: string;
 	verification_tools_active: boolean;
 	verification: {
 		google: string;

projects/packages/seo/_inc/data/test/build-payload.test.ts

@@ -11,6 +11,7 @@ const makeSettings = ( overrides: Partial< SettingsResponse > = {} ): SettingsRe
 	title_formats: { posts: [ { type: 'token', value: 'site_name' } ] },
 	title_separator: '-',
 	title_formats_editable: true,
+	conflicting_seo_plugin: '',
 	verification_tools_active: true,
 	verification: { google: '', bing: '', pinterest: '', yandex: '', facebook: '' },
 	site_is_private: false,

projects/packages/seo/_inc/data/test/fixtures/store-fixtures.ts

@@ -29,6 +29,7 @@ export const SEEDED_SETTINGS: SettingsResponse = {
 	title_formats: {},
 	title_separator: '-',
 	title_formats_editable: true,
+	conflicting_seo_plugin: '',
 	verification_tools_active: true,
 	verification: { google: '', bing: '', pinterest: '', yandex: '', facebook: '' },
 	search_engines_visible: true,

projects/packages/seo/_inc/data/test/use-settings.test.ts

@@ -24,6 +24,7 @@ const SEED: SettingsResponse = {
 	title_formats: { posts: [ { type: 'token', value: 'site_name' } ] },
 	title_separator: '-',
 	title_formats_editable: true,
+	conflicting_seo_plugin: '',
 	verification_tools_active: true,
 	verification: { google: '', bing: '', pinterest: '', yandex: '', facebook: '' },
 	search_engines_visible: true,

projects/packages/seo/_inc/screens/overview/test/index.test.tsx

@@ -56,6 +56,7 @@ const buildOverview = (): OverviewResponse => ( {
 	plan: {
 		seo_enabled_for_site: true,
 	},
+	conflicting_seo_plugin: '',
 	verification_switchable: true,
 } );
 

projects/packages/seo/_inc/screens/settings/test/gated.test.tsx

@@ -56,6 +56,7 @@ const buildForm = ( hasLegacy: boolean ): SettingsForm => {
 		title_formats: {},
 		title_separator: '-',
 		title_formats_editable: true,
+		conflicting_seo_plugin: '',
 		verification_tools_active: true,
 		verification: { google: '', bing: '', pinterest: '', yandex: '', facebook: '' },
 		search_engines_visible: true,

projects/packages/seo/_inc/screens/settings/test/settings-screen.test.tsx

@@ -64,6 +64,7 @@ const buildForm = ( overrides: Partial< SettingsResponse > = {} ): SettingsForm
 		title_formats: {},
 		title_separator: '-',
 		title_formats_editable: true,
+		conflicting_seo_plugin: '',
 		verification_tools_active: true,
 		verification: { ...EMPTY_VERIFICATION },
 		search_engines_visible: false,

projects/packages/seo/changelog/add-seo-conflicting-plugin-data

@@ -0,0 +1,4 @@
+Significance: patch
+Type: added
+
+Dashboard: Report which conflicting SEO plugin owns the site's SEO output, via the new `jetpack_seo_conflicting_plugin` filter.

projects/packages/seo/src/class-dashboard-data.php

@@ -564,6 +564,30 @@ private static function is_jetpack_seo_enabled_without_helper() {
 		return ( new Host() )->is_wpcom_simple() ? ! Initializer::is_gated() : true;
 	}
 
+	/**
+	 * Name of the SEO plugin Jetpack stepped aside for, or '' when Jetpack's SEO output is live.
+	 *
+	 * @return string
+	 */
+	private static function get_conflicting_seo_plugin() {
+		/** This filter is documented in projects/plugins/jetpack/modules/seo-tools/class-jetpack-seo-utils.php */
+		if ( ! apply_filters( 'jetpack_disable_seo_tools', false ) ) {
+			return '';
+		}
+
+		/**
+		 * Names the SEO plugin that owns the site's SEO output, so the SEO dashboard can say
+		 * so. Only read while `jetpack_disable_seo_tools` is true.
+		 *
+		 * @since $$next-version$$
+		 *
+		 * @param string $name The plugin's display name, or '' when no plugin owns the output.
+		 */
+		$name = apply_filters( 'jetpack_seo_conflicting_plugin', '' );
+
+		return is_string( $name ) ? trim( $name ) : '';
+	}
+
 	/**
 	 * Drop the superseded legacy front page description once a modern one is saved.
 	 *
@@ -1005,6 +1029,7 @@ public static function get_overview_data() {
 			'plan'                    => array(
 				'seo_enabled_for_site' => $seo_enabled,
 			),
+			'conflicting_seo_plugin'  => self::get_conflicting_seo_plugin(),
 			// Whether the site-verification toggle can do anything here. False where
 			// that module isn't present — WordPress.com Simple ships no Jetpack modules
 			// and reports every one of them active — so the dashboard hides the control
@@ -1106,6 +1131,7 @@ public static function get_settings_data() {
 			// Settings tab replays that composition to preview it.
 			'title_separator'            => self::get_default_title_separator(),
 			'title_formats_editable'     => $title_formats_editable,
+			'conflicting_seo_plugin'     => self::get_conflicting_seo_plugin(),
 			'front_page_description'     => (string) $front_page_desc,
 			'has_legacy_front_page_meta' => $has_legacy_front_page_meta,
 			'verification_tools_active'  => $modules->is_active( 'verification-tools' ),