UPSTREAM FIX

magento2-37570: Extract handlers load layout XML without an exception for invalid XML

Community fix magento2-37570 merged into magento/magento2 on 2025-06-26, released in 2.4.9; applies cleanly to 33 releases from 2.4.6 to 2.4.8-p5.

Extract handlers load layout XML without an exception for invalid XML edited

Pull request title
Avoid lots of uncessary exceptions during layout XML merge loading
Pull request
magento/magento2#37570
Issues
#39877 pr-derived
Author
@amenk
Merged
2025-06-26
Fixed in
2.4.9
Reported on
—
Categories
—
Components
magento/framework

Labels

Area
Framework
Component
Frontend
Priority
P3
Severity
—
Reported on (labels)
2.4.x

Issue

Title and steps come from the upstream issue and pull request.

Description

* Introduce a new function (for B/C compat we don't overwrite the protected _loadXmlString) to load and not throw an exception
* Use it in extract handlers -> no need to catch the exception any more

Steps to reproduce

1. Install the sentry plugin
2. Have some invalid XML there
3. Exception is reported, even it is not necessary

### Reason

When using tools like Sentry, because of there inner workings, such exceptions still might be reported. While this is not exactly the root cause, it's always cleaner to not throw an exception and immediately catch it, if invalid cases can happen often.

This might even improve performance a bit and improves developer's experience.

### Remarks

There seems some invalid XML at that place in the code happen quite often - it might be also interesting to check if that can be avoided.

This is a simple, trivial change to the code and should not break anything, so hopefully this can get triaged quickly and without to much back-and-forth about the testing procedure :-)

Taken from the upstream pull request.

Error signatures

Code match per tag

Each tag was checked with git apply --check against that tag's files. A clean match means the change applies; it is not a test result. Tags that already contain the fix are marked.

LineCode match per tagTests
2.4.6
2.4.6 clean 2.4.6-p1 clean 2.4.6-p2 clean 2.4.6-p3 clean 2.4.6-p4 clean 2.4.6-p5 clean 2.4.6-p6 clean 2.4.6-p7 clean 2.4.6-p8 clean 2.4.6-p9 clean 2.4.6-p10 clean 2.4.6-p11 clean 2.4.6-p12 clean 2.4.6-p13 clean 2.4.6-p14 clean 2.4.6-p15 clean
2.4.6: no test data 2.4.6-p1: no test data 2.4.6-p2: no test data 2.4.6-p3: no test data 2.4.6-p4: no test data 2.4.6-p5: no test data 2.4.6-p6: no test data 2.4.6-p7: no test data 2.4.6-p8: no test data 2.4.6-p9: no test data 2.4.6-p10: no test data 2.4.6-p11: no test data 2.4.6-p12: no test data 2.4.6-p13: no test data 2.4.6-p14: no test data 2.4.6-p15: no test data
2.4.7
2.4.7 clean 2.4.7-p1 clean 2.4.7-p2 clean 2.4.7-p3 clean 2.4.7-p4 clean 2.4.7-p5 clean 2.4.7-p6 clean 2.4.7-p7 clean 2.4.7-p8 clean 2.4.7-p9 clean 2.4.7-p10 clean
2.4.7: no test data 2.4.7-p1: no test data 2.4.7-p2: no test data 2.4.7-p3: no test data 2.4.7-p4: no test data 2.4.7-p5: no test data 2.4.7-p6: no test data 2.4.7-p7: no test data 2.4.7-p8: no test data 2.4.7-p9: no test data 2.4.7-p10: no test data
2.4.8
2.4.8 clean 2.4.8-p1 clean 2.4.8-p2 clean 2.4.8-p3 clean 2.4.8-p4 clean 2.4.8-p5 clean
2.4.8: no test data 2.4.8-p1: no test data 2.4.8-p2: no test data 2.4.8-p3: no test data 2.4.8-p4: no test data 2.4.8-p5: no test data
2.4.9
2.4.9 conflictcontains the fix
2.4.9: no test data

Triage

Model @cf/cloudflare/clef. Probability this is a bug fix: 45.6%. Probability it is security relevant: 0.8%.

Show the model's answers and probabilities
QuestionAnswerProbabilitiesConfidence
Change kindrefactorrefactor 46.9%, bugfix 46.7%, feature 3.9%, tests_only 0.9%, dependency 0.9%, docs_only 0.7%32.8%
Areaframeworkframework 73.2%, frontend 19.3%, admin 2.0%51.4%
Reported versionunspecifiedunspecified 26.9%, 2.4.6 2.1%, 2.4.9 1.8%6.9%
Scope0.85 of 21 58.0%, 0 28.7%, 2 13.4%15.4%
Risk0.34 of 20 69.3%, 1 27.2%, 2 3.4%33.4%
Worth backporting0.98 of 21 35.9%, 0 33.0%, 2 31.1%0.2%

Download

For cweagans/composer-patches, choose a version below and download the bundle. Copy its magento2-37570/ folder into patches/composer/, merge composer.patches.json into composer.json, then run composer install. Test files are always removed; paths are relative to each package root, using the default -p1 level.

Packages (1): magento/framework
Bundle README (what the ZIP ships)
# magento2-37570

Community fix merged upstream into magento/magento2, adapted by magento.watch.
This is not a patch published by Adobe.

Pull request: https://github.com/magento/magento2/pull/37570
Issue: https://github.com/magento/magento2/issues/39877
Author: @amenk
Source commit: 89c19806dad90e0b5345148ef5d6bc6f6421b602
Modifications: test files and documentation removed, paths rewritten relative to each Composer package.
Licence: OSL-3.0 / AFL-3.0, as the original Magento Open Source code.
Maintainer: Łukasz Bajsarowicz (@lbajsarowicz)

Licence: Magento Open Source code under OSL-3.0 and AFL-3.0. The bundle carries the original author, source commit and the list of modifications.

Sources

Łukasz Bajsarowicz
Built by

Łukasz Bajsarowicz, e-commerce architect

Magento and Adobe Commerce architecture, upgrades, performance and audits for merchants and agencies since 2015; magento.watch is the tooling I use on those projects.

Open source, maintained on weekends.