Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Untangle theme screens #41374

Draft
wants to merge 37 commits into
base: trunk
Choose a base branch
from
Draft

Untangle theme screens #41374

wants to merge 37 commits into from

Conversation

scruffian
Copy link
Member

Fixes #

Proposed changes:

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:

  • Go to '..'

Copy link
Contributor

github-actions bot commented Jan 28, 2025

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:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. 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.
  3. Get at least one approval before merging.

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

@github-actions github-actions bot added the [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. label Jan 28, 2025
Copy link
Contributor

github-actions bot commented Jan 28, 2025

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 add/theme-install 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 add/theme-install
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin add/theme-install
    

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

Copy link
Contributor

github-actions bot commented Jan 28, 2025

Code Coverage Summary

Cannot generate coverage summary while tests are failing. 🤐

Please fix the tests, or re-run the Code coverage job if it was something being flaky.

Full summary · PHP report · JS report

@draganescu draganescu changed the title Add/theme install Untangle theme screens Jan 29, 2025
@github-actions github-actions bot added [Feature] Masterbar WordPress.com Toolbar and Dashboard customizations [Package] Masterbar labels Jan 29, 2025
/**
* Displays a banner before the theme browser that links to the WP.com Theme Showcase.
*/
function wpcom_themes_show_banner() {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can't remove this function until it's removed from being called on WPCOM: fbhepr%2Skers%2Sjcpbz%2Sjc%2Qpbagrag%2Snqzva%2Qcyhtvaf%2Sjcpbz%2Qgurzrf.cuc%3Se%3Q04155113%23176%2Q179-og

@ryelle
Copy link
Member

ryelle commented Jan 29, 2025

In 02fe4c2 I copied over the files from wpcomsh (the code used for Atomic themes), but this doesn't remove those original files yet. Then in 32b4963, I forked the core wp_ajax_query_themes handler, because it first checks for install_themes permissions. I don't like this approach, copying more core code, so I'm open to better solutions — but this at least lets the existing wpcom API functions hook into the correct results.

@ryelle
Copy link
Member

ryelle commented Jan 31, 2025

There are now wrapper filters on the template code — wpcom_themes_tmpl_theme for the card template & wpcom_themes_tmpl_theme_preview for the full-screen customizer preview. I've then added in the theme tier, passed back from the wpcom endpoint, and added it next to the theme name. It's not styled, probably needs to go somewhere else, but it's starting point.

Screenshot:

Screenshot 2025-01-31 at 12 26 03 PM

Maybe this should replace the "Installed" banner?

@ryelle ryelle force-pushed the add/theme-install branch from 32e9c8e to 563f07a Compare February 4, 2025 20:28
@ryelle
Copy link
Member

ryelle commented Feb 4, 2025

I'm not sure the best place for this, but just to note this down somewhere, here's how I'm thinking about the work breakdown for the theme-install.php portion of the work (this does cross over a few of the other open issues). Unchecked checkboxes are tasks anyone can pick up, so we can work on this in parallel.

  • Add a custom theme-install page for Simple sites
    • New page on simple sites, should show themes & core filters
    • Add DIFM banner (IIRC this should support JiTM in general, which is in progress by @getdave)
    • Add “Upload theme” button to header, should reveal Atomic upsell
  • Display wpcom, partner, and community themes
    • Community themes that are available on wpcom should be hidden, priority given to the wpcom theme (for example, searching "Layover" should only return the wpcom version) — probably not working due to the prefixed stylesheet value.
    • Themes should display plan label (reference PR for text and conditions), buttons should change to “Upgrade to…” (in progress by @matiasbenedetto)
    • “Install" button tries to run behind the scenes with install ajax request, but fails (of course). This applies to community & partner themes.
    • Add partner themes to Atomic results.
  • Users should be able to upgrade and activate paid themes/plans, including community and partner (#98662)
    • Personal & Premium are working great
    • Atomic conversion currently requires a visit to the Theme Showcase page (see these notes). We talked about moving this screen to wp-admin; also simply redirecting back to wp-admin after theme activation. Updated to Marketplace route.
    • Atomic conversion is now using Marketplace route, needs testing (see pdL8AQ-14e-p2)
    • Some partner themes (Drinkify) don't populate product_details, so they’re not purchasable.
  • Direct links to theme should show wpcom theme info. For example, /wp-admin/themes.php?page=wpcom-install-theme&theme=pub%2Fconference. Not working on Atomic either (/wp-admin/theme-install.php?theme=timestream).

@ryelle
Copy link
Member

ryelle commented Feb 11, 2025

Eventually we'll need to figure out how to roll this out - not that it's ready yet, but to think about:

  • All the packages/jetpack-mu-wpcom/src/features/wpcom-themes/includes/* files are simply copied from plugins/wpcomsh/wpcom-themes/includes/; but they should live in one unified place, for both Atomic and Simple
  • The modified theme-install.php file is based on a core file. How will we handle that? Even if the filters we added are merged into core, Simple sites can't use it directly. So does it actually live forever as a forked file? Not that I see this as a file likely to change often, but still.
  • wpcom_themes_ajax_query_themes and wpcom_themes_ajax_save_wporg_username are forked from the core functions wp_ajax_query_themes and wp_ajax_save_wporg_username — this should be more clear, since any updates to those functions will require merging back into here.

@scruffian
Copy link
Member Author

So does it actually live forever as a forked file?

I would think so yes. We'd need to copy/paste it every time we merge core in.

* @param object $theme The theme object.
* @return object The theme object.
*/
function wpcom_themes_api_theme_object( $theme ) {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this get added to the endpoint itself?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left it as a filter (in wpcom_themes_ajax_query_themes) because that function is copied from core, and our code here needs to run after the body of that function runs.

The alternative would be updating the endpoint, but then we would need to alter the wpcom_themes_ajax_query_themes more, which could be harder to merge later if there are core changes. I added a note about that to my how to merge comment.

*
* @return array<stdClass> An array with all the WPCom themes.
*/
protected function fetch_themes( string $cache_key, array $params = array() ): array {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This function calls the API through HTTP. On Simple sites we can call the code directly, which means that we don't need to wait for an HTTP request. I think we can do this using Client::wpcom_json_api_request_as_blog

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in 458df77 - we should now be able to modify the API and see the results when testing.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I reverted this because it was broken, but it should give you an idea how to do it!

@scruffian
Copy link
Member Author

All the packages/jetpack-mu-wpcom/src/features/wpcom-themes/includes/* files are simply copied from plugins/wpcomsh/wpcom-themes/includes/; but they should live in one unified place, for both Atomic and Simple

I think the first step here could be to open a separate PR to move those files from wpcomsh to here. That will also make the diff easier to grok.

@jeryj
Copy link
Contributor

jeryj commented Feb 12, 2025

I think the first step here could be to open a separate PR to move those files from wpcomsh to here. That will also make the diff easier to grok.

I can do this if no one else has yet.

@jeryj
Copy link
Contributor

jeryj commented Feb 12, 2025

PR for moving files in the works: https://github.com/Automattic/jetpack/pull/41770/files

@scruffian scruffian changed the base branch from trunk to update/move-wpcom-themes-api February 17, 2025 17:55
@scruffian scruffian changed the base branch from update/move-wpcom-themes-api to trunk February 17, 2025 17:56
ryelle and others added 25 commits February 17, 2025 14:28
…missions

# Conflicts:
#	projects/packages/jetpack-mu-wpcom/src/features/wpcom-themes/wpcom-themes.php
On simple sites, the `stylesheet` includes the path (e.g., `pub/`), while atomic sites don't use this folder structure, so the "installed" theme would not match. In this case, the `id` value is the correct slug.
Installed themes on wpcom have prefixed slugs like `pub/*` or `premium/*` due to the file structure, but wporg expects just the theme name (e.g. psychedeli).
Copy link

Code Coverage Summary

Cannot generate coverage summary while tests are failing. 🤐

Please fix the tests, or re-run the Code coverage job if it was something being flaky.

Full summary · PHP report · JS report

@ryelle
Copy link
Member

ryelle commented Feb 17, 2025

The commits in f188246 & 6d58cde fix some API merge issues. The first ensures there are no duplicates in the results, so you can search for "Layover" or "Videomaker" and you won't see the community option. The second commit prevents wpcomsh_feature_filter_wpcom_themes_api_result from running over the "Block Themes" tab, since it's already running wpcomsh_block_themes_wpcom_themes_api_result. According to that function, it should merge the resulting themes by release date, but since both functions ran, the general filter result was merging with wpcom themes first. Now it's back to just using release date. Is this actually the preferred behavior?

There is an interesting … glitch? i guess — the merge_by_release_date function filters out any theme released after the first wporg theme, so right now on Latest, you'll see "Omega Food Delivery" as the most recent, even though technically "Booknest" was released more recently. I assume it's to handle paginated requests, but it should probably not apply to the first page of results.

These both change the WPCom_Themes* functions — should I move those over to #41770 or do we want to have a separate PR for changes to those files?

@scruffian
Copy link
Member Author

These both change the WPCom_Themes* functions — should I move those over to #41770 or do we want to have a separate PR for changes to those files?

I think let's keep #41770 just for the file moving, so we can assess the impact of the changes we're making more carefully.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] Masterbar WordPress.com Toolbar and Dashboard customizations [mu wpcom Feature] Wpcom Themes [Package] Jetpack mu wpcom WordPress.com Features [Package] Masterbar [Status] In Progress [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants