Skip to content

Fix admin grid filter backslash escaping issue #39535

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

wubinworks
Copy link
Contributor

Fixed admin grid filter backslash escaping issue.

Description (*)

The Admin Grid Filter cannot return correct result for keyword that contains backslash. For example Magento\Store.
This pull request fixed it by escaping backslash.

Related Pull Requests

Fixed Issues (if relevant)

  1. Fixes [Small Bug] Filter of Admin Panel listing component cannot hit when field value contains \ #39513

Manual testing scenarios (*)

  1. Create a new block in CMS block admin grid with title Magento\Store.
  2. Input Magento\Store in title filter to search and then check the search result.
  3. The result should contain Magento\Store after merging this branch.

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 Jan 11, 2025

Hi @wubinworks. 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.

@wubinworks
Copy link
Contributor Author

@magento run all tests

@engcom-Bravo engcom-Bravo added the Priority: P2 A defect with this priority could have functionality issues which are not to expectations. label Jan 17, 2025
@engcom-Hotel
Copy link
Contributor

@magento run all tests

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 @wubinworks,

Thanks for the contribution!

The code changes seems good to us, but please look into the following review comments:

  1. Fix the static test failures, other failures seems flaky to me. Hence re-running the tests.
  2. Consider adding some automated tests like unit or integration which verifies filtering behavior with backslash characters. Specifically:
  1. Unit tests could ensure Filter::applyFilter() properly handles backslashes
  2. Integration tests could verify admin grid filtering works with values containing backslashes

Thanks

@engcom-Dash
Copy link
Contributor

@wubinworks I wanted to check if you are working on the static failures & automated test coverage. If not, Can I take care of them? Just let me know what works best for you.

@engcom-Dash engcom-Dash self-assigned this Jun 25, 2025
@wubinworks
Copy link
Contributor Author

@magento run all tests

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 @wubinworks,

Thanks for making the changes!

Some static tests are still failing, please fix those as well.

Thanks

@engcom-Hotel engcom-Hotel moved this from Review in Progress to Changes Requested in Community Dashboard Jun 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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
Projects
Status: Changes Requested
Development

Successfully merging this pull request may close these issues.

[Small Bug] Filter of Admin Panel listing component cannot hit when field value contains \
6 participants