ACP2E-618: caroussel problem with sorting by High stock

- fix
- modify test

Author: o-dubovyk

app/code/Magento/CatalogInventory/Model/Source/Stock.php

@@ -5,7 +5,12 @@
  */
 namespace Magento\CatalogInventory\Model\Source;
 
+use Magento\Catalog\Api\Data\ProductInterface;
+use Magento\CatalogInventory\Model\Stock as StockModel;
 use Magento\Eav\Model\Entity\Attribute\Source\AbstractSource;
+use Magento\Eav\Model\Entity\Collection\AbstractCollection;
+use Magento\Framework\Data\Collection;
+use Magento\Framework\EntityManager\MetadataPool;
 
 /**
  * CatalogInventory Stock source model
@@ -18,6 +23,20 @@
  */
 class Stock extends AbstractSource
 {
+    /**
+     * @var MetadataPool
+     */
+    private $metadataPool;
+
+    /**
+     * @param MetadataPool $metadataPool
+     */
+    public function __construct(
+        MetadataPool $metadataPool
+    ) {
+        $this->metadataPool = $metadataPool;
+    }
+
     /**
      * Retrieve option array
      *
@@ -26,28 +45,57 @@ class Stock extends AbstractSource
     public function getAllOptions()
     {
         return [
-            ['value' => \Magento\CatalogInventory\Model\Stock::STOCK_IN_STOCK, 'label' => __('In Stock')],
-            ['value' => \Magento\CatalogInventory\Model\Stock::STOCK_OUT_OF_STOCK, 'label' => __('Out of Stock')]
+            ['value' => StockModel::STOCK_IN_STOCK, 'label' => __('In Stock')],
+            ['value' => StockModel::STOCK_OUT_OF_STOCK, 'label' => __('Out of Stock')]
         ];
     }
 
     /**
      * Add Value Sort To Collection Select.
      *
-     * @param \Magento\Eav\Model\Entity\Collection\AbstractCollection $collection
+     * @param AbstractCollection $collection
      * @param string $dir
      *
      * @return $this
      * @since 100.2.4
      */
-    public function addValueSortToCollection($collection, $dir = \Magento\Framework\Data\Collection::SORT_ORDER_DESC)
+    public function addValueSortToCollection($collection, $dir = Collection::SORT_ORDER_DESC)
     {
-        $collection->getSelect()->joinLeft(
-            ['stock_item_table' => $collection->getTable('cataloginventory_stock_item')],
-            "e.entity_id=stock_item_table.product_id",
-            []
+        $productLinkField = $this->metadataPool->getMetadata(ProductInterface::class)->getLinkField();
+
+        $collection->joinField(
+            'child_id',
+            $collection->getTable('catalog_product_relation'),
+            'child_id',
+            'parent_id=' . $productLinkField,
+            null,
+            'left'
+        );
+
+        $collection->joinField(
+            'child_stock',
+            $collection->getTable('cataloginventory_stock_item'),
+            null,
+            'product_id = entity_id',
+            ['stock_id' => StockModel::DEFAULT_STOCK_ID],
+            'left'
+        );
+        $collection->joinField(
+            'parent_stock',
+            $collection->getTable('cataloginventory_stock_item'),
+            null,
+            'product_id = child_id',
+            ['stock_id' => StockModel::DEFAULT_STOCK_ID],
+            'left'
         );
-        $collection->getSelect()->order("stock_item_table.qty $dir");
+
+        $select = $collection->getSelect();
+        $select->columns(
+            'IF(SUM(`at_parent_stock`.`qty`), SUM(`at_parent_stock`.`qty`), `at_child_stock`.`qty`) as stock'
+        );
+        $select->group('e.entity_id');
+        $select->order("stock $dir");
+
         return $this;
     }
 }

app/code/Magento/CatalogInventory/Test/Unit/Model/Source/StockTest.php

@@ -10,6 +10,10 @@
 use Magento\CatalogInventory\Model\Source\Stock;
 use Magento\Eav\Model\Entity\Collection\AbstractCollection;
 use Magento\Framework\DB\Select;
+use Magento\Framework\EntityManager\EntityMetadata;
+use Magento\Framework\EntityManager\MetadataPool;
+use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
+use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 
 class StockTest extends TestCase
@@ -19,29 +23,47 @@ class StockTest extends TestCase
      */
     private $model;
 
+    /**
+     * @var MetadataPool|MockObject
+     */
+    private $metadataPool;
+
     protected function setUp(): void
     {
-        $this->model = new Stock();
+        $this->metadataPool = $this->getMockBuilder(MetadataPool::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $this->model = new Stock($this->metadataPool);
     }
 
     public function testAddValueSortToCollection()
     {
+        $entityMetadata = $this->getMockBuilder(EntityMetadata::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+        $entityMetadata->expects($this->once())
+            ->method('getLinkField')
+            ->willReturn('entity_id');
+        $this->metadataPool->expects($this->once())
+            ->method('getMetadata')
+            ->willReturn($entityMetadata);
+
         $selectMock = $this->createMock(Select::class);
         $collectionMock = $this->createMock(AbstractCollection::class);
         $collectionMock->expects($this->atLeastOnce())->method('getSelect')->willReturn($selectMock);
         $collectionMock->expects($this->atLeastOnce())->method('getTable')->willReturn('cataloginventory_stock_item');
+        $collectionMock->expects($this->exactly(3))->method('joinField')
+            ->withConsecutive(['child_id'], ['child_stock'], ['parent_stock'])
+            ->willReturnSelf();
 
         $selectMock->expects($this->once())
-            ->method('joinLeft')
-            ->with(
-                ['stock_item_table' => 'cataloginventory_stock_item'],
-                "e.entity_id=stock_item_table.product_id",
-                []
-            )
+            ->method('group')
+            ->with('e.entity_id')
             ->willReturnSelf();
         $selectMock->expects($this->once())
             ->method('order')
-            ->with("stock_item_table.qty DESC")
+            ->with('stock DESC')
             ->willReturnSelf();
 
         $this->model->addValueSortToCollection($collectionMock);