MAGETWO-93753: [Forwardport] Implement sharding and parallelization for Price Indexer - part 2

duhon · duhon · commit 5d93f82af230 · 2018-08-09T14:06:17.000+03:00
diff --git a/app/code/Magento/AdvancedSearch/Model/ResourceModel/Index.php b/app/code/Magento/AdvancedSearch/Model/ResourceModel/Index.php
@@ -58,7 +58,7 @@ class Index extends AbstractDb
      * @param Context $context
      * @param StoreManagerInterface $storeManager
      * @param MetadataPool $metadataPool
-     * @param null $connectionName
+     * @param string|null $connectionName
      * @param TableResolver|null $tableResolver
      * @param DimensionCollectionFactory|null $dimensionCollectionFactory
      */
diff --git a/app/code/Magento/Bundle/Model/ResourceModel/Indexer/Price.php b/app/code/Magento/Bundle/Model/ResourceModel/Indexer/Price.php
@@ -129,7 +129,8 @@ public function __construct(
 
     /**
      * {@inheritdoc}
-     *
+     * @param array $dimensions
+     * @param \Traversable $entityIds
      * @throws \Exception
      */
     public function executeByDimensions(array $dimensions, \Traversable $entityIds)
@@ -238,8 +239,8 @@ private function prepareBundleOptionTable()
     /**
      * Prepare temporary price index data for bundle products by price type
      *
-     * @param array $dimensions
      * @param int $priceType
+     * @param array $dimensions
      * @param int|array $entityIds the entity ids limitation
      * @return void
      * @throws \Exception
diff --git a/app/code/Magento/Catalog/Model/Indexer/Product/Price/ModeSwitcher.php b/app/code/Magento/Catalog/Model/Indexer/Product/Price/ModeSwitcher.php
@@ -48,10 +48,10 @@ class ModeSwitcher implements \Magento\Indexer\Model\ModeSwitcherInterface
     private $modeSwitcherConfiguration;
 
     /**
-     * @param TableMaintainer            $tableMaintainer
+     * @param TableMaintainer $tableMaintainer
      * @param DimensionCollectionFactory $dimensionCollectionFactory
      * @param DimensionModeConfiguration $dimensionModeConfiguration
-     * @param ModeSwitcherConfiguration  $modeSwitcherConfiguration
+     * @param ModeSwitcherConfiguration $modeSwitcherConfiguration
      */
     public function __construct(
         TableMaintainer $tableMaintainer,
diff --git a/app/code/Magento/Catalog/Model/Indexer/Product/Price/ModeSwitcherConfiguration.php b/app/code/Magento/Catalog/Model/Indexer/Product/Price/ModeSwitcherConfiguration.php
@@ -38,9 +38,9 @@ class ModeSwitcherConfiguration
     private $indexer;
 
     /**
-     * @param ConfigInterface   $configWriter
+     * @param ConfigInterface $configWriter
      * @param TypeListInterface $cacheTypeList
-     * @param Indexer           $indexer
+     * @param Indexer $indexer
      */
     public function __construct(
         ConfigInterface $configWriter,
diff --git a/app/code/Magento/Downloadable/Model/ResourceModel/Indexer/Price.php b/app/code/Magento/Downloadable/Model/ResourceModel/Indexer/Price.php
@@ -101,7 +101,8 @@ public function __construct(
 
     /**
      * {@inheritdoc}
-     *
+     * @param array $dimensions
+     * @param \Traversable $entityIds
      * @throws \Exception
      */
     public function executeByDimensions(array $dimensions, \Traversable $entityIds)
diff --git a/app/code/Magento/GroupedProduct/Model/ResourceModel/Product/Indexer/Price/Grouped.php b/app/code/Magento/GroupedProduct/Model/ResourceModel/Product/Indexer/Price/Grouped.php
@@ -86,7 +86,8 @@ public function __construct(
 
     /**
      * {@inheritdoc}
-     *
+     * @param array $dimensions
+     * @param \Traversable $entityIds
      * @throws \Exception
      */
     public function executeByDimensions(array $dimensions, \Traversable $entityIds)
diff --git a/app/code/Magento/Indexer/Console/Command/IndexerSetDimensionsModeCommand.php b/app/code/Magento/Indexer/Console/Command/IndexerSetDimensionsModeCommand.php
@@ -43,8 +43,8 @@ class IndexerSetDimensionsModeCommand extends AbstractIndexerCommand
     private $dimensionProviders;
 
     /**
-     * @param ObjectManagerFactory    $objectManagerFactory
-     * @param ScopeConfigInterface    $configReader
+     * @param ObjectManagerFactory $objectManagerFactory
+     * @param ScopeConfigInterface $configReader
      * @param ModeSwitcherInterface[] $dimensionSwitchers
      */
     public function __construct(
@@ -70,6 +70,9 @@ protected function configure()
 
     /**
      * {@inheritdoc}
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     * @return int
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
@@ -185,7 +188,7 @@ private function validate(InputInterface $input): array
      *
      * @param string $inputKey
      * @param string $inputIndexer
-     * @param array  $acceptedValues
+     * @param array $acceptedValues
      * @return string[]
      */
     private function validateArgument(string $inputKey, string $inputIndexer, array $acceptedValues): array
diff --git a/app/code/Magento/Indexer/Console/Command/IndexerShowDimensionsModeCommand.php b/app/code/Magento/Indexer/Console/Command/IndexerShowDimensionsModeCommand.php
@@ -40,7 +40,7 @@ class IndexerShowDimensionsModeCommand extends AbstractIndexerCommand
     /**
      * @param ObjectManagerFactory $objectManagerFactory
      * @param ScopeConfigInterface $configReader
-     * @param array                $indexers
+     * @param array $indexers
      */
     public function __construct(
         ObjectManagerFactory $objectManagerFactory,
@@ -63,8 +63,12 @@ protected function configure()
         parent::configure();
     }
 
+
     /**
      * {@inheritdoc}
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     * @return int
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
@@ -134,8 +138,8 @@ private function validate(InputInterface $input): array
      * Validate command argument and return errors in case if argument is invalid
      *
      * @param string $inputKey
-     * @param array  $inputIndexer
-     * @param array  $acceptedValues
+     * @param array $inputIndexer
+     * @param array $acceptedValues
      * @return array
      */
     private function validateArgument(string $inputKey, array $inputIndexer, array $acceptedValues): array
diff --git a/app/code/Magento/Indexer/Model/DimensionMode.php b/app/code/Magento/Indexer/Model/DimensionMode.php
@@ -24,7 +24,7 @@ class DimensionMode
 
     /**
      * @param string $name
-     * @param array  $dimensions
+     * @param array $dimensions
      */
     public function __construct(string $name, array $dimensions)
     {
diff --git a/app/code/Magento/Indexer/Test/Unit/Console/Command/IndexerSetDimensionsModeCommandTest.php b/app/code/Magento/Indexer/Test/Unit/Console/Command/IndexerSetDimensionsModeCommandTest.php
@@ -92,10 +92,10 @@ protected function getObjectManagerReturnValueMap()
     /**
      * Tests method \Magento\Indexer\Console\Command\IndexerDimensionsModeCommand::execute
      *
-     * @param $indexerTitle
-     * @param $previousMode
-     * @param $command
-     * @param $consoleOutput
+     * @param string $indexerTitle
+     * @param string $previousMode
+     * @param string $command
+     * @param string $consoleOutput
      * @dataProvider dimensionModesDataProvider
      * @return void
      */
diff --git a/app/code/Magento/Indexer/Test/Unit/Console/Command/IndexerShowDimensionsModeCommandTest.php b/app/code/Magento/Indexer/Test/Unit/Console/Command/IndexerShowDimensionsModeCommandTest.php
@@ -74,8 +74,8 @@ protected function getObjectManagerReturnValueMap(): array
     /**
      * Tests method \Magento\Indexer\Console\Command\IndexerDimensionsModeCommand::execute
      *
-     * @param $command
-     * @param $consoleOutput
+     * @param string $command
+     * @param string $consoleOutput
      * @dataProvider dimensionModesDataProvider
      */
     public function testExecuteWithAttributes($command, $consoleOutput)
diff --git a/dev/tests/integration/framework/Magento/TestFramework/Annotation/IndexerDimensionMode.php b/dev/tests/integration/framework/Magento/TestFramework/Annotation/IndexerDimensionMode.php
@@ -41,6 +41,9 @@ class IndexerDimensionMode
     /** @var bool */
     private $isDimensionMode = false;
 
+    /**
+     * Restore db
+     */
     private function restoreDb()
     {
         $this->db = Bootstrap::getInstance()->getBootstrap()->getApplication()->getDbInstance();
diff --git a/dev/tests/integration/framework/Magento/TestFramework/Bootstrap/DocBlock.php b/dev/tests/integration/framework/Magento/TestFramework/Bootstrap/DocBlock.php
@@ -5,6 +5,8 @@
  */
 namespace Magento\TestFramework\Bootstrap;
 
+use Magento\TestFramework\Application;
+
 /**
  * Bootstrap of the custom DocBlock annotations
  *
@@ -27,8 +29,9 @@ public function __construct($fixturesBaseDir)
 
     /**
      * Activate custom DocBlock annotations along with more-or-less permanent workarounds
+     * @param Application $application
      */
-    public function registerAnnotations(\Magento\TestFramework\Application $application)
+    public function registerAnnotations(Application $application)
     {
         $eventManager = new \Magento\TestFramework\EventManager($this->_getSubscribers($application));
         \Magento\TestFramework\Event\PhpUnit::setDefaultEventManager($eventManager);
@@ -42,10 +45,10 @@ public function registerAnnotations(\Magento\TestFramework\Application $applicat
      * To allow config fixtures to deal with fixture stores, data fixtures should be processed first.
      * ConfigFixture applied twice because data fixtures could clean config and clean custom settings
      *
-     * @param \Magento\TestFramework\Application $application
+     * @param Application $application
      * @return array
      */
-    protected function _getSubscribers(\Magento\TestFramework\Application $application)
+    protected function _getSubscribers(Application $application)
     {
         return [
             new \Magento\TestFramework\Workaround\Segfault(),
diff --git a/dev/tests/integration/testsuite/Magento/Bundle/Block/Catalog/Product/View/Type/BundleTest.php b/dev/tests/integration/testsuite/Magento/Bundle/Block/Catalog/Product/View/Type/BundleTest.php
@@ -74,6 +74,9 @@ public function testGetJsonConfig()
         $this->assertEquals(5, $selection['prices']['finalPrice']['amount']);
     }
 
+    /**
+     * Tear Down
+     */
     protected function tearDown()
     {
         $this->objectManager->get(\Magento\Framework\Registry::class)->unregister('product');
diff --git a/dev/tests/integration/testsuite/Magento/Bundle/Model/Product/FixedBundlePriceCalculatorWithDimensionTest.php b/dev/tests/integration/testsuite/Magento/Bundle/Model/Product/FixedBundlePriceCalculatorWithDimensionTest.php
@@ -370,8 +370,8 @@ private function getProductWithDifferentPrice()
 
     /**
      * Fixed bundle product with required option, custom option and without any discounts
-     * @param $selectionsPriceType
-     * @param $customOptionsPriceType
+     * @param string $selectionsPriceType
+     * @param string $customOptionsPriceType
      * @return array
      */
     private function getBundleConfiguration3($selectionsPriceType, $customOptionsPriceType)
diff --git a/dev/tests/integration/testsuite/Magento/Bundle/Model/Product/OptionListTest.php b/dev/tests/integration/testsuite/Magento/Bundle/Model/Product/OptionListTest.php
@@ -21,6 +21,9 @@ class OptionListTest extends \PHPUnit\Framework\TestCase
      */
     protected $objectManager;
 
+    /**
+     * Set up
+     */
     protected function setUp()
     {
         $this->objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
diff --git a/dev/tests/integration/testsuite/Magento/Bundle/Model/Product/PriceWithDimensionTest.php b/dev/tests/integration/testsuite/Magento/Bundle/Model/Product/PriceWithDimensionTest.php
@@ -20,13 +20,19 @@ class PriceWithDimensionTest extends \PHPUnit\Framework\TestCase
      */
     protected $_model;
 
+    /**
+     * Set up
+     */
     protected function setUp()
     {
         $this->_model = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()->create(
             \Magento\Bundle\Model\Product\Price::class
         );
     }
 
+    /**
+     * Get tier price
+     */
     public function testGetTierPrice()
     {
         /** @var \Magento\Catalog\Api\ProductRepositoryInterface $productRepository */
diff --git a/dev/tests/integration/testsuite/Magento/Catalog/Model/Indexer/Product/Price/SimpleWithOptionsTierPriceWithDimensionTest.php b/dev/tests/integration/testsuite/Magento/Catalog/Model/Indexer/Product/Price/SimpleWithOptionsTierPriceWithDimensionTest.php
@@ -35,6 +35,9 @@ class SimpleWithOptionsTierPriceWithDimensionTest extends \PHPUnit\Framework\Tes
      */
     private $productCollectionFactory;
 
+    /**
+     * set up
+     */
     protected function setUp()
     {
         $this->objectManager = Bootstrap::getObjectManager();
diff --git a/dev/tests/integration/testsuite/Magento/Catalog/Model/Product/Type/PriceWithDimensionTest.php b/dev/tests/integration/testsuite/Magento/Catalog/Model/Product/Type/PriceWithDimensionTest.php
@@ -30,13 +30,19 @@ class PriceWithDimensionTest extends \PHPUnit\Framework\TestCase
      */
     protected $_model;
 
+    /**
+     * Set up
+     */
     protected function setUp()
     {
         $this->_model = Bootstrap::getObjectManager()->create(
             \Magento\Catalog\Model\Product\Type\Price::class
         );
     }
 
+    /**
+     * Get price from indexer
+     */
     public function testGetPriceFromIndexer()
     {
         /** @var PriceTableResolver $tableResolver */
@@ -66,11 +72,17 @@ public function testGetPriceFromIndexer()
         $this->assertEquals('19', $return[0]['max_price']);
     }
 
+    /**
+     * Get price
+     */
     public function testGetPrice()
     {
         $this->assertEquals('test', $this->_model->getPrice(new DataObject(['price' => 'test'])));
     }
 
+    /**
+     * Get final price
+     */
     public function testGetFinalPrice()
     {
         $repository = Bootstrap::getObjectManager()->create(
@@ -95,6 +107,9 @@ public function testGetFinalPrice()
         $this->assertEquals(14.0, $this->_model->getFinalPrice(5, $product));
     }
 
+    /**
+     * Get formated price
+     */
     public function testGetFormatedPrice()
     {
         $repository = Bootstrap::getObjectManager()->create(
@@ -105,12 +120,18 @@ public function testGetFormatedPrice()
         $this->assertEquals('<span class="price">$10.00</span>', $this->_model->getFormatedPrice($product));
     }
 
+    /**
+     * Calculate price
+     */
     public function testCalculatePrice()
     {
         $this->assertEquals(10, $this->_model->calculatePrice(10, 8, '1970-12-12 23:59:59', '1971-01-01 01:01:01'));
         $this->assertEquals(8, $this->_model->calculatePrice(10, 8, '1970-12-12 23:59:59', '2034-01-01 01:01:01'));
     }
 
+    /**
+     * Calculate special price
+     */
     public function testCalculateSpecialPrice()
     {
         $this->assertEquals(
@@ -123,6 +144,9 @@ public function testCalculateSpecialPrice()
         );
     }
 
+    /**
+     * Is tier price fixed
+     */
     public function testIsTierPriceFixed()
     {
         $this->assertTrue($this->_model->isTierPriceFixed());
diff --git a/dev/tests/integration/testsuite/Magento/Catalog/Model/ProductPriceWithDimensionTest.php b/dev/tests/integration/testsuite/Magento/Catalog/Model/ProductPriceWithDimensionTest.php
@@ -33,19 +33,28 @@ class ProductPriceWithDimensionTest extends \PHPUnit\Framework\TestCase
      */
     private $productRepository;
 
+    /**
+     * Set up
+     */
     protected function setUp()
     {
         $this->_model = Bootstrap::getObjectManager()->create(Product::class);
         $this->productRepository = Bootstrap::getObjectManager()->create(ProductRepositoryInterface::class);
     }
 
+    /**
+     * Get price
+     */
     public function testGetPrice()
     {
         $this->assertEmpty($this->_model->getPrice());
         $this->_model->setPrice(10.0);
         $this->assertEquals(10.0, $this->_model->getPrice());
     }
 
+    /**
+     * Get price model
+     */
     public function testGetPriceModel()
     {
         $default = $this->_model->getPriceModel();
@@ -77,6 +86,9 @@ public function testGetFormatedPrice()
         $this->assertEquals('<span class="price">$0.00</span>', $this->_model->getFormatedPrice());
     }
 
+    /**
+     * Set get final price
+     */
     public function testSetGetFinalPrice()
     {
         $this->assertEquals(0, $this->_model->getFinalPrice());
diff --git a/dev/tests/integration/testsuite/Magento/Catalog/Pricing/Render/FinalPriceBoxTest.php b/dev/tests/integration/testsuite/Magento/Catalog/Pricing/Render/FinalPriceBoxTest.php
diff --git a/dev/tests/integration/testsuite/Magento/CatalogInventory/Model/Quote/Item/QuantityValidatorTest.php b/dev/tests/integration/testsuite/Magento/CatalogInventory/Model/Quote/Item/QuantityValidatorTest.php
diff --git a/dev/tests/integration/testsuite/Magento/Checkout/Controller/CartTest.php b/dev/tests/integration/testsuite/Magento/Checkout/Controller/CartTest.php
diff --git a/dev/tests/integration/testsuite/Magento/ConfigurableProduct/Pricing/Price/SpecialPriceIndexerWithDimensionTest.php b/dev/tests/integration/testsuite/Magento/ConfigurableProduct/Pricing/Price/SpecialPriceIndexerWithDimensionTest.php
diff --git a/dev/tests/integration/testsuite/Magento/ConfigurableProduct/Pricing/Render/FinalPriceBox/RenderingBasedOnIsProductListFlagWithDimensionTest.php b/dev/tests/integration/testsuite/Magento/ConfigurableProduct/Pricing/Render/FinalPriceBox/RenderingBasedOnIsProductListFlagWithDimensionTest.php
diff --git a/dev/tests/integration/testsuite/Magento/Sales/Model/Order/Address/RendererTest.php b/dev/tests/integration/testsuite/Magento/Sales/Model/Order/Address/RendererTest.php
diff --git a/dev/tests/integration/testsuite/Magento/Setup/Console/Command/PriceIndexerDimensionsModeSetCommandTest.php b/dev/tests/integration/testsuite/Magento/Setup/Console/Command/PriceIndexerDimensionsModeSetCommandTest.php

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ class DimensionMode`
`24`	`24`
`25`	`25`	`/**`
`26`	`26`	`* @param string $name`
`27`		`- * @param array $dimensions`
	`27`	`+ * @param array $dimensions`
`28`	`28`	`*/`
`29`	`29`	`public function __construct(string $name, array $dimensions)`
`30`	`30`	`{`