Jetpack_Media_Summary: Prevent warnings related to undefined keys and unexpected array offsets #43641

coder-karen · 2025-05-27T15:00:48Z

Fixes VULCAN-139

Proposed changes:

This PR prevents a few undefined array key warnings, and warnings related to accessing unexpected offsets: Warning: Undefined array key "id", Trying to access array offset on null, Trying to access array offset on value of type null, Trying to access array offset on false, Trying to access array offset on value of type bool
The approach to fix these is just to check if the specific arrays / array keys are set
Logs: 796d1002405c80e7d4b6965a0c522e14-logstash

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

pdWQjU-1g0-p2

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

No.

Testing instructions:

To replicate the most prominent warnings:

On trunk or the latest Jetpack version on self-hosted, WoA or a Simple site:

Ensure Compose using shortcodes to embed media from popular sites is enabled at /wp-admin/admin.php?page=jetpack#writing (I believe this may be default on Simple sites)
Add a shortcode block to a post or page. Add a Vimeo shortcode with no id added - just [vimeo].
Visit the post / page on the front-end - if you are tailing errors - tail -f /tmp/php-errors on Simple, or error logs - you should see the following warnings: Warning: Undefined array key "id" and Trying to access array offset on value of type null. On Simple test sites, that warning is Trying to access array offset on null.

To test the fix:

Apply the PR locally or using the Jetpack Beta Tester plugin (or using the commands in the generated comment below for a sandboxed Simple site).
Follow the same steps as above, and notice there are no warnings.

For the additional warnings, I've been unable to test, however the added check (see line 268) prevents the warnings and also ensure the relevant URLs are not created - with the previous warnings those URLs would not have been created anyway, so this shouldn't cause issues.
However you can certainly test the Happy Path here - add a new image via an Image block, and there should be no issues. Check 'og' tags in the page source, and you should see 'og' tags for the image URLs. You wouldn't see these if there you commented out $return['image'] and $return['secure']['image'] in the code.

…ng unexpected array offsets.

github-actions · 2025-05-27T15:01:43Z

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 WoA dev 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 (Jetpack), and enable the update/class-media-summary-array-warnings branch.
To test on Simple, run the following command on your sandbox:

bin/jetpack-downloader test jetpack update/class-media-summary-array-warnings

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 · 2025-05-27T15:01:47Z

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 Review, ...).
✅ Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
✅ 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 🤖

Follow this PR Review Process:

Ensure all required checks appearing at the bottom of this PR are passing.
Make sure to test your changes on all platforms that it applies to. You're responsible for the quality of the code you ship.
You can use GitHub's Reviewers functionality to request a review.
When it's reviewed and merged, you will be pinged in Slack to deploy the changes to WordPress.com simple once the build is done.

If you have questions about anything, 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 as soon as you deploy your changes after merging this PR (PCYsg-Jjm-p2).
WoA releases happen weekly.
Releases to self-hosted sites happen monthly:
- Scheduled release: June 3, 2025
- Code freeze: June 2, 2025

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

jp-launch-control · 2025-05-27T15:09:46Z

Code Coverage Summary

Coverage changed in 1 file.

File	Coverage	Δ%	Δ Uncovered
projects/plugins/jetpack/_inc/lib/class.media-summary.php	76/225 (33.78%)	-0.46%	3 ❤️‍🩹

Full summary · PHP report · JS report

coder-karen · 2025-05-28T09:41:16Z

projects/plugins/jetpack/_inc/lib/class.media-summary.php


