jetpack icon indicating copy to clipboard operation
jetpack copied to clipboard

Masterbar: Deprecate Jetpack module code

Open fgiannar opened this issue 1 year ago • 4 comments

Deprecates the Jetpack Masterbar module code. Same functionality is now provided via the jetpack-masterbar package.

Proposed changes:

  • Deprecates the Jetpack Masterbar module code.
  • Updates relevant unit tests

Other information:

  • [x] Have you written new tests for your changes, if applicable?
  • [x] Have you checked the E2E test CI results, and verified that your changes do not break them?
  • [x] 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:

  • Code Review
  • Use the provided test instructions in https://github.com/Automattic/jetpack/pull/37676 to play around with Masterbar features and confirm no relevant deprecation warnings occur, in a:
  1. Self-hosted site
  2. WoA classic site
  3. WoA default site
  4. Simple classic site
  5. Simple default site

A reminder on Classic/Default sites: Classic sites are the ones where wpcom_is_nav_redesign_enabled() will be true. This means that return get_blog_option( YOUR_WPCOM_BLOG_ID, 'wpcom_admin_interface' ) returns wp-admin

For WoA sites there's a corresponding option to toggle this setting under Settings->General in wp-admin for a classic WoA site

Screenshot 2024-06-13 at 14 29 19

You can toggle this option via Settings->General in Calypso for a Default WoA site:

Screenshot 2024-06-18 at 13 06 21

For Simple ones, you can update the wpcom_admin_interface option via wpsh

fgiannar avatar Jun 28 '24 12:06 fgiannar

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • :white_check_mark: Include a description of your PR changes.
  • :white_check_mark: Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • :white_check_mark: Add testing instructions.
  • :white_check_mark: Specify whether this PR includes any changes to data or privacy.
  • :white_check_mark: 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 :robot:


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 August 6, 2024 (scheduled code freeze on August 5, 2024).

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

github-actions[bot] avatar Jun 28 '24 12:06 github-actions[bot]

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/deprecate-masterbar-module branch.

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

    bin/jetpack-downloader test jetpack update/deprecate-masterbar-module
    

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[bot] avatar Jun 28 '24 12:06 github-actions[bot]

I retested all the functionality on Simple Classic and Default, WoA Classic and Default, and Self-hosted, to make sure there were no deprecation notices in logs, or changes, and all looked good! I looked through the code but admit there was a lot to take in so I mainly focussed on general structure. Left some comments.

coder-karen avatar Jul 02 '24 10:07 coder-karen

@anomiex Now that my team has tested the functionality, would you mind giving it a look as well? I left a few questions in the PR, hopefully you might have some insights. Many thanks!

fgiannar avatar Jul 02 '24 11:07 fgiannar