MSI: Update Magento 2 core to support MSI

Author: RomaKis

app/code/Magento/CatalogImportExport/Model/Import/Product.php

@@ -536,6 +536,7 @@ class Product extends \Magento\ImportExport\Model\Import\Entity\AbstractEntity
 
     /**
      * @var \Magento\CatalogInventory\Model\ResourceModel\Stock\ItemFactory
+     * @deprecated
      */
     protected $_stockResItemFac;
 
@@ -707,7 +708,7 @@ class Product extends \Magento\ImportExport\Model\Import\Entity\AbstractEntity
     /**
      * Stock Item Importer
      *
-     * @var StockItemImporterInterface $stockItemImporter
+     * @var StockItemImporterInterface
      */
     private $stockItemImporter;
 
@@ -759,13 +760,13 @@ class Product extends \Magento\ImportExport\Model\Import\Entity\AbstractEntity
      * @param TransactionManagerInterface $transactionManager
      * @param Product\TaxClassProcessor $taxClassProcessor
      * @param \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig
+     * @param \Magento\Catalog\Model\Product\Url $productUrl
      * @param array $data
      * @param array $dateAttrCodes
      * @param CatalogConfig $catalogConfig
-     * @param StockItemImporterInterface $stockItemImporter
      * @param ImageTypeProcessor $imageTypeProcessor
      * @param MediaGalleryProcessor $mediaProcessor
-     * @throws \Magento\Framework\Exception\LocalizedException
+     * @param StockItemImporterInterface|null $stockItemImporter
      *
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */

app/code/Magento/CatalogImportExport/Model/StockItemImporter.php

@@ -41,11 +41,7 @@ public function __construct(
     }
 
     /**
-     * Handle Import of Stock Item Data
-     *
-     * @param array $stockData
-     * @return void
-     * @throws CouldNotSaveException
+     * @inheritdoc
      */
     public function import(array $stockData)
     {

app/code/Magento/ImportExport/Controller/Adminhtml/Import/Download.php

@@ -7,6 +7,7 @@
 
 use Magento\Framework\App\Filesystem\DirectoryList;
 use Magento\Framework\Component\ComponentRegistrar;
+use Magento\Framework\Controller\Result\Redirect;
 use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\ImportExport\Controller\Adminhtml\Import as ImportController;
 
@@ -43,14 +44,12 @@ class Download extends ImportController
     private $sampleFileProvider;
 
     /**
-     * Constructor
-     *
      * @param \Magento\Backend\App\Action\Context $context
      * @param \Magento\Framework\App\Response\Http\FileFactory $fileFactory
      * @param \Magento\Framework\Controller\Result\RawFactory $resultRawFactory
      * @param \Magento\Framework\Filesystem\Directory\ReadFactory $readFactory
-     * @param \Magento\ImportExport\Model\Import\SampleFileProvider $sampleFileProvider
      * @param ComponentRegistrar $componentRegistrar
+     * @param \Magento\ImportExport\Model\Import\SampleFileProvider|null $sampleFileProvider
      */
     public function __construct(
         \Magento\Backend\App\Action\Context $context,
@@ -81,14 +80,19 @@ public function execute()
     {
         $entityName = $this->getRequest()->getParam('filename');
 
+        if (preg_match('/^\w+$/', $entityName) == 0) {
+            /** @var \Magento\Backend\Model\View\Result\Redirect $resultRedirect */
+            $this->messageManager->addErrorMessage(__('Incorrect file name.'));
+
+            return $this->getResultRedirect();        }
+
         try {
             $fileContents = $this->sampleFileProvider->getFileContents($entityName);
         } catch (NoSuchEntityException $e) {
             /** @var \Magento\Backend\Model\View\Result\Redirect $resultRedirect */
             $this->messageManager->addError(__('There is no sample file for this entity.'));
-            $resultRedirect = $this->resultRedirectFactory->create();
-            $resultRedirect->setPath('*/import');
-            return $resultRedirect;
+
+            return $this->getResultRedirect();
         }
 
         $fileSize = $this->sampleFileProvider->getSize($entityName);
@@ -107,4 +111,15 @@ public function execute()
         $resultRaw->setContents($fileContents);
         return $resultRaw;
     }
+
+    /**
+     * @return Redirect
+     */
+    private function getResultRedirect(): Redirect
+    {
+        $resultRedirect = $this->resultRedirectFactory->create();
+        $resultRedirect->setPath('*/import');
+
+        return $resultRedirect;
+    }
 }

app/code/Magento/ImportExport/Model/Import/SampleFileProvider.php

@@ -10,7 +10,8 @@
 use Magento\Framework\Filesystem\Directory\ReadInterface;
 
 /**
- * Import Sample File Provider model
+ * Import Sample File Provider model.
+ * This class support only *.csv.
  */
 class SampleFileProvider
 {
@@ -78,7 +79,7 @@ public function getFileContents(string $entityName): string
     }
 
     /**
-     * @param $entityName
+     * @param string $entityName
      * @return string $entityName
      * @throws NoSuchEntityException
      */

dev/tests/api-functional/phpunit_rest.xml.dist

@@ -21,9 +21,6 @@
             <exclude>testsuite/Magento/GraphQl</exclude>
             <directory suffix="Test.php">../../../app/code/*/*/Test/Api</directory>
         </testsuite>
-        <testsuite name="msi">
-            <directory suffix="Test.php">../../../app/code/*/*/Test/Api</directory>
-        </testsuite>
     </testsuites>
 
     <!-- PHP INI settings and constants definition -->

lib/internal/Magento/Framework/Model/ResourceModel/PredefinedId.php

@@ -0,0 +1,64 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Framework\Model\ResourceModel;
+
+use Magento\Framework\Exception\LocalizedException;
+use Magento\Framework\Model\AbstractModel;
+
+/**
+ * Provides possibility of saving entity with predefined/pre-generated id
+ *
+ * The choice to use trait instead of inheritance was made to prevent the introduction of new layer super type on
+ * the module basis as well as better code reusability, as potentially current trait not coupled to Inventory module
+ * and other modules could re-use this approach.
+ */
+trait PredefinedId
+{
+    /**
+     * Overwrite default \Magento\Framework\Model\ResourceModel\Db\AbstractDb implementation of the isObjectNew
+     * @see \Magento\Framework\Model\ResourceModel\Db\AbstractDb::isObjectNew()
+     *
+     * Adding the possibility to check whether record already exists in DB or not
+     *
+     * @param AbstractModel $object
+     * @return bool
+     */
+    protected function isObjectNotNew(AbstractModel $object)
+    {
+        $connection = $this->getConnection();
+        $select = $connection->select()
+            ->from($this->getMainTable(), [$this->getIdFieldName()])
+            ->where($this->getIdFieldName() . ' = ?', $object->getId())
+            ->limit(1);
+        return (bool)$connection->fetchOne($select);
+    }
+
+    /**
+     * Save New Object
+     *
+     * Overwrite default \Magento\Framework\Model\ResourceModel\Db\AbstractDb implementation of the saveNewObject
+     * @see \Magento\Framework\Model\ResourceModel\Db\AbstractDb::saveNewObject()
+     *
+     * @param \Magento\Framework\Model\AbstractModel $object
+     * @throws LocalizedException
+     * @return void
+     */
+    protected function saveNewObject(\Magento\Framework\Model\AbstractModel $object)
+    {
+        $bind = $this->_prepareDataForSave($object);
+        $this->getConnection()->insert($this->getMainTable(), $bind);
+
+        if ($this->_isPkAutoIncrement) {
+            $object->setId($this->getConnection()->lastInsertId($this->getMainTable()));
+        }
+
+        if ($this->_useIsObjectNew) {
+            $object->isObjectNew(false);
+        }
+    }
+}

lib/internal/Magento/Framework/MultiDimensionalIndexer/IndexName.php

@@ -7,6 +7,8 @@
 
 namespace Magento\Framework\MultiDimensionalIndexer;
 
+use Magento\Framework\Exception\LocalizedException;
+
 /**
  * Index Name object
  *
@@ -33,9 +35,19 @@ class IndexName
      * @param string $indexId
      * @param Dimension[] $dimensions
      * @param Alias $alias
+     *
+     * @throws LocalizedException
      */
     public function __construct(string $indexId, array $dimensions, Alias $alias)
     {
+        foreach ($dimensions as $dimension) {
+            if (!$dimension instanceof Dimension) {
+                throw new LocalizedException(
+                    __('Dimension have to be instance of Dimension class.')
+                );
+            }
+        }
+
         $this->indexId = $indexId;
         $this->dimensions = $dimensions;
         $this->alias = $alias;

lib/internal/Magento/Framework/MultiDimensionalIndexer/IndexNameBuilder.php

@@ -18,22 +18,16 @@ class IndexNameBuilder
 {
     /**
      * Index id parameter name. Used internally in this object
-     *
-     * Can not replace on private constant (feature of PHP 7.1) because we need to support PHP 7.0
      */
     private static $indexId = 'indexId';
 
     /**
      * Dimensions parameter name. Used internally in this object
-     *
-     * Can not replace on private constant (feature of PHP 7.1) because we need to support PHP 7.0
      */
     private static $dimensions = 'dimensions';
 
     /**
      * Alias parameter name. Used internally in this object
-     *
-     * Can not replace on private constant (feature of PHP 7.1) because we need to support PHP 7.0
      */
     private static $alias = 'alias';
 

lib/internal/Magento/Framework/MultiDimensionalIndexer/README.md

@@ -1 +1,8 @@
-MultiDimensionalIndexer
+A library for multi dimensional indexing processing
+
+it's supposed to split indexes by the Dimensional (Scope). Builds independent index table per each Dimensional. 
+Dimension and Alias objects help to resolve correct index.
+
+Contains switchable indexes to switch from an old index (current index, which exists before full reindex operation 
+has been launched) to a new index (created when the full reindex operation finished) with zero downtime to make 
+Front-End responsive while Full Reindex being worked.

lib/internal/Magento/Framework/Test/Unit/MultiDimensionalIndexer/IndexTableSwitcherTest.php

@@ -0,0 +1,98 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Framework\Test\Unit\MultiDimensionalIndexer;
+
+use Magento\Framework\App\ResourceConnection;
+use Magento\Framework\DB\Adapter\AdapterInterface;
+use Magento\Framework\MultiDimensionalIndexer\IndexName;
+use Magento\Framework\MultiDimensionalIndexer\IndexNameResolverInterface;
+use Magento\Framework\MultiDimensionalIndexer\IndexTableSwitcher;
+use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * Test for @see IndexTableSwitcher.
+ */
+class IndexTableSwitcherTest extends TestCase
+{
+    /**
+     * @var IndexTableSwitcher|\PHPUnit_Framework_MockObject_MockObject
+     */
+    private $indexTableSwitcher;
+
+    /**
+     * @var IndexName|\PHPUnit_Framework_MockObject_MockObject
+     */
+    private $indexName;
+
+    /**
+     * @var ResourceConnection|\PHPUnit_Framework_MockObject_MockObject
+     */
+    private $resourceConnection;
+
+    /**
+     * @var IndexNameResolverInterface|\PHPUnit_Framework_MockObject_MockObject
+     */
+    private $indexNameResolver;
+
+    /**
+     * @var AdapterInterface|\PHPUnit_Framework_MockObject_MockObject
+     */
+    private $adapter;
+
+    /**
+     * @inheritdoc
+     */
+    protected function setUp()
+    {
+        parent::setUp();
+
+        $objectManager = new ObjectManager($this);
+        $this->indexName = $this->createMock(IndexName::class);
+        $this->resourceConnection = $this->createMock(ResourceConnection::class);
+        $this->indexNameResolver = $this->createMock(IndexNameResolverInterface::class);
+        $this->adapter = $this->createMock(AdapterInterface::class);
+
+        $this->indexTableSwitcher = $objectManager->getObject(
+            IndexTableSwitcher::class,
+            [
+                'resourceConnection' => $this->resourceConnection,
+                'indexNameResolver' => $this->indexNameResolver,
+            ]
+        );
+    }
+
+    public function testSwitch()
+    {
+        $connectionName = 'testConnection';
+        $tableName = 'some_table_name';
+        $toRename =
+            [
+                [
+                    'oldName' => $tableName,
+                    'newName' => $tableName . '_outdated',
+                ],
+                [
+                    'oldName' => $tableName . '_replica',
+                    'newName' => $tableName,
+                ],
+                [
+                    'oldName' => $tableName . '_outdated',
+                    'newName' => $tableName . '_replica',
+                ],
+            ];
+
+        $this->resourceConnection->expects($this->once())->method('getConnection')
+            ->with($connectionName)->willReturn($this->adapter);
+        $this->indexNameResolver->expects($this->once())->method('resolveName')
+            ->with($this->indexName)->willReturn($tableName);
+        $this->adapter->expects($this->once())->method('renameTablesBatch')
+            ->with($toRename);
+
+        $this->indexTableSwitcher->switch($this->indexName, $connectionName);
+    }
+}