-				if ( $number_of_paragraphs <= 2 && is_countable( $extract['image'] ) && 1 === count( $extract['image'] ) ) {
+				if ( $number_of_paragraphs <= 2 && is_countable( $extract['image'] ) && 1 === count( $extract['image'] ) ) {  // @phan-suppress-current-line PhanTypePossiblyInvalidDimOffset -- We established the image offset exists with '! empty( $extract['has']['image']' earlier.


This line was flagged by Phan due to the 'image' offset possibly being invalid. However as mentioned when suppressing, we established that the image offset exists earlier.
Previous change was added here, so I've opted to leave as-is: https://github.com/Automattic/jetpack/pull/31250/files#diff-8a52a367cf42b78b5fea4ec178b867663dd4979986a114b95b38fc0463fa73d0

! empty( $extract['has']['image']

Might be missing the obvious here but where is this check? I couldn't find it

We check that here:

jetpack/projects/plugins/jetpack/_inc/lib/class.media-summary.php

Line 245 in a81d6d3

} elseif ( ! empty( $extract['has']['image'] ) ) {

…ier, as it is unrelated and causing issues.

fgiannar · 2025-05-30T10:19:11Z

projects/plugins/jetpack/_inc/lib/class.media-summary.php

-				$return['secure']['image'] = self::ssl_img( $return['image'] );
-				++$return['count']['image'];
+				if ( isset( $extract['image'][0]['url'] ) ) {
+					$return['image']           = $extract['image'][0]['url'];


I wonder if consumers of this method always expect the image key to be present. For example enhanced_og_image here would produce Undefined array key Warnings

Thanks for digging in to this! Good point - in this case the default is set here:

jetpack/projects/plugins/jetpack/_inc/lib/class.media-summary.php

Line 73 in a81d6d3

'image' => '',

coder-karen added 2 commits May 27, 2025 15:53

Prevent undefined array key warnings plus warnings related to accessi…

632e1b4

…ng unexpected array offsets.

changelog

f9f3988

coder-karen self-assigned this May 27, 2025

coder-karen added [Type] Bug When a feature is broken and / or not performing as intended [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ labels May 27, 2025

github-actions bot added the [Status] In Progress label May 27, 2025

github-actions bot added the [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. label May 27, 2025

coder-karen removed the [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. label May 27, 2025

coder-karen changed the title ~~Prevent undefined array key warnings plus warnings related to accessi…~~ Jetpack_Media_Summary: Prevent warnings related to undefined keys and unexpected array offsets May 28, 2025

Prevent phan warning

7bc53d2

coder-karen commented May 28, 2025

View reviewed changes

coder-karen added 3 commits May 28, 2025 10:58

Update Phan baseline

17cea61

Merge branch 'trunk' into update/class-media-summary-array-warnings

894e7bc

Removing an addition automatically added by Phan to the baseline earl…

56ff43a

…ier, as it is unrelated and causing issues.

coder-karen marked this pull request as ready for review May 28, 2025 12:33

coder-karen requested a review from a team May 28, 2025 13:02

coder-karen added [Status] Needs Review This PR is ready for review. and removed [Status] In Progress labels May 28, 2025

fgiannar requested changes May 30, 2025

View reviewed changes

fgiannar added [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. and removed [Status] Needs Review This PR is ready for review. labels May 30, 2025

coder-karen added [Status] Needs Review This PR is ready for review. and removed [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. labels May 30, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Jetpack_Media_Summary: Prevent warnings related to undefined keys and unexpected array offsets #43641

Jetpack_Media_Summary: Prevent warnings related to undefined keys and unexpected array offsets #43641

Uh oh!

coder-karen commented May 27, 2025 •

edited

Loading

Uh oh!

github-actions bot commented May 27, 2025 •

edited

Loading

Uh oh!

github-actions bot commented May 27, 2025 •

edited

Loading

Uh oh!

jp-launch-control bot commented May 27, 2025 •

edited

Loading

Uh oh!

coder-karen May 28, 2025

Uh oh!

fgiannar May 30, 2025

Uh oh!

coder-karen May 30, 2025

Uh oh!

fgiannar May 30, 2025

Uh oh!

coder-karen May 30, 2025

Uh oh!

Uh oh!


		if ( $number_of_paragraphs <= 2 && is_countable( $extract['image'] ) && 1 === count( $extract['image'] ) ) {
		if ( $number_of_paragraphs <= 2 && is_countable( $extract['image'] ) && 1 === count( $extract['image'] ) ) { // @phan-suppress-current-line PhanTypePossiblyInvalidDimOffset -- We established the image offset exists with '! empty( $extract['has']['image']' earlier.

Jetpack_Media_Summary: Prevent warnings related to undefined keys and unexpected array offsets #43641

Are you sure you want to change the base?

Jetpack_Media_Summary: Prevent warnings related to undefined keys and unexpected array offsets #43641

Uh oh!

Conversation

coder-karen commented May 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed changes:

Other information:

Jetpack product discussion

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

Testing instructions:

Uh oh!

github-actions bot commented May 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented May 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jp-launch-control bot commented May 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Coverage Summary

Uh oh!

coder-karen May 28, 2025

Choose a reason for hiding this comment

Uh oh!

fgiannar May 30, 2025

Choose a reason for hiding this comment

Uh oh!

coder-karen May 30, 2025

Choose a reason for hiding this comment

Uh oh!

fgiannar May 30, 2025

Choose a reason for hiding this comment

Uh oh!

coder-karen May 30, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coder-karen commented May 27, 2025 •

edited

Loading

github-actions bot commented May 27, 2025 •

edited

Loading

github-actions bot commented May 27, 2025 •

edited

Loading

jp-launch-control bot commented May 27, 2025 •

edited

Loading