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

Move Jetpack menu position for atomic wp-admin #35154

Merged
merged 4 commits into from
Jan 26, 2024

Conversation

candy02058912
Copy link
Contributor

@candy02058912 candy02058912 commented Jan 22, 2024

Fixes https://github.com/Automattic/dotcom-forge/issues/5272

Proposed changes:

Before After

Self-hosted site Jetpack menu position
self-hosted

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?

No

Testing instructions:

@candy02058912 candy02058912 changed the title Update/atomic jetpack menu position Move Jetpack menu position for atomic wp-admin Jan 22, 2024
Copy link
Contributor

github-actions bot commented Jan 22, 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/atomic-jetpack-menu-position branch.

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

    bin/jetpack-downloader test jetpack update/atomic-jetpack-menu-position
    

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 [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Status] In Progress labels Jan 22, 2024
Copy link
Contributor

github-actions bot commented Jan 22, 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 February 6, 2024 (scheduled code freeze on February 5, 2024).

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

* @param bool $seperator Whether to add a separator before the menu item.
*/
public function add_jetpack_menu( $position = 2, $seperator = false ) {
if ( get_option( 'wpcom_admin_interface' ) === 'wp-admin' ) {
Copy link
Contributor Author

@candy02058912 candy02058912 Jan 22, 2024

Choose a reason for hiding this comment

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

This seems to return false even if I set to Classic view.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Seems like something was broken with my test site: p1706004199390829/1706004045.925339-slack-C06DN6QQVAQ

if ( get_option( 'wpcom_admin_interface' ) === 'wp-admin' ) {
parent::add_jetpack_menu( $position, $seperator );
} else {
parent::add_jetpack_menu();
Copy link
Contributor Author

@candy02058912 candy02058912 Jan 22, 2024

Choose a reason for hiding this comment

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

Will need to change this line to parent::add_jetpack_menu( $position, $seperator ); to see the changes mentioned in the PR description.

Update: I've completely changed the approach as modifying the parameters as mentioned in the strikethrough will also mean a change is needed for https://github.com/Automattic/wc-calypso-bridge/blob/master/includes/class-wc-calypso-bridge-ecommerce-admin-menu.php

@candy02058912
Copy link
Contributor Author

candy02058912 commented Jan 22, 2024

I am aware there is a typo seperator -> separator, which I'll update.
In the meantime, I wanted to get this PR up here to get a review of whether this approach is good or not.

@candy02058912 candy02058912 force-pushed the update/atomic-jetpack-menu-position branch from b25fbc2 to b180548 Compare January 23, 2024 11:49
@candy02058912 candy02058912 marked this pull request as ready for review January 23, 2024 12:03
@candy02058912 candy02058912 force-pushed the update/atomic-jetpack-menu-position branch from 178237e to cfb513c Compare January 23, 2024 12:04
@candy02058912 candy02058912 requested review from a team January 24, 2024 05:11
lupus2k
lupus2k previously approved these changes Jan 24, 2024
Copy link
Contributor

@lupus2k lupus2k left a comment

Choose a reason for hiding this comment

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

It works great and nothing is broken outside wp-admin interface.

DustyReagan
DustyReagan previously approved these changes Jan 26, 2024
Copy link
Member

@DustyReagan DustyReagan left a comment

Choose a reason for hiding this comment

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

Works great!

Just throwing out an option to consider: we could create a new public method in the parent class that takes the position as a parameter to reduce duplicated code. Then we'd call that method in the base parent method and in our method override, so our override would look something like:

public function add_jetpack_menu() {
	// This is supposed to be the same as class-admin-menu but with a different position specified for the Jetpack menu.
	if ( get_option( 'wpcom_admin_interface' ) === 'wp-admin' ) {
		parent::create_jetpack_menu( 2 );
	} else {
		parent::add_jetpack_menu();
	}
}

I'm not sure if we want to do that; I'm just always looking for ways to dedupe code. 😂

Copy link
Contributor

@taipeicoder taipeicoder left a comment

Choose a reason for hiding this comment

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

Works great 👍

Before After
Screenshot 2024-01-26 at 5 36 18 PM Screenshot 2024-01-26 at 5 36 58 PM

@DustyReagan DustyReagan merged commit 91da16e into trunk Jan 26, 2024
54 checks passed
@DustyReagan DustyReagan deleted the update/atomic-jetpack-menu-position branch January 26, 2024 16:03
@github-actions github-actions bot added this to the jetpack/13.1 milestone Jan 26, 2024
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 [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants