ENGCOM-8311: Replace hard-coded list of category attributes #28216

Author: gabrieldagama

app/code/Magento/Catalog/Model/Category/DataProvider.php

@@ -22,6 +22,8 @@
 use Magento\Eav\Model\Entity\Type;
 use Magento\Framework\App\ObjectManager;
 use Magento\Framework\App\RequestInterface;
+use Magento\Framework\AuthorizationInterface;
+use Magento\Framework\Config\DataInterfaceFactory;
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\Framework\Registry;
@@ -32,7 +34,6 @@
 use Magento\Ui\Component\Form\Field;
 use Magento\Ui\DataProvider\EavValidationRules;
 use Magento\Ui\DataProvider\Modifier\PoolInterface;
-use Magento\Framework\AuthorizationInterface;
 use Magento\Ui\DataProvider\ModifierPoolDataProvider;
 
 /**
@@ -153,6 +154,11 @@ class DataProvider extends ModifierPoolDataProvider
      */
     private $categoryFactory;
 
+    /**
+     * @var DataInterfaceFactory
+     */
+    private $uiConfigFactory;
+
     /**
      * @var ScopeOverriddenValue
      */
@@ -177,6 +183,7 @@ class DataProvider extends ModifierPoolDataProvider
      * @var AuthorizationInterface
      */
     private $auth;
+
     /**
      * @var Image
      */
@@ -202,6 +209,7 @@ class DataProvider extends ModifierPoolDataProvider
      * @param ArrayManager|null $arrayManager
      * @param FileInfo|null $fileInfo
      * @param Image|null $categoryImage
+     * @param DataInterfaceFactory|null $uiConfigFactory
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
@@ -223,7 +231,8 @@ public function __construct(
         ScopeOverriddenValue $scopeOverriddenValue = null,
         ArrayManager $arrayManager = null,
         FileInfo $fileInfo = null,
-        ?Image $categoryImage = null
+        ?Image $categoryImage = null,
+        ?DataInterfaceFactory $uiConfigFactory = null
     ) {
         $this->eavValidationRules = $eavValidationRules;
         $this->collection = $categoryCollectionFactory->create();
@@ -240,6 +249,10 @@ public function __construct(
         $this->arrayManager = $arrayManager ?: ObjectManager::getInstance()->get(ArrayManager::class);
         $this->fileInfo = $fileInfo ?: ObjectManager::getInstance()->get(FileInfo::class);
         $this->categoryImage = $categoryImage ?? ObjectManager::getInstance()->get(Image::class);
+        $this->uiConfigFactory = $uiConfigFactory ?? ObjectManager::getInstance()->create(
+            DataInterfaceFactory::class,
+            ['instanceName' => \Magento\Ui\Config\Data::class]
+        );
 
         parent::__construct($name, $primaryFieldName, $requestFieldName, $meta, $data, $pool);
     }
@@ -611,7 +624,7 @@ private function convertValues($category, $categoryData): array
 
                     $categoryData[$attributeCode][0]['url'] = $this->categoryImage->getUrl($category, $attributeCode);
 
-                    $categoryData[$attributeCode][0]['size'] = isset($stat) ? $stat['size'] : 0;
+                    $categoryData[$attributeCode][0]['size'] = $stat['size'];
                     $categoryData[$attributeCode][0]['type'] = $mime;
                 }
             }
