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

Custom Content Types: Ensure settings page functionality works without module requirement #41349

Open
wants to merge 14 commits into
base: trunk
Choose a base branch
from

Conversation

coder-karen
Copy link
Contributor

@coder-karen coder-karen commented Jan 28, 2025

Fixes https://github.com/Automattic/vulcan/issues/508

Proposed changes:

This PR ensures the Custom Content Types card with Jetpack Portfolio and Testimonials toggles and links on the Jetpack > Settings > Writing page can continue to function when there is no Custom Content Types module file in Jetpack. This is because this file will be removed as part of the cleanup once the Classic Theme Helper plugin is live and the features loaded via the Classic Theme Helper package directly.
Changes include:

  • The creation of a new REST API route, which allows information about the Custom Content Type to be passed (name, status, whether it is overridden, search queries, description). This also allows values to be overridden by third parties.
  • There is also a window variable fallback with an initial value, following the same style as other initial states such as JP_CONNECTION_INITIAL_STATE. This prevents delayed loading of the custom content type settings card by using the value directly, instead of waiting for the rest_api_init hook.
  • On the React Writing page itself, instead of checking for the module we check that the Custom Content Type status is active, before showing the card.
  • I've removed Custom Content Types from the legacy Jetpack modules page - /wp-admin/admin.php?page=jetpack_modules - rather than trying to create a workaround. It also it wasn't working prior to this PR.
  • Several previous quirks that existed when toggling on Testimonials or Portfolios on themes that supported one or the other have been fixed in this PR. More details at the bottom of the PR.

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:

  • On the Jetpack Settings > Writing page, make sure there is a settings card showing for Custom Content Types. Toggle testimonials and portfolios on and off, checking the following:
    • When toggling either on, you should see the 'portfolio' or 'testimonial' text in the description has now become a link, and clicking on it opens the page to add a portfolio or testimonial. The 'Add a testimonial' or 'Add a portfolio' link should also be added underneath the toggle, and the link should work.
    • When switching to a theme that supports one or both CPTs, ensure the relevant toggle is turned on and the feature enabled. Examples: Sketch (portfolios), Dara (testimonials), Lodestar (both). See the quirks section below for some previous quirks related to themes that support CPTs, that have been fixed.
    • When toggling either on, the menu item should display, and the feature should be enabled or disabled as expected.
    • Clicking on 'learn more' and the privacy info link via the info icon should continue to work.
    • Search for 'Testimonials' or 'Portfolios' via the Search box, and it should show the Custom Content Types section.

Other tests:

  • Test a non-admin user - make sure they can't see custom content types
  • Visit http://localhost/wp-admin/admin.php?page=jetpack_modules, make sure you can't see Custom Content Types (this also didn't work previously so it's removal should have no consequence)
  • The Nova Restaurant CPT should not be affected in anyway - add the Confit theme and make sure you see the Food Menus menu item, and can add and edit items.

This functionality should continue to work both with and without the Custom Content Types module file in place. However if you want to test that removing the module file also does not break any functionality, then delete the jetpack/modules/custom-content-types.php file and follow the same testing steps as above.

Previous quirks that have been fixed in this PR
  • On a theme that supports Testimonials (Dara), turn on Portfolios, and Testimonials does not toggle on (vs trunk where it does).
  • Also, toggle off testimonials toggles it off in all circumstances - previously it toggled off but stayed active (in menu) if portfolio was also toggled on.
  • On a theme that supports Portfolios (Sketch), turn on Testimonials, and Portfolios does not toggle on (vs trunk where it does).
  • On a theme that supports both Testimonials and Portfolios (Lodestar), activating one does not also activate the other.

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 remove/custom-content-types-module-requirement 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 remove/custom-content-types-module-requirement
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin remove/custom-content-types-module-requirement
    

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 github-actions bot added [Feature] Theme Tools [JS Package] API [Package] Classic Theme Helper [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ Admin Page React-powered dashboard under the Jetpack menu Docs RNA labels Jan 28, 2025
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!


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 February 4, 2025 (scheduled code freeze on February 4, 2025).

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

Copy link
Contributor

github-actions bot commented Jan 29, 2025

Code Coverage Summary

Coverage changed in 10 files. Only the first 5 are listed here.

File Coverage Δ% Δ Uncovered
projects/packages/classic-theme-helper/src/custom-content-types.php 0/81 (0.00%) 0.00% 49 💔
projects/plugins/jetpack/_inc/client/writing/index.jsx 0/32 (0.00%) 0.00% 16 💔
projects/js-packages/api/index.jsx 25/150 (16.67%) -0.11% 1 💔
projects/plugins/jetpack/extensions/store/membership-products/resolvers.js 55/106 (51.89%) -0.94% 1 💔
projects/plugins/jetpack/_inc/client/state/action-types.js 189/189 (100.00%) 0.00% 0 💚

3 files are newly covered.

File Coverage
projects/plugins/jetpack/_inc/client/state/feature-check/actions.js 0/7 (0.00%) 💔
projects/plugins/jetpack/_inc/client/state/feature-check/reducer.js 0/7 (0.00%) 💔
projects/plugins/jetpack/_inc/client/state/feature-check/index.js 0/0 (—%) 🤷

Full summary · PHP report · JS report

@@ -34,18 +35,74 @@ function jetpack_load_custom_post_types() {
add_action( 'jetpack_activate_module_custom-content-types', array( '\Automattic\Jetpack\Classic_Theme_Helper\Jetpack_Testimonial', 'activation_post_type_support' ) );

add_action( 'init', array( '\Automattic\Jetpack\Classic_Theme_Helper\Nova_Restaurant', 'init' ) );

$site_id = Connection_Manager::get_site_id();
if ( is_wp_error( $site_id ) ) {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Adding the site id check here prevents issues with multiple APIs, or rather failing tests. See the link in this Slack thread for more on those failing tests: p1738057987804199/1738056861.398469-slack-CDLH4C1UZ

I'd like to hear more though from anyone who has more knowledge of the interconnectedness of the REST APIs as well as the api-v2 tests as to how these may have been overlapping, if possible.

if ( class_exists( 'Jetpack' ) ) {
Jetpack::enable_module_configurable( __FILE__ );
}
$initial_state = 'var CUSTOM_CONTENT_TYPE__INITIAL_STATE; typeof CUSTOM_CONTENT_TYPE__INITIAL_STATE === "object" || (CUSTOM_CONTENT_TYPE__INITIAL_STATE = JSON.parse(decodeURIComponent("' . rawurlencode(
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This variable follows the same style as a couple of other initial states, such as JP_CONNECTION_INITIAL_STATE:

return 'var JP_CONNECTION_INITIAL_STATE; typeof JP_CONNECTION_INITIAL_STATE === "object" || (JP_CONNECTION_INITIAL_STATE = JSON.parse(decodeURIComponent("' . rawurlencode( wp_json_encode( self::get_data() ) ) . '")));';

@coder-karen coder-karen marked this pull request as ready for review January 29, 2025 11:24
@@ -277,6 +277,11 @@ function JetpackRestApiClient( root, nonce ) {
.then( checkStatus )
.then( parseJsonResponse ),

getFeatureTypeStatus: customContentType =>
Copy link
Contributor Author

@coder-karen coder-karen Jan 29, 2025

Choose a reason for hiding this comment

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

The intention behind having this as part of the Jetpack HTTP API is because it ideally will be able to be used by multiple removed 'features' depending on their location.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Admin Page React-powered dashboard under the Jetpack menu Docs [Feature] Theme Tools [JS Package] API [Package] Classic Theme Helper [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ RNA [Status] Needs Team Review [Type] Janitorial
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant