Move WordPress.com themes api into jetpack-mu-wpcom package #41770

jeryj · 2025-02-12T21:14:42Z

Part of the Theme Untangling project. This PR should not impact any functionality.

Proposed changes:

We modify some WordPress.com themes API calls using hooks while in the wp-admin view on WordPress.com sites.

Currently we do this only for Atomic sites. This PR moves that modification code into a place where the modifications can also work for Simple sites.

Note: currently as of this PR the modifications will only be loaded on Atomic until such time as we want to include them on Simple. This matches existing Production but sets us up for future development.

In #41374 we are modifying these files, so it makes sense to move them first in one PR, so that we can see what modifications are being made in the other PR.

We need to think about how to release this, since the release cycle for wpcom's mu-jetpack-wcom plugin and wpcomsh differ.

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:

This PR should not change any functionality.

On a simple site

Open wp-admin/themes.php
Confirm that you see the same list of themes as on trunk
Try switching themes
Confirm that it works the same as trunk
Try deleting a theme (this option is in the theme details modal)
Confirm that it works the same as trunk

On an Atomic site

Follow the instructions above
Go to wp-admin/theme-install.php
Search for a theme and confirm that the results are the same as trunk
Try installing a new theme - it should continue to work as trunk

github-actions · 2025-02-12T21:15:35Z

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 WoA dev 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 (WordPress.com Site Helper), and enable the update/move-wpcom-themes-api branch.
To test on Simple, run the following command on your sandbox:

bin/jetpack-downloader test jetpack-mu-wpcom-plugin update/move-wpcom-themes-api

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-02-12T21:15:48Z

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.

🔴 Action required: Please add missing changelog entries for the following projects: projects/plugins/mu-wpcom-plugin

Use the Jetpack CLI tool to generate changelog entries by running the following command: jetpack changelog add.
Guidelines: /docs/writing-a-good-changelog-entry.md

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.

Mu Wpcom plugin:

Next scheduled release: WordPress.com Simple releases happen semi-continuously (PCYsg-Jjm-p2).

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

Wpcomsh plugin:

Next scheduled release: Atomic deploys happen twice daily on weekdays (p9o2xV-2EN-p2).

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

github-actions · 2025-02-12T22:14:40Z

Code Coverage Summary

Coverage changed in 2 files.

File	Coverage	Δ%	Δ Uncovered
projects/packages/jetpack-mu-wpcom/src/class-jetpack-mu-wpcom.php	0/217 (0.00%)	0.00%	2 ❤️‍🩹
projects/plugins/wpcomsh/wpcom-themes/themes.php	0/26 (0.00%)	0.00%	-55 💚

6 files are newly checked for coverage. Only the first 5 are listed here.

File	Coverage
projects/packages/jetpack-mu-wpcom/src/features/wpcom-themes/includes/class-wpcom-themes-api.php	0/33 (0.00%) 💔
projects/packages/jetpack-mu-wpcom/src/features/wpcom-themes/includes/class-wpcom-themes-cache.php	0/5 (0.00%) 💔
projects/packages/jetpack-mu-wpcom/src/features/wpcom-themes/includes/class-wpcom-themes-mapper.php	0/36 (0.00%) 💔
projects/packages/jetpack-mu-wpcom/src/features/wpcom-themes/includes/class-wpcom-themes-merger.php	0/34 (0.00%) 💔
projects/packages/jetpack-mu-wpcom/src/features/wpcom-themes/includes/class-wpcom-themes-service.php	0/37 (0.00%) 💔

Full summary · PHP report · JS report

_{Add label

I don't care about code coverage for this PR
Use this label to ignore the check for insufficient code coveage.
to override the failing coverage check.}

ryelle · 2025-02-12T23:34:15Z

Haven't tested thoroughly, but this seems to work well on a WoA dev site (with both WordPress.com Site Helper and WordPress.com Features using this branch) — theme-install.php returns wpcom themes 👍🏻

When I deactivate "WordPress.com Features" though, the themes return to what's in core. I think that's expected with the dev process, but I just want to check that we're sure this code will load on both simple and atomic sites.

Haven't tested on wpcom simple yet (though it should not do anything there, since these filters are never called).

projects/packages/jetpack-mu-wpcom/src/features/wpcom-themes-api/themes.php

scruffian · 2025-02-13T09:27:40Z

I made some changes here:

Only move the files, don't change any function names etc. yet, so that we don't risk breakages
Load the files with the same conditions as before (both Atomic and not WP_CLI)

Testing:
✅ I tested on a Simple site. Nothing should change.
✅ I tested on an Atomic site - searching, installing, activating and deleting a theme.

scruffian · 2025-02-13T09:30:29Z

Actually, thinking about this some more, I wonder if we should leave some of this in wpcomsh, as it isn't relevant to Simple sites - particularly the stuff about symlinks etc. However the requires are used for both. Maybe this is simpler. 🤔

getdave · 2025-02-13T10:57:59Z

projects/packages/jetpack-mu-wpcom/src/class-jetpack-mu-wpcom.php

@@ -160,6 +160,11 @@ public static function load_wpcom_user_features() {
 		require_once __DIR__ . '/features/wpcom-sidebar-notice/wpcom-sidebar-notice.php';
 		require_once __DIR__ . '/features/wpcom-themes/wpcom-themes.php';

+		// We include WPCom Themes results and installation on WoA sites only and non-WP_CLI context.


Nit: I think it would be really helpful to future developers if we explained why we only enable in these contexts. Otherwise I think we can just remove the comment entirely.

projects/packages/jetpack-mu-wpcom/changelog/update-move-wpcom-themes-api

projects/packages/jetpack-mu-wpcom/src/class-jetpack-mu-wpcom.php

jp-launch-control · 2025-02-18T16:42:58Z

Code Coverage Summary

Coverage changed in 2 files.

File	Coverage	Δ%	Δ Uncovered
projects/packages/jetpack-mu-wpcom/src/class-jetpack-mu-wpcom.php	0/225 (0.00%)	0.00%	2 ❤️‍🩹
projects/plugins/wpcomsh/wpcom-themes/themes.php	0/26 (0.00%)	0.00%	-55 💚

6 files are newly checked for coverage. Only the first 5 are listed here.

File	Coverage
projects/packages/jetpack-mu-wpcom/src/features/wpcom-themes/includes/class-wpcom-themes-api.php	0/35 (0.00%) 💔
projects/packages/jetpack-mu-wpcom/src/features/wpcom-themes/includes/class-wpcom-themes-cache.php	0/7 (0.00%) 💔
projects/packages/jetpack-mu-wpcom/src/features/wpcom-themes/includes/class-wpcom-themes-mapper.php	0/38 (0.00%) 💔
projects/packages/jetpack-mu-wpcom/src/features/wpcom-themes/includes/class-wpcom-themes-merger.php	0/36 (0.00%) 💔
projects/packages/jetpack-mu-wpcom/src/features/wpcom-themes/includes/class-wpcom-themes-service.php	0/39 (0.00%) 💔

Full summary · PHP report

_{Add label

I don't care about code coverage for this PR
Use this label to ignore the check for insufficient code coveage.
to override the failing coverage check.}

jeryj · 2025-02-18T17:23:35Z

projects/packages/jetpack-mu-wpcom/src/features/wpcom-themes/wpcomsh-themes.php

+	// Add results to the resulting array.
+	return $wpcom_themes_service->filter_themes_api_result_recommended( $res );
+}
+add_filter( 'themes_api_result', 'wpcomsh_popular_wpcom_themes_api_result', 0, 3 );


We will want these to also run on WPcom in the untangling themes PR, right? Should we move them to run on WPcom now, or only in the untangling themes PR?

I a bit torn on if we should rename these functions and move the filters over entirely or not. I think it's best to leave it as is. We don't need any of this on WPcom yet. It's probably best to enable it in untangling themes as that's when it's actually needed.

Yeah I agree. If we keep this PR as just a code moving task, then we can consider changes in the future on a case by case basis. If we start changing things as well as moving them its gets harder to reason about.

Actually, when I thought about the deploy process for this - because wpcomsh and jetpack-mu-wpcom are deployed at different times, I think it does make more sense to rename the functions now - that way we avoid errors when a function is redefined.

I was worried about this too, but I think it's not an issue. I believe WoA sites run jetpack-mu-wpcom bundled as wpcomsh. They don't run the WPcom mu-plugin AND wpcomsh. So there should only be one version of anything running, even if deploy cycles are different. We should absolutely confirm to be sure though!

Yeah I wasn't sure exactly how they fit together but @zinigor suggested it might be a problem and I thought better safe than sorry, since we want to rename anyway.

