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

Sidebar menu: Register "plugin install" route on sites with the default interface #37686

Merged
merged 3 commits into from
Jun 4, 2024

Conversation

mmtr
Copy link
Member

@mmtr mmtr commented Jun 3, 2024

Proposed changes:

In #37521 we added a new "Add New Plugin" submenu which is only registered on sites with the classic admin interface so we could redirect from /wp-admin/plugin-install.php to the route of that submenu (/wp-admin/plugins.php?page=wpcom-install-plugin).

However, for that redirect to work, we need the new route to be working on all Simple sites, including sites with the default admin interface (see pMz3w-k1d-p2#comment-119194).

Since we don't want the "Add New Plugin" submenu to be visible on sites with the default admin interface, this PR implements a workaround in which it registers the menu (on all sites) and then hides it (on sites with the default interface).

To simplify the workaround, the existing logic that registers the Plugins parent menu from Nav Unification to the jetpack-mu-wpcom package.

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

N/A

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

No

Testing instructions:

  • Apply these changes to your WP.com simple site
  • With the classic admin interface, make sure you get the same behavior as before (3 submenus: Plugins > Installed Plugins, Plugins > Add New Plugin, Plugins > Marketplace)
  • With the default admin interface:
    • Make sure Plugins still links to the Marketplace
    • Make sure there are no submenus
    • Make sure you can visit /wp-admin/plugins.php?page=wpcom-install-plugin

@mmtr mmtr self-assigned this Jun 3, 2024
Copy link
Contributor

github-actions bot commented Jun 3, 2024

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/plugins-menu 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/plugins-menu
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin update/plugins-menu
    

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] Masterbar WordPress.com Toolbar and Dashboard customizations [mu wpcom Feature] Wpcom Site Menu [Package] Jetpack mu wpcom WordPress.com Features [Package] Masterbar [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ labels Jun 3, 2024
Copy link
Contributor

github-actions bot commented Jun 3, 2024

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 June 24, 2024).

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


Mu Wpcom plugin:

  • Next scheduled release: July 2, 2024.
  • Scheduled code freeze: June 24, 2024.

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

Comment on lines -420 to -427
if ( ! is_multisite() && current_user_can( 'update_plugins' ) ) {
$update_data = wp_get_update_data();
$count = sprintf(
'<span class="update-plugins count-%s"><span class="plugin-count">%s</span></span>',
$update_data['counts']['plugins'],
number_format_i18n( $update_data['counts']['plugins'] )
);
}
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 is some logic that we copy/pasted from a file that was shared between Simple and Atomic sites. For Simple sites, we don't need this logic (is_multisite always returns true), which is why I didn't incorporated into the jetpack-mu-wpcom package.

Comment on lines -404 to -411
if ( ! is_multisite() && current_user_can( 'update_plugins' ) ) {
$update_data = wp_get_update_data();
$count = sprintf(
'<span class="update-plugins count-%s"><span class="plugin-count">%s</span></span>',
$update_data['counts']['plugins'],
number_format_i18n( $update_data['counts']['plugins'] )
);
}
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 is some logic that we copy/pasted from a file that was shared between Simple and Atomic sites. For Simple sites, we don't need this logic (is_multisite always returns true), which is why I didn't incorporated into the jetpack-mu-wpcom package.

@mmtr mmtr requested a review from a team June 3, 2024 15:12
@github-actions github-actions bot added the [Plugin] mu wpcom jetpack-mu-wpcom plugin label Jun 4, 2024
@rcrdortiz
Copy link
Contributor

Since we don't want the "Add New Plugin" submenu to be visible on sites with the default admin interface, this PR implements a workaround in which it registers the menu (on all sites) and then hides it (on sites with the default interface).

Are we 100% sure about this? What are the cons and pros of hiding the add new plugin page on the default admin interface?

Copy link
Contributor

@dsas dsas left a comment

Choose a reason for hiding this comment

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

Works as described, lets answer Richard's question before merging though.

@rcrdortiz
Copy link
Contributor

Would it make sense to highlight the Plugins menu on sites that use the Default interface?

Screenshot 2024-06-04 at 13 13 35

With the current implementation, it looks like this:

Screenshot 2024-06-04 at 13 14 43

Copy link
Contributor

@rcrdortiz rcrdortiz left a comment

Choose a reason for hiding this comment

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

Changes work as described.

@mmtr
Copy link
Member Author

mmtr commented Jun 4, 2024

Are we 100% sure about this? What are the cons and pros of hiding the add new plugin page on the default admin interface?

Not 100% sure, but it is what we decided when we launched Nav Unification a few years ago, so I just wanted to avoid revisiting that decision.

Would it make sense to highlight the Plugins menu on sites that use the Default interface?

It makes total sense, but unfortunately it's not-so-trivial technically if the submenu remains hidden.

@mmtr mmtr merged commit fa24d75 into trunk Jun 4, 2024
57 checks passed
@mmtr mmtr deleted the update/plugins-menu branch June 4, 2024 11:25
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 Site Menu [Package] Jetpack mu wpcom WordPress.com Features [Package] Masterbar [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Plugin] mu wpcom jetpack-mu-wpcom plugin
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants