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

Jetpack: Check $submenu is not NULL before adding Scan option #39424

Open
wants to merge 1 commit into
base: trunk
Choose a base branch
from

Conversation

ecairol
Copy link
Contributor

@ecairol ecairol commented Sep 17, 2024

Fixes #39423

Proposed changes:

  • There might be some cases where $submenu is empty. It is happening for sites with Jetpack CRM that have users with the role "Jetpack CRM Admin" and login using SSO.
  • The Fatal error happens when the Scan option is added to the submenu
  • I suspect the error could happen for other custom user roles as well

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:

  • Go to '..'

Copy link
Contributor

github-actions bot commented Sep 17, 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 fix/submenu-jetpack-null 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 fix/submenu-jetpack-null
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin fix/submenu-jetpack-null
    

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 [Package] Masterbar labels Sep 17, 2024
Copy link
Contributor

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.


🔴 Action required: Please add missing changelog entries for the following projects: projects/packages/masterbar

Use the Jetpack CLI tool to generate changelog entries by running the following command: jetpack changelog add.
Guidelines: /docs/writing-a-good-changelog-entry.md


Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Choose a review path based on your changes:
    • A. Team Review: add the "[Status] Needs Team Review" label
      • For most changes, including minor cross-team impacts.
      • Example: Updating a team-specific component or a small change to a shared library.
    • B. Crew Review: add the "[Status] Needs Review" label
      • For significant changes to core functionality.
      • Example: Major updates to a shared library or complex features.
    • C. Both: Start with Team, then request Crew
      • For complex changes or when you need extra confidence.
      • Example: Refactor affecting multiple systems.
  3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

@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 Sep 17, 2024
@ecairol
Copy link
Contributor Author

ecairol commented Sep 17, 2024

cc @vykes-mac since you're most likely familiar with the changes. Let me know if you have any thoughts or feedback.

@vykes-mac
Copy link
Contributor

cc @vykes-mac since you're most likely familiar with the changes. Let me know if you have any thoughts or feedback.

@ecairol Thanks for the ping. Based on the described issue this guard check looks reasonable.

@bryanwmiller
Copy link

@vykes-mac - Hello! We have a team51 partner who is waiting on this fix. Just so we know how to proceed with that particular site - would this patch just be added to the next release, or would it be sooner? I know it is an edge case (so not an urgent issue), but we want to know whether we should just patch it locally on this particular site until the next release. Thank you!

@vykes-mac
Copy link
Contributor

@vykes-mac - Hello! We have a team51 partner who is waiting on this fix. Just so we know how to proceed with that particular site - would this patch just be added to the next release, or would it be sooner? I know it is an edge case (so not an urgent issue), but we want to know whether we should just patch it locally on this particular site until the next release. Thank you!

I think it's okay to apply the patch on your end while waiting for the next jetpack release.

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 [Package] Masterbar [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fatal error when $submenu is NULL for cetain user roles
3 participants