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

Untangling Cleanup: Clean up wpcom_is_nav_redesign_enabled() flag #38197

Merged
merged 15 commits into from
Jul 8, 2024

Conversation

xavier-lc
Copy link
Contributor

@xavier-lc xavier-lc commented Jul 4, 2024

Related to: https://github.com/Automattic/dotcom-forge/issues/7927

Proposed changes:

  • As we've launched untangling & nav redesign, the wpcom_is_nav_redesign_enabled function name is not relevant anymore and can be confusing for future developers.

This goes alongside this wpcom PR: D154312-code

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?

Testing instructions:

  • Apply this patch on your sandbox
  • On a site using the classic admin interface style, set the wpcom_classic_tour_completed option to '0':
    • On your sandbox, run wpsh and then update_blog_option( SITE_ID, 'wpcom_classic_tour_completed', '0' );
  • Go to /wp-admin/?admin-interface-changed=true
  • Check that you see the tour dialog:

image

Copy link
Contributor

github-actions bot commented Jul 4, 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/rename-wpcom_is_nav_redesign_enabled 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/rename-wpcom_is_nav_redesign_enabled
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin update/rename-wpcom_is_nav_redesign_enabled
    

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
Copy link
Contributor

github-actions bot commented Jul 4, 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 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.


Mu Wpcom plugin:

  • Next scheduled release: August 6, 2024.
  • Scheduled code freeze: July 29, 2024.

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


Wpcomsh plugin:

  • Next scheduled release: August 6, 2024.
  • Scheduled code freeze: July 29, 2024.

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

@github-actions github-actions bot added the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Jul 4, 2024
@xavier-lc xavier-lc force-pushed the update/rename-wpcom_is_nav_redesign_enabled branch from 43a350a to bb5dfc6 Compare July 4, 2024 12:12
@github-actions github-actions bot added the [Plugin] mu wpcom jetpack-mu-wpcom plugin label Jul 4, 2024
@xavier-lc xavier-lc changed the title Update/rename wpcom is nav redesign enabled Jul 4, 2024
@xavier-lc xavier-lc self-assigned this Jul 4, 2024
@xavier-lc xavier-lc requested a review from a team July 4, 2024 13:16
Copy link
Contributor

@fushar fushar left a comment

Choose a reason for hiding this comment

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

Thanks for this! Some comments:

  1. One of the reasons we used wpcom_is_nav_redesign_enabled() (and therefore the massive function_exists checks) in wpcomsh, is so that we could quickly release/revert the feature in wpcomsh, without having to rely on Jetpack release cycle. Now that it's released, we don't need to rely on wpcomsh anymore. That's the reason why I proposed in the issue to just simply use get_option( 'wpcom_admin_interface' ) === 'wp-admin' as it's literally what it is.
  2. If we still want to use functions, what I suggest is:
    • Put the function in another feature in mu-wpcom. E.g.: admin-interface/admin-interface.php
    • Use it and remove all the function_exists checks.
    • See this example Hide wpcom items if is_agency_managed_site #37993, where we added a similar is_agency_managed_site() function.
  3. We should do similar thing in wpcomsh and not rely on the feature-plugins/nav-redesign.php file anymore, as that would defeat the purpose of the refactor.

What do you think?

@fushar
Copy link
Contributor

fushar commented Jul 5, 2024

Can we now rename the PR 😄

@xavier-lc xavier-lc changed the title Rename wpcom_is_nav_redesign_enabled to uses_wp_admin_interface Jul 5, 2024
@xavier-lc
Copy link
Contributor Author

Can we now rename the PR 😄

@fushar haha right, done!

Copy link
Contributor

@fushar fushar left a comment

Choose a reason for hiding this comment

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

Triple-checked the changes, and smoke-tested on a WoA dev test site and everything works as usual. Nice 👍

@fushar
Copy link
Contributor

fushar commented Jul 8, 2024

Merging this now to unblock things because we have another Untangling iteration this week!

@fushar fushar merged commit 2024b54 into trunk Jul 8, 2024
57 checks passed
@fushar fushar deleted the update/rename-wpcom_is_nav_redesign_enabled branch July 8, 2024 05:07
@github-actions github-actions bot removed the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Jul 8, 2024
@xavier-lc
Copy link
Contributor Author

@fushar thanks for merging this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment