CMS Hierarchy renders breadcrumbs even when disabled

fredden commented 2 years ago

Preconditions and environment

Adobe Commerce. Tested on version 2.4.3-p2.
Set a hierarchy for CMS pages
Turn off hierarchy (admin -> Stores -> Settings -> Configuration -> General -> Content Management -> CMS Page Hierarchy -> Enable Hierarchy Functionality)

Steps to reproduce

Navigate to a CMS page on the front-end which exists within a hierarchy
Observe the breadcrumbs displayed

Expected result

Default (ie, no hierarchy) breadcrumbs displayed

Actual result

Breadcrumbs from CMS Page Hierarchy are shown. Clicking these may result in a 404.

Additional information

I don't have access to the relevant repository any more so I'm unable to submit this as a pull request. The following is what I have used to fix this in the magento/module-versions-cms composer package via cweagans/composer-patches.

diff --git a/Block/Cms/Page.php b/Block/Cms/Page.php
index 751c658..08df823 100644
--- a/Block/Cms/Page.php
+++ b/Block/Cms/Page.php
@@ -76,6 +76,10 @@ class Page extends \Magento\Cms\Block\Page
      */
     protected function _addBreadcrumbs(\Magento\Cms\Model\Page $page)
     {
+        if (!$this->_scopeConfig->isSetFlag('cms/hierarchy/enabled', ScopeInterface::SCOPE_STORE)) {
+            return parent::_addBreadcrumbs($page);
+        }
+
         $breadcrumbs = [];
         if ($this->_scopeConfig->getValue('web/default/show_cms_breadcrumbs', ScopeInterface::SCOPE_STORE)
             && ($breadcrumbsBlock = $this->getLayout()->getBlock('breadcrumbs'))

Release note

No response

Triage and priority

[X] Severity: S0 - Affects critical data or functionality and leaves users without workaround.
[ ] Severity: S1 - Affects critical data or functionality and forces users to employ a workaround.
[ ] Severity: S2 - Affects non-critical data or functionality and forces users to employ a workaround.
[ ] Severity: S3 - Affects non-critical data or functionality and does not force users to employ a workaround.
[ ] Severity: S4 - Affects aesthetics, professional look and feel, “quality” or “usability”.

m2-assistant[bot] commented 2 years ago

Hi @fredden. Thank you for your report. To speed up processing of this issue, make sure that you provided the following information:

Summary of the issue
Information on your environment
Steps to reproduce
Expected and actual results

Make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, Add a comment to the issue:

@magento give me 2.4-develop instance - upcoming 2.4.x release

For more details, review the Magento Contributor Assistant documentation.

Add a comment to assign the issue: @magento I am working on this

To learn more about issue processing workflow, refer to the Code Contributions.

Join Magento Community Engineering Slack and ask your questions in #github channel.

:warning: According to the Magento Contribution requirements, all issues must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.

:clock10: You can find the schedule on the Magento Community Calendar page.

:telephone_receiver: The triage of issues happens in the queue order. If you want to speed up the delivery of your contribution, join the Community Contributions Triage session to discuss the appropriate ticket.

:pencil2: Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel

m2-assistant[bot] commented 2 years ago

Hi @engcom-November. Thank you for working on this issue. In order to make sure that issue has enough information and ready for development, please read and check the following instruction: :point_down:

[ ] 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).
Details
If the issue has a valid description, the label Issue: Format is valid will be added to the issue automatically. Please, edit issue description if needed, until label Issue: Format is valid appears.
[ ] 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue. If the report is valid, add Issue: Clear Description label to the issue by yourself.
[ ] 3. Add Component: XXXXX label(s) to the ticket, indicating the components it may be related to.
[ ] 4. Verify that the issue is reproducible on 2.4-develop branch
Details
- Add the comment @magento give me 2.4-develop instance to deploy test instance on Magento infrastructure.
- If the issue is reproducible on 2.4-develop branch, please, add the label Reproduced on 2.4.x.
- If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!
[ ] 5. Add label Issue: Confirmed once verification is complete.
[ ] 6. Make sure that automatic system confirms that report has been added to the backlog.

engcom-November commented 2 years ago

Hi @fredden , Thank you for reporting and collaboration. Verified the issue on Magento 2.4-develop branch with enterprise edition modules enabled and the issue is reproducible. Breadcrumbs from CMS Page Hierarchy getting displayed even after disabling page Hierarchy Functionality Clicking on the node gives 404 error

github-jira-sync-bot commented 2 years ago

:white_check_mark: Jira issue https://jira.corp.magento.com/browse/AC-3167 is successfully created for this GitHub issue.

m2-assistant[bot] commented 2 years ago

:white_check_mark: Confirmed by @engcom-November. Thank you for verifying the issue.
Issue Available: @engcom-November, You will be automatically unassigned. Contributors/Maintainers can claim this issue to continue. To reclaim and continue work, reassign the ticket to yourself.

glo17680 commented 2 years ago

@fredden thanks for contributing, internal team has started working on this.

engcom-Hotel commented 2 years ago

Hello,

As I can see this issue got fixed in the scope of the internal Jira ticket AC-3167 by the internal team Related commits: https://github.com/magento/magento2/search?q=AC-3167&type=commits

Based on the Jira ticket, the target version is 2.4.6.

Thanks

magento / magento2