ACP2E-156: Merchants can create custom attribute, but it causes an error when trying to save an entity account

- fix
- add test

Author: o-dubovyk

app/code/Magento/Catalog/Model/Product/ReservedAttributeCheckerAdapter.php

@@ -0,0 +1,43 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Catalog\Model\Product;
+
+use Magento\Eav\Model\Entity\Attribute\AbstractAttribute;
+use Magento\Eav\Model\ReservedAttributeCheckerInterface;
+
+/**
+ * Adapter for \Magento\Catalog\Model\Product\ReservedAttributeList
+ *
+ * Is created to implement proper interface and to use api class ReservedAttributeList
+ * while keeping it backward compatible
+ * @see \Magento\Catalog\Model\Product\ReservedAttributeList
+ */
+class ReservedAttributeCheckerAdapter implements ReservedAttributeCheckerInterface
+{
+    /**
+     * @var ReservedAttributeList
+     */
+    protected $reservedAttributeList;
+
+    /**
+     * @param ReservedAttributeList $reservedAttributeList
+     */
+    public function __construct(
+        ReservedAttributeList $reservedAttributeList
+    ) {
+        $this->reservedAttributeList = $reservedAttributeList;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function isReservedAttribute(AbstractAttribute $attribute): bool
+    {
+        return $this->reservedAttributeList->isReservedAttribute($attribute);
+    }
+}

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

@@ -1333,4 +1333,13 @@
             <argument name="imageResizeScheduler" xsi:type="object">Magento\MediaStorage\Service\ImageResizeScheduler\Proxy</argument>
         </arguments>
     </type>
+    <type name="Magento\Eav\Model\ReservedAttributeChecker">
+        <arguments>
+            <argument name="validators" xsi:type="array">
+                <item name="catalog_product" xsi:type="array">
+                    <item name="product_reserved_attribute_codes" xsi:type="object">\Magento\Catalog\Model\Product\ReservedAttributeCheckerAdapter</item>
+                </item>
+            </argument>
+        </arguments>
+    </type>
 </config>

app/code/Magento/Eav/Model/ReservedAttributeChecker.php

@@ -0,0 +1,55 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Eav\Model;
+
+use Magento\Eav\Model\Entity\Attribute\AbstractAttribute;
+use Magento\Framework\Exception\LocalizedException;
+
+/**
+ * Composite Reserved Attribute Checker
+ *
+ * Iterates through individual Reserved Attribute Checkers to check whether attribute is reserved by system
+ */
+class ReservedAttributeChecker implements ReservedAttributeCheckerInterface
+{
+    /**
+     * @var ReservedAttributeCheckerInterface[][]
+     */
+    private $validators;
+
+    /**
+     * @param array $validators
+     */
+    public function __construct(
+        $validators = []
+    ) {
+        $this->validators = $validators;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function isReservedAttribute(AbstractAttribute $attribute): bool
+    {
+        $isReserved = false;
+        try {
+            $attribute->getEntityType();
+        } catch (LocalizedException $exception) {
+            $isReserved = false;
+        }
+        $validators = $this->validators[$attribute->getEntityType()->getEntityTypeCode()] ?? [];
+        foreach ($validators as $validator) {
+            $isReserved = $validator->isReservedAttribute($attribute);
+            if ($isReserved === true) {
+                break;
+            }
+        }
+
+        return $isReserved;
+    }
+}

app/code/Magento/Eav/Model/ReservedAttributeCheckerInterface.php

@@ -0,0 +1,27 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Eav\Model;
+
+use Magento\Eav\Model\Entity\Attribute\AbstractAttribute;
+
+/**
+ * Checks whether attribute is reserved by system
+ */
+interface ReservedAttributeCheckerInterface
+{
+    /**
+     * Check whether attribute is reserved by system.
+     *
+     * Check that given user defined EAV attribute doesn't contain the attribute code
+     * that matches to a getter field related to related model (e.g. product, category, customer...)
+     *
+     * @param AbstractAttribute $attribute
+     * @return bool
+     */
+    public function isReservedAttribute(AbstractAttribute $attribute): bool;
+}

app/code/Magento/Eav/Setup/EavSetup.php

@@ -6,8 +6,12 @@
 
 namespace Magento\Eav\Setup;
 
+use Magento\Eav\Model\AttributeFactory;
+use Magento\Eav\Model\Config;
+use Magento\Eav\Model\Entity\Attribute;
 use Magento\Eav\Model\Entity\Setup\Context;
 use Magento\Eav\Model\Entity\Setup\PropertyMapperInterface;
+use Magento\Eav\Model\ReservedAttributeChecker;
 use Magento\Eav\Model\ResourceModel\Entity\Attribute\Group\CollectionFactory;
 use Magento\Eav\Model\Validator\Attribute\Code;
 use Magento\Framework\App\CacheInterface;
@@ -27,57 +31,41 @@
 class EavSetup
 {
     /**
-     * Cache
-     *
      * @var CacheInterface
      */
     private $cache;
 
     /**
-     * Attribute group collection factory
-     *
      * @var CollectionFactory
      */
     private $attrGroupCollectionFactory;
 
     /**
-     * Attribute mapper
-     *
      * @var PropertyMapperInterface
      */
     private $attributeMapper;
 
     /**
-     * Setup model
-     *
      * @var ModuleDataSetupInterface
      */
     private $setup;
 
     /**
-     * General Attribute Group Name
-     *
      * @var string
      */
     private $_generalGroupName = 'General';
 
     /**
-     * Default attribute group name to id pairs
-     *
      * @var array
      */
     private $defaultGroupIdAssociations = ['general' => 1];
 
     /**
-     * Default attribute group name
-     *
      * @var string
      */
     private $_defaultGroupName = 'Default';
 
     /**
-     * Default attribute set name
-     *
      * @var string
      */
     private $_defaultAttributeSetName = 'Default';
@@ -92,6 +80,21 @@ class EavSetup
      */
     private $attributeCodeValidator;
 
+    /**
+     * @var ReservedAttributeChecker
+     */
+    private $reservedAttributeChecker;
+
+    /**
+     * @var AttributeFactory
+     */
+    private $attributeFactory;
+
+    /**
+     * @var Config|null
+     */
+    private $eavConfig;
+
     /**
      * Init
      *
@@ -101,6 +104,9 @@ class EavSetup
      * @param CollectionFactory $attrGroupCollectionFactory
      * @param Code|null $attributeCodeValidator
      * @param AddOptionToAttribute|null $addAttributeOption
+     * @param ReservedAttributeChecker|null $reservedAttributeChecker
+     * @param AttributeFactory|null $attributeFactory
+     * @param Config|null $eavConfig
      * @SuppressWarnings(PHPMD.LongVariable)
      */
     public function __construct(
@@ -109,17 +115,22 @@ public function __construct(
         CacheInterface $cache,
         CollectionFactory $attrGroupCollectionFactory,
         Code $attributeCodeValidator = null,
-        AddOptionToAttribute $addAttributeOption = null
+        AddOptionToAttribute $addAttributeOption = null,
+        ReservedAttributeChecker $reservedAttributeChecker = null,
+        AttributeFactory $attributeFactory = null,
+        Config $eavConfig = null
     ) {
         $this->cache = $cache;
         $this->attrGroupCollectionFactory = $attrGroupCollectionFactory;
         $this->attributeMapper = $context->getAttributeMapper();
         $this->setup = $setup;
         $this->addAttributeOption = $addAttributeOption
             ?? ObjectManager::getInstance()->get(AddOptionToAttribute::class);
-        $this->attributeCodeValidator = $attributeCodeValidator ?: ObjectManager::getInstance()->get(
-            Code::class
-        );
+        $this->attributeCodeValidator = $attributeCodeValidator ?? ObjectManager::getInstance()->get(Code::class);
+        $this->reservedAttributeChecker = $reservedAttributeChecker
+            ?? ObjectManager::getInstance()->get(ReservedAttributeChecker::class);
+        $this->attributeFactory = $attributeFactory ?? ObjectManager::getInstance()->get(AttributeFactory::class);
+        $this->eavConfig = $eavConfig ?? ObjectManager::getInstance()->get(Config::class);
     }
 
     /**
@@ -1364,7 +1375,7 @@ public function installEntities($entities = null)
 
         foreach ($entities as $entityName => $entity) {
             $this->addEntityType($entityName, $entity);
-
+            $this->eavConfig->clear();
             $frontendPrefix = isset($entity['frontend_prefix']) ? $entity['frontend_prefix'] : '';
             $backendPrefix = isset($entity['backend_prefix']) ? $entity['backend_prefix'] : '';
             $sourcePrefix = isset($entity['source_prefix']) ? $entity['source_prefix'] : '';
@@ -1503,5 +1514,16 @@ private function validateAttributeCode(array $data): void
 
             throw new LocalizedException(__($errorMessage));
         }
+
+        /* Actual attribute is created from data array for compatibility with reserved attribute validator logic */
+        $attribute = $this->attributeFactory->createAttribute(Attribute::class, $data);
+        if ($this->reservedAttributeChecker->isReservedAttribute($attribute)) {
+            throw new LocalizedException(
+                __(
+                    'The attribute code \'%1\' is reserved by system. Please try another attribute code',
+                    $attributeCode
+                )
+            );
+        }
     }
 }