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

Prevent PHP warning produced by the "Howdy" link rewrite #39160

Closed
wants to merge 3 commits into from

Conversation

david-binda
Copy link
Contributor

@david-binda david-binda commented Aug 30, 2024

Fixes a PHP warning raised by the code introduced in #39113 for logged-in Automatticians in /wp-admin on a any WPCOM simple sites:

Warning: Undefined array key "id" in ...jetpack-mu-wpcom/src/features/wpcom-admin-bar/class-wpcom-admin-bar.php on line 63

Proposed changes:

  • The PR is adding an isset( $args['id'] ) check to the conditional which is checking the value of the key.

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:

  • Logged-in to WordPress.com as an Automattician, go to '/wp-admin' of a sandboxed WPCOM simple site
  • Notice the PHP warning

Copy link
Contributor

github-actions bot commented Aug 30, 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/howdy-link-warning 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 fix/howdy-link-warning
    

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 Aug 30, 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.


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 Aug 30, 2024
@@ -55,7 +55,7 @@ class WPCOM_Admin_Bar extends \WP_Admin_Bar {
* }
*/
public function add_node( $args ) {
if ( ! is_array( $args ) || empty( $args['href'] ) ) {
if ( ! is_array( $args ) || empty( $args['href'] ) || ! isset( $args['id'] ) ) {
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 this changes more behavior than is intended. Why shouldn't the code on lines 74–80 still be run?

I'd add the check to line 63 instead, which is the start of the piece that was added in #39113.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

True, you're right. Only the conditional starting on line 63 was added in #39113 so the rest of the code should still run.

I've updated the PR accordingly. Thanks for catching that!

@anomiex
Copy link
Contributor

anomiex commented Aug 30, 2024

Needs a changelogger change entry (run pnpm jetpack changelog add, after pnpm install if necessary), otherwise looks good to me.

@okmttdhr
Copy link
Member

okmttdhr commented Sep 2, 2024

@david-binda
Thank you for taking the time to fix this issue! I have refactored and removed the code in #39091 (I'll ship it when it's ready), so I believe this change is no longer necessary. I apologize for any inconvenience my previous changes may have caused.

@david-binda
Copy link
Contributor Author

Thanks! Closing in favor of #39091

@david-binda david-binda closed this Sep 2, 2024
@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 Sep 2, 2024
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.

3 participants