Skip to content

Conversation

@tbradsha
Copy link
Contributor

@tbradsha tbradsha commented Feb 5, 2025

If the Map block receives empty content, it results in a PHP fatal. This PR returns early in that scenario.

Proposed changes:

This was discovered while monitoring a deploy:

PHP Fatal error: Uncaught ValueError: DOMDocument::loadHTML(): Argument #1 ($source) must not be empty in /wordpress/plugins/jetpack/14.3-a.5/extensions/blocks/map/map.php:159 Stack trace: #0 /wordpress/plugins/jetpack/14.3-a.5/extensions/blocks/map/map.php(159): DOMDocument->loadHTML('')

Prior to PHP 8, DOMDocument::loadHTML() would throw a deprecation notice if the source string is empty; now it gives a fatal (docs).

There's no way to reliably prevent $content from being empty, given there's an apply_filters() just before which could be used by any third-party code.

At first I wasn't sure if it was safe to just return, but looking further in code that'd be precisely what it does if $container is not truthy, which would always be case since the DOMXPath::query would not find the path in question with empty content anyway. I believe another solution would be to throw a dummy <div></div> into $content should it be empty, but that seems more hackish.

Anyway, I'm fairly confident this restores the same behavior seen in PHP <8.

Note: the line in question did have a suppression before with @ added in d9492d1, but it's unclear from the PR (#13405) or the commit message if this or some other scenario warranted it. As such, I'm leaving it in place for now. There are also some libxml_use_internal_errors() calls, but those would be applicable for normal parsing errors too, so should stay.

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:

I'm not sure how to reproduce this best...check my logic above?

@tbradsha tbradsha added [Type] Bug When a feature is broken and / or not performing as intended [Status] Needs Review This PR is ready for review. labels Feb 5, 2025
@tbradsha tbradsha requested a review from a team February 5, 2025 22:06
@tbradsha tbradsha self-assigned this Feb 5, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Feb 5, 2025

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/map_block_fatal branch.

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

    bin/jetpack-downloader test jetpack fix/map_block_fatal
    

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 [Block] Map [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ labels Feb 5, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Feb 5, 2025

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 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 🤖


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 none scheduled (scheduled code freeze on undefined).

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

@github-actions
Copy link
Contributor

github-actions bot commented Feb 5, 2025

Code Coverage Summary

Coverage changed in 1 file.

File Coverage Δ% Δ Uncovered
projects/plugins/jetpack/extensions/blocks/map/map.php 0/120 (0.00%) 0.00% 2 💔

Full summary · PHP report · JS report

@jeherve jeherve added [Status] Ready to Merge Go ahead, you can push that green button! and removed [Status] Needs Review This PR is ready for review. labels Feb 6, 2025
@tbradsha tbradsha merged commit c02cec5 into trunk Feb 6, 2025
68 checks passed
@tbradsha tbradsha deleted the fix/map_block_fatal branch February 6, 2025 14:06
@github-actions github-actions bot removed the [Status] Ready to Merge Go ahead, you can push that green button! label Feb 6, 2025
@zinigor zinigor added this to the jetpack/14.4 milestone Feb 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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

4 participants