Fix exception which is thrown on search results page

[wojtekn]

Description

PR fixes issue which results with throwing exception on search page when phrase contains slash (/).

Related Pull Requests

n/a

Fixed Issues (if relevant)

1. Fixes SynonymAnalyzer.php in module-search is evaluating user input as a regex #25886
2. Fixes Elasticsearch not able to search for term with a slash / in it #25110
3. Fixes ElasticSearch breaks with / #28286

Manual testing scenarios

1. Install clean Magento
2. Ensure that Elasticsearch is enabled as search backend
3. Ensure the synonym exists in SEO & Search -> Search Synonyms:
   foo,bar"foobar",
4. Search for "Foo/Bar" in frontend

Without fix, the exception is thrown. PR ensures that generated phrases have preg modifiers escaped so exception won't be thrown.

Questions or comments

Fix was made inside private method. I'm not sure if any tests should be changed for that? Or regression test should be added?

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)
• All automated tests passed successfully (all builds are green)

[m2-assistant]

Hi @wojtekn. Thank you for your contribution
Here is 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

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

[wojtekn]

I reviewed testGetSynonymsForPhrase and it was not including slash, so the buggy use case was not caught by that test.

I was able to make small modification to the test to cover for the change. Test fails when fix is not in place, it goes through when fix is applied.

[lbajsarowicz]

@magento run all tests

[magento-engcom-team]

Hi @sidolov, thank you for the review.
ENGCOM-8303 has been created to process this Pull Request
✳️ @sidolov, could you please add one of the following labels to the Pull Request?

Label	Description
Auto-Tests: Covered	All changes in Pull Request is covered by auto-tests
Auto-Tests: Not Covered	Changes in Pull Request requires coverage by auto-tests
Auto-Tests: Not Required	Changes in Pull Request does not require coverage by auto-tests

[engcom-Alfa]

@magento give me 2.4-develop instance

[magento-deployment-service]

Hi @engcom-Alfa. Thank you for your request. I'm working on Magento instance for you.

[magento-deployment-service]

Hi @engcom-Alfa, here is your Magento Instance: https://31e7cf5c4abc987742a6f9b02e3ad670-2-4-develop.instances.magento-community.engineering
Admin access: https://31e7cf5c4abc987742a6f9b02e3ad670-2-4-develop.instances.magento-community.engineering/admin_398d
Login: 9f2e7678
Password: faee9215a3c5

[engcom-Alfa]

Hi @wojtekn .

Could you fix failing tests?
Thanks!

Pull Request state was updated. Re-review required.

[engcom-Alfa]

@wojtekn yes, the issue occurs if a phrase which contains not escaped slash will be passed to public
\Magento\Search\Model\SynonymAnalyzer::getSynonymsForPhrase method

Manual testing scenario:

1. Ensure that Elasticsearch is enabled as search backend
2. Ensure the synonym exists in SEO & Search -> Search Synonyms:
   foo,bar"foobar",
3. Add phrase ('Foo/Bar') which contains not escaped slash to public
   \Magento\Search\Model\SynonymAnalyzer::getSynonymsForPhrase method

Before: ✖️ Search results in an error.

After: ✔️ Find that product without errors.

@sivaschenko @lbajsarowicz @sidolov Could you take a look?

Thanks!

[sivaschenko]

I think we should deliver this fix

[magento-engcom-team]

Hi @sivaschenko, thank you for the review.
ENGCOM-8303 has been created to process this Pull Request

[magento-engcom-team]

Hi @sidolov, thank you for the review.
ENGCOM-8303 has been created to process this Pull Request

[m2-assistant]

Hi @wojtekn, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.