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

Fix class-wpcom-admin-bar.php fatal error #38526

Merged
merged 3 commits into from
Jul 25, 2024
Merged

Conversation

DustyReagan
Copy link
Member

@DustyReagan DustyReagan commented Jul 24, 2024

Fixes p1721840431003479-slack-C02FMH4G8

Proposed changes:

We saw the following fatal error with class-wpcom-admin-bar.php while it was in production before it was rolled back.

PHP Fatal error:  Uncaught Error: Cannot use object of type stdClass as array in /wordpress/plugins/wpcomsh/5.0.0/vendor/automattic/jetpack-mu-wpcom/src/features/wpcom-admin-bar/class-wpcom-admin-bar.php:63

This error can be reproduced on an Atomic site by adding the Elementor plugin.

This PR addresses the fatal error by ensuring $args is an array before continuing.

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

No.

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

Testing instructions:

  • First, reproduce the original error by using Jetpack Beta plugin and loading the bleeding edge of jetpack-mu-plugin.
  • Ensure your test Atomic site is set to the Default admin interface.
  • Install the Elementor plugin on your Atomic test site and go a wp-admin page like /wp-admin/plugins.php
  • You should receive the fatal error at this point.
  • If you go to /_cli on your Atomic site and run the command wp plugin deactivate elementor the error should disappear.
  • Now use Jetpack Beta plugin to load this PR and re-enable Elementor. (You can use /_cli to do this)
  • With this PR loaded go to a wp-admin page like /wp-admin/plugins.php. You should no longer see the fatal error.
  • With the fatal error gone, ensure the code still works using these instructions Admin Bar: Replace the wp-admin url with the calypso ones for the default interface #38377
  • Consider how other plugins might affect this code.

Copy link
Contributor

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

@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 24, 2024
Copy link
Contributor

github-actions bot commented Jul 24, 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 try/fix-admin-bar-error 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-mu-wpcom-plugin try/fix-admin-bar-error
    

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

@DustyReagan DustyReagan changed the title Try/fix admin bar error Fix class-wpcom-admin-bar.php fatal error Jul 24, 2024
@DustyReagan DustyReagan requested review from a team July 24, 2024 23:06
@DustyReagan DustyReagan self-assigned this Jul 24, 2024
@DustyReagan DustyReagan added [Status] Needs Team Review and removed [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! labels Jul 24, 2024
@@ -60,6 +60,11 @@ class WPCOM_Admin_Bar extends \WP_Admin_Bar {
* }
*/
public function add_node( $args ) {
// Ensure $args is an array.
if ( is_object( $args ) ) {
Copy link
Contributor

Choose a reason for hiding this comment

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

I think the most robust way is to just call parent::add_node( $args ); and bail, if $args is not an array. Similar to the next if-block at line 68.

(It means we only care to manipulate the nodes on wpcom side only if $args is array)

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah, I like that. 👍 I updated the PR.

Copy link
Contributor

@arthur791004 arthur791004 Jul 25, 2024

Choose a reason for hiding this comment

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

yep, it looks better to return early if it's not an array because the args might be a string as well 😓

Or we have to add the following lines before processing

// Shim for old method signature: add_node( $parent_id, $menu_obj, $args ).
if ( func_num_args() >= 3 && is_string( $args ) ) {
	$args = array_merge( array( 'parent' => $args ), func_get_arg( 2 ) );
}

if ( is_object( $args ) ) {
	$args = get_object_vars( $args );
}

Copy link
Member

@okmttdhr okmttdhr left a comment

Choose a reason for hiding this comment

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

Confirmed the critical error has gone and the instructions in #38377 looked well to me. ✅

CC: @fushar @arthur791004

@okmttdhr
Copy link
Member

Merging this PR, as I saw ✅ from @arthur791004

@okmttdhr okmttdhr merged commit 991bb5f into trunk Jul 25, 2024
54 checks passed
@okmttdhr okmttdhr deleted the try/fix-admin-bar-error branch July 25, 2024 02:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants