Enable JITMs in WPAdmin on Simple sites

projects/packages/jitm/changelog/try-jitm-on-simple

@@ -0,0 +1,4 @@
+Significance: patch
+Type: changed
+
+Enable JITM on Simple sites

projects/packages/jitm/src/class-jitm.php

@@ -22,6 +22,19 @@ class JITM {
 
 	const PACKAGE_VERSION = '4.0.7';
 
+	/**
+	 * List of screen IDs where JITMs are allowed to display.
+	 *
+	 * @var string[]
+	 */
+	const APPROVED_SCREEN_IDS = array(
+		'jetpack',
+		'woo',
+		'shop',
+		'product',
+		'themes',
+	);
+
 	/**
 	 * The configuration method that is called from the jetpack-config package.
 	 */
@@ -36,7 +49,7 @@ public static function configure() {
 	 * @return Post_Connection_JITM|Pre_Connection_JITM JITM instance.
 	 */
 	public static function get_instance() {
-		if ( ( new Connection_Manager() )->is_connected() ) {
+		if ( ( new Connection_Manager() )->is_connected() || defined( 'IS_WPCOM' ) && IS_WPCOM ) {
 			$jitm = new Post_Connection_JITM();
 		} else {
 			$jitm = new Pre_Connection_JITM();
@@ -127,6 +140,7 @@ public function prepare_jitms( $screen ) {
 			add_action( 'admin_enqueue_scripts', array( $this, 'jitm_enqueue_files' ) );
 			add_action( 'admin_notices', array( $this, 'ajax_message' ) );
 			add_action( 'edit_form_top', array( $this, 'ajax_message' ) );
+
 		}
 	}
 
@@ -156,7 +170,10 @@ public function is_a8c_admin_page() {
 		return (
 			$current_screen
 			&& $current_screen->id
-			&& (bool) preg_match( '/jetpack|woo|shop|product/', $current_screen->id )
+			&& (bool) preg_match(
+				'/' . implode( '|', self::APPROVED_SCREEN_IDS ) . '/',
+				$current_screen->id
+			)
 		);
 	}
 
@@ -226,7 +243,7 @@ public function ajax_message() {
 			return;
 		}
 
-		// Only add this to Jetpack or Woo admin pages.
+		// Only add this to specifically whitelisted pages.
 		if ( ! $this->is_a8c_admin_page() ) {
 			return;
 		}

projects/packages/jitm/src/class-post-connection-jitm.php

@@ -225,7 +225,11 @@ public function dismiss( $id, $feature_class ) {
 	}
 
 	/**
-	 * Asks the wpcom API for the current message to display keyed on query string and message path
+	 * Asks the wpcom API for the current message to display keyed on query string and message path.
+	 *
+	 * For sites running on the Dotcom Simple codebase, the network request is bypassed
+	 * via Client::wpcom_json_api_request_as_blog allowing for the JITM\Engine to be called
+	 * directly.
 	 *
 	 * @param string $message_path The message path to ask for.
 	 * @param string $query The query string originally from the front end.

projects/packages/jitm/src/js/jetpack-jitm.js

@@ -1,8 +1,13 @@
 import jQuery from 'jquery';
+import apiFetch from '@wordpress/api-fetch';
+import { addQueryArgs } from '@wordpress/url';
 
 import '../css/jetpack-admin-jitm.scss';
 
 jQuery( document ).ready( function ( $ ) {
+	// Site ID will be automatically added to the request.// Site ID will be automatically added to the request.
+	const JITM_ENDPOINT_URL = `/wpcom/v2/jitm-v2`;
+
 	var templates = {
 		default: function ( envelope ) {
 			const EXTERNAL_LINK_ICON = `
@@ -155,8 +160,8 @@ jQuery( document ).ready( function ( $ ) {
 				$my_template.hide();
 
 				apiFetch( {
-					path: '/jetpack/v4/jitm',
-					method: 'POST', // using DELETE without permalinks is broken in default nginx configuration
+					path: JITM_ENDPOINT_URL,
+					method: 'POST',
 					data: {
 						id: response.id,
 						feature_class: response.feature_class,
@@ -300,14 +305,16 @@ jQuery( document ).ready( function ( $ ) {
 
 			var full_jp_logo_exists = $( '.jetpack-logo__masthead' ).length ? true : false;
 
-			$.get( window.jitm_config.api_root + 'jetpack/v4/jitm', {
-				message_path: message_path,
-				query: query,
-				full_jp_logo_exists: full_jp_logo_exists,
-				_wpnonce: $el.data( 'nonce' ),
+			apiFetch( {
+				path: addQueryArgs( JITM_ENDPOINT_URL, {
+					message_path: message_path,
+					query: query,
+					full_jp_logo_exists: full_jp_logo_exists,
+				} ),
+				method: 'GET',
 			} ).then( function ( response ) {
-				if ( 'object' === typeof response && response[ '1' ] ) {
-					response = [ response[ '1' ] ];
+				if ( 'object' === typeof response && response[ 'data' ] ) {
+					response = [ response[ 'data' ][ 0 ] ];
 				}
 
 				// properly handle the case of an empty array or no content set

projects/packages/jitm/tests/php/test_JITM.php

@@ -152,6 +152,7 @@ public function data_test_is_a8c_admin_page() {
 			'WooCommerce admin page'         => array( 'woocommerce_page_wc-admin', true ),
 			'WooCommerce order management'   => array( 'edit-shop_order', true ),
 			'WooCommerce product management' => array( 'edit-product', true ),
+			'Themes page'                    => array( 'themes', true ),
 		);
 	}
 }

projects/plugins/jetpack/_inc/lib/core-api/wpcom-endpoints/class-wpcom-rest-api-v2-endpoint-jitm-v2.php

@@ -0,0 +1,151 @@
+<?php
+/**
+ * REST API endpoint for retrieving JITMs from the WPCOM API.
+ *
+ * Available on:
+ * - Simple - via Dotcom Public API (https://public-api.wordpress.com/wpcom/v2/sites/{site_id}/jitm-v2).
+ * - WoA and Jetpack connected sites - via local site REST API (https://myjetpackconnectedsite.com/wp-json/wpcom/v2/jitm-v2)
+ *
+ * Utilises Jetpack classes to orchestrate the request and response handling.
+ * All JITM configuration happens on the Dotcom Simple codebase.
+ *
+ * @package automattic/jetpack
+ */
+
+use Automattic\Jetpack\Connection\REST_Connector;
+
+/**
+ * Class WPCOM_REST_API_V2_Endpoint_JITM_V2ssssss
+ */
+class WPCOM_REST_API_V2_Endpoint_JITM_V2 extends WP_REST_Controller {
+
+	/**
+	 * Namespace prefix.
+	 *
+	 * @var string
+	 */
+	public $namespace = 'wpcom/v2';
+
+	/**
+	 * Endpoint base route.
+	 *
+	 * @var string
+	 */
+	public $rest_base = 'jitm-v2';
+
+	/**
+	 * WPCOM_REST_API_V2_Endpoint_JITM_V2 constructor.
+	 */
+	public function __construct() {
+		add_action( 'rest_api_init', array( $this, 'register_routes' ) );
+	}
+
+	/**
+	 * Register routes.
+	 */
+	public function register_routes() {
+		register_rest_route(
+			$this->namespace,
+			$this->rest_base . '/',
+			array(
+				array(
+					'methods'             => WP_REST_Server::READABLE,
+					'callback'            => array( $this, 'get_item' ),
+					'permission_callback' => '__return_true',
+				),
+				array(
+					'methods'             => WP_REST_Server::CREATABLE,
+					'callback'            => array( $this, 'dismiss_item' ),
+					'permission_callback' => array( $this, 'dismiss_item_permissions_check' ),
+				),
+			)
+		);
+	}
+
+	/**
+	 * Retrieves the JITMs.
+	 *
+	 * @param WP_REST_Request $request Full details about the request.
+	 * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
+	 */
+	public function get_item( $request ) {
+		$jitm = Automattic\Jetpack\JITMS\JITM::get_instance();
+
+		if ( ! $jitm->jitms_enabled() ) {
+			return rest_ensure_response( array() );
+		}
+
+		// add the search term to the query params if it exists
+		$query_param = $request['query'] ?? '';
+
+		// Disable the jetpack_user_auth_check filter on Dotcom Simple codebase.
+		// This allows the wpcom/v2/jitm endpoint to work for Simple sites.
+		// See fbhepr%2Skers%2Sjcpbz%2Sjc%2Qpbagrag%2Serfg%2Qncv%2Qcyhtvaf%2Sraqcbvagf%2Swrgcnpx.cuc%3Se%3Q4580oq59%2374-og.
+		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
+			add_filter( 'rest_api_jitm_jetpack_user_auth_check', '__return_true' );
+		}
+
+		$messages = $jitm->get_messages(
+			$request['message_path'],
+			urldecode_deep( array( 'query' => $query_param ) ),
+			'true' === $request['full_jp_logo_exists']
+		);
+
+		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
+			remove_filter( 'rest_api_jitm_jetpack_user_auth_check', '__return_true' );
+		}
+
+		return rest_ensure_response( $messages );
+	}
+
+	/**
+	 * Checks if a given request has access to dismiss JITMs.
+	 *
+	 * @return true|WP_Error True if the request has permission to dismiss, WP_Error object otherwise.
+	 */
+	public function dismiss_item_permissions_check() {
+		if ( ! current_user_can( 'read' ) ) {
+			return new WP_Error(
+				'invalid_user_permission_jetpack_delete_jitm_message',
+				REST_Connector::get_user_permissions_error_msg(),
+				array( 'status' => rest_authorization_required_code() )
+			);
+		}
+
+		return true;
+	}
+
+	/**
+	 * Dismisses a JITM message.
+	 *
+	 * @param WP_REST_Request $request Full details about the request.
+	 * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
+	 */
+	public function dismiss_item( $request ) {
+		$jitm = Automattic\Jetpack\JITMS\JITM::get_instance();
+
+		if ( ! $jitm->jitms_enabled() ) {
+			// Boolean return matches return type of $jitm->dismiss().
+			// Not returning a WP_Error avoids a 400 response code
+			// and allows the dismiss action to be silently ignored.
+			return rest_ensure_response( true );
+		}
+
+		// Disable the jetpack_user_auth_check filter on Dotcom Simple codebase.
+		// This allows the wpcom/v2/jitm endpoint to work for Simple sites.
+		// See fbhepr%2Skers%2Sjcpbz%2Sjc%2Qpbagrag%2Serfg%2Qncv%2Qcyhtvaf%2Sraqcbvagf%2Swrgcnpx.cuc%3Se%3Q4580oq59%2374-og.
+		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
+			add_filter( 'rest_api_jitm_jetpack_user_auth_check', '__return_true' );
+		}
+
+		$result = $jitm->dismiss( $request['id'], $request['feature_class'] );
+
+		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
+			remove_filter( 'rest_api_jitm_jetpack_user_auth_check', '__return_true' );
+		}
+
+		return rest_ensure_response( $result );
+	}
+}
+
+wpcom_rest_api_v2_load_plugin( 'WPCOM_REST_API_V2_Endpoint_JITM_V2' );

projects/plugins/jetpack/changelog/try-jitm-on-simple

@@ -0,0 +1,4 @@
+Significance: minor
+Type: other
+
+Adds new WPCom v2 endpoint for handling JITMs