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_PostImages::from_attachment: Prevent warning when $thumb_post_data cannot be found #35264

Merged
merged 2 commits into from
Jan 26, 2024

Conversation

mreishus
Copy link
Contributor

@mreishus mreishus commented Jan 25, 2024

Fixes warnings like:

[25-Jan-2024 21:08:38 UTC] Warning: Attempt to read property "guid" on null in (...)/class.jetpack-post-images.php on line 342

Proposed changes:

  • When Jetpack_PostImages::from_attachment runs, it tries to get data from a thumbnail post:
			if ( ! is_array( $img_src ) ) {
				// If wp_get_attachment_image_src returns false but we know that there should be an image that could be used.
				// we try a bit harder and user the data that we have.
				$thumb_post_data = get_post( $thumb );
				$img_src         = array( $thumb_post_data->guid, $meta['width'], $meta['height'] );
			}

get_post() can return null, so sometimes $thumb_post_data->guid is null and generates a warning.

However, the 0th (first) entry of $img_src isn't always used. The code block after it is:

			if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
				$featured_image = get_post_meta( $post->ID, '_jetpack_featured_image' );
				if ( $featured_image ) {
					$url = $featured_image[0];
				} else {
					$url = $img_src[0];
				}
			} else {
				$url = $img_src[0];
			}
			$images = array(
				array( // Other methods below all return an array of arrays.
					'type'       => 'image',
					'from'       => 'thumbnail',
					'src'        => $url,
					'src_width'  => $img_src[1],
					'src_height' => $img_src[2],
					'href'       => get_permalink( $thumb ),
					'alt_text'   => self::get_alt_text( $thumb ),
				),
			);

Note that at least one of the code paths uses $featured_image[0] instead of $img_src[0]. In the real world case that I tried of seeing the warning generated, that was the case. So my solution is only to silence the warning by using $thumb_post_data->guid ?? null instead of $thumb_post_data->guid. That should keep the behavior the same, but stop the warning from happening.

As far as I know, there is no unwanted behavior or bugs happening here, only a warning.

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:

  • See D135990-code for a testing helper and directions

Copy link
Contributor

github-actions bot commented Jan 25, 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/post-images-2 branch.

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

    bin/jetpack-downloader test jetpack update/post-images-2
    

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 Jan 25, 2024
Copy link
Contributor

github-actions bot commented Jan 25, 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.


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 February 6, 2024 (scheduled code freeze on February 5, 2024).

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

@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 Jan 25, 2024
@mreishus mreishus added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. Reviewer Can Merge PR author indicates the reviewer is free to merge/deploy if they want to own the change. 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 Jan 25, 2024
@mreishus mreishus self-assigned this Jan 25, 2024
Copy link
Contributor

@anomiex anomiex left a comment

Choose a reason for hiding this comment

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

Not sure what's going on to make it not get a post there. But this shouldn't make it any worse, whatever it is.

@mreishus mreishus merged commit 99ea66d into trunk Jan 26, 2024
57 of 58 checks passed
@mreishus mreishus deleted the update/post-images-2 branch January 26, 2024 21:27
@github-actions github-actions bot removed the [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. label Jan 26, 2024
@github-actions github-actions bot added this to the jetpack/13.1 milestone Jan 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ Reviewer Can Merge PR author indicates the reviewer is free to merge/deploy if they want to own the change.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants