Skip to content

xsd validation fails on etc/adminhtml/system.xml files that contain comments below field items. #39148

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.

Sign up for GitHub

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

Jump to bottom
Open
1 of 5 tasks
gwharton opened this issue Sep 9, 2024 · 7 comments · May be fixed by #39867
Open
1 of 5 tasks

xsd validation fails on etc/adminhtml/system.xml files that contain comments below field items. #39148

gwharton opened this issue Sep 9, 2024 · 7 comments · May be fixed by #39867
Assignees
@Kiraberos
Labels
Area: Framework Component: Xml Issue: Confirmed Gate 3 Passed. Manual verification of the issue completed. Issue is confirmed Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Progress: ready for dev Reported on 2.4.x Indicates original Magento version for the Issue report. Reproduced on 2.4.x The issue has been reproduced on latest 2.4-develop branch Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it

Comments

@gwharton
Copy link
Contributor

gwharton commented Sep 9, 2024

Summary

xsd validation fails on etc/adminhtml/system.xml files that contain <comments> below <field> items.

Examples

Launch PHPStorm and setup xsd validation, as per Magento devdocs.
Browse to a file containing a <comment> as a child to a <field>. Theres plenty to choose from
image
Check out the definition in the xsd file vendor/magento/module-config/etc/system_file.xsd
image
Notice that comment is not defined as a string.
Verify that on Experience League (https://experienceleague.adobe.com/en/docs/commerce-operations/configuration-guide/files/config-reference-systemxml), using <comment> as a child of <field> is supported. It is used extensively throughout Magento backend.
image

Proposed solution

Its an annoyance. Its been around for years. Its time to fix it.

Update type of comment to be string.

Release note

XSD validation now accepts <comment> entries as children of <field> entries in system.xml config files.

Triage and priority

  • Severity: S0 - Affects critical data or functionality and leaves users without workaround.
  • Severity: S1 - Affects critical data or functionality and forces users to employ a workaround.
  • Severity: S2 - Affects non-critical data or functionality and forces users to employ a workaround.
  • Severity: S3 - Affects non-critical data or functionality and does not force users to employ a workaround.
  • Severity: S4 - Affects aesthetics, professional look and feel, “quality” or “usability”.
@gwharton gwharton added the Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it label Sep 9, 2024
@m2-assistant M2 Assistant
Copy link

m2-assistant bot commented Sep 9, 2024

Hi @gwharton. Thank you for your report.
To speed up processing of this issue, make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, Add a comment to the issue:

Join Magento Community Engineering Slack and ask your questions in #github channel.
⚠️ According to the Magento Contribution requirements, all issues must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.
🕙 You can find the schedule on the Magento Community Calendar page.
📞 The triage of issues happens in the queue order. If you want to speed up the delivery of your contribution, join the Community Contributions Triage session to discuss the appropriate ticket.

@github-project-automation github-project-automation bot moved this to Ready for Confirmation in Issue Confirmation and Triage Board Sep 9, 2024
@engcom-Bravo engcom-Bravo added the Reported on 2.4.x Indicates original Magento version for the Issue report. label Sep 9, 2024
@engcom-Hotel engcom-Hotel self-assigned this Sep 10, 2024
@m2-assistant M2 Assistant
Copy link

m2-assistant bot commented Sep 10, 2024

Hi @engcom-Hotel. Thank you for working on this issue.
In order to make sure that issue has enough information and ready for development, please read and check the following instruction: 👇

  • 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).
  • 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue.
  • 3. Add Area: XXXXX label to the ticket, indicating the functional areas it may be related to.
  • 4. Verify that the issue is reproducible on 2.4-develop branch
    Details- Add the comment @magento give me 2.4-develop instance to deploy test instance on Magento infrastructure.
    - If the issue is reproducible on 2.4-develop branch, please, add the label Reproduced on 2.4.x.
    - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!
  • 5. Add label Issue: Confirmed once verification is complete.
  • 6. Make sure that automatic system confirms that report has been added to the backlog.

@engcom-Hotel
Copy link
Contributor

Hello @gwharton,

Thanks for the report and collaboration!

We are able to reproduce the issue in the latest 2.4-develop branch. Hence confirming the issue.

image

Thanks

@engcom-Hotel engcom-Hotel added Issue: Confirmed Gate 3 Passed. Manual verification of the issue completed. Issue is confirmed Reproduced on 2.4.x The issue has been reproduced on latest 2.4-develop branch Component: Xml Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Area: Framework and removed Issue: ready for confirmation labels Sep 10, 2024
@github-jira-sync-bot
Copy link

✅ Jira issue https://jira.corp.adobe.com/browse/AC-12945 is successfully created for this GitHub issue.

@m2-assistant M2 Assistant
Copy link

m2-assistant bot commented Sep 10, 2024

✅ Confirmed by @engcom-Hotel. Thank you for verifying the issue.
Issue Available: @engcom-Hotel, You will be automatically unassigned. Contributors/Maintainers can claim this issue to continue. To reclaim and continue work, reassign the ticket to yourself.

@Den4ik
Copy link
Contributor

Den4ik commented Oct 8, 2024

@magento give me 2.4-develop instance

@Kiraberos
Copy link
Contributor

@magento I am working on this

Kiraberos added a commit to Kiraberos/magento2 that referenced this issue Feb 28, 2025
@Kiraberos
magento#39148: xsd validation that contains comments below field items
48b2769 
- fixed issue with adding string type
@Kiraberos Kiraberos mentioned this issue Feb 28, 2025
Closed
5 tasks
Kiraberos added a commit to Kiraberos/magento2 that referenced this issue Feb 28, 2025
@Kiraberos
magento#39148: xsd validation that contains comments below field items
7141da0 
- the copyright information has been updated
@engcom-Bravo engcom-Bravo linked a pull request May 22, 2025 that will close this issue
system_file.xsd - better code highlight when using URN schemas #39867
Open
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Kiraberos Kiraberos

Labels
Area: Framework Component: Xml Issue: Confirmed Gate 3 Passed. Manual verification of the issue completed. Issue is confirmed Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Progress: ready for dev Reported on 2.4.x Indicates original Magento version for the Issue report. Reproduced on 2.4.x The issue has been reproduced on latest 2.4-develop branch Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it
Projects
None yet
Milestone
No milestone
6 participants
@Den4ik @gwharton @engcom-Bravo @engcom-Hotel @Kiraberos @github-jira-sync-bot