Skip to content

Fix appearance of HTML entities in the name of attribute groups when editing or after saving #33024

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 2 commits into
base: 2.4-develop
Choose a base branch
from

Conversation

blmage
Copy link
Contributor

@blmage blmage commented May 15, 2021

Description (*)

This PR fixes the appearance of HTML entities in the names of attribute groups when editing them, or after saving the corresponding attribute set.

Related Pull Requests

Fixed Issues (if relevant)

  1. Fixes Encoding of ampersands in attribute set group name #32962

Manual testing scenarios (*)

  1. See Encoding of ampersands in attribute set group name #32962

Questions or comments

The problem is located deep within the library code: the same text variable is used both when displaying and when editing the node labels, but the library does not take care of (un)escaping them, so there is always one case that is handled incorrectly (we either get a potential XSS, or unwanted HTML entities in the edit input).

The PR ensures that the HTML entities contained in the group names are decoded (only) when the names are edited, or when the attribute set is saved.

Also, directly updating the ext-tree.js file was preferred over a monkey-patch, because:

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)

@m2-assistant
Copy link

m2-assistant bot commented May 15, 2021

Hi @blmage. Thank you for your contribution
Here are some useful tips 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:

  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

ℹ️ Please run only needed test builds instead of all when developing. Please run all test builds before sending your PR for review.

For more details, please, review the Magento Contributor Guide documentation.

⚠️ According to the Magento Contribution requirements, all Pull Requests 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 Pull Requests happens in the queue order. If you want to speed up the delivery of your contribution, please join the Community Contributions Triage session to discuss the appropriate ticket.

🎥 You can find the recording of the previous Community Contributions Triage on the Magento Youtube Channel

✏️ Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel

@m2-community-project m2-community-project bot added the Priority: P4 No current plan to fix. Fixing can be deferred as a logical part of more important work. label May 15, 2021
@blmage
Copy link
Contributor Author

blmage commented May 15, 2021

@magento run all tests

@magento-automated-testing
Copy link

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 ihor-sviziev removed their assignment May 17, 2021
@blmage blmage changed the title Fix appearance of HTML entities in the name of attribute groups when editing of after saving Fix appearance of HTML entities in the name of attribute groups when editing or after saving May 19, 2021
@blmage
Copy link
Contributor Author

blmage commented May 26, 2021

@magento run Functional Tests B2B

@magento-automated-testing
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Frontend Area: Lib/Frontend Component: Catalog Priority: P4 No current plan to fix. Fixing can be deferred as a logical part of more important work. Progress: pending review Release Line: 2.4
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Encoding of ampersands in attribute set group name
3 participants