Reports module has no place modifying CMS homepage

[fredden]

Description

Today I learned (through conversation with a colleague) that the Magento_Reports module has a set-up script which modifies the CMS homepage of Magento. This feels like over-reach. The specific change uses a deprecated feature where each CMS block/page can have layout XML specified in the database. It adds some comments which look like they should be layout instructions, but without any context nor direction for developers.

This pull request removes the modification from future websites. This will have no impact to existing websites as the data patch will have already been applied. I have specifically separated the intended change from the commit where coding standards are applied.

Manual testing scenarios

1. Install Magento
2. Review layout configuration of home CMS page in the database.

Contribution checklist

• [x] Pull request has a meaningful description of its purpose
• [x] All commits are accompanied by meaningful commit messages
• [x] All new or changed code is covered with unit/integration tests (if applicable)
• [x] README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
• [x] All automated tests passed successfully (all builds are green)

Resolved issues:

1. [x] resolves magento/magento2#37782: Reports module has no place modifying CMS homepage

[m2-assistant[bot]]

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

:exclamation: 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 :information_source: 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.

[magento-automated-testing[bot]]

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please message the #magento-devops slack channel if they don't show in a reasonable amount of time and a representative will look into any issues.

[engcom-Bravo]

@magento create issue

[magento-automated-testing[bot]]

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please message the #magento-devops slack channel if they don't show in a reasonable amount of time and a representative will look into any issues.

[ihor-sviziev]

@magento run all tests

[engcom-Hotel]

@magento run Functional Tests B2B, Functional Tests EE, Functional Tests CE, Static Tests, WebAPI Tests

[engcom-Hotel]

@magento run Functional Tests EE

[ihor-sviziev]

@magento run Static Tests

[engcom-Hotel]

@magento run all tests

[engcom-Charlie]

Hi @fredden,

Thank you for your contribution!

We are in discussion with Product Owner on this PR as its tagged as feature request in here. Once we will get input, we have a look at it, till then moving it to On Hold.

Thank you!

[engcom-Charlie]

Hi @fredden,

Thank you for your contribution!

We are in discussion with Product Owner on this PR as its tagged as feature request in here. Once we will get input, we have a look at it, till then moving it to On Hold.

Thank you!

Hi @fredden,

Can you please mention the area/impact of this change or any error/scenario you have came across to raise this issue. I can see that we are removing layout_update_xml field's data into this PR. It will be really helpful, if you please mention the Expected result in Manual testing scenario.

Thank you!

[engcom-Charlie]

Hi @fredden,

Did you get a chance to check this comment.

Thank you!

[fredden]

Can you please mention the area/impact of this change or any error/scenario you have came across to raise this issue. I can see that we are removing layout_update_xml field's data into this PR.

I'm not sure what more you want than what I've already provided in the initial pull request description. Can you give an example of what you are expecting to see?

It will be really helpful, if you please mention the Expected result in Manual testing scenario.

I have updated this part of the pull request description to say that there should no layout configuration changes from the reports module in a CMS page.

[engcom-Charlie]

As we not seeing or taking care any functional or a dev experience issue in this PR description, we are not proceeding ahead with modifying the source code. Unfortunately, we are closing this PR for now. Please feel free to reopen it for any further updates.

[fredden]

Unfortunately, we are closing this PR

Yes, it does seem unfortunate. As I'm no longer working with Magento day-to-day, I will not pursue this. Others are welcome to pick this up and help Adobe understand why this change is valuable.