Merge pull request #2436 from Automattic/master

dkoo · web-flow · commit c1bb46d87574 · 2023-05-03T09:44:17.000-06:00
Alpha release May 03
diff --git a/assets/wizards/engagement/components/prompt.tsx b/assets/wizards/engagement/components/prompt.tsx
@@ -41,21 +41,9 @@ import {
 	WebPreview,
 } from '../../../components/src';
 
-const previewIcon = (
-	<SVG xmlns="http://www.w3.org/2000/svg" height="24" viewBox="0 0 24 24" width="24">
-		<Path
-			fillRule="evenodd"
-			clipRule="evenodd"
-			d="M4.5001 13C5.17092 13.3354 5.17078 13.3357 5.17066 13.3359L5.17346 13.3305C5.1767 13.3242 5.18233 13.3135 5.19036 13.2985C5.20643 13.2686 5.23209 13.2218 5.26744 13.1608C5.33819 13.0385 5.44741 12.8592 5.59589 12.6419C5.89361 12.2062 6.34485 11.624 6.95484 11.0431C8.17357 9.88241 9.99767 8.75 12.5001 8.75C15.0025 8.75 16.8266 9.88241 18.0454 11.0431C18.6554 11.624 19.1066 12.2062 19.4043 12.6419C19.5528 12.8592 19.662 13.0385 19.7328 13.1608C19.7681 13.2218 19.7938 13.2686 19.8098 13.2985C19.8179 13.3135 19.8235 13.3242 19.8267 13.3305L19.8295 13.3359C19.8294 13.3357 19.8293 13.3354 20.5001 13C21.1709 12.6646 21.1708 12.6643 21.1706 12.664L21.1702 12.6632L21.1693 12.6614L21.1667 12.6563L21.1588 12.6408C21.1522 12.6282 21.1431 12.6108 21.1315 12.5892C21.1083 12.5459 21.0749 12.4852 21.0311 12.4096C20.9437 12.2584 20.8146 12.0471 20.6428 11.7956C20.2999 11.2938 19.7823 10.626 19.0798 9.9569C17.6736 8.61759 15.4977 7.25 12.5001 7.25C9.50252 7.25 7.32663 8.61759 5.92036 9.9569C5.21785 10.626 4.70033 11.2938 4.35743 11.7956C4.1856 12.0471 4.05654 12.2584 3.96909 12.4096C3.92533 12.4852 3.89191 12.5459 3.86867 12.5892C3.85705 12.6108 3.84797 12.6282 3.84141 12.6408L3.83346 12.6563L3.8309 12.6614L3.82997 12.6632L3.82959 12.664C3.82943 12.6643 3.82928 12.6646 4.5001 13ZM12.5001 16C14.4331 16 16.0001 14.433 16.0001 12.5C16.0001 10.567 14.4331 9 12.5001 9C10.5671 9 9.0001 10.567 9.0001 12.5C9.0001 14.433 10.5671 16 12.5001 16Z"
-			fill="#3366FF"
-		/>
-	</SVG>
-);
-
 // Note: Schema and types for the `prompt` prop is defined in Newspack Campaigns: https://github.com/Automattic/newspack-popups/blob/master/includes/schemas/class-prompts.php
 export default function Prompt( { inFlight, prompt, setInFlight, setPrompts }: PromptProps ) {
 	const [ values, setValues ] = useState< InputValues | Record< string, never > >( {} );
-	const [ isDirty, setIsDirty ] = useState( false );
 	const [ error, setError ] = useState< false | { message: string } >( false );
 	const [ success, setSuccess ] = useState< false | string >( false );
 	const [ image, setImage ] = useState< null | Attachment >( null );
@@ -64,14 +52,9 @@ export default function Prompt( { inFlight, prompt, setInFlight, setPrompts }: P
 	useEffect( () => {
 		if ( Array.isArray( prompt?.user_input_fields ) ) {
 			const fields = { ...values };
-			let _isDirty = true;
 			prompt.user_input_fields.forEach( ( field: InputField ) => {
 				fields[ field.name ] = field.value || field.default;
-				if ( field.value ) {
-					_isDirty = false; // Allow saving if all values are default.
-				}
 			} );
-			setIsDirty( _isDirty );
 			setValues( fields );
 		}
 
@@ -97,10 +80,21 @@ export default function Prompt( { inFlight, prompt, setInFlight, setPrompts }: P
 		setTimeout( () => setSuccess( false ), 5000 );
 	}, [ success ] );
 
+	const previewIcon = (
+		<SVG xmlns="http://www.w3.org/2000/svg" height="24" viewBox="0 0 24 24" width="24">
+			<Path
+				fillRule="evenodd"
+				clipRule="evenodd"
+				d="M4.5001 13C5.17092 13.3354 5.17078 13.3357 5.17066 13.3359L5.17346 13.3305C5.1767 13.3242 5.18233 13.3135 5.19036 13.2985C5.20643 13.2686 5.23209 13.2218 5.26744 13.1608C5.33819 13.0385 5.44741 12.8592 5.59589 12.6419C5.89361 12.2062 6.34485 11.624 6.95484 11.0431C8.17357 9.88241 9.99767 8.75 12.5001 8.75C15.0025 8.75 16.8266 9.88241 18.0454 11.0431C18.6554 11.624 19.1066 12.2062 19.4043 12.6419C19.5528 12.8592 19.662 13.0385 19.7328 13.1608C19.7681 13.2218 19.7938 13.2686 19.8098 13.2985C19.8179 13.3135 19.8235 13.3242 19.8267 13.3305L19.8295 13.3359C19.8294 13.3357 19.8293 13.3354 20.5001 13C21.1709 12.6646 21.1708 12.6643 21.1706 12.664L21.1702 12.6632L21.1693 12.6614L21.1667 12.6563L21.1588 12.6408C21.1522 12.6282 21.1431 12.6108 21.1315 12.5892C21.1083 12.5459 21.0749 12.4852 21.0311 12.4096C20.9437 12.2584 20.8146 12.0471 20.6428 11.7956C20.2999 11.2938 19.7823 10.626 19.0798 9.9569C17.6736 8.61759 15.4977 7.25 12.5001 7.25C9.50252 7.25 7.32663 8.61759 5.92036 9.9569C5.21785 10.626 4.70033 11.2938 4.35743 11.7956C4.1856 12.0471 4.05654 12.2584 3.96909 12.4096C3.92533 12.4852 3.89191 12.5459 3.86867 12.5892C3.85705 12.6108 3.84797 12.6282 3.84141 12.6408L3.83346 12.6563L3.8309 12.6614L3.82997 12.6632L3.82959 12.664C3.82943 12.6643 3.82928 12.6646 4.5001 13ZM12.5001 16C14.4331 16 16.0001 14.433 16.0001 12.5C16.0001 10.567 14.4331 9 12.5001 9C10.5671 9 9.0001 10.567 9.0001 12.5C9.0001 14.433 10.5671 16 12.5001 16Z"
+				fill={ inFlight ? '#828282' : '#3366FF' }
+			/>
+		</SVG>
+	);
+
 	const getPreviewUrl = ( { options, slug }: { options: PromptOptions; slug: string } ) => {
 		const { placement, trigger_type: triggerType } = options;
 		const previewQueryKeys = window.newspack_engagement_wizard.preview_query_keys;
-		const abbreviatedKeys = { preset: slug };
+		const abbreviatedKeys = { preset: slug, values };
 		Object.keys( options ).forEach( ( key: string ) => {
 			if ( previewQueryKeys.hasOwnProperty( key ) ) {
 				abbreviatedKeys[ previewQueryKeys[ key ] ] = options[ key ];
@@ -137,7 +131,6 @@ export default function Prompt( { inFlight, prompt, setInFlight, setPrompts }: P
 				.then( ( fetchedPrompts: Array< PromptType > ) => {
 					setPrompts( fetchedPrompts );
 					setSuccess( __( 'Prompt saved.', 'newspack' ) );
-					setIsDirty( false );
 					res();
 				} )
 				.catch( err => {
@@ -194,11 +187,9 @@ export default function Prompt( { inFlight, prompt, setInFlight, setPrompts }: P
 																toUpdate[ field.name ].indexOf( option.id ),
 																1
 															);
-															setIsDirty( true );
 														}
 														if ( value && toUpdate[ field.name ].indexOf( option.id ) === -1 ) {
 															toUpdate[ field.name ].push( option.id );
-															setIsDirty( true );
 														}
 														setValues( toUpdate );
 													} }
@@ -221,7 +212,6 @@ export default function Prompt( { inFlight, prompt, setInFlight, setPrompts }: P
 											const toUpdate = { ...values };
 											toUpdate[ field.name ] = value;
 											if ( JSON.stringify( toUpdate ) !== JSON.stringify( values ) ) {
-												setIsDirty( true );
 											}
 											setValues( toUpdate );
 										} }
@@ -243,7 +233,6 @@ export default function Prompt( { inFlight, prompt, setInFlight, setPrompts }: P
 											const toUpdate = { ...values };
 											toUpdate[ field.name ] = value;
 											if ( JSON.stringify( toUpdate ) !== JSON.stringify( values ) ) {
-												setIsDirty( true );
 											}
 											setValues( toUpdate );
 										} }
@@ -264,7 +253,6 @@ export default function Prompt( { inFlight, prompt, setInFlight, setPrompts }: P
 												const toUpdate = { ...values };
 												toUpdate[ field.name ] = attachment?.id || 0;
 												if ( toUpdate[ field.name ] !== values[ field.name ] ) {
-													setIsDirty( true );
 												}
 												setValues( toUpdate );
 												if ( attachment?.url ) {
@@ -309,13 +297,7 @@ export default function Prompt( { inFlight, prompt, setInFlight, setPrompts }: P
 										disabled={ inFlight }
 										icon={ previewIcon }
 										isSecondary
-										onClick={ async () => {
-											if ( isDirty ) {
-												setIsSavingFromPreview( true );
-												await savePrompt( prompt.slug, values );
-											}
-											showPreview();
-										} }
+										onClick={ async () => showPreview() }
 									>
 										{ __( 'Preview prompt', 'newspack' ) }
 									</Button>
diff --git a/assets/wizards/readerRevenue/index.js b/assets/wizards/readerRevenue/index.js
@@ -69,7 +69,7 @@ const ReaderRevenueWizard = () => {
 			isHidden: usedPlatform !== NEWSPACK,
 		},
 		{
-			label: __( 'NRH Settings', 'newspack' ),
+			label: __( 'News Revenue Hub Settings', 'newspack' ),
 			path: '/settings',
 			render: Views.NRHSettings,
 			isHidden: usedPlatform !== NRH,
diff --git a/assets/wizards/readerRevenue/views/nrh-settings/index.js b/assets/wizards/readerRevenue/views/nrh-settings/index.js
@@ -1,13 +1,13 @@
 /**
  * WordPress dependencies
  */
-import { useDispatch } from '@wordpress/data';
 import { __ } from '@wordpress/i18n';
+import { useDispatch } from '@wordpress/data';
 
 /**
  * Internal dependencies
  */
-import { Grid, TextControl, Wizard, Button } from '../../../../components/src';
+import { ActionCard, Button, Grid, TextControl, Wizard } from '../../../../components/src';
 import { READER_REVENUE_WIZARD_SLUG } from '../../constants';
 
 const NRHSettings = () => {
@@ -27,25 +27,39 @@ const NRHSettings = () => {
 		} );
 
 	return (
-		<>
-			<Grid>
+		<ActionCard
+			hasGreyHeader
+			isMedium
+			title={ __( 'News Revenue Hub Settings', 'newspack' ) }
+			description={ __( 'Configure your site’s connection to News Revenue Hub.', 'newspack' ) }
+			actionContent={
+				<Button isPrimary onClick={ onSave }>
+					{ __( 'Save Settings' ) }
+				</Button>
+			}
+		>
+			<Grid columns={ 3 }>
 				<TextControl
-					label={ __( 'NRH Organization ID (required)', 'newspack' ) }
+					label={ __( 'Organization ID', 'newspack' ) }
+					placeholder="exampleid"
 					value={ wizardData.platform_data?.nrh_organization_id || '' }
 					onChange={ changeHandler( 'nrh_organization_id' ) }
 				/>
 				<TextControl
-					label={ __( 'NRH Salesforce Campaign ID', 'newspack' ) }
+					label={ __( 'Custom domain (optional)', 'newspack' ) }
+					help={ __( 'Enter the raw domain without protocol or slashes.' ) }
+					placeholder="donate.example.com"
+					value={ wizardData.platform_data?.nrh_custom_domain || '' }
+					onChange={ changeHandler( 'nrh_custom_domain' ) }
+				/>
+				<TextControl
+					label={ __( 'Salesforce Campaign ID (optional)', 'newspack' ) }
+					placeholder="exampleid"
 					value={ wizardData.platform_data?.nrh_salesforce_campaign_id || '' }
 					onChange={ changeHandler( 'nrh_salesforce_campaign_id' ) }
 				/>
 			</Grid>
-			<div className="newspack-buttons-card">
-				<Button isPrimary onClick={ onSave }>
-					{ __( 'Update' ) }
-				</Button>
-			</div>
-		</>
+		</ActionCard>
 	);
 };
 
diff --git a/includes/class-nrh.php b/includes/class-nrh.php
@@ -10,16 +10,90 @@
 defined( 'ABSPATH' ) || exit;
 
 /**
- * Handles Salesforce functionality.
+ * Handles News Revenue Hub functionality.
  */
 class NRH {
+	/**
+	 * Allowed config keys for NRH settings.
+	 *
+	 * @var array
+	 */
+	protected static $allowed_keys = [
+		'nrh_organization_id',
+		'nrh_custom_domain',
+		'nrh_salesforce_campaign_id',
+	];
+
 	/**
 	 * Add hooks.
 	 */
 	public static function init() {
-		add_filter( 'newspack_donation_checkout_url', [ __CLASS__, 'redirect_to_nrh_checkout' ], 10, 3 );
-		add_filter( 'newspack_blocks_donate_block_html', [ __CLASS__, 'handle_custom_campaign_id' ], 10, 2 );
-		add_filter( 'allowed_redirect_hosts', [ __CLASS__, 'allow_redirect_to_nrh' ] );
+		\add_filter( 'newspack_donation_checkout_url', [ __CLASS__, 'redirect_to_nrh_checkout' ], 10, 3 );
+		\add_filter( 'newspack_blocks_donate_block_html', [ __CLASS__, 'handle_custom_campaign_id' ], 10, 2 );
+		\add_filter( 'allowed_redirect_hosts', [ __CLASS__, 'allow_redirect_to_nrh' ] );
+	}
+
+	/**
+	 * Get all News Revenue Hub settings.
+	 *
+	 * @return array Array of settings.
+	 */
+	private static function get_settings() {
+		return \get_option( NEWSPACK_NRH_CONFIG, [] );
+	}
+
+	/**
+	 * Get a specific News Revenue Hub setting by key name.
+	 * Validates given key against valid keys.
+	 *
+	 * @param string $key Key of setting to get.
+	 *
+	 * @return string|boolean Value of setting if found, false otherwise.
+	 */
+	private static function get_setting( $key ) {
+		if ( ! in_array( $key, self::$allowed_keys, true ) ) {
+			return false;
+		}
+
+		$settings = self::get_settings();
+		return isset( $settings[ $key ] ) ? \wp_strip_all_tags( $settings[ $key ] ) : false;
+	}
+
+	/**
+	 * Update News Revenue Hub settings.
+	 * Validates given data against valid keys.
+	 *
+	 * @param array $data Array of settings to update.
+	 *
+	 * @return boolean True if settings were updated, false otherwise.
+	 */
+	public static function update_settings( $data ) {
+		$settings = self::get_settings();
+
+		foreach ( $data as $key => $value ) {
+			if ( in_array( $key, self::$allowed_keys, true ) ) {
+				$settings[ $key ] = $value;
+			}
+		}
+
+		return \update_option( NEWSPACK_NRH_CONFIG, $settings );
+	}
+
+	/**
+	 * Strips protocol from a domain, if it contains one.
+	 *
+	 * @param string|boolean $domain Domain to strip protocol from. Will accept falsy values as well.
+	 *
+	 * @return string|boolean Domain without protocol or false if the given domain is empty.
+	 */
+	public static function strip_protocol( $domain ) {
+		if ( empty( $domain ) ) {
+			return false;
+		}
+
+		$domain_parts = explode( '//', $domain );
+
+		return \wp_unslash( end( $domain_parts ) );
 	}
 
 	/**
@@ -38,16 +112,14 @@ public static function redirect_to_nrh_checkout( $checkout_url, $donation_value,
 			'once'  => 'once',
 		];
 
-		$nrh_config = get_option( NEWSPACK_NRH_CONFIG );
+		$nrh_config = self::get_settings();
 
-		$organization_id = wp_strip_all_tags( $nrh_config['nrh_organization_id'] );
-		$salesforce_id   = false;
-		if ( isset( $nrh_config['nrh_salesforce_campaign_id'] ) ) {
-			$salesforce_id = wp_strip_all_tags( $nrh_config['nrh_salesforce_campaign_id'] );
-		}
+		$organization_id = self::get_setting( 'nrh_organization_id' );
+		$custom_domain   = self::strip_protocol( self::get_setting( 'nrh_custom_domain' ) );
+		$salesforce_id   = self::get_setting( 'nrh_salesforce_campaign_id' );
 		$custom_campaign = filter_input( INPUT_GET, 'campaign', FILTER_SANITIZE_FULL_SPECIAL_CHARS );
 		if ( $custom_campaign ) {
-			$salesforce_id = wp_strip_all_tags( $custom_campaign );
+			$salesforce_id = \wp_strip_all_tags( $custom_campaign );
 		}
 		$donation_value     = floatval( $donation_value );
 		$donation_frequency = isset( $donation_frequencies[ $donation_frequency ] ) ? $donation_frequencies[ $donation_frequency ] : false;
@@ -60,7 +132,8 @@ public static function redirect_to_nrh_checkout( $checkout_url, $donation_value,
 		Donations::remove_donations_from_cart();
 
 		$url = sprintf(
-			'https://checkout.fundjournalism.org/memberform?amount=%.1f&installmentPeriod=%s&org_id=%s',
+			'https://%s/?amount=%.1f&frequency=%s&org_id=%s',
+			! empty( $custom_domain ) ? $custom_domain : $organization_id . '.fundjournalism.org',
 			$donation_value,
 			$donation_frequency,
 			$organization_id
@@ -97,13 +170,25 @@ public static function handle_custom_campaign_id( $html, $attributes ) {
 	}
 
 	/**
-	 * Add the NRH checkout URL as an allowed redirect target.
+	 * Add the potential NRH checkout URLs as allowed redirect targets.
 	 *
 	 * @param array $hosts Array of allowed hosts.
 	 * @return array Modified $hosts.
 	 */
 	public static function allow_redirect_to_nrh( $hosts ) {
-		$hosts[] = 'checkout.fundjournalism.org';
+		$organization_id = self::get_setting( 'nrh_organization_id' );
+		$custom_domain   = self::strip_protocol( self::get_setting( 'nrh_custom_domain' ) );
+		$allowed_urls    = [
+			'checkout.fundjournalism.org',
+			$organization_id . '.fundjournalism.org',
+		];
+
+		if ( ! empty( $custom_domain ) ) {
+			$allowed_urls[] = $custom_domain;
+		}
+
+		$hosts = array_merge( $hosts, $allowed_urls );
+
 		return $hosts;
 	}
 
diff --git a/includes/wizards/class-reader-revenue-wizard.php b/includes/wizards/class-reader-revenue-wizard.php
@@ -97,6 +97,9 @@ public function register_api_endpoints() {
 						'sanitize_callback' => 'Newspack\newspack_clean',
 						'validate_callback' => [ $this, 'api_validate_not_empty' ],
 					],
+					'nrh_custom_domain'          => [
+						'sanitize_callback' => 'Newspack\newspack_clean',
+					],
 					'nrh_salesforce_campaign_id' => [
 						'sanitize_callback' => 'Newspack\newspack_clean',
 					],
@@ -274,14 +277,10 @@ public function api_update( $request ) {
 		$params   = $request->get_params();
 		$platform = $params['platform'];
 		Donations::set_platform_slug( $platform );
-		if ( 'nrh' === $platform && isset( $params['nrh_organization_id'] ) ) {
-			$nrh_config = [
-				'nrh_organization_id' => $params['nrh_organization_id'],
-			];
-			if ( isset( $params['nrh_salesforce_campaign_id'] ) ) {
-				$nrh_config['nrh_salesforce_campaign_id'] = $params['nrh_salesforce_campaign_id'];
-			}
-			update_option( NEWSPACK_NRH_CONFIG, $nrh_config );
+
+		// Update NRH settings.
+		if ( 'nrh' === $platform ) {
+			NRH::update_settings( $params );
 		}
 
 		// Ensure that any Reader Revenue settings changed while the platform wasn't WC are persisted to WC products.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json

Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@ const ReaderRevenueWizard = () => {`
`69`	`69`	`isHidden: usedPlatform !== NEWSPACK,`
`70`	`70`	`},`
`71`	`71`	`{`
`72`		`- label: __( 'NRH Settings', 'newspack' ),`
	`72`	`+ label: __( 'News Revenue Hub Settings', 'newspack' ),`
`73`	`73`	`path: '/settings',`
`74`	`74`	`render: Views.NRHSettings,`
`75`	`75`	`isHidden: usedPlatform !== NRH,`