Fix for magento/magento2#29315: \Magento\Config\Model\Config\Source\Email\Tem…

[willwright]

Description (*)

Adds a guard to \Magento\Config\Model\Config\Source\Email\Template::toOptionArray which protects against throwing an unhandled exception when a user has not called $this->setPath() before calling toOptionArray()

Related Pull Requests

Fixed Issues (if relevant)

1. Fixes \Magento\Config\Model\Config\Source\Email\Template::toOptionArray throws error when setPath() is not called first #29315

Manual testing scenarios (*)

1. Create a custom module, plugin, or Observer
2. Inject a concrete instance of \Magento\Framework\ObjectManagerInterface ($this->_objectManager) through the constructor
3. Execute the following:
   $sourceModelObj = $this->_objectManager->create('\Magento\Config\Model\Config\Source\Email\Template');
   $optionsArray = $sourceModelObj->toOptionArray();
4. Notice unhandled exception is written to the screen

Questions or comments

I included a Unit test in app/code/Magento/Config/Test/Unit/Model/Config/Source/Email/TemplateTest.php to illustrate the issue and test for it.

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

[m2-assistant]

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

[m2-assistant]

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

[willwright]

@magento run all tests

[rogyar]

Hi @willwright. Thank you for your collaboration. Please, take a look at the failing static tests.
Thank you!

[willwright]

@magento run Static Tests

[willwright]

@magento run all tests

[willwright]

@rogyar Thanks for your comment.

I updated the branch and re-ran the tests. Please let me know if you have any other questions.

[rogyar]

@magento run all tests

[rogyar]

The failing tests are not related to the current changeset

[magento-engcom-team]

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

[magento-engcom-team]

@willwright thank you for contributing. Please accept Community Contributors team invitation here to gain extended permissions for this repository.

[engcom-Charlie]

✔️ QA Passed

Manual testing scenario:

1. Inject a concrete instance of \Magento\Framework\ObjectManagerInterface ($this->_objectManager) through the constructor

$sourceModelObj = $this->_objectManager->create('\Magento\Config\Model\Config\Source\Email\Template');

2. Execute the following:

$optionsArray = $sourceModelObj->toOptionArray();

Before: We see an exception message.

After: The exception wasn't thrown.

[m2-assistant]

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