ACP2E-212: Customer Grid loading on the Admin Order creation page is slow

- fix
- add test

Author: o-dubovyk

app/code/Magento/Sales/Model/ResourceModel/Order/Customer/Collection.php

@@ -7,9 +7,89 @@
  */
 namespace Magento\Sales\Model\ResourceModel\Order\Customer;
 
+use Magento\Eav\Model\Config as EavConfig;
+use Magento\Eav\Model\EntityFactory as EavEntityFactory;
+use Magento\Eav\Model\ResourceModel\Helper;
+use Magento\Framework\App\ResourceConnection;
+use Magento\Framework\Data\Collection\Db\FetchStrategyInterface;
+use Magento\Framework\Data\Collection\EntityFactory;
+use Magento\Framework\DataObject;
+use Magento\Framework\DataObject\Copy\Config;
+use Magento\Framework\DB\Adapter\AdapterInterface;
+use Magento\Framework\Event\ManagerInterface;
+use Magento\Framework\Model\ResourceModel\Db\VersionControl\Snapshot;
+use Magento\Framework\Validator\UniversalFactory;
+use Magento\Store\Model\StoreManagerInterface;
+use Psr\Log\LoggerInterface;
+
+/**
+ * Customer collection
+ *
+ * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ */
 class Collection extends \Magento\Customer\Model\ResourceModel\Customer\Collection
 {
     /**
+     * @var StoreManagerInterface
+     */
+    private $storeManager;
+
+    /**
+     * Constructor
+     *
+     * @param EntityFactory $entityFactory
+     * @param LoggerInterface $logger
+     * @param FetchStrategyInterface $fetchStrategy
+     * @param ManagerInterface $eventManager
+     * @param EavConfig $eavConfig
+     * @param ResourceConnection $resource
+     * @param EavEntityFactory $eavEntityFactory
+     * @param Helper $resourceHelper
+     * @param UniversalFactory $universalFactory
+     * @param Snapshot $entitySnapshot
+     * @param Config $fieldsetConfig
+     * @param StoreManagerInterface $storeManager
+     * @param AdapterInterface|null $connection
+     * @param string $modelName
+     * @SuppressWarnings(PHPMD.ExcessiveParameterList)
+     */
+    public function __construct(
+        EntityFactory $entityFactory,
+        LoggerInterface $logger,
+        FetchStrategyInterface $fetchStrategy,
+        ManagerInterface $eventManager,
+        EavConfig $eavConfig,
+        ResourceConnection $resource,
+        EavEntityFactory $eavEntityFactory,
+        Helper $resourceHelper,
+        UniversalFactory $universalFactory,
+        Snapshot $entitySnapshot,
+        Config $fieldsetConfig,
+        StoreManagerInterface $storeManager,
+        AdapterInterface $connection = null,
+        $modelName = self::CUSTOMER_MODEL_NAME
+    ) {
+        $this->storeManager = $storeManager;
+        parent::__construct(
+            $entityFactory,
+            $logger,
+            $fetchStrategy,
+            $eventManager,
+            $eavConfig,
+            $resource,
+            $eavEntityFactory,
+            $resourceHelper,
+            $universalFactory,
+            $entitySnapshot,
+            $fieldsetConfig,
+            $connection,
+            $modelName
+        );
+    }
+
+    /**
+     * Init select
+     *
      * @return $this
      */
     protected function _initSelect()
@@ -49,21 +129,31 @@ protected function _initSelect()
             'default_billing',
             null,
             'left'
-        )->joinField(
-            'store_name',
-            'store',
-            'name',
-            'store_id=store_id',
-            null,
-            'left'
-        )->joinField(
-            'website_name',
-            'store_website',
-            'name',
-            'website_id=website_id',
-            null,
-            'left'
         );
         return $this;
     }
+
+    /**
+     * Performance issue fix for large number (over million) of customers on Orders Creation page in Admin
+     *
+     * Initially _initSelect method of this collection had two joins to Store and Website
+     * tables on store_id and website_id to add store and website names. This caused extreme performance drop
+     * resulting in loading page over minute, despite all optimizations were already in place.
+     * To fix the issue the joins were removed, instead store and website names are added in this method.
+     *
+     * @param DataObject $item
+     * @return DataObject
+     */
+    protected function beforeAddLoadedItem(DataObject $item): DataObject
+    {
+        $storeId = $item->getStoreId();
+        $storeName = $storeId !== null ? $this->storeManager->getStore($storeId)->getName() : null;
+        $item->setStoreName($storeName);
+
+        $websiteId = $item->getWebsiteId();
+        $websiteName = $websiteId !== null ? $this->storeManager->getWebsite($websiteId)->getName() : null;
+        $item->setWebsiteName($websiteName);
+
+        return parent::beforeAddLoadedItem($item);
+    }
 }

dev/tests/integration/testsuite/Magento/Sales/Model/ResourceModel/Order/Customer/CollectionTest.php

@@ -0,0 +1,53 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Sales\Model\ResourceModel\Order\Customer;
+
+use Magento\Framework\ObjectManagerInterface;
+use Magento\Store\Api\StoreRepositoryInterface;
+use Magento\Store\Api\WebsiteRepositoryInterface;
+use Magento\TestFramework\Helper\Bootstrap;
+use PHPUnit\Framework\TestCase;
+
+class CollectionTest extends TestCase
+{
+    /**
+     * @var ObjectManagerInterface
+     */
+    private $objectManager;
+
+    /**
+     * @inheritDoc
+     */
+    protected function setUp(): void
+    {
+        $this->objectManager = Bootstrap::getObjectManager();
+    }
+
+    /**
+     * Tests that Customer collection data for Order retain website and store names after fixing performance issue.
+     * @see \Magento\Customer\Model\ResourceModel\Customer\Collection::beforeAddLoadedItem()
+     *
+     * @magentoDataFixture Magento/Customer/_files/customer_for_second_website.php
+     */
+    public function testCollection(): void
+    {
+        /** @var Collection $customerCollection */
+        $customerCollection = $this->objectManager->create(Collection::class);
+        $customer = $customerCollection->getItems();
+        $customer = array_shift($customer);
+        /** @var WebsiteRepositoryInterface $websiteRepository */
+        $websiteRepository = $this->objectManager->get(WebsiteRepositoryInterface::class);
+        $website = $websiteRepository->getById($customer->getWebsiteId());
+        /** @var StoreRepositoryInterface $storeRepository */
+        $storeRepository = $this->objectManager->get(StoreRepositoryInterface::class);
+        $store = $storeRepository->getById($customer->getStoreId());
+
+        $this->assertEquals($website->getName(), $customer->getWebsiteName());
+        $this->assertEquals($store->getName(), $customer->getStoreName());
+    }
+}