fix: check for required plugins in RAS setup wizard (#2442)

Author: dkoo

assets/wizards/engagement/components/types.ts

@@ -96,6 +96,9 @@ export type PrequisiteProps = {
 	// Schema for prequisite object is defined in PHP class Reader_Activation::get_prerequisites_status().
 	prerequisite: {
 		active: boolean;
+		plugins?: {
+			[ pluginName: string ]: boolean; // Are the required plugins active?
+		};
 		label: string;
 		description: string;
 		warning?: string;

assets/wizards/engagement/views/reader-activation/index.js

@@ -15,6 +15,7 @@ import {
 	Button,
 	Card,
 	Notice,
+	PluginInstaller,
 	SectionHeader,
 	TextControl,
 	Waiting,
@@ -32,6 +33,7 @@ export default withWizardScreen( () => {
 	const [ allReady, setAllReady ] = useState( false );
 	const [ isActiveCampaign, setIsActiveCampaign ] = useState( false );
 	const [ prerequisites, setPrerequisites ] = useState( null );
+	const [ missingPlugins, setMissingPlugins ] = useState( [] );
 	const [ showAdvanced, setShowAdvanced ] = useState( false );
 	const updateConfig = ( key, val ) => {
 		setConfig( { ...config, [ key ]: val } );
@@ -84,9 +86,27 @@ export default withWizardScreen( () => {
 	}, [] );
 	useEffect( () => {
 		const _allReady =
-			prerequisites && Object.keys( prerequisites ).every( key => prerequisites[ key ]?.active );
+			! missingPlugins.length &&
+			prerequisites &&
+			Object.keys( prerequisites ).every( key => prerequisites[ key ]?.active );
 
 		setAllReady( _allReady );
+
+		if ( prerequisites ) {
+			setMissingPlugins(
+				Object.keys( prerequisites ).reduce( ( acc, slug ) => {
+					const prerequisite = prerequisites[ slug ];
+					if ( prerequisite.plugins ) {
+						for ( const pluginSlug in prerequisite.plugins ) {
+							if ( ! prerequisite.plugins[ pluginSlug ] ) {
+								acc.push( pluginSlug );
+							}
+						}
+					}
+					return acc;
+				}, [] )
+			);
+		}
 	}, [ prerequisites ] );
 
 	const getSharedProps = ( configKey, type = 'checkbox' ) => {
@@ -148,7 +168,10 @@ export default withWizardScreen( () => {
 					isError
 				/>
 			) }
-			{ prerequisites && ! allReady && (
+			{ 0 < missingPlugins.length && (
+				<Notice noticeText={ __( 'The following plugins are required.', 'newspack' ) } isWarning />
+			) }
+			{ 0 === missingPlugins.length && prerequisites && ! allReady && (
 				<Notice
 					noticeText={ __( 'Complete these settings to enable Reader Activation.', 'newspack' ) }
 					isWarning
@@ -163,14 +186,23 @@ export default withWizardScreen( () => {
 					{ __( 'Retrieving status…', 'newspack' ) }
 				</>
 			) }
-			{ prerequisites &&
+			{ 0 < missingPlugins.length && prerequisites && (
+				<PluginInstaller
+					plugins={ missingPlugins }
+					withoutFooterButton
+					onStatus={ ( { complete } ) => complete && fetchConfig() }
+				/>
+			) }
+			{ ! missingPlugins.length &&
+				prerequisites &&
 				Object.keys( prerequisites ).map( key => (
 					<Prerequisite
 						key={ key }
 						config={ config }
 						getSharedProps={ getSharedProps }
 						inFlight={ inFlight }
 						prerequisite={ prerequisites[ key ] }
+						fetchConfig={ fetchConfig }
 						saveConfig={ saveConfig }
 					/>
 				) ) }

includes/reader-activation/class-reader-activation.php

@@ -386,6 +386,9 @@ public static function get_prerequisites_status() {
 			],
 			'esp'              => [
 				'active'       => self::is_esp_configured(),
+				'plugins'      => [
+					'newspack-newsletters' => class_exists( '\Newspack_Newsletters' ),
+				],
 				'label'        => __( 'Email Service Provider (ESP)', 'newspack' ),
 				'description'  => __( 'Connect to your ESP to register readers with their email addresses and send newsletters.', 'newspack' ),
 				'instructions' => __( 'Connect to your email service provider (ESP) and enable at least one subscription list.', 'newspack' ),
@@ -424,6 +427,12 @@ public static function get_prerequisites_status() {
 			],
 			'reader_revenue'   => [
 				'active'       => self::is_reader_revenue_ready(),
+				'plugins'      => [
+					'newspack-blocks'             => class_exists( '\Newspack_Blocks' ),
+					'woocommerce'                 => function_exists( 'WC' ),
+					'woocommerce-subscriptions'   => class_exists( 'WC_Subscriptions_Product' ),
+					'woocommerce-name-your-price' => class_exists( 'WC_Name_Your_Price_Helpers' ),
+				],
 				'label'        => __( 'Reader Revenue', 'newspack' ),
 				'description'  => __( 'Setting suggested donation amounts is required for enabling a streamlined donation experience.', 'newspack' ),
 				'instructions' => __( 'Set platform to "Newspack" and configure your default donation settings.', 'newspack' ),
@@ -433,6 +442,9 @@ public static function get_prerequisites_status() {
 			],
 			'ras_campaign'     => [
 				'active'         => self::is_ras_campaign_configured(),
+				'plugins'        => [
+					'newspack-popups' => class_exists( '\Newspack_Popups_Model' ),
+				],
 				'label'          => __( 'Reader Activation Campaign', 'newspack' ),
 				'description'    => __( 'Building a set of prompts with default segments and settings allows for an improved experience optimized for Reader Activation.', 'newspack' ),
 				'help_url'       => 'https://help.newspack.com/engagement/reader-activation-system',