feat: more informative error message on xml validation errors #36836

adamzero1 · 2023-02-09T14:03:58Z

Description (*)

This PR adds more informative output to the existing error message displayed, when there is invalid XML configuration.

For example if there is invalid layout.xml the standard error message displayed to a developer would be something like:

1 exception(s):
Exception #0 (Magento\Framework\Config\Dom\ValidationException): Element 'arguments': This element is not expected.
Line: 1471

This isn't very helpful as the line number refers to the XML after it has been merged, making it pretty impossible to determine the file that caused the issue.
This PR changes the output to

1 exception(s):
Exception #0 (Magento\Framework\Config\Dom\ValidationException): Element 'arguments': This element is not expected.
Line: 1471
The xml was: 
1466:            <argument name="show_category" xsi:type="boolean">true</argument>
1467:         </arguments>
1468:      </block>
1469:      <referenceBlock name="product_view_detail" remove="true"/>
1470:      <block name="abc.gtm.product_view_detail" class="ABC\GoogleTagManager\Block\Detail" template="ABC_GoogleTagManager::detailproduct.phtml"/>
1471:      <arguments>
1472:         <argument name="show_category" xsi:type="boolean">true</argument>
1473:      </arguments>
1474:   </referenceContainer>
1475:</body>

Which although the line numbers still refer to the merged XML, it will allow the developer to search the source files for a more specific string. Making it much easier to find the source of the issue.

Related Pull Requests

https://github.com/magento-gl/magento2ee/pull/205

Fixed Issues (if relevant)

N/A

Manual testing scenarios (*)

Put the site into development mode, and disable cache.
Add a breaking change to a layout XML file. e.g add: <bar>foo</bar>
Load the frontend of the site,

You should get an error message that you can use to find the offending configuration.

Questions or comments

Contribution checklist (*)

Pull request has a meaningful description of its purpose
All commits are accompanied by meaningful commit messages
All new or changed code is covered with unit/integration tests (if applicable)
README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
All automated tests passed successfully (all builds are green)

Resolved issues:

resolves [Issue] feat: more informative error message on xml validation errors #37788: feat: more informative error message on xml validation errors

m2-assistant · 2023-02-09T14:04:02Z

Hi @adamzero1. Thank you for your contribution!
Here are some useful tips on how you can test your changes using Magento test environment.

Add the comment under your pull request to deploy test or vanilla Magento instance:

@magento give me test instance - deploy test instance based on PR changes
@magento give me 2.4-develop instance - deploy vanilla Magento instance

❗ Automated tests can be triggered manually with an appropriate comment:

@magento run all tests - run or re-run all required tests against the PR changes
@magento run <test-build(s)> - run or re-run specific test build(s)
For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names.

Allowed build names are:

Database Compare
Functional Tests CE
Functional Tests EE
Functional Tests B2B
Integration Tests
Magento Health Index
Sample Data Tests CE
Sample Data Tests EE
Sample Data Tests B2B
Static Tests
Unit Tests
WebAPI Tests
Semantic Version Checker

You can find more information about the builds here
ℹ️ Run only required test builds during development. Run all test builds before sending your pull request for review.

For more details, review the Code Contributions documentation.
Join Magento Community Engineering Slack and ask your questions in #github channel.

hostep · 2023-02-09T21:56:37Z

Nice!

However, there was already another improvement made in this area recently I believe: #36239 (it looks like this one is not going to be included in Magento 2.4.6, because it's not in 2.4.6-beta5, and that would really suck, so we'll have to wait until the year 2024 for this one to be included in Magento 2.4.7 ...)

Anyway, not sure if we need both improvements?

lib/internal/Magento/Framework/Config/Dom.php

ihor-sviziev

Could you also please cover your change with any type of automated tests?

ihor-sviziev · 2023-02-10T13:45:04Z

@magento run all tests

magento-automated-testing · 2023-02-10T13:45:12Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

Co-authored-by: Ihor Sviziev <[email protected]>

adamzero1 · 2023-02-10T15:48:09Z

Nice!

However, there was already another improvement made in this area recently I believe: #36239 (it looks like this one is not going to be included in Magento 2.4.6, because it's not in 2.4.6-beta5, and that would really suck, so we'll have to wait until the year 2024 for this one to be included in Magento 2.4.7 ...)

Anyway, not sure if we need both improvements?

I'm not sure of the performance implications of merging on everyfile, considering the number of files that are processed.
Though this would help the file be identified.
I will have a look to see if there is a way to get best of both

hostep · 2023-03-15T08:06:02Z

Regarding my previous comment, I just ran into a situation where I needed more info to see where an xml error came from exactly and the fix from #36239 didn't help in this particular case, but the fix from this PR did!

So I think both should be processed.
Thanks for the PR!

ihor-sviziev · 2023-03-17T15:02:46Z

@magento run all tests

magento-automated-testing · 2023-03-17T15:02:52Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

ihor-sviziev

Could you also please cover your change with any type of automated tests and fix failing tests?

ihor-sviziev · 2023-04-13T09:08:40Z

@magento run all tests

magento-automated-testing · 2023-04-13T09:08:50Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

engcom-Lima · 2023-07-24T06:27:10Z

@magento create issue

engcom-Lima · 2023-07-24T06:27:28Z

@magento run Functional Tests EE , Functional Tests CE

magento-automated-testing · 2023-07-24T06:27:39Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please message the #magento-devops slack channel if they don't show in a reasonable amount of time and a representative will look into any issues.

engcom-Lima · 2023-07-24T08:20:50Z

@magento run Functional Tests B2B

magento-automated-testing · 2023-07-24T08:21:02Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please message the #magento-devops slack channel if they don't show in a reasonable amount of time and a representative will look into any issues.

engcom-Lima · 2023-07-24T10:39:08Z

✔️ QA Passed

Preconditions:

Install fresh Magento 2.4-develop and PHP 8.1

Manual testing scenario:

Put the site into development mode, and disable the cache.
Add a breaking change to a layout XML file. e.g add: <bar>foo</bar>
Load the front end of the site.

Before: ✖️ Complete information was not available of error message on XML validation errors.

After: ✔️ Now complete information is getting displayed on XML validation errors.

Builds are failed. Hence, moving this PR to Extended Testing.

engcom-Echo · 2023-07-25T06:52:18Z

@magento run Unit Tests

magento-automated-testing · 2023-07-25T06:52:31Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please message the #magento-devops slack channel if they don't show in a reasonable amount of time and a representative will look into any issues.

engcom-Echo · 2023-07-25T08:16:35Z

@magento run Unit Tests

magento-automated-testing · 2023-07-25T08:16:44Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please message the #magento-devops slack channel if they don't show in a reasonable amount of time and a representative will look into any issues.

engcom-Echo · 2023-07-25T10:18:43Z

Functional Failure are not related to the PR changes.
Hence moving to merge in progress.

engcom-Echo · 2023-08-18T02:40:55Z

@magento run all tests

magento-automated-testing · 2023-08-18T02:41:04Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please message the #magento-devops slack channel if they don't show in a reasonable amount of time and a representative will look into any issues.

engcom-Echo · 2023-08-18T04:45:45Z

@magento run WebAPI Tests,Unit Tests,Integration Tests,Functional Tests EE

magento-automated-testing · 2023-08-18T04:45:51Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please message the #magento-devops slack channel if they don't show in a reasonable amount of time and a representative will look into any issues.

engcom-Echo · 2023-08-18T07:02:21Z

Functional Tests EE failures are different on last two run on same commit. Other build failures are not related to PR.
Functional Tests EE
Run1

Run2

feat: more informative error message on xml validation errors

8783b88

Merge branch '2.4-develop' into more-informative-xml-error-message

17a04cc

ihor-sviziev added the Priority: P2 A defect with this priority could have functionality issues which are not to expectations. label Feb 10, 2023

m2-community-project bot added the Progress: pending review label Feb 10, 2023

ihor-sviziev requested changes Feb 10, 2023

View reviewed changes

lib/internal/Magento/Framework/Config/Dom.php Outdated Show resolved Hide resolved

lib/internal/Magento/Framework/Config/Dom.php Show resolved Hide resolved

lib/internal/Magento/Framework/Config/Dom.php Show resolved Hide resolved

m2-community-project bot assigned ihor-sviziev Feb 10, 2023

m2-community-project bot added Progress: needs update and removed Progress: pending review labels Feb 10, 2023

ihor-sviziev requested changes Feb 10, 2023