@@ -645,56 +658,42 @@ public function getDefaultMetaData($result)
      */
     protected function getFieldsMap()
     {
-        return [
-            'general' => [
-                'parent',
-                'path',
-                'is_active',
-                'include_in_menu',
-                'name',
-            ],
-            'content' => [
-                'image',
-                'description',
-                'landing_page',
-            ],
-            'display_settings' => [
-                'display_mode',
-                'is_anchor',
-                'available_sort_by',
-                'use_config.available_sort_by',
-                'default_sort_by',
-                'use_config.default_sort_by',
-                'filter_price_range',
-                'use_config.filter_price_range',
-            ],
-            'search_engine_optimization' => [
-                'url_key',
-                'url_key_create_redirect',
-                'url_key_group',
-                'meta_title',
-                'meta_keywords',
-                'meta_description',
-            ],
-            'assign_products' => [
-            ],
-            'design' => [
-                'custom_use_parent_settings',
-                'custom_apply_to_products',
-                'custom_design',
-                'page_layout',
-                'custom_layout_update',
-                'custom_layout_update_file'
-            ],
-            'schedule_design_update' => [
-                'custom_design_from',
-                'custom_design_to',
-            ],
-            'category_view_optimization' => [
-            ],
-            'category_permissions' => [
-            ],
-        ];
+        $referenceName = 'category_form';
+        $config = $this->uiConfigFactory
+            ->create(['componentName' => $referenceName])
+            ->get($referenceName);
+
+        if (empty($config)) {
+            return [];
+        }
+
+        $fieldsMap = [];
+
+        foreach ($config['children'] as $group => $node) {
+            // Skip disabled components (required for Commerce Edition)
+            if ($node['arguments']['data']['config']['componentDisabled'] ?? false) {
+                continue;
+            }
+
+            $fields = [];
+
+            foreach ($node['children'] as $childName => $childNode) {
+                if (!empty($childNode['children'])) {
+                    // <container/> nodes need special handling
+                    foreach (array_keys($childNode['children']) as $grandchildName) {
+                        $fields[] = $grandchildName;
+                    }
+                } else {
+                    $fields[] = $childName;
+                }
+            }
+
+            if (!empty($fields)) {
+                $fieldsMap[$group] = $fields;
+            }
+        }
+
+        return $fieldsMap;
     }
 
     /**

app/code/Magento/Catalog/Test/Unit/Model/Category/DataProviderTest.php

@@ -20,6 +20,8 @@
 use Magento\Eav\Model\Entity\Type;
 use Magento\Framework\App\RequestInterface;
 use Magento\Framework\AuthorizationInterface;
+use Magento\Framework\Config\Data;
+use Magento\Framework\Config\DataInterfaceFactory;
 use Magento\Framework\Registry;
 use Magento\Framework\Stdlib\ArrayUtils;
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
@@ -70,6 +72,11 @@ class DataProviderTest extends TestCase
      */
     private $categoryFactory;
 
+    /**
+     * @var DataInterfaceFactory|MockObject
+     */
+    private $uiConfigFactory;
+
     /**
      * @var Collection|MockObject
      */
@@ -151,6 +158,15 @@ protected function setUp(): void
             ->disableOriginalConstructor()
             ->getMock();
 
+        $dataMock = $this->getMockBuilder(Data::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+        $this->uiConfigFactory = $this->getMockBuilder(DataInterfaceFactory::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+        $this->uiConfigFactory->method('create')
+            ->willReturn($dataMock);
+
         $this->fileInfo = $this->getMockBuilder(FileInfo::class)
             ->disableOriginalConstructor()
             ->getMock();
@@ -198,6 +214,7 @@ private function getModel()
                 'eavConfig' => $this->eavConfig,
                 'request' => $this->request,
                 'categoryFactory' => $this->categoryFactory,
+                'uiConfigFactory' => $this->uiConfigFactory,
                 'pool' => $this->modifierPool,
                 'auth' => $this->auth,
                 'arrayUtils' => $this->arrayUtils,

app/code/Magento/Catalog/etc/di.xml

@@ -80,6 +80,9 @@
         <plugin name="catalogLog" type="Magento\Catalog\Model\Plugin\Log" />
     </type>
     <type name="Magento\Catalog\Model\Category\DataProvider">
+        <arguments>
+            <argument name="uiConfigFactory" xsi:type="object">uiComponentConfigFactory</argument>
+        </arguments>
         <plugin name="set_page_layout_default_value" type="Magento\Catalog\Model\Plugin\SetPageLayoutDefaultValue" />
     </type>
     <type name="Magento\Theme\Block\Html\Topmenu">

dev/tests/integration/testsuite/Magento/CatalogUrlRewrite/Plugin/Catalog/Block/Adminhtml/Category/Tab/AttributesTest.php

@@ -9,6 +9,9 @@
 use Magento\Eav\Model\Config as EavConfig;
 use Magento\TestFramework\Helper\Bootstrap;
 
+/**
+ * @magentoAppArea adminhtml
+ */
 class AttributesTest extends \PHPUnit\Framework\TestCase
 {
     /**