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

Roles endpoint: Use instance of for checking wp roles #39634

Merged
merged 5 commits into from
Oct 3, 2024

Conversation

darssen
Copy link
Contributor

@darssen darssen commented Oct 3, 2024

Fixes a Fatal in wpcom when using the endpoint with the force=wpcom param.

Based on https://bugs.php.net/bug.php?id=79623 it looks like this was introduced when switching to PHP8

Proposed changes:

Use instanceof WP_Roles check instead of method_exists since in the Jetpack Shadow Site $wp_roles is an array not an object.

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

b3afe066ca610f6dd94a60779e59882e-logstash

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

No

Testing instructions:

Call the endpoints for 3 scenarios:

Simple site (Should go through WPCOM)

  • Test without the patch applied.
  • Test with the patch applied using instructions given by bot below.

Jetpack site

  • Test without the patch applied.
  • Test with the patch applied in your local site.

Jetpack site with query_param force=wpcom (Should go through WPCOM)

  • Test without the patch applied. It should fatal
  • Test with the patch applied using instructions given by bot below.

@darssen darssen added [Status] Needs Review To request a review from Crew. Label will be renamed soon. [Focus] Compatibility Ensuring our products play well with third-parties labels Oct 3, 2024
@darssen darssen requested a review from a team October 3, 2024 09:37
@darssen darssen self-assigned this Oct 3, 2024
Copy link
Contributor

github-actions bot commented Oct 3, 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/use-instance-of-for-checking-wp-roles branch.

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

    bin/jetpack-downloader test jetpack update/use-instance-of-for-checking-wp-roles
    

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] WPCOM API [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ labels Oct 3, 2024
Copy link
Contributor

github-actions bot commented Oct 3, 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!


Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

  • WordPress.com Simple releases happen semi-continuously (PCYsg-Jjm-p2).
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for November 5, 2024 (scheduled code freeze on November 4, 2024).

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

@fgiannar fgiannar self-requested a review October 3, 2024 09:43
@@ -124,7 +124,7 @@ public function callback( $path = '', $blog_id = 0 ) {
return new WP_Error( 'unauthorized', 'User cannot view roles for specified site', 403 );
}

if ( method_exists( $wp_roles, 'get_names' ) ) {
if ( $wp_roles instanceof WP_Roles ) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe we could be more defensive here and also check if $wp_roles is actually an array next?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for reviewing, I addressed it in 6540dbd

fgiannar
fgiannar previously approved these changes Oct 3, 2024
Copy link
Contributor

@fgiannar fgiannar left a comment

Choose a reason for hiding this comment

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

Works great!

Tested on both Jetpack and Simple sites and ensured we don't fatal anymore for requests for Jetpack sites with ?force=wpcom

@fgiannar fgiannar added [Status] Ready to Merge Go ahead, you can push that green button! and removed [Status] Needs Review To request a review from Crew. Label will be renamed soon. labels Oct 3, 2024
@darssen darssen merged commit f3687fc into trunk Oct 3, 2024
57 checks passed
@darssen darssen deleted the update/use-instance-of-for-checking-wp-roles branch October 3, 2024 12:11
@github-actions github-actions bot added this to the jetpack/14.0 milestone Oct 3, 2024
@github-actions github-actions bot removed the [Status] Ready to Merge Go ahead, you can push that green button! label Oct 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] WPCOM API [Focus] Compatibility Ensuring our products play well with third-parties [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants