MC-35212: Unable to save "No layout updates" for category

Author: yelahin-serhiy

app/code/Magento/Catalog/Model/Plugin/SetPageLayoutDefaultValue.php

@@ -11,7 +11,10 @@
 namespace Magento\Catalog\Model\Plugin;
 
 use Magento\Catalog\Model\Category\DataProvider;
+use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Framework\Exception\NoSuchEntityException;
+use Magento\Store\Model\ScopeInterface;
+use Magento\Store\Model\StoreManagerInterface;
 
 /**
  * Sets the default value for Category Design Layout if provided
@@ -21,11 +24,28 @@ class SetPageLayoutDefaultValue
     private $defaultValue;
 
     /**
+     * @var StoreManagerInterface
+     */
+    private $storeManager;
+
+    /**
+     * @var ScopeConfigInterface
+     */
+    private $scopeConfig;
+
+    /**
+     * @param ScopeConfigInterface $scopeConfig
+     * @param StoreManagerInterface $storeManager
      * @param string $defaultValue
      */
-    public function __construct(string $defaultValue = "")
-    {
+    public function __construct(
+        ScopeConfigInterface $scopeConfig,
+        StoreManagerInterface $storeManager,
+        string $defaultValue = ""
+    ) {
         $this->defaultValue = $defaultValue;
+        $this->scopeConfig = $scopeConfig;
+        $this->storeManager = $storeManager;
     }
 
     /**
@@ -42,7 +62,15 @@ public function afterGetDefaultMetaData(DataProvider $subject, array $result): a
         $currentCategory = $subject->getCurrentCategory();
 
         if ($currentCategory && !$currentCategory->getId() && array_key_exists('page_layout', $result)) {
-            $result['page_layout']['default'] = $this->defaultValue ?: null;
+            $defaultAdminValue = $this->scopeConfig->getValue(
+                'web/default_layouts/default_category_layout',
+                ScopeInterface::SCOPE_STORE,
+                $this->storeManager->getStore()->getId()
+            );
+
+            $defaultValue = $defaultAdminValue ?: $this->defaultValue;
+
+            $result['page_layout']['default'] = $defaultValue ?: null;
         }
 
         return $result;

app/code/Magento/Catalog/view/adminhtml/ui_component/category_form.xml

@@ -470,7 +470,7 @@
                 </imports>
             </settings>
         </field>
-        <field name="page_layout" sortOrder="190" formElement="select" component="Magento_Catalog/js/components/use-parent-settings/select" class="Magento\Catalog\Ui\Component\Form\Field\Category\PageLayout">
+        <field name="page_layout" sortOrder="190" formElement="select" component="Magento_Catalog/js/components/use-parent-settings/select">
             <settings>
                 <dataType>string</dataType>
                 <label translate="true">Layout</label>

dev/tests/integration/testsuite/Magento/Catalog/Model/Category/DataProviderTest.php

@@ -3,15 +3,20 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 namespace Magento\Catalog\Model\Category;
 
+use Magento\Catalog\Model\Category;
+use Magento\Catalog\Model\Category\Attribute\Backend\LayoutUpdate;
+use Magento\Catalog\Model\CategoryFactory;
+use Magento\Framework\App\Config\ScopeConfigInterface;
+use Magento\Framework\Exception\NoSuchEntityException;
+use Magento\Framework\Registry;
+use Magento\Store\Model\ScopeInterface;
+use Magento\Store\Model\StoreManagerInterface;
 use Magento\TestFramework\Catalog\Model\CategoryLayoutUpdateManager;
 use Magento\TestFramework\Helper\Bootstrap;
-use Magento\Framework\Registry;
 use PHPUnit\Framework\TestCase;
-use Magento\Catalog\Model\Category;
-use Magento\Catalog\Model\CategoryFactory;
-use Magento\Catalog\Model\Category\Attribute\Backend\LayoutUpdate;
 
 /**
  * @magentoDbIsolation enabled
@@ -40,6 +45,16 @@ class DataProviderTest extends TestCase
      */
     private $fakeFiles;
 
+    /**
+     * @var ScopeConfigInterface
+     */
+    private $scopeConfig;
+
+    /**
+     * @var StoreManagerInterface
+     */
+    private $storeManager;
+
     /**
      * Create subject instance.
      *
@@ -58,7 +73,7 @@ private function createDataProvider(): DataProvider
     }
 
     /**
-     * {@inheritDoc}
+     * @inheritDoc
      */
     protected function setUp(): void
     {
@@ -68,12 +83,14 @@ protected function setUp(): void
         $this->registry = $objectManager->get(Registry::class);
         $this->categoryFactory = $objectManager->get(CategoryFactory::class);
         $this->fakeFiles = $objectManager->get(CategoryLayoutUpdateManager::class);
+        $this->scopeConfig = $objectManager->get(ScopeConfigInterface::class);
+        $this->storeManager = $objectManager->get(StoreManagerInterface::class);
     }
 
     /**
      * @return void
      */
-    public function testGetMetaRequiredAttributes()
+    public function testGetMetaRequiredAttributes(): void
     {
         $requiredAttributes = [
             'general' => ['name'],
@@ -221,4 +238,48 @@ public function testCustomLayoutMeta(): void
         sort($list);
         $this->assertEquals($expectedList, $list);
     }
+
+    /**
+     * Check if existing category page layout will remain unaffected by category page layout default value setting
+     *
+     * @return void
+     */
+    public function testExistingCategoryLayoutUnaffectedByDefaults(): void
+    {
+        /** @var Category $category */
+        $category = $this->categoryFactory->create();
+        $category->load(2);
+
+        $this->registry->register('category', $category);
+        $meta = $this->dataProvider->getMeta();
+        $categoryPageLayout = $meta["design"]["children"]["page_layout"]["arguments"]["data"]["config"]["default"];
+        $this->registry->unregister('category');
+
+        $this->assertNull($categoryPageLayout);
+    }
+
+    /**
+     * Check if category page layout default value setting will apply to the new category during it's creation
+     *
+     * @throws NoSuchEntityException
+     */
+    public function testNewCategoryLayoutMatchesDefault(): void
+    {
+        $categoryDefaultPageLayout = $this->scopeConfig->getValue(
+            'web/default_layouts/default_category_layout',
+            ScopeInterface::SCOPE_STORE,
+            $this->storeManager->getStore()->getId()
+        );
+
+        /** @var Category $category */
+        $category = $this->categoryFactory->create();
+        $category->setName('Net Test Category');
+
+        $this->registry->register('category', $category);
+        $meta = $this->dataProvider->getMeta();
+        $categoryPageLayout = $meta["design"]["children"]["page_layout"]["arguments"]["data"]["config"]["default"];
+        $this->registry->unregister('category');
+
+        $this->assertEquals($categoryDefaultPageLayout, $categoryPageLayout);
+    }
 }