I believe WoA sites run jetpack-mu-wpcom bundled as wpcomsh. They don't run the WPcom mu-plugin AND wpcomsh.

That's correct! I sometimes get confused with what environment gets affected with what. WoA and Atomic sites should be fine in this regard. The WordPress.com environment though will have these files ~~removed~~ added, but not used?

If that's so, then I'm sorry for causing additional anxiety about deploying this.

jeryj · 2025-02-18T17:26:27Z

projects/plugins/wpcomsh/wpcom-themes/themes.php

-	return $wpcom_themes_service->get_theme( $args->slug ) ?? $res;
-}
-add_filter( 'themes_api_result', 'wpcomsh_theme_information_wpcom_themes_api_result', 0, 3 );
-


Should we move over this whole file? Or is what's left in this file separate enough that it's fine to leave in a separate location? As in, if someone needed to fix something related to the themes API, then they wouldn't need to work in both this file and jetpack-mu-wpcom/src/features/wpcom-themes/wpcomsh-themes.php?

I reviewed more thoroughly. I think this file can stay here and the separation is good. What's left in this file isn't about API calls. It's about symlinking wpcom themes for atomic sites, and doesn't run on api calls.

jeryj · 2025-02-18T17:52:02Z

I think this PR code-wise is good to go. I'm going to take time this afternoon to test it on atomic. @scruffian - did you check any network requests in your testing?

ryelle · 2025-02-18T21:12:05Z

projects/plugins/wpcomsh/wpcom-themes/themes.php

@@ -5,174 +5,6 @@
 * @package wpcom-themes
 */

