ISSUE-27397 - Fix phrase handling in widget validation

[zaximus84]

Description (*)

The doc block in \Magento\Widget\Model\Widget\Instance::validate indicates that it can return a boolean or phrase object, but \Magento\Widget\Controller\Adminhtml\Widget\Instance\Validate doesn't handle the phrase object properly. This PR updates the controller to recognize a phrase result value as an error message and output it to the user.

Fixed Issues (if relevant)

1. Fixes Creating custom widget instance validation is weird due to controller type mismatch #27397

Manual testing scenarios (*)

1. Create a custom widget type (in code).
2. Ensure that the widget class implements the validate() method and returns an instance of \Magento\Framework\Phrase.
3. In admin, go to Content > Widgets.
4. Click Add Widget.
5. Select the custom widget type and save.
6. Instead of saving, an error message should appear with the text from the widget's validate method.

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 @zaximus84. 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.

[zaximus84]

@magento run all tests

[zaximus84]

@magento run all tests

[sidolov]

@zaximus84 please, cover changes with automated test

[gabrieldagama]

Risk set to low since the functionality may not affect other areas.

[engcom-Charlie]

@zaximus84 I'll take care of the test coverage.

[engcom-Charlie]

@magento run all tests

[magento-engcom-team]

Hi @ihor-sviziev, thank you for the review.
ENGCOM-8250 has been created to process this Pull Request

[engcom-Alfa]

✔️ QA Passed

Manual testing scenario:

1. Create a custom widget type (in code).
2. Ensure that the widget class implements the validate() method and returns an instance of \Magento\Framework\Phrase.
3. In admin, go to Content > Widgets.
4. Click Add Widget.
5. Select the custom widget type and save.

After ✔️ The error message appears with the text from the widget's validate method

[m2-assistant]

Hi @zaximus84, 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.