Admin menu: Change order of Jetpack sub-menu items #39095

coder-karen · 2024-08-27T10:38:10Z

Fixes https://github.com/Automattic/jetpack-roadmap/issues/856

Continuation of #38768

Proposed changes:

This PR changes the order of the Jetpack sub-menu items, based on this issue comment: https://github.com/Automattic/jetpack-roadmap/issues/856#issuecomment-2308599496.

View the order of items here

My Jetpack
Stats
Boost
VideoPress
Social
Protect
Akismet Anti-spam
VaultPress Backup
Activity Log (External)
Scan
Search
Subscribers (External)
WordAds
Settings
Dashboard
Jetpack Manage (External)
Beta Tester

This PR also updates the logic to ensure that Dashboard, Settings, and Activity Log items are shown as selected, when the relevant dashboard pages are open.
Other Jetpack menu items apart from those mentioned above haven't been considered here, for example Monetize on WoA sites.
Also, ideally we'd add tests here, particularly for jetpackPageOrder (ensuring the correct menu item is showing as selected). Since there is a level of urgency in getting this change out I'll follow up separately: https://github.com/Automattic/vulcan/issues/482
Simple sites have their own order defined, see also add_jetpack_submenu in mu-plugins/jetpack-newsletter.php

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

See https://github.com/Automattic/jetpack-roadmap/issues/856

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

No.

Testing instructions:

This is relevant for self-hosted and WoA sites - Simple sites override menu locations.

With this PR applied, you should be able to see Jetpack menu items in the same order as explained under Proposed Changes above.
The Dashboard and Settings menu items should show as selected when clicked, regardless of the number of menu items before or after them.
To test with all menu items, note that Scan can be added by adding a Scan plan (and ensure Scan is working on the site) and deactivating Protect. WordAds can be added by including define( 'ENABLE_WORDADS_SHARED_UI', true ); in your wp-config.php file. Subscribers will be added if you enable the Newsletter feature at /wp-admin/admin.php?page=jetpack#/newsletter. I found the best way to add the other items if not testing locally is using the Jetpack Beta tester plugin, then activating all relevant plugins. However as Akismet is not included with the Beta tester plugin, you'd have to apply the branch for a plugin that uses the admin-ui package, which is most (eg. Jetpack, Beta plugin, Boost..).
You'll also want to test without Jetpack installed as well, and just some standalones instead. If testing on Jurassic Ninja or WoA, using the Beta tester plugin is the best way to do this as well, as you'll need to ensure you're applying this branch to the relevant standalone to make sure the menu priority is up to date - including Jetpack Beta itself.

github-actions · 2024-08-27T10:39:07Z

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 update/jetpack-menu-item-order 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 update/jetpack-menu-item-order

bin/jetpack-downloader test jetpack-mu-wpcom-plugin update/jetpack-menu-item-order

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 · 2024-08-27T10:39:25Z

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 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!

Beta plugin:

Next scheduled release: none scheduled.