Merge remote-tracking branch 'tango/MC-37630' into PR-10-14

dhorytskyi · dhorytskyi · commit 14a84d48954e · 2020-10-15T10:03:50.000-05:00
diff --git a/app/code/Magento/Theme/Model/Indexer/Design/IndexerHandler.php b/app/code/Magento/Theme/Model/Indexer/Design/IndexerHandler.php
@@ -0,0 +1,76 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\Theme\Model\Indexer\Design;
+
+use Magento\Framework\App\ResourceConnection;
+use Magento\Framework\Indexer\IndexStructureInterface;
+use Magento\Framework\Indexer\SaveHandler\Batch;
+use Magento\Framework\Indexer\SaveHandler\Grid;
+use Magento\Framework\Indexer\SaveHandler\IndexerInterface;
+use Magento\Framework\Indexer\ScopeResolver\FlatScopeResolver;
+use Magento\Framework\Indexer\ScopeResolver\IndexScopeResolver;
+use Magento\Framework\Search\Request\Dimension;
+
+class IndexerHandler extends Grid
+{
+    /**
+     * @var FlatScopeResolver
+     */
+    private $flatScopeResolver;
+
+    /**
+     * @param IndexStructureInterface $indexStructure
+     * @param ResourceConnection $resource
+     * @param Batch $batch
+     * @param IndexScopeResolver $indexScopeResolver
+     * @param FlatScopeResolver $flatScopeResolver
+     * @param array $data
+     * @param int $batchSize
+     */
+    public function __construct(
+        IndexStructureInterface $indexStructure,
+        ResourceConnection $resource,
+        Batch $batch,
+        IndexScopeResolver $indexScopeResolver,
+        FlatScopeResolver $flatScopeResolver,
+        array $data,
+        $batchSize = 100
+    ) {
+        parent::__construct(
+            $indexStructure,
+            $resource,
+            $batch,
+            $indexScopeResolver,
+            $flatScopeResolver,
+            $data,
+            $batchSize
+        );
+
+        $this->flatScopeResolver = $flatScopeResolver;
+    }
+
+    /**
+     * Clean index table by deleting all records unconditionally or create the index table if not exists
+     *
+     * @param Dimension[] $dimensions
+     * @return IndexerInterface
+     */
+    public function cleanIndex($dimensions)
+    {
+        $tableName = $this->flatScopeResolver->resolve($this->getIndexName(), $dimensions);
+
+        if ($this->connection->isTableExists($tableName)) {
+            $this->connection->delete($tableName);
+        } else {
+            $this->indexStructure->create($this->getIndexName(), $this->fields, $dimensions);
+        }
+
+        return $this;
+    }
+}
diff --git a/app/code/Magento/Theme/Test/Unit/Model/Indexer/Design/ConfigTest.php b/app/code/Magento/Theme/Test/Unit/Model/Indexer/Design/ConfigTest.php
@@ -10,82 +10,196 @@
  */
 namespace Magento\Theme\Test\Unit\Model\Indexer\Design;
 
+use Magento\Framework\App\ResourceConnection;
 use Magento\Framework\Data\Collection;
 use Magento\Framework\Indexer\FieldsetInterface;
 use Magento\Framework\Indexer\FieldsetPool;
 use Magento\Framework\Indexer\HandlerInterface;
 use Magento\Framework\Indexer\HandlerPool;
 use Magento\Framework\Indexer\IndexStructureInterface;
-use Magento\Framework\Indexer\SaveHandler\IndexerInterface;
+use Magento\Framework\Indexer\SaveHandler\Batch;
 use Magento\Framework\Indexer\SaveHandlerFactory;
+use Magento\Framework\Indexer\ScopeResolver\FlatScopeResolver;
+use Magento\Framework\Indexer\ScopeResolver\IndexScopeResolver;
 use Magento\Framework\Indexer\StructureFactory;
+use Magento\Theme\Model\Data\Design\Config as DesignConfig;
 use Magento\Theme\Model\Indexer\Design\Config;
+use Magento\Theme\Model\ResourceModel\Design\Config\Scope\CollectionFactory;
+use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
+use Magento\Theme\Model\Indexer\Design\IndexerHandler;
+use Magento\Framework\DB\Adapter\AdapterInterface;
 
+/**
+ * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ */
 class ConfigTest extends TestCase
 {
-    /** @var Config */
-    protected $model;
+    /**
+     * @var AdapterInterface|MockObject
+     */
+    private $adapter;
+    /**
+     * @var ResourceConnection|MockObject
+     */
+    private $resourceConnection;
+    /**
+     * @var Batch|MockObject
+     */
+    private $batch;
+    /**
+     * @var IndexStructureInterface|MockObject
+     */
+    private $indexerStructure;
+    /**
+     * @var IndexScopeResolver|MockObject
+     */
+    private $indexScopeResolver;
+    /**
+     * @var FlatScopeResolver|MockObject
+     */
+    private $flatScopeResolver;
+    /**
+     * @var SaveHandlerFactory|MockObject
+     */
+    private $saveHandlerFactory;
+    /**
+     * @var StructureFactory|MockObject
+     */
+    private $structureFactory;
+    /**
+     * @var FieldsetInterface|MockObject
+     */
+    private $indexerFieldset;
+    /**
+     * @var FieldsetPool|MockObject
+     */
+    private $fieldsetPool;
+    /**
+     * @var HandlerInterface|MockObject
+     */
+    private $indexerHandler;
+    /**
+     * @var HandlerPool|MockObject
+     */
+    private $handlerPool;
+    /**
+     * @var Collection|MockObject
+     */
+    private $collection;
+    /**
+     * @var CollectionFactory|MockObject
+     */
+    private $collectionFactory;
 
     protected function setUp(): void
     {
-        $indexerStructure = $this->getMockBuilder(IndexStructureInterface::class)
+        $this->indexerStructure = $this->getMockBuilder(IndexStructureInterface::class)
             ->getMockForAbstractClass();
-        $structureFactory = $this->getMockBuilder(StructureFactory::class)
+        $this->structureFactory = $this->getMockBuilder(StructureFactory::class)
             ->disableOriginalConstructor()
             ->getMock();
-        $structureFactory->expects($this->any())
-            ->method('create')
-            ->willReturn($indexerStructure);
-
-        $indexer = $this->getMockBuilder(IndexerInterface::class)
+        $this->resourceConnection = $this->getMockBuilder(ResourceConnection::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+        $this->adapter = $this->getMockBuilder(AdapterInterface::class)
             ->getMockForAbstractClass();
-        $saveHandlerFactory = $this->getMockBuilder(SaveHandlerFactory::class)
+        $this->batch = $this->getMockBuilder(Batch::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+        $this->indexScopeResolver = $this->getMockBuilder(IndexScopeResolver::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+        $this->flatScopeResolver = $this->getMockBuilder(FlatScopeResolver::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+        $this->saveHandlerFactory = $this->getMockBuilder(SaveHandlerFactory::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+        $this->fieldsetPool = $this->getMockBuilder(FieldsetPool::class)
             ->disableOriginalConstructor()
             ->getMock();
-        $saveHandlerFactory->expects($this->any())
+        $this->collection = $this->getMockBuilder(Collection::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+        $this->collectionFactory = $this->getMockBuilder(CollectionFactory::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+        $this->indexerHandler = $this->getMockBuilder(HandlerInterface::class)
+            ->getMockForAbstractClass();
+        $this->handlerPool = $this->getMockBuilder(HandlerPool::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+        $this->indexerFieldset = $this->getMockBuilder(FieldsetInterface::class)
+            ->getMockForAbstractClass();
+    }
+
+    /**
+     * Generate flat index table name from design config grid index ID
+     *
+     * @return string
+     */
+    private function getFlatIndexTableName(): string
+    {
+        return DesignConfig::DESIGN_CONFIG_GRID_INDEXER_ID . '_flat';
+    }
+
+    /**
+     * Initialize and return Design Config Indexer Model
+     *
+     * @return Config
+     */
+    private function getDesignConfigIndexerModel(): Config
+    {
+        $this->structureFactory->expects($this->any())
+            ->method('create')
+            ->willReturn($this->indexerStructure);
+        $this->resourceConnection
+            ->expects($this->any())
+            ->method('getConnection')
+            ->willReturn($this->adapter);
+        $this->flatScopeResolver->expects($this->any())
+            ->method('resolve')
+            ->willReturn($this->getFlatIndexTableName());
+
+        $indexer = new IndexerHandler(
+            $this->indexerStructure,
+            $this->resourceConnection,
+            $this->batch,
+            $this->indexScopeResolver,
+            $this->flatScopeResolver,
+            [
+                'fieldsets' => [],
+                'indexer_id' => DesignConfig::DESIGN_CONFIG_GRID_INDEXER_ID
+            ]
+        );
+
+        $this->saveHandlerFactory->expects($this->any())
             ->method('create')
             ->willReturn($indexer);
 
-        $indexerFieldset = $this->getMockBuilder(FieldsetInterface::class)
-            ->getMockForAbstractClass();
-        $indexerFieldset->expects($this->any())
+        $this->indexerFieldset->expects($this->any())
             ->method('addDynamicData')
             ->willReturnArgument(0);
-        $fieldsetPool = $this->getMockBuilder(FieldsetPool::class)
-            ->disableOriginalConstructor()
-            ->getMock();
-        $fieldsetPool->expects($this->any())
+
+        $this->fieldsetPool->expects($this->any())
             ->method('get')
-            ->willReturn($indexerFieldset);
+            ->willReturn($this->indexerFieldset);
 
-        $indexerHandler = $this->getMockBuilder(HandlerInterface::class)
-            ->getMockForAbstractClass();
-        $handlerPool = $this->getMockBuilder(HandlerPool::class)
-            ->disableOriginalConstructor()
-            ->getMock();
-        $handlerPool->expects($this->any())
+        $this->handlerPool->expects($this->any())
             ->method('get')
-            ->willReturn($indexerHandler);
+            ->willReturn($this->indexerHandler);
 
-        $collection = $this->getMockBuilder(Collection::class)
-            ->disableOriginalConstructor()
-            ->getMock();
-        $collectionFactory =
-            $this->getMockBuilder(\Magento\Theme\Model\ResourceModel\Design\Config\Scope\CollectionFactory::class)
-                ->disableOriginalConstructor()
-                ->setMethods(['create'])
-                ->getMock();
-        $collectionFactory->expects($this->any())
+        $this->collectionFactory->expects($this->any())
             ->method('create')
-            ->willReturn($collection);
-
-        $this->model = new Config(
-            $structureFactory,
-            $saveHandlerFactory,
-            $fieldsetPool,
-            $handlerPool,
-            $collectionFactory,
+            ->willReturn($this->collection);
+
+        return new Config(
+            $this->structureFactory,
+            $this->saveHandlerFactory,
+            $this->fieldsetPool,
+            $this->handlerPool,
+            $this->collectionFactory,
             [
                 'fieldsets' => ['test_fieldset' => [
                     'fields' => [
@@ -102,7 +216,7 @@ protected function setUp(): void
                             'handler' => null,
                         ],
                     ],
-                    'provider' => $indexerFieldset,
+                    'provider' => $this->indexerFieldset,
                 ]
                 ],
                 'saveHandler' => 'saveHandlerClass',
@@ -111,9 +225,46 @@ protected function setUp(): void
         );
     }
 
-    public function testExecuteFull()
+    public function testFullReindex()
     {
-        $result = $this->model->executeFull();
-        $this->assertNull($result);
+        $this->adapter->expects($this->any())
+            ->method('isTableExists')
+            ->willReturn(true);
+        $this->indexerStructure->expects($this->never())->method('create')
+            ->with(DesignConfig::DESIGN_CONFIG_GRID_INDEXER_ID);
+        $this->adapter->expects($this->once())->method('delete')
+            ->with($this->getFlatIndexTableName());
+        $this->batch->expects($this->any())
+            ->method('getItems')->willReturn([]);
+
+        $this->getDesignConfigIndexerModel()->executeFull();
+    }
+
+    public function testFullReindexWithFlatTableCreate()
+    {
+        $this->adapter->expects($this->any())->method('isTableExists')
+            ->willReturn(false);
+        $this->indexerStructure->expects($this->once())->method('create')
+            ->with(DesignConfig::DESIGN_CONFIG_GRID_INDEXER_ID);
+        $this->adapter->expects($this->never())->method('delete')
+            ->with($this->getFlatIndexTableName());
+        $this->batch->expects($this->any())->method('getItems')
+            ->willReturn([]);
+
+        $this->getDesignConfigIndexerModel()->executeFull();
+    }
+
+    public function testPartialReindex()
+    {
+        $this->adapter->expects($this->any())->method('isTableExists')
+            ->willReturn(true);
+        $this->indexerStructure->expects($this->never())->method('create')
+            ->with(DesignConfig::DESIGN_CONFIG_GRID_INDEXER_ID);
+        $this->adapter->expects($this->once())->method('delete')
+            ->with($this->getFlatIndexTableName(), ['entity_id IN(?)' => [1, 2, 3]]);
+        $this->batch->expects($this->any())->method('getItems')
+            ->willReturn([[1, 2, 3]]);
+
+        $this->getDesignConfigIndexerModel()->executeList([1, 2, 3]);
     }
 }
diff --git a/app/code/Magento/Theme/etc/indexer.xml b/app/code/Magento/Theme/etc/indexer.xml
@@ -17,7 +17,7 @@
             <field name="store_group_id" xsi:type="filterable" dataType="int"/>
             <field name="store_id" xsi:type="filterable" dataType="int"/>
         </fieldset>
-        <saveHandler class="Magento\Framework\Indexer\SaveHandler\Grid"/>
+        <saveHandler class="Magento\Theme\Model\Indexer\Design\IndexerHandler"/>
         <structure class="Magento\Framework\Indexer\GridStructure"/>
     </indexer>
 </config>
