Jetpack plugin: Require and use jetpack-masterbar package #37676

fgiannar · 2024-06-03T09:12:32Z

Load the Masterbar module (WordPress.com Toolbar) functionality from the masterbar-package instead of using the corresponding Module code, soon to be deprecated.

Proposed changes:

jetpack\modules\masterbar.php: Use package to load the Masterbar module functionality
Backport modules updates from Masterbar - Update Notification icon #37625

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

pfwV0U-3U-p2

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

No

Testing instructions:

Important! While testing on WoA make sure to also activate the WordPress.com Features plugin (Bleeding Edge just in case) via Beta Tester and add define( 'JETPACK_MU_WPCOM_LOAD_VIA_BETA_PLUGIN', true ); to your wp-config.php

nav-unification: Testing the admin menu in Simple, WoA and self-hosted:

You can test this in the WPCOM REST API Dev console for the wpcom/v2/sites/YOUR_BLOG_ID/admin-menu endpoint.

For block based themes, "Customize" should not be present under "Appearance".

Make sure to test with/without the PR applied and confirm the responses are identical. For Simple and WoA sites we'll also need to test with classic/default Admin Interface Style.

nav-unification: Admin color schemes

For self-hosted sites and classic WoA sites, upon editing a User Profile via wp-admin, confirm the Admin Color Scheme field is present:

Ensure that by picking one of the options, the admin theme is updated.

For default WoA sites, upon editing a User Profile via wp-admin, confirm you see the following link to update the field on WPCOM:

For a WoA site, this change should be also reflected in Calypso.

Confirm that the admin_color user meta is also part of the corresponding REST API response to the users endpoint.
You can test this in the WPCOM REST API Dev console for the wp/v2/sites/YOUR_BLOG_ID/users endpoint.

Make sure to test this with a self-hosted and WoA. Not applicable for Simple sites.

Classic vs Default view

Try switching between Classic vs Default view for a WoA and Simple site. Confirm nothing breaks and both views are displayed as expected.

For self-hosted sites, this option should NOT be visible since there should be no nav customizations on WP Admin of Jetpack sites

For WoA sites with SSO disabled this option should NOT be visible since there should be no nav customizations on WP Admin of Atomic sites when SSO is disabled.

Editing a user profile on wp-admin for WoA sites

When editing a user's profile via wp-admin on a WoA site, confirm that you see the following message and the corresponding links to your WPCOM account page work as expected:

Inline Help

TBA

Nudges to purchase a WordPress.com Plan to be able to customize CSS on your site (Simple and WoA sites)

Make sure your site is 1) using a non-block theme, eg Hever. and 2) IS NOT on the explorer plan
Navigate to Appearance -> Additional CSS and confirm you see the following nudge:

Ensure the Upgrade flow is working as expected by clicking the "Upgrade now" button. You should be redirected to checkout with the Explorer plan in your cart.
Note sure how to test this on a WoA site

Disable edit_post and delete_post capabilities for Posts Pages in WP-Admin and display a notification icon.

See #19900

RTL support

Simple & WoA: Update your WPCOM user locale to Arab and ensure the Masterbar and Admin menu is displayed consistently with/without the PR.
Self hosted: Update your user locale to Arab and ensure the Masterbar and Admin menu is displayed consistently with/without the PR.
Let's make sure to test this as much as possible since the package loads RTL styles automatically via the Assets package.
Example: All the relevant $this->is_rtl() conditionals in the module code have been removed from the corresponding package code.

github-actions · 2024-06-03T09:13:28Z

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/use-masterbar-pkg-in-jetpack-plugin branch.

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

bin/jetpack-downloader test jetpack update/use-masterbar-pkg-in-jetpack-plugin

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-06-03T09:13:30Z

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.

Once your PR is ready for review, check one last time that all required checks appearing at the bottom of this PR are passing or skipped.
Then, add the "[Status] Needs Team Review" label and ask someone from your team review the code. Once reviewed, it can then be merged.
If you need an extra review from someone familiar with the codebase, you can update the labels from "[Status] Needs Team Review" to "[Status] Needs Review", and in that case Jetpack Approvers will do a final review of your PR.

Jetpack plugin:

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

WordPress.com Simple releases happen daily.
WoA releases happen weekly.
Releases to self-hosted sites happen monthly. The next release is scheduled for July 2, 2024 (scheduled code freeze on July 1, 2024).

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

fgiannar · 2024-06-05T13:07:28Z

projects/packages/masterbar/src/admin-menu/class-base-admin-menu.php

 	 */
 	public function enqueue_scripts() {
 		$assets_base_path = '../../dist/admin-menu/';
-		if ( $this->is_rtl() ) {


Clean up. This is no longer used below

...ns/jetpack/_inc/lib/core-api/wpcom-endpoints/class-wpcom-rest-api-v2-endpoint-admin-menu.php

mmtr · 2024-06-05T13:31:34Z

Wow @fgiannar, impressive work! Everything seems to be working as expected for me.

Inline Help
TBA

Probably no longer needed now that the inline help is powered by the ETK plugin:

https://github.com/Automattic/wp-calypso/blob/fd360657e5d9095d1f7d96c58c3312da5460ff00/apps/editing-toolkit/editing-toolkit-plugin/help-center/src/help-center.scss#L14

Nudges to purchase a WordPress.com Plan to be able to customize CSS on your site (Simple and WoA sites)
Note sure how to test this on a WoA site

Yeah, me neither. When I removed the plan from SA, Jetpack gets deactivated so the masterbar module does not run. I guess it's not a big deal – it probably works as expected (and if it doesn't, in practice all Atomic sites have the needed plan except for a brief time after plan expiration, so we'll only have very few edge cases).

fgiannar · 2024-06-06T09:25:21Z

...ns/jetpack/_inc/lib/core-api/wpcom-endpoints/class-wpcom-rest-api-v2-endpoint-admin-menu.php

 			remove_action( 'customize_register', array( 'Jetpack_Fonts_Typekit', 'maybe_override_for_advanced_mode' ), 20 );

-			remove_action( 'customize_register', 'Automattic\Jetpack\Dashboard_Customizations\register_css_nudge_control' );
+			remove_action( 'customize_register', 'Automattic\Jetpack\Masterbar\register_css_nudge_control' );


This is currently not working for Simple sites since we are still using the module code on WPCOM. We should probably add a class_exists here so that when we are on WPCOM (Simple sites) we keep using Automattic\Jetpack\Dashboard_Customizations\register_css_nudge_control, while on remote sites (self-hosted and WoA) we use Automattic\Jetpack\Masterbar\register_css_nudge_control

Done via 6aa5a1e

…oved depending on the env

...ns/jetpack/_inc/lib/core-api/wpcom-endpoints/class-wpcom-rest-api-v2-endpoint-admin-menu.php

…ding admin-menu but more explicit

Code updated

mmtr

Alright, tried to be more thorough this time (tested with Simple Classic, Simple Default, Atomic Classic, Atomic Default, Self-hosted with toolbar module enabled, and Self-hosted with toolbar module disabled) and everything seems to be working as expected for me.

Considering the number of scenarios and features to check, it'd be great if someone else could test this as well!

coder-karen

Tested on Atomic, self-hosted and Simple. Everything works as expected now.
RTL actually works better from my tests on Atomic - the notification panel works there but doesn't on trunk, when RTL is enabled.

bindlegirl

Tested and everything seems to be fine.

fgiannar added 3 commits June 3, 2024 11:39

Jetpack plugin: Require and use Masterbar package

f48d6ef

Masterbar package: Backport module css updates

03c7d7b

changelog

9dd3806

fgiannar added the [Status] In Progress label Jun 3, 2024

fgiannar self-assigned this Jun 3, 2024

github-actions bot added [Feature] Masterbar WordPress.com Toolbar and Dashboard customizations [Package] Masterbar [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ labels Jun 3, 2024

fgiannar added 7 commits June 3, 2024 12:38

Masterbar package: Add missing namespace declarations

7cca37f

Masterbar package: Phan fixes

deedd10

Jetpack phan: Update baselines

8dcb03e

WPCOM_REST_API_V2_Endpoint_Admin_Menu: Use Masterbar package

d6b8bbe

WPCOM_REST_API_V2_Endpoint_Admin_Menu endpoint: Remove redundant require

a817130

Merge branch 'trunk' into update/use-masterbar-pkg-in-jetpack-plugin

d8e0a02

Cleanup: Remove unused code

6ea014e

fgiannar added [Status] Needs Review This PR is ready for review. [Status] Needs Team Review Obsolete. Use Needs Review instead. and removed [Status] In Progress labels Jun 5, 2024

fgiannar requested review from a team, jeherve and mmtr June 5, 2024 11:44

fgiannar commented Jun 5, 2024

View reviewed changes

...ns/jetpack/_inc/lib/core-api/wpcom-endpoints/class-wpcom-rest-api-v2-endpoint-admin-menu.php Show resolved Hide resolved

mmtr previously approved these changes Jun 5, 2024

View reviewed changes

bindlegirl added [Status] Ready to Merge Go ahead, you can push that green button! and removed [Status] Needs Review This PR is ready for review. [Status] Needs Team Review Obsolete. Use Needs Review instead. labels Jun 6, 2024

fgiannar added [Status] Needs Review This PR is ready for review. and removed [Status] Ready to Merge Go ahead, you can push that green button! labels Jun 6, 2024

fgiannar commented Jun 6, 2024

View reviewed changes

WPCOM_REST_API_V2_Endpoint_Admin_Menu: Ensure the right action is rem…

6aa5a1e

…oved depending on the env

fgiannar dismissed mmtr’s stale review via 6aa5a1e June 6, 2024 09:40

fushar previously requested changes Jun 6, 2024

View reviewed changes

...ns/jetpack/_inc/lib/core-api/wpcom-endpoints/class-wpcom-rest-api-v2-endpoint-admin-menu.php Show resolved Hide resolved

WPCOM_REST_API_V2_Endpoint_Admin_Menu: Bring back conditional for loa…

c8114b3

…ding admin-menu but more explicit

mmtr approved these changes Jun 6, 2024

View reviewed changes

coder-karen approved these changes Jun 6, 2024

View reviewed changes

bindlegirl approved these changes Jun 6, 2024

View reviewed changes

fgiannar merged commit 87a4de6 into trunk Jun 6, 2024

fgiannar deleted the update/use-masterbar-pkg-in-jetpack-plugin branch June 6, 2024 13:50

github-actions bot added this to the jetpack/13.6 milestone Jun 6, 2024

github-actions bot removed the [Status] Needs Review This PR is ready for review. label Jun 6, 2024

This was referenced Jun 11, 2024

Masterbar package: Require the package in both the Jetpack plugin and the mu-wpcom plugin #36918

Closed

Masterbar: Require and use 'jetpack-masterbar' package in jetpack-mu-wpcom #37812

Merged

fgiannar mentioned this pull request Jun 28, 2024

Masterbar: Deprecate Jetpack module code #38109

Merged

3 tasks

coder-karen mentioned this pull request Aug 9, 2024

Masterbar: Remove feature inclusion on Jetpack self-hosted sites #38804

Merged

3 tasks

fgiannar mentioned this pull request Sep 12, 2024

Wpcomsh: Remove actions and filters related to the Masterbar module #39367

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Jetpack plugin: Require and use jetpack-masterbar package #37676

Jetpack plugin: Require and use jetpack-masterbar package #37676

Uh oh!

fgiannar commented Jun 3, 2024 •

edited

Loading

Uh oh!

github-actions bot commented Jun 3, 2024 •

edited

Loading

Uh oh!

github-actions bot commented Jun 3, 2024 •

edited

Loading

Uh oh!

fgiannar Jun 5, 2024

Uh oh!

Uh oh!

mmtr commented Jun 5, 2024

Uh oh!

fgiannar Jun 6, 2024

Uh oh!

fgiannar Jun 6, 2024

Uh oh!

Uh oh!

mmtr left a comment

Uh oh!

coder-karen left a comment

Uh oh!

bindlegirl left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Jetpack plugin: Require and use jetpack-masterbar package #37676

Jetpack plugin: Require and use jetpack-masterbar package #37676

Uh oh!

Conversation

fgiannar commented Jun 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed changes:

Other information:

Jetpack product discussion

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

Testing instructions:

nav-unification: Testing the admin menu in Simple, WoA and self-hosted:

nav-unification: Admin color schemes

Classic vs Default view

Editing a user profile on wp-admin for WoA sites

Inline Help

Nudges to purchase a WordPress.com Plan to be able to customize CSS on your site (Simple and WoA sites)

Disable edit_post and delete_post capabilities for Posts Pages in WP-Admin and display a notification icon.

RTL support

Uh oh!

github-actions bot commented Jun 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jun 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fgiannar Jun 5, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mmtr commented Jun 5, 2024

Uh oh!

fgiannar Jun 6, 2024

Choose a reason for hiding this comment

Uh oh!

fgiannar Jun 6, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mmtr left a comment

Choose a reason for hiding this comment

Uh oh!

coder-karen left a comment

Choose a reason for hiding this comment

Uh oh!

bindlegirl left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

fgiannar commented Jun 3, 2024 •

edited

Loading

github-actions bot commented Jun 3, 2024 •

edited

Loading

github-actions bot commented Jun 3, 2024 •

edited

Loading