Partner Compatibility: Adding a unique connection screen for customers who receive a coupon from a Jetpack partner

projects/plugins/jetpack/_inc/client/main.jsx

@@ -5,7 +5,7 @@ import React from 'react';
 import { connect } from 'react-redux';
 import { withRouter, Prompt } from 'react-router-dom';
 import { __, sprintf } from '@wordpress/i18n';
-import { getRedirectUrl } from '@automattic/jetpack-components';
+import { ActionButton, getRedirectUrl } from '@automattic/jetpack-components';
 import { ConnectScreen, CONNECTION_STORE_ID } from '@automattic/jetpack-connection';
 import { Dashicon } from '@wordpress/components';
 import { withDispatch } from '@wordpress/data';
@@ -43,6 +43,7 @@ import {
 	getTracksUserData,
 	showRecommendations,
 	getPluginBaseUrl,
+	getPartnerCoupon,
 	isWoASite,
 } from 'state/initial-state';
 import { areThereUnsavedSettings, clearUnsavedSettingsFlag } from 'state/settings';
@@ -198,6 +199,75 @@ class Main extends React.Component {
 	}
 
 	renderMainContent = route => {
+		/**
+		 * There are two conditions (groups of conditions, really) where we would want to
+		 * show the partner connection screen.
+		 *
+		 * 1. The site is not yet connected to WPCOM, but has the jetpack_partner_coupon
+		 * option set in the database (this.props.partnerCoupon in redux). This is likely a
+		 * partner-user who has just arrived here from a CTA within a partner's dashboard
+		 * or other ecosystem.
+		 *
+		 * 2. The site is already connected to WPCOM, but the jetpack_partner_coupon option
+		 * is still set in the database. This means the user connected their site, but never
+		 * redeemed the coupon. If this is the case, we don't want to override the dashboard
+		 * or at a glance pages with the redemption screen. Instead, we'll catch a URL
+		 * parameter that JITMs will set (showCouponRedemption=true), and show the screen only
+		 * when the user came from a a JITM.
+		 */
+		if ( this.props.partnerCoupon ) {
+			const forceShow = new URLSearchParams( window.location.search ).get( 'showCouponRedemption' );
+			const partnerCoupon = this.props.partnerCoupon;
+
+			if ( ! this.props.isSiteConnected || forceShow ) {
+				return (
+					<ConnectScreen
+						apiNonce={ this.props.apiNonce }
+						registrationNonce={ this.props.registrationNonce }
+						apiRoot={ this.props.apiRoot }
+						images={ [ '/images/connect-right-partner.png' ] }
+						assetBaseUrl={ this.props.pluginBaseUrl }
+						title={ sprintf(
+							/* translators: %s: Jetpack partner name. */
+							__( 'Welcome to Jetpack %s traveler!', 'jetpack' ),
+							partnerCoupon.partner
+						) }
+						buttonLabel={ sprintf(
+							/* translators: %s: Name of a Jetpack product. */
+							__( 'Set up & redeem %s', 'jetpack' ),
+							partnerCoupon.product.title
+						) }
+						redirectUri={ `admin.php?page=jetpack&partnerCoupon=${ partnerCoupon.coupon_code }` }
+						connectionStatus={ this.props.connectionStatus }
+					>
+						<p>
+							{ sprintf(
+								/* translators: %s: Name of a Jetpack product. */
+								__(
+									'Redeem your coupon and get started with %s for free the first year!',
+									'jetpack'
+								),
+								partnerCoupon.product.title
+							) }
+						</p>
+						<ul>
+							{ partnerCoupon.product.features.map( ( feature, key ) => (
+								<li className="jp-recommendations-product-purchased__feature" key={ key }>
+									{ feature }
+								</li>
+							) ) }
+						</ul>
+						{ this.props.connectionStatus.hasConnectedOwner && (
+							<ActionButton
+								label={ __( 'Redeem coupon', 'jetpack' ) }
+								href={ `https://wordpress.com/checkout/${ this.props.siteRawUrl }/${ partnerCoupon.product.slug }?coupon=${ partnerCoupon.coupon_code }` }
+							/>
+						) }
+					</ConnectScreen>
+				);
+			}
+		}
+
 		if (
 			this.isUserConnectScreen() &&
 			( this.props.userCanManageModules || this.props.hasConnectedOwner )
@@ -556,6 +626,7 @@ export default connect(
 			connectUrl: getConnectUrl( state ),
 			connectingUserFeatureLabel: getConnectingUserFeatureLabel( state ),
 			isWoaSite: isWoASite( state ),
+			partnerCoupon: getPartnerCoupon( state ),
 		};
 	},
 	dispatch => ( {

projects/plugins/jetpack/_inc/client/state/initial-state/reducer.js

@@ -416,6 +416,16 @@ export function getPartnerSubsidiaryId( state ) {
 	return get( state.jetpack.initialState, 'partnerSubsidiaryId', '' );
 }
 
+/**
+ * Returns the partner coupon associated with this site, if any.
+ *
+ * @param {object} state - Global state tree
+ * @returns {object|boolean} partner coupon if exists or false.
+ */
+export function getPartnerCoupon( state ) {
+	return get( state.jetpack.initialState, 'partnerCoupon' );
+}
+
 /**
  * Return an upgrade URL
  *

projects/plugins/jetpack/_inc/lib/admin-pages/class-jetpack-redux-state-helper.php

@@ -101,6 +101,7 @@ public static function get_initial_state() {
 			'WP_API_nonce'                => wp_create_nonce( 'wp_rest' ),
 			'registrationNonce'           => wp_create_nonce( 'jetpack-registration-nonce' ),
 			'purchaseToken'               => self::get_purchase_token(),
+			'partnerCoupon'               => Jetpack_Partner_Coupon_Helper::get_coupon(),
 			'pluginBaseUrl'               => plugins_url( '', JETPACK__PLUGIN_FILE ),
 			'connectionStatus'            => $connection_status,
 			'connectUrl'                  => false == $current_user_data['isConnected'] // phpcs:ignore WordPress.PHP.StrictComparisons.LooseComparison

projects/plugins/jetpack/_inc/lib/class-jetpack-partner-coupon-helper.php

@@ -0,0 +1,210 @@
+<?php
+/**
+ * Class for the Jetpack partner coupon logic.
+ *
+ * @package automattic/jetpack
+ */
+
+/**
+ * Disable direct access.
+ */
+if ( ! defined( 'ABSPATH' ) ) {
+	exit;
+}
+
+/**
+ * Class Jetpack_Partner_Coupon_Helper
+ *
+ * @since 10.4.0
+ */
+class Jetpack_Partner_Coupon_Helper {
+
+	/**
+	 * Jetpack_Partner_Coupon_Helper
+	 *
+	 * @var Jetpack_Partner_Coupon_Helper|null
+	 **/
+	private static $instance = null;
+
+	/**
+	 * A list of supported partners.
+	 *
+	 * @var array
+	 */
+	private static $supported_partners = array(
+		'IONOS' => 'IONOS',
+	);
+
+	/**
+	 * A list of supported presets.
+	 *
+	 * @var array
+	 */
+	private static $supported_presets = array(
+		'IONA' => 'jetpack_backup_daily',
+	);
+
+	/**
+	 * Initialize class.
+	 */
+	public static function init() {
+		if ( is_null( self::$instance ) ) {
+			self::$instance = new Jetpack_Partner_Coupon_Helper();
+		}
+
+		return self::$instance;
+	}
+
+	/**
+	 * Constructor.
+	 */
+	private function __construct() {
+		add_action( 'admin_init', array( $this, 'catch_coupon' ) );
+	}
+
+	/**
+	 * Catch partner coupon and redirect to claim component.
+	 */
+	public function catch_coupon() {
+		// Accept and store a partner coupon if present, and redirect to Jetpack connection screen.
+		$partner_coupon = isset( $_GET['jetpack-partner-coupon'] ) ? sanitize_text_field( $_GET['jetpack-partner-coupon'] ) : false; // phpcs:ignore WordPress.Security.NonceVerification.Recommended
+		if ( $partner_coupon ) {
+			update_option( 'jetpack_partner_coupon', $partner_coupon );
+
+			if ( Jetpack::connection()->is_connected() ) {
+				wp_safe_redirect( Jetpack::admin_url( 'showCouponRedemption=1' ) );
+			} else {
+				wp_safe_redirect( Jetpack::admin_url() );
+			}
+		}
+	}
+
+	/**
+	 * Get partner coupon data.
+	 *
+	 * @return array|bool
+	 */
+	public static function get_coupon() {
+		$coupon_code = get_option( 'jetpack_partner_coupon', '' );
+
+		if ( ! is_string( $coupon_code ) || empty( $coupon_code ) ) {
+			return false;
+		}
+
+		$partner = self::$instance->get_coupon_partner_name( $coupon_code );
+
+		if ( ! $partner ) {
+			return false;
+		}
+
+		$product = self::$instance->get_coupon_product( $coupon_code );
+
+		if ( ! $product ) {
+			return false;
+		}
+
+		return array(
+			'coupon_code' => $coupon_code,
+			'partner'     => $partner,
+			'product'     => $product,
+		);
+	}
+
+	/**
+	 * Get coupon partner name.
+	 *
+	 * @param string $coupon_code Coupon code to go through.
+	 * @return string|bool
+	 */
+	private function get_coupon_partner_name( $coupon_code ) {
+		if ( ! is_string( $coupon_code ) || false === strpos( $coupon_code, '_' ) ) {
+			return false;
+		}
+
+		$partner            = strtok( $coupon_code, '_' );
+		$supported_partners = $this->get_supported_partners();
+
+		return isset( $supported_partners[ $partner ] ) ? $supported_partners[ $partner ] : false;
+	}
+
+	/**
+	 * Get coupon product.
+	 *
+	 * @param string $coupon_code Coupon code to go through.
+	 * @return array|bool
+	 */
+	private function get_coupon_product( $coupon_code ) {
+		$coupon_preset = $this->get_coupon_preset( $coupon_code );
+
+		if ( ! $coupon_preset ) {
+			return false;
+		}
+
+		$product_details = Jetpack::get_products_for_purchase( true );
+		$product_slug    = $this->get_supported_presets()[ $coupon_preset ];
+
+		foreach ( $product_details as $product ) {
+			if ( $product_slug === $product['slug'] ) {
+				return $product;
+			}
+		}
+
+		return false;
+	}
+
+	/**
+	 * Get coupon preset.
+	 *
+	 * @param string $coupon_code Coupon code to go through.
+	 * @return string|bool
+	 */
+	private function get_coupon_preset( $coupon_code ) {
+		if ( ! is_string( $coupon_code ) ) {
+			return false;
+		}
+
+		$regex   = '/^.*?_(?P<slug>.*?)_.+$/';
+		$matches = array();
+
+		if ( ! preg_match( $regex, $coupon_code, $matches ) ) {
+			return false;
+		}
+
+		return isset( $this->get_supported_presets()[ $matches['slug'] ] ) ? $matches['slug'] : false;
+	}
+
+	/**
+	 * Get supported partners.
+	 *
+	 * @return array
+	 */
+	private function get_supported_partners() {
+		/**
+		 * Allow external code to add additional supported partners.
+		 *
+		 * @since 10.4.0
+		 *
+		 * @param array $supported_partners A list of supported partners.
+		 * @return array
+		 */
+		return apply_filters( 'jetpack_partner_coupon_supported_partners', self::$supported_partners );
+	}
+
+	/**
+	 * Get supported presets.
+	 *
+	 * @return array
+	 */
+	private function get_supported_presets() {
+		/**
+		 * Allow external code to add additional supported presets.
+		 *
+		 * @since 10.4.0
+		 *
+		 * @param array $supported_presets A list of supported presets.
+		 * @return array
+		 */
+		return apply_filters( 'jetpack_partner_coupon_supported_presets', self::$supported_presets );
+	}
+
+}

projects/plugins/jetpack/changelog/add-partner-coupon-connection

@@ -0,0 +1,4 @@
+Significance: minor
+Type: compat
+
+Adding a unique connection screen for customers who receive a coupon from a Jetpack partner

projects/plugins/jetpack/class.jetpack.php

@@ -6695,8 +6695,11 @@ public static function is_active_and_not_offline_mode() {
 	 * This method will not take current purchases or upgrades into account
 	 * but is instead a static list of products Jetpack offers with some
 	 * corresponding sales text/materials.
+	 *
+	 * @param bool $show_legacy Determine if we should include legacy product/plan details.
+	 * @return array
 	 */
-	public static function get_products_for_purchase() {
+	public static function get_products_for_purchase( $show_legacy = false ) {
 		$products = array();
 
 		$products['backup'] = array(
@@ -6789,7 +6792,32 @@ public static function get_products_for_purchase() {
 			),
 		);
 
-		return $products;
+		if ( $show_legacy ) {
+			$products['jetpack_backup_daily'] = array(
+				'title'             => __( 'Jetpack Backup', 'jetpack' ),
+				'slug'              => 'jetpack_backup_daily',
+				'description'       => __( 'Never lose a word, image, page, or time worrying about your site with automated backups & one-click restores.', 'jetpack' ),
+				'show_promotion'    => false,
+				'discount_percent'  => 0,
+				'included_in_plans' => array(),
+				'features'          => array(
+					_x( 'Automated daily backups (off-site)', 'Backup Product Feature', 'jetpack' ),
+					_x( 'One-click restores', 'Backup Product Feature', 'jetpack' ),
+					_x( 'Unlimited backup storage', 'Backup Product Feature', 'jetpack' ),
+				),
+			);
+		}
+
+		/**
+		 * Allow for product details modifications.
+		 *
+		 * @since 10.4.0
+		 *
+		 * @param array $products A list of product details.
+		 * @param array $show_legacy Determine if the list should include legacy plans/products.
+		 * @return array
+		 */
+		return apply_filters( 'jetpack_get_products_for_purchase', $products, $show_legacy );
 	}
 
 	/**

projects/plugins/jetpack/load-jetpack.php

@@ -71,6 +71,9 @@ function jetpack_should_use_minified_assets() {
 jetpack_require_lib( 'class-jetpack-recommendations' );
 require_once JETPACK__PLUGIN_DIR . 'class-jetpack-recommendations-banner.php';
 
+jetpack_require_lib( 'class-jetpack-partner-coupon-helper' );
+Jetpack_Partner_Coupon_Helper::init();
+
 if ( is_admin() ) {
 	require_once JETPACK__PLUGIN_DIR . 'class.jetpack-admin.php';
 	jetpack_require_lib( 'debugger' );