improved cms page custom layout update logic

Author: Vaha

app/code/Magento/Cms/Model/Page/CustomLayout/CustomLayoutManager.php

@@ -147,7 +147,8 @@ public function applyUpdate(PageLayout $layout, CustomLayoutSelectedInterface $l
         }
 
         $layout->addPageLayoutHandles(
-            ['selectable' => $this->sanitizeIdentifier($page) .'_' .$layoutSelected->getLayoutFileId()]
+            ['selectable' => $this->sanitizeIdentifier($page) .'_' .$layoutSelected->getLayoutFileId()],
+            'cms_page_view'
         );
     }
 }

dev/tests/integration/testsuite/Magento/Cms/Controller/PageTest.php

@@ -85,4 +85,20 @@ public function testCustomHandles(): void
         $handles = $layout->getUpdate()->getHandles();
         $this->assertContains('cms_page_view_selectable_test_custom_layout_page_3_test_selected', $handles);
     }
+
+    /**
+     * Check home page custom handle is applied when rendering a page.
+     *
+     * @return void
+     * @throws \Throwable
+     * @magentoDataFixture Magento/Cms/_files/home_with_custom_handle.php
+     */
+    public function testHomePageCustomHandles(): void
+    {
+        $this->dispatch('/');
+        /** @var LayoutInterface $layout */
+        $layout = Bootstrap::getObjectManager()->get(LayoutInterface::class);
+        $handles = $layout->getUpdate()->getHandles();
+        $this->assertContains('cms_page_view_selectable_home_page_custom_layout', $handles);
+    }
 }

dev/tests/integration/testsuite/Magento/Cms/Model/Page/CustomLayoutManagerTest.php

@@ -97,6 +97,9 @@ public function testCustomLayoutUpdate(): void
         $result = $this->resultFactory->create();
         $this->manager->applyUpdate($result, $this->repo->getFor($pageId));
         $this->identityMap->remove((int)$page->getId());
-        $this->assertContains('___selectable_page100_select2', $result->getLayout()->getUpdate()->getHandles());
+        $this->assertContains(
+            'cms_page_view_selectable_page100_select2',
+            $result->getLayout()->getUpdate()->getHandles()
+        );
     }
 }

dev/tests/integration/testsuite/Magento/Cms/_files/home_with_custom_handle.php

@@ -0,0 +1,30 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+use Magento\Cms\Model\Page as PageModel;
+use Magento\Cms\Model\PageFactory as PageModelFactory;
+use Magento\TestFramework\Cms\Model\CustomLayoutManager;
+use Magento\TestFramework\Helper\Bootstrap;
+
+$objectManager = Bootstrap::getObjectManager();
+
+/** @var PageModelFactory $pageFactory */
+$pageFactory = $objectManager->get(PageModelFactory::class);
+/** @var CustomLayoutManager $fakeManager */
+$fakeManager = $objectManager->get(CustomLayoutManager::class);
+$layoutRepo = $objectManager->create(PageModel\CustomLayoutRepositoryInterface::class, ['manager' => $fakeManager]);
+
+$customLayoutName = 'page_custom_layout';
+
+/** @var PageModel $page */
+$page = $pageFactory->create(['customLayoutRepository' => $layoutRepo]);
+$page->load('home');
+$cmsPageId = (int)$page->getId();
+
+$fakeManager->fakeAvailableFiles($cmsPageId, [$customLayoutName]);
+$page->setData('layout_update_selected', $customLayoutName);
+$page->save();

dev/tests/integration/testsuite/Magento/Cms/_files/home_with_custom_handle_rollback.php

@@ -0,0 +1,21 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+use Magento\Cms\Api\PageRepositoryInterface;
+use Magento\Cms\Model\Page\CustomLayout\CustomLayoutRepository;
+use Magento\TestFramework\Helper\Bootstrap;
+
+$objectManager = Bootstrap::getObjectManager();
+
+/** @var PageRepositoryInterface $pageRepository */
+$pageRepository = $objectManager->get(PageRepositoryInterface::class);
+$cmsPage = $pageRepository->getById('home');
+$cmsPageId = (int)$cmsPage->getId();
+
+/** @var CustomLayoutRepository $customLayoutRepository */
+$customLayoutRepository = $objectManager->get(CustomLayoutRepository::class);
+$customLayoutRepository->deleteFor($cmsPageId);