View reviewed changes

adamzero1 and others added 2 commits February 10, 2023 15:39

Update lib/internal/Magento/Framework/Config/Dom.php

0317262

Co-authored-by: Ihor Sviziev <[email protected]>

Update lib/internal/Magento/Framework/Config/Dom.php

6394ae7

Co-authored-by: Ihor Sviziev <[email protected]>

m2-community-project bot added Progress: review and removed Progress: needs update labels Feb 10, 2023

Merge branch '2.4-develop' into more-informative-xml-error-message

554ce92

ihor-sviziev requested changes Mar 23, 2023

View reviewed changes

m2-community-project bot added Progress: needs update and removed Progress: review labels Mar 23, 2023

engcom-Charlie assigned engcom-Charlie and unassigned engcom-Charlie Jun 7, 2023

engcom-Echo self-assigned this Jun 7, 2023

m2-community-project bot added Progress: testing in progress and removed Progress: ready for testing labels Jul 24, 2023

m2-assistant bot mentioned this pull request Jul 24, 2023

[Issue] feat: more informative error message on xml validation errors #37788

Closed

5 tasks

m2-community-project bot added Progress: ready for testing and removed Progress: testing in progress labels Jul 24, 2023

engcom-Lima added the Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it label Jul 24, 2023

m2-community-project bot added Progress: testing in progress and removed Progress: ready for testing labels Jul 24, 2023

m2-community-project bot added Progress: extended testing and removed Progress: testing in progress labels Jul 24, 2023

m2-community-project bot added Progress: accept and removed Progress: extended testing labels Jul 25, 2023

Merge branch '2.4-develop' into more-informative-xml-error-message

c210641

magento-devops-reposync-svc merged commit c4c2eac into magento:2.4-develop Aug 31, 2023

feat: more informative error message on xml validation errors #36836

feat: more informative error message on xml validation errors #36836

Uh oh!

Conversation

adamzero1 commented Feb 9, 2023 • edited by m2-assistant bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description (*)

Related Pull Requests

Fixed Issues (if relevant)

Manual testing scenarios (*)

Questions or comments

Contribution checklist (*)

Resolved issues:

Uh oh!

m2-assistant bot commented Feb 9, 2023

Uh oh!

hostep commented Feb 9, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ihor-sviziev left a comment

Choose a reason for hiding this comment

Uh oh!

ihor-sviziev commented Feb 10, 2023

Uh oh!

magento-automated-testing bot commented Feb 10, 2023

Uh oh!

adamzero1 commented Feb 10, 2023

Uh oh!

hostep commented Mar 15, 2023

Uh oh!

ihor-sviziev commented Mar 17, 2023

Uh oh!

magento-automated-testing bot commented Mar 17, 2023

Uh oh!

ihor-sviziev left a comment

Choose a reason for hiding this comment

Uh oh!

ihor-sviziev commented Apr 13, 2023

Uh oh!

magento-automated-testing bot commented Apr 13, 2023

Uh oh!

engcom-Lima commented Jul 24, 2023

Uh oh!

engcom-Lima commented Jul 24, 2023

Uh oh!

magento-automated-testing bot commented Jul 24, 2023

Uh oh!

engcom-Lima commented Jul 24, 2023

Uh oh!

magento-automated-testing bot commented Jul 24, 2023

Uh oh!

engcom-Lima commented Jul 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✔️ QA Passed

Uh oh!

engcom-Echo commented Jul 25, 2023

Uh oh!

magento-automated-testing bot commented Jul 25, 2023

Uh oh!

engcom-Echo commented Jul 25, 2023

Uh oh!

magento-automated-testing bot commented Jul 25, 2023

Uh oh!

engcom-Echo commented Jul 25, 2023

Uh oh!

engcom-Echo commented Aug 18, 2023

Uh oh!

magento-automated-testing bot commented Aug 18, 2023

Uh oh!

engcom-Echo commented Aug 18, 2023

Uh oh!

magento-automated-testing bot commented Aug 18, 2023

Uh oh!

engcom-Echo commented Aug 18, 2023

Uh oh!

Reviewers

Assignees

Labels

adamzero1 commented Feb 9, 2023 •

edited by m2-assistant bot

Loading

engcom-Lima commented Jul 24, 2023 •

edited

Loading