Enable JITMs in WPAdmin on Simple sites #41252

getdave · 2025-01-22T15:05:03Z

Fixes Automattic/wp-calypso#95651
Related to: 170707-ghe-Automattic/wpcom

Proposed changes:

Enables JITMs on Simple sites in WPAdmin (i.e. outside of Calypso). Must be partnered with 170707-ghe-Automattic/wpcom.

enables the JITM module on Dotcom Simple codebase.
Registers (and includes) a new wpcom/v2/jitm-v2 endpoint which replaces the current jetpack/v4/jitm endpoint. This makes the endpoint available for both Simple and Jetpack Connected sites (including WoA).
Updates the JavaScript to call the new API endpoint.
API endpoint sends requests via existing Jetpack JITM class "plumbing"
- the is_jetpack_authorized_for_site check on the existing wpcom/v2/jitm (not to be confused with the new endpoint above!) is disabled for sites running on the Dotcom Simple codebase (via a filter).
- the Client::wpcom_json_api_request_as_blog means there is no additional network request when running on Dotcom Simple)

Other information:

Have you written new tests for your changes, if applicable?
Have you checked the E2E test CI results, and verified that your changes do not break them?
Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

Does this pull request change what data or activity we track or use?

Testing instructions:

Apply 170707-ghe-Automattic/wpcom to your sandbox. This will (amongst other things):
- ensure the Jetpack JITM module is loaded on Simple.
- include/load the new wpcom/v2/jitm-v2 endpoint on the Dotcom Simple Public API.
- update the message_path to target /wp:themes:admin_notices/ (display in "WPAdmin" on the "Themes" path in the "admin_notices" action).
- modify certain "scoring" functions to always ignore requests from non-jetpack connected sites.

Simple site

Add the following to an mu-plugin:

<?php
add_filter( 'jetpack_just_in_time_msg_cache', '__return_false', 1000 );


add_filter('jetpack_jitm_should_return_jitms', '__return_true', 1000);

add_filter('jetpack_jitm_should_ignore_dismissals', '__return_true', 1000);

Use the bin/jetpack-downloader command (see Github bot comment below) to apply this PR to your sandbox.
Go to https://{YOUR_SANDBOXED_SIMPLE_SITE}.wordpress.com/wp-admin/themes.php
See the Let us build your dream website JITM at the top of the page.

Atomic site 🤦

