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 plugin - JSON API: Fix Warnings in post endpoints #38365

Merged
merged 2 commits into from
Jul 17, 2024

Conversation

fgiannar
Copy link
Contributor

@fgiannar fgiannar commented Jul 17, 2024

Fixes the following Warnings in class.json-api-post-base.php:

  • Attempt to read property "blog_id" on null in line 794
  • Attempt to read property "guid" on bool in line 1020
  • Undefined property: stdClass::$finish_date_gmt in line 1022
  • Attempt to read property "finish_date_gmt" on bool in line 1022

Proposed changes:

  • SAL_Post::get_author: Ensure $active_blog->blog_id is set before using it - Related to Attempt to read property "blog_id" on null
  • SAL_Post::get_media_item_v1_1: Take into account that video_get_info_by_blogpostid may return false - Related to Attempt to read property "guid" on bool and Attempt to read property "finish_date_gmt" on bool
  • SAL_Post::get_media_item_v1_1: Take into account that finish_date_gmt might be missing when video_get_info_by_blogpostid is executed on WPCOM - Related to Undefined property: stdClass::$finish_date_gmt

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

p1HpG7-tpT-p2

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

No

Testing instructions:

  • Code Review should be enough in this case

Copy link
Contributor

github-actions bot commented Jul 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/warnings-json-api-post-base branch.

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

    bin/jetpack-downloader test jetpack fix/warnings-json-api-post-base
    

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 the [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ label Jul 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.


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.

@fgiannar fgiannar requested a review from a team July 17, 2024 12:01
@fgiannar fgiannar added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. and removed [Status] In Progress labels Jul 17, 2024
@fgiannar fgiannar enabled auto-merge (squash) July 17, 2024 12:58
@@ -1017,11 +1017,9 @@ private function get_media_item_v1_1( $media_id ) {
}
}

$response['videopress_guid'] = $info->guid;
$response['videopress_guid'] = $info->guid ?? null;
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm wondering if this should be is_object($info) ? $info->guid ?? null : null ? If guid is still a bool it would seem like this would still trigger a warning as we're trying to access a property on a bool?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I believe it wouldn't as it's safe to check object properties and sub-properties with isset directly. Checkout https://onlinephp.io/c/bacc9

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah true, it doesn't actually generate a PHP warning using isset, only editor notices in test cases.

if ( '0000-00-00 00:00:00' === $info->finish_date_gmt ) {
$response['videopress_processing_done'] = false;
}
$response['videopress_processing_done'] = isset( $info->finish_date_gmt ) && '0000-00-00 00:00:00' !== $info->finish_date_gmt ? $info->finish_date_gmt : false;
Copy link
Contributor

Choose a reason for hiding this comment

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

With this one, would we also need to check if $info is an object initially, for the same reason as the above comment?

So $response['videopress_processing_done'] = is_object($info) && isset($info->finish_date_gmt) && '0000-00-00 00:00:00' !== $info->finish_date_gmt ? $info->finish_date_gmt : false; perhaps?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@jeherve jeherve added [Feature] WPCOM API [Type] Bug When a feature is broken and / or not performing as intended [Pri] Normal labels Jul 17, 2024
@fgiannar fgiannar merged commit 7181da9 into trunk Jul 17, 2024
63 of 65 checks passed
@fgiannar fgiannar deleted the fix/warnings-json-api-post-base branch July 17, 2024 15:12
@github-actions github-actions bot removed the [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. label Jul 17, 2024
@github-actions github-actions bot added this to the jetpack/13.7 milestone Jul 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] WPCOM API [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Pri] Normal [Type] Bug When a feature is broken and / or not performing as intended
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants