Skip to content

magento/magento2#39148: xsd validation that contains comments below f… #39675

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.

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

Open
wants to merge 3 commits into
base: 2.4-develop
Choose a base branch
from

Conversation

Kiraberos
Copy link
Contributor

Description (*)

  • Fixed issue with adding string type for the <comment> element.

Related Pull Requests

Fixed Issues (if relevant)

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

Manual testing scenarios (*)

  1. Launch PHPStorm and configure XSD verification as described in the Magento documentation.
  2. Locate a file that contains a <comment> as a child element of a <field>.
  3. Verify the XSD validation for <comment> elements under <field> elements in system.xml configuration files.

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)

Copy link

m2-assistant bot commented Feb 28, 2025

Hi @Kiraberos. Thank you for your contribution!
Here are some useful tips on how you can test your changes using Magento test environment.
❗ 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:
  1. Database Compare
  2. Functional Tests CE
  3. Functional Tests EE
  4. Functional Tests B2B
  5. Integration Tests
  6. Magento Health Index
  7. Sample Data Tests CE
  8. Sample Data Tests EE
  9. Sample Data Tests B2B
  10. Static Tests
  11. Unit Tests
  12. WebAPI Tests
  13. 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.

@m2-github-services m2-github-services added Partner: Perspective partners-contribution Pull Request is created by Magento Partner labels Feb 28, 2025
@engcom-Bravo engcom-Bravo added the Priority: P2 A defect with this priority could have functionality issues which are not to expectations. label Feb 28, 2025
@Kiraberos
Copy link
Contributor Author

@magento run all tests

@Kiraberos
Copy link
Contributor Author

@magento run all tests

1 similar comment
@Kiraberos
Copy link
Contributor Author

@magento run all tests

@Priyakshic Priyakshic added the Project: Community Picked PRs upvoted by the community label Mar 13, 2025
@Priyakshic Priyakshic moved this to Pending Review in Community Dashboard Mar 13, 2025
@engcom-Bravo engcom-Bravo added the Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it label Mar 17, 2025
@engcom-Hotel
Copy link
Contributor

@magento run all tests

@engcom-Hotel
Copy link
Contributor

@magento run Functional Tests B2B, Functional Tests CE, Functional Tests EE, Unit Tests, WebAPI Tests

@engcom-Hotel engcom-Hotel moved this from Pending Review to Review in Progress in Community Dashboard Mar 27, 2025
Copy link
Contributor

@engcom-Hotel engcom-Hotel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @Kiraberos,

Thank you for your contribution!

It seems the automated tests like Integration, Static and WebApi are failing due to this PR changes. We request you to please fix those.

Thanks

@@ -1,8 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
* Copyright 2015 Adobe
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Copyright 2015 Adobe
* Copyright 2012 Adobe

@engcom-Hotel engcom-Hotel moved this from Review in Progress to Changes Requested in Community Dashboard Mar 27, 2025
@engcom-Dash
Copy link
Contributor

Hello @Kiraberos

Thank you for the contribution!

Before moving forward with the changes on the PR we have tried to reproduce the issue in PhpStrom IDE. However it is not reproducible on 2.4-develop branch. Please find below screenshots.

We have ran the command "bin/magento dev:urn-catalog:generate .idea/misc.xml" to generate urn mappings and configure xsd verification.

image

After this we have restarted the Phpstorm. Still the comment tag looks fine and rendering without any error.
image

Are we missing any other configuration to reproduce the issue?

Thank you!

@engcom-Dash
Copy link
Contributor

@Kiraberos Since we are still unable to reproduce the issue on 2.4-develop branch, we are placing this PR on hold for now. Please let us know if you have any additional information that could help us investigate further.

Thank You!

@engcom-Dash engcom-Dash moved this from Changes Requested to On Hold in Community Dashboard Apr 7, 2025
@gwharton
Copy link
Contributor

I was able to reproduce on my development build, a fresh 2.4.8 composer install and 2.4-develop.

One thing I did notice is that PHPStorm will not carry out xsd validation prior to indexing being completed.

image

@jakwinkler
Copy link

This PR can be closed as it does not address all variations of the <comment> node in system.xml
Proper fix is here: #39867

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Partner: Perspective partners-contribution Pull Request is created by Magento Partner Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Progress: needs update Project: Community Picked PRs upvoted by the community Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it
Projects
Status: On Hold
Development

Successfully merging this pull request may close these issues.

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