-/**


Since this file isn't doing API things anymore, can you update the file comment ^?

Another idea (not blocking for this PR) would be to moved these symlink functions to
managed-themes.php — since there are other wpcom theme related functions there.

Another idea (not blocking for this PR) would be to moved these symlink functions to
managed-themes.php

I think it's a good idea to move it. Those functions all fit together since they're about managing symlinked themes. I don't see a reason to have them in different files.

The problem with moving it is that the conditions for loading wpcom-themes are different for the conditions for loading managed-themes. (wpcom-themes is not loaded in a CLI context). I'm not sure how deliberate this is.

ryelle · 2025-02-18T22:50:13Z

projects/packages/jetpack-mu-wpcom/src/class-jetpack-mu-wpcom.php

+		if ( ( defined( 'IS_ATOMIC' ) && IS_ATOMIC ) && ( ! defined( 'WP_CLI' ) || ! WP_CLI ) ) {
+			require_once __DIR__ . '/features/wpcom-themes/wpcomsh-themes.php';
+		}


What is the plan for removing this atomic gate? Can that be done here, or as part of a follow-up PR? Asking because I think it will help with a PR for the atomic transfer process (Automattic/wp-calypso#99761). And technically this shouldn't have any effect on simple sites yet anyway, since they don't call any install code.

Ah, I see the PR description says "This matches existing Production but sets us up for future development", so I assume a future PR.

Yeah I think its good to keep the PR purely for moving the code.

scruffian · 2025-02-19T15:39:03Z

I renamed the duplicated functions so that we can deploy without worrying about name conflicts. I also added class_exists checks before each of the classes in case they get included twice.

projects/packages/jetpack-mu-wpcom/composer.json

jeryj · 2025-02-20T21:46:02Z

@scruffian - I split out the PHP 8.1 upgrade (#41928) and Phan (#41931) commits to separate PRs since they were necessary but unrelated to this work. Then I rebased this branch off of the PHP 8.1 upgrade branch and cherry-picked all the commits from this branch back. I have a local copy of the branch pre-rebasing if something is messed up.

jeryj · 2025-02-20T21:47:45Z

I also added class_exists checks before each of the classes in case they get included twice.

@scruffian - It seems like this is unnecessary too. Was the worry here if both the jetpack-mu-wpcom-plugin and wpcomsh get loaded?

jeryj

Flagging the code that can probably be removed.

jeryj · 2025-02-20T21:48:13Z

...ects/packages/jetpack-mu-wpcom/src/features/wpcom-themes/includes/class-wpcom-themes-api.php

+if ( class_exists( 'WPCom_Themes_Api' ) ) {
+	return;
+}


Potentially unnecessary.

jeryj · 2025-02-20T21:48:17Z

...ts/packages/jetpack-mu-wpcom/src/features/wpcom-themes/includes/class-wpcom-themes-cache.php

+if ( class_exists( 'WPCom_Themes_Cache' ) ) {
+	return;
+}


Potentially unnecessary.

jeryj · 2025-02-20T21:48:22Z

...s/packages/jetpack-mu-wpcom/src/features/wpcom-themes/includes/class-wpcom-themes-mapper.php

+if ( class_exists( 'WPCom_Themes_Mapper' ) ) {
+	return;
+}


Potentially unnecessary.

jeryj · 2025-02-20T21:48:26Z

...s/packages/jetpack-mu-wpcom/src/features/wpcom-themes/includes/class-wpcom-themes-merger.php

+if ( class_exists( 'WPCom_Themes_Merger' ) ) {
+	return;
+}


Potentially unnecessary.

jeryj · 2025-02-20T21:48:31Z

.../packages/jetpack-mu-wpcom/src/features/wpcom-themes/includes/class-wpcom-themes-service.php

+if ( class_exists( 'WPCom_Themes_Service' ) ) {
+	return;
+}


Potentially unnecessary.

scruffian · 2025-02-20T22:44:20Z

@scruffian - It seems like this is unnecessary too. Was the worry here if both the jetpack-mu-wpcom-plugin and wpcomsh get loaded?

Yeah, i was thinking about what might happen if the the mu plugin is running at the same time as wpcomsh - since that plugin will be deployed before this one - I think we want to ensure that both changes can happen independently of each other since we can't guarantee the timings.

I do also think it's generally good practice to check a class doesn't exist before you define it, just in case.

github-actions bot added [Package] Jetpack mu wpcom WordPress.com Features [Plugin] Wpcomsh [mu wpcom Feature] Wpcom Themes Api labels Feb 12, 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 Feb 12, 2025

scruffian reviewed Feb 13, 2025

View reviewed changes

projects/packages/jetpack-mu-wpcom/src/features/wpcom-themes-api/themes.php Outdated Show resolved Hide resolved

scruffian reviewed Feb 13, 2025

View reviewed changes

projects/packages/jetpack-mu-wpcom/src/features/wpcom-themes-api/themes.php Outdated Show resolved Hide resolved

scruffian mentioned this pull request Feb 13, 2025

Untangling Themes Automattic/wp-calypso#95651

Open

github-actions bot added the [mu wpcom Feature] Wpcom Themes label Feb 13, 2025

getdave reviewed Feb 13, 2025

View reviewed changes

projects/packages/jetpack-mu-wpcom/changelog/update-move-wpcom-themes-api Show resolved Hide resolved

scruffian reviewed Feb 14, 2025

View reviewed changes

projects/packages/jetpack-mu-wpcom/src/class-jetpack-mu-wpcom.php Outdated Show resolved Hide resolved

ryelle mentioned this pull request Feb 17, 2025

Untangle theme screens #41374

Draft

3 tasks

jeryj commented Feb 18, 2025

View reviewed changes

ryelle reviewed Feb 18, 2025

View reviewed changes

ryelle mentioned this pull request Feb 18, 2025

Marketplace installation: Support externally managed themes Automattic/wp-calypso#99761

Open

8 tasks

ryelle reviewed Feb 18, 2025

View reviewed changes

scruffian force-pushed the update/move-wpcom-themes-api branch from 07b61ce to 06513b1 Compare February 19, 2025 11:21

github-actions bot added the [Plugin] mu wpcom jetpack-mu-wpcom plugin label Feb 19, 2025

jeryj commented Feb 20, 2025

View reviewed changes

projects/packages/jetpack-mu-wpcom/composer.json Outdated Show resolved Hide resolved

jeryj mentioned this pull request Feb 20, 2025

Update package/jetpack-mu-wpcom to php 8.1 #41928

Open

3 tasks

jeryj and others added 20 commits February 20, 2025 15:39

Move wpcomsh themes api files into jetpack-mu-wpcom

280cc48

Rename wpcomsh functions to wpcom_themes_api

129dd74

changelog

0f5b598

Fix typo in changelog

e0853a5

Remove wpcom-themes from the autoloader list

ec17c89

Remove the call to load the (moved) themes files

235e0b2

Load the moved themes files into wpcom mu plugin

f1fff1b

go with original function names

c473855

move the wpcomsh theme files into wpcom-themes

48d1113

only include on atomic

0f40a7b

add missing files

d59105a

Move symlink stuff back to wpcomsh

3f57998

add the package back

22aac2b

prevent duplicate class declarations

b519aa5

update comment to make it more accurate

177cb0c

try defining IS_ATOMIC in tests

54f45ad

remove test

008e630

move the condition on which we load wpcomsh themes code

d56759d

fix condition

bc27aeb

update lock files

d0a6f06

jeryj force-pushed the update/move-wpcom-themes-api branch from d4eb451 to d0a6f06 Compare February 20, 2025 21:42

jeryj changed the base branch from trunk to update/php-8.1 February 20, 2025 21:43

github-actions bot added [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! and removed [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. labels Feb 20, 2025

jeryj commented Feb 20, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move WordPress.com themes api into jetpack-mu-wpcom package #41770

Move WordPress.com themes api into jetpack-mu-wpcom package #41770

jeryj commented Feb 12, 2025 •

edited by getdave

Loading

github-actions bot commented Feb 12, 2025 •

edited

Loading

github-actions bot commented Feb 12, 2025 •

edited

Loading

github-actions bot commented Feb 12, 2025 •

edited

Loading

ryelle commented Feb 12, 2025

scruffian commented Feb 13, 2025

scruffian commented Feb 13, 2025 •

edited

Loading

getdave Feb 13, 2025 •

edited

Loading

jp-launch-control bot commented Feb 18, 2025 •

edited

Loading

jeryj Feb 18, 2025

jeryj Feb 18, 2025

scruffian Feb 19, 2025

scruffian Feb 19, 2025

jeryj Feb 19, 2025

scruffian Feb 19, 2025

zinigor Feb 19, 2025 •

edited

Loading

jeryj Feb 18, 2025

jeryj Feb 18, 2025

jeryj commented Feb 18, 2025

ryelle Feb 18, 2025 •

edited

Loading

jeryj Feb 18, 2025

scruffian Feb 19, 2025

ryelle Feb 18, 2025

ryelle Feb 18, 2025

scruffian Feb 19, 2025

scruffian commented Feb 19, 2025

jeryj commented Feb 20, 2025

jeryj commented Feb 20, 2025

jeryj left a comment

jeryj Feb 20, 2025

jeryj Feb 20, 2025

jeryj Feb 20, 2025

jeryj Feb 20, 2025

jeryj Feb 20, 2025

scruffian commented Feb 20, 2025 •

edited

Loading

Move WordPress.com themes api into jetpack-mu-wpcom package #41770

Are you sure you want to change the base?

Move WordPress.com themes api into jetpack-mu-wpcom package #41770

Conversation

jeryj commented Feb 12, 2025 • edited by getdave Loading

Proposed changes:

Other information:

Jetpack product discussion

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

Testing instructions:

github-actions bot commented Feb 12, 2025 • edited Loading

github-actions bot commented Feb 12, 2025 • edited Loading

github-actions bot commented Feb 12, 2025 • edited Loading

Code Coverage Summary

ryelle commented Feb 12, 2025

scruffian commented Feb 13, 2025

scruffian commented Feb 13, 2025 • edited Loading

getdave Feb 13, 2025 • edited Loading

Choose a reason for hiding this comment

jp-launch-control bot commented Feb 18, 2025 • edited Loading

Code Coverage Summary

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

zinigor Feb 19, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jeryj commented Feb 18, 2025

ryelle Feb 18, 2025 • 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

scruffian commented Feb 19, 2025

jeryj commented Feb 20, 2025

jeryj commented Feb 20, 2025

jeryj 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

scruffian commented Feb 20, 2025 • edited Loading

jeryj commented Feb 12, 2025 •

edited by getdave

Loading

github-actions bot commented Feb 12, 2025 •

edited

Loading

github-actions bot commented Feb 12, 2025 •

edited

Loading

github-actions bot commented Feb 12, 2025 •

edited

Loading

scruffian commented Feb 13, 2025 •

edited

Loading

getdave Feb 13, 2025 •

edited

Loading

jp-launch-control bot commented Feb 18, 2025 •

edited

Loading

zinigor Feb 19, 2025 •

edited

Loading

ryelle Feb 18, 2025 •

edited

Loading

scruffian commented Feb 20, 2025 •

edited

Loading