ENGCOM-5690: Standardize the array structure for the getAttributes result #23818

Author: sidolov

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

@@ -3,6 +3,7 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
 
 namespace Magento\Eav\Model;
 
@@ -52,7 +53,7 @@ public function __construct(
      * Returns array of fields
      *
      * @param string $entityType
-     * @return array
+     * @return string[]
      * @throws \Exception
      */
     public function getAttributes($entityType)
@@ -66,6 +67,7 @@ public function getAttributes($entityType)
         foreach ($searchResult->getItems() as $attribute) {
             $attributes[] = $attribute->getAttributeCode();
         }
+
         return $attributes;
     }
 }

lib/internal/Magento/Framework/Model/EntitySnapshot.php

@@ -3,6 +3,7 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
 
 namespace Magento\Framework\Model;
 
@@ -44,6 +45,8 @@ public function __construct(
     }
 
     /**
+     * Register snapshot of entity data.
+     *
      * @param string $entityType
      * @param object $entity
      * @return void
@@ -55,7 +58,7 @@ public function registerSnapshot($entityType, $entity)
         $entityData = $hydrator->extract($entity);
         $attributes = $this->attributeProvider->getAttributes($entityType);
         $this->snapshotData[$entityType][$entityData[$metadata->getIdentifierField()]]
-            = array_intersect_key($entityData, $attributes);
+            = array_intersect(\array_keys($entityData), $attributes);
     }
 
     /**

lib/internal/Magento/Framework/Model/EntitySnapshot/AttributeProvider.php

@@ -3,6 +3,7 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
 
 namespace Magento\Framework\Model\EntitySnapshot;
 
@@ -53,31 +54,29 @@ public function __construct(
      * Returns array of fields
      *
      * @param string $entityType
-     * @return array
+     * @return string[]
      * @throws \Exception
      */
     public function getAttributes($entityType)
     {
         if (!isset($this->registry[$entityType])) {
             $metadata = $this->metadataPool->getMetadata($entityType);
-            $this->registry[$entityType] = $metadata->getEntityConnection()->describeTable($metadata->getEntityTable());
-            if ($metadata->getLinkField() != $metadata->getIdentifierField()) {
-                unset($this->registry[$entityType][$metadata->getLinkField()]);
-            }
-            $providers = [];
-            if (isset($this->providers[$entityType])) {
-                $providers = $this->providers[$entityType];
-            } elseif (isset($this->providers['default'])) {
-                $providers = $this->providers['default'];
+            $entityDescription = $metadata->getEntityConnection()->describeTable($metadata->getEntityTable());
+            if ($metadata->getLinkField() !== $metadata->getIdentifierField()) {
+                unset($entityDescription[$metadata->getLinkField()]);
             }
+            $attributes = [];
+            $attributes[] = \array_keys($entityDescription);
+
+            $providers = $this->providers[$entityType] ?? $this->providers['default'] ?? [];
             foreach ($providers as $providerClass) {
                 $provider = $this->objectManager->get($providerClass);
-                $this->registry[$entityType] = array_merge(
-                    $this->registry[$entityType],
-                    $provider->getAttributes($entityType)
-                );
+                $attributes[] = $provider->getAttributes($entityType);
             }
+
+            $this->registry[$entityType] = \array_merge(...$attributes);
         }
+
         return $this->registry[$entityType];
     }
 }

lib/internal/Magento/Framework/Model/EntitySnapshot/AttributeProviderInterface.php

@@ -3,6 +3,7 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
 
 namespace Magento\Framework\Model\EntitySnapshot;
 
@@ -12,8 +13,10 @@
 interface AttributeProviderInterface
 {
     /**
+     * Returns array of fields
+     *
      * @param string $entityType
-     * @return array
+     * @return string[]
      */
     public function getAttributes($entityType);
 }