Get an WoA Dev Site
Transfer to the pool (see the FG)
Go to WPAdmin - upload the Jetpack Beta Plugin (get a copy from the Gitub repo)
Go to Jetpack -> Beta Tester
In the list of modules look for the Jetpack entry and click "Manage"
Search for try/jitm-on-simple and enable it.
SSH into your WoA site (hint - go to https://wordpress.com/hosting-config/MY_WoA_SITE_HERE and enable SSH.
edit the wp-config.php file in the root and add the define( 'JETPACK__SANDBOX_DOMAIN', 'MY_SANDBOX_HERE' );. This will ensure the WoA site uses your sandbox for the Public API. This will ensure that the changes from 170707-ghe-Automattic/wpcom are used by the WoA site.
Add the following to an mu-plugin:

<?php
add_filter( 'jetpack_just_in_time_msg_cache', '__return_false', 1000 );


add_filter('jetpack_jitm_should_return_jitms', '__return_true', 1000);

add_filter('jetpack_jitm_should_ignore_dismissals', '__return_true', 1000);

Go to https://{YOUR_WoA_SITE}/wp-admin/themes.php
See the Let us build your dream website JITM at the top of the page.

getdave · 2025-01-22T15:05:29Z

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

@@ -139,6 +177,7 @@ public function prepare_jitms( $screen ) {
 	 * @return bool True if the current page is a Jetpack or WooCommerce admin page, else false.
 	 */
 	public function is_a8c_admin_page() {
+		return true;


Short-circuiting this for testing purposes.

getdave · 2025-01-22T15:05:55Z

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

-			$.get( window.jitm_config.api_root + 'jetpack/v4/jitm', {
+			// Original code
+			// const url = jitm_config.api_root + 'jetpack/v4/jitm';
+
+			// make an WP Ajax request to local site as REST API is not initialized on Simple sites.
+			const dotComURL = window.ajaxurl;


Obviously this will need to be made conditional based on whether run on Simple or not.

github-actions · 2025-01-22T15:05:58Z

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

To test on WoA, go to the Plugins menu on a WordPress.com Simple site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin, and enable the try/jitm-on-simple branch.
- For jetpack-mu-wpcom changes, also add define( 'JETPACK_MU_WPCOM_LOAD_VIA_BETA_PLUGIN', true ); to your wp-config.php file.

To test on Simple, run the following command on your sandbox:

bin/jetpack-downloader test jetpack try/jitm-on-simple

bin/jetpack-downloader test jetpack-mu-wpcom-plugin try/jitm-on-simple

Interested in more tips and information?

In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
Read more about our development workflow here: PCYsg-eg0-p2
Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

github-actions · 2025-01-22T15:05:59Z

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

✅ Include a description of your PR changes.
✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
✅ Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
✅ Add testing instructions.
✅ Specify whether this PR includes any changes to data or privacy.
✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖

The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.

Follow this PR Review Process:

Ensure all required checks appearing at the bottom of this PR are passing.
Choose a review path based on your changes:
- A. Team Review: add the "[Status] Needs Team Review" label
  - For most changes, including minor cross-team impacts.
  - Example: Updating a team-specific component or a small change to a shared library.
- B. Crew Review: add the "[Status] Needs Review" label
  - For significant changes to core functionality.
  - Example: Major updates to a shared library or complex features.
- C. Both: Start with Team, then request Crew
  - For complex changes or when you need extra confidence.
  - Example: Refactor affecting multiple systems.
Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

WordPress.com Simple releases happen semi-continuously (PCYsg-Jjm-p2).
WoA releases happen weekly.
Releases to self-hosted sites happen monthly. The next release is scheduled for none scheduled (scheduled code freeze on undefined).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

github-actions · 2025-01-31T22:44:36Z

Code Coverage Summary

Coverage changed in 1 file.

File	Coverage	Δ%	Δ Uncovered
projects/packages/jitm/src/class-jitm.php	68/123 (55.28%)	1.12%	0 💚

1 file is newly checked for coverage.

File	Coverage
projects/plugins/jetpack/_inc/lib/core-api/wpcom-endpoints/class-wpcom-rest-api-v2-endpoint-jitm-v2.php	16/48 (33.33%) ❤️‍🩹

Full summary · PHP report · JS report

getdave · 2025-02-11T17:00:12Z

Note to self. Ensure that changes to the jetpack/v4 endpoint are rebased into this PR.

getdave · 2025-02-11T17:04:43Z

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

+		$query = $request['query'];
+		if ( ! empty( $request['s'] ) ) {
+			$query['s'] = $request['s'];


Let's bring in changes outlined in #41542 once that PR is merged.

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

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

cpapazoglou · 2025-02-11T21:00:26Z

Thanks for working on this Dave and the detailed testing instructions. While testing it worked find in a Simple site

~~In a WoA site, the were no messages returned though~~

~~I wonder if that's expected or I missed something from the testing instructions?~~
Update: the public-api wasn't sandboxed. Works well in Atomic too!

cpapazoglou

LGTM after reviewing and testing. I added some minor comments.

getdave · 2025-02-12T09:59:58Z

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

-					( externalLink ? EXTERNAL_LINK_ICON : '' )
-					'</a>';
+					( externalLink ? EXTERNAL_LINK_ICON : '' );
+				( '</a>' );


All whitespace changes can be shipped independently.

getdave · 2025-02-12T10:00:14Z

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

-				$.ajax( {
-					url: window.jitm_config.api_root + 'jetpack/v4/jitm',
-					method: 'POST', // using DELETE without permalinks is broken in default nginx configuration
-					beforeSend: function ( xhr ) {
-						xhr.setRequestHeader( 'X-WP-Nonce', window.jitm_config.nonce );
-					},
+				apiFetch( {
+					path: '/wpcom/v2/jitm-v2',
+					method: 'POST',


Change to apiFetch can be shipped independently.

getdave · 2025-02-12T10:01:59Z

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

@@ -351,8 +357,11 @@ public function get_messages( $message_path, $query, $full_jp_logo_exists ) {

 			$dismissed_feature = isset( $hidden_jitms[ $envelope->feature_class ] ) && is_array( $hidden_jitms[ $envelope->feature_class ] ) ? $hidden_jitms[ $envelope->feature_class ] : null;

+			// If ignore_dismissible is true, skip the dismiss check
+			$ignore_dismissible = apply_filters( 'jetpack_jitm_should_ignore_dismissals', false );


Let's ship this as a standalone PR.

I closed that PR. Let's remove this code entirely as we can work around it using filters and providing a fake JITM for testing purposes.

getdave · 2025-02-13T17:00:35Z

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

@@ -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 ) {


@scruffian You asked about whether the IS_WPCOM check should be part of Connection_Manager. The answer is I have no idea. It could be.

We'd need input from the Jetpack team on this I think.

getdave · 2025-02-13T17:12:25Z

...ugins/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.


@scruffian Do you agree we should pull this out into a separate PR?

That way the code can be available on Simple, Atomic and JP and we can enable it on Simple by way of 170707-ghe-Automattic/wpcom when we are ready.

Also we can write some tests for it.

Yeah good idea

jeherve

This tests well for me! I left a few minor remarks below.

Sorry for the late review! I had forgotten to submit my review after adding the comments!

jeherve · 2025-02-13T11:24:46Z

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

@@ -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 ) {


Since we have the Status package as a requirement for the JITM package, we can use ( new Automattic\Jetpack\Status\Host() )->is_wpcom_simple() here.

jeherve · 2025-02-13T11:26:21Z

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

@@ -351,8 +357,11 @@ public function get_messages( $message_path, $query, $full_jp_logo_exists ) {

 			$dismissed_feature = isset( $hidden_jitms[ $envelope->feature_class ] ) && is_array( $hidden_jitms[ $envelope->feature_class ] ) ? $hidden_jitms[ $envelope->feature_class ] : null;

+			// If ignore_dismissible is true, skip the dismiss check
+			$ignore_dismissible = apply_filters( 'jetpack_jitm_should_ignore_dismissals', false );


Let's add a docblock for this filter, so it can be picked up by the codex.

In that docblock, you can use $$next-version$$ for the version number:

jetpack/projects/packages/README.md

Lines 114 to 123 in d3f5823

### Package Version Annotations

When needing to add a package version number inside a DocBlock, please use `$$next-version$$` as such:

- `@since $$next-version$$`

- `@deprecated $$next-version$$`

- `@deprecated since $$next-version$$`

- `_deprecated_function( __METHOD__, 'package-$$next-version$$' );` (other WordPress deprecation functions also work, but note it must be all on one line).

The `$$next-version$$` specifier will be automatically replaced with the correct package version number the next time a new version of that package is released.

jeherve · 2025-02-13T11:38:03Z

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

@@ -1,8 +1,13 @@
 import jQuery from 'jquery';


At this point, maybe we could get rid of jQuery in a follow-up PR? :)

jeherve · 2025-02-13T11:38:13Z

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


 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.


Suggested change

// Site ID will be automatically added to the request.// Site ID will be automatically added to the request.

// Site ID will be automatically added to the request.

jeherve · 2025-02-13T11:38:56Z

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

-							CHECKMARK_ICON +
-							text +
-							'</li>';
+						html += '<li>' + CHECKMARK_ICON + text + '</li>';


If we're to make changes, maybe we could switch to template strings, here and below, so it would be more readable?

jeherve · 2025-02-13T11:41:50Z

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

+					message_path: message_path,
+					query: query,
+					full_jp_logo_exists: full_jp_logo_exists,


Since the keys and values are the same, can't we use shorthand here and avoid duplication?

jeherve · 2025-02-13T11:47:46Z

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

-				if ( 'object' === typeof response && response[ '1' ] ) {
-					response = [ response[ '1' ] ];
+				if ( 'object' === typeof response && response[ 'data' ] ) {
+					response = [ response[ 'data' ][ 0 ] ];


Do we need to account for situations when response[ 'data' ] would not be an array?

jeherve · 2025-02-13T11:49:07Z

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

@@ -0,0 +1,167 @@
+<?php
+/**
+ * REST API endpoint for retrieving JITMs from the WPCOM API.


Maybe we could ship this endpoint in the JITM package instead, so things stay close together?

jeherve · 2025-02-13T11:51:26Z

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

+		$jitm = Automattic\Jetpack\JITMS\JITM::get_instance();
+
+		if ( ! $jitm->jitms_enabled() ) {
+			return rest_ensure_response( array() );


Would it make sense to return more than just an empty array in those situations, to make debugging easier?

getdave self-assigned this Jan 22, 2025

getdave commented Jan 22, 2025

View reviewed changes

github-actions bot added [Package] Jitm [Status] In Progress labels Jan 22, 2025

github-actions bot added the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Jan 22, 2025

jeryj force-pushed the try/jitm-on-simple branch from f6a951b to ce3b588 Compare January 31, 2025 22:33

github-actions bot added the [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ label Feb 10, 2025

getdave marked this pull request as ready for review February 10, 2025 12:43

getdave requested review from jeherve and scruffian February 10, 2025 14:54

getdave added [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it [Status] Needs Team Review labels Feb 11, 2025

getdave mentioned this pull request Feb 11, 2025

JITMs: allow shortcircuiting via existing filter #41380

Merged

3 tasks

getdave mentioned this pull request Feb 11, 2025

Update query parameter for JITM requests #41542

Merged

3 tasks

getdave commented Feb 11, 2025

View reviewed changes

getdave requested a review from cpapazoglou February 11, 2025 17:05

getdave changed the title ~~Try enabling JITM on Simple sites~~ Enable JITMs on Simple sites Feb 11, 2025

getdave changed the title ~~Enable JITMs on Simple sites~~ Enable JITMs in WPAdmin on Simple sites Feb 11, 2025

cpapazoglou reviewed Feb 11, 2025

View reviewed changes

projects/packages/jitm/src/js/jetpack-jitm.js Outdated Show resolved Hide resolved

cpapazoglou reviewed Feb 11, 2025

View reviewed changes

...ugins/jetpack/_inc/lib/core-api/wpcom-endpoints/class-wpcom-rest-api-v2-endpoint-jitm-v2.php Show resolved Hide resolved

cpapazoglou previously approved these changes Feb 11, 2025

View reviewed changes

getdave commented Feb 12, 2025

View reviewed changes

getdave added 21 commits February 13, 2025 16:49

Remove redundant function in JS

cce91e9

Hack around some things

8a2ae76

Remove logging from JS

66436d7

Improve ajax handler security and allow themes screen for jitms

767acc0

Remove ajax handling for no-logged in users

2fe8d3e

Make it easier to see which screens jitms are enabled on

a07724c

Use correct nonce

d1de75e

Remove redundant code

f631378

Remove Ajax handling but retain original Jetpack endpoint

39dcb07

changelog

2c01a40

Add ability to dismiss JITMs

c587e35

Move WP_COM code fork into JP class to preserve all functionality

1686b8c

Add helpful comment to explain code fork

ff8382a

Remove code fork and use filter to bypass Jetpack user auth check

ac7af97

Tidy Post_Connection class

1f7b336

Improve auth filter to run only on Dotcom Simple

4398240

Allow dismissals to bypass JP auth check on Simple

d9b3081

Correction

a76cbc4

Apply changes from #41542 to new endpoint

0cdabb2

Provide context on true type

1259953

Reuse endpoint URL

246ac3d

getdave force-pushed the try/jitm-on-simple branch from 5d489c6 to 246ac3d Compare February 13, 2025 16:51

getdave commented Feb 13, 2025

View reviewed changes

getdave added 3 commits February 13, 2025 17:02

remove addition of new filter for dissmissable JITMs

6a8565a

Tidy whitespace changes

beb9503

Update permissions checks in endpoint to match existing endpoint

25e198b

getdave commented Feb 13, 2025

View reviewed changes

Add Themes page to test case

5323a50

github-actions bot added the [Tests] Includes Tests label Feb 13, 2025

jeherve reviewed Feb 13, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enable JITMs in WPAdmin on Simple sites #41252

Enable JITMs in WPAdmin on Simple sites #41252

getdave commented Jan 22, 2025 •

edited

Loading

getdave Jan 22, 2025

getdave Jan 22, 2025

github-actions bot commented Jan 22, 2025 •

edited

Loading

github-actions bot commented Jan 22, 2025 •

edited

Loading

github-actions bot commented Jan 31, 2025 •

edited

Loading

getdave commented Feb 11, 2025

getdave Feb 11, 2025

cpapazoglou commented Feb 11, 2025 •

edited

Loading

cpapazoglou left a comment

getdave Feb 12, 2025

getdave Feb 12, 2025

getdave Feb 12, 2025

getdave Feb 12, 2025

getdave Feb 12, 2025

getdave Feb 12, 2025

getdave Feb 13, 2025

getdave Feb 13, 2025

getdave Feb 13, 2025

scruffian Feb 13, 2025

jeherve left a comment •

edited

Loading

jeherve Feb 13, 2025

jeherve Feb 13, 2025

jeherve Feb 13, 2025

jeherve Feb 13, 2025

jeherve Feb 13, 2025

jeherve Feb 13, 2025

jeherve Feb 13, 2025

jeherve Feb 13, 2025

jeherve Feb 13, 2025

	### Package Version Annotations

	When needing to add a package version number inside a DocBlock, please use `$$next-version$$` as such:

	- `@since $$next-version$$`
	- `@deprecated $$next-version$$`
	- `@deprecated since $$next-version$$`
	- `_deprecated_function( __METHOD__, 'package-$$next-version$$' );` (other WordPress deprecation functions also work, but note it must be all on one line).

	The `$$next-version$$` specifier will be automatically replaced with the correct package version number the next time a new version of that package is released.

	// Site ID will be automatically added to the request.// Site ID will be automatically added to the request.
	// Site ID will be automatically added to the request.

Enable JITMs in WPAdmin on Simple sites #41252

Are you sure you want to change the base?

Enable JITMs in WPAdmin on Simple sites #41252

Conversation

getdave commented Jan 22, 2025 • edited Loading

Proposed changes:

Other information:

Jetpack product discussion

Does this pull request change what data or activity we track or use?

Testing instructions:

Simple site

Atomic site 🤦

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Jan 22, 2025 • edited Loading

github-actions bot commented Jan 22, 2025 • edited Loading

github-actions bot commented Jan 31, 2025 • edited Loading

Code Coverage Summary

getdave commented Feb 11, 2025

Choose a reason for hiding this comment

cpapazoglou commented Feb 11, 2025 • edited Loading

cpapazoglou left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jeherve left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

getdave commented Jan 22, 2025 •

edited

Loading

github-actions bot commented Jan 22, 2025 •

edited

Loading

github-actions bot commented Jan 22, 2025 •

edited

Loading

github-actions bot commented Jan 31, 2025 •

edited

Loading

cpapazoglou commented Feb 11, 2025 •

edited

Loading

jeherve left a comment •

edited

Loading