magento/graphql-ce#736: Configurable products with "out of stock" return as product: null

- added tests

Author: lenaorobei

app/code/Magento/ConfigurableProductGraphQl/Model/Variant/Collection.php

@@ -9,14 +9,11 @@
 
 use Magento\Catalog\Api\Data\ProductInterface;
 use Magento\Catalog\Model\Product;
-use Magento\Catalog\Model\ProductFactory;
 use Magento\ConfigurableProduct\Model\ResourceModel\Product\Type\Configurable\Product\Collection as ChildCollection;
 use Magento\ConfigurableProduct\Model\ResourceModel\Product\Type\Configurable\Product\CollectionFactory;
 use Magento\Framework\EntityManager\MetadataPool;
 use Magento\Framework\Api\SearchCriteriaBuilder;
-use Magento\CatalogGraphQl\Model\Resolver\Products\DataProvider\Product as DataProvider;
-use Magento\CatalogInventory\Helper\Stock;
-use Magento\CatalogInventory\Api\StockConfigurationInterface;
+use Magento\CatalogGraphQl\Model\Resolver\Products\DataProvider\Product\CollectionProcessorInterface;
 
 /**
  * Collection for fetching configurable child product data.
@@ -28,31 +25,11 @@ class Collection
      */
     private $childCollectionFactory;
 
-    /**
-     * @var ProductFactory
-     */
-    private $productFactory;
-
     /**
      * @var SearchCriteriaBuilder
      */
     private $searchCriteriaBuilder;
 
-    /**
-     * @var DataProvider
-     */
-    private $productDataProvider;
-
-    /**
-     * @var Stock
-     */
-    private $stockHelper;
-
-    /**
-     * @var StockConfigurationInterface
-     */
-    private $stockConfig;
-
     /**
      * @var MetadataPool
      */
@@ -73,31 +50,27 @@ class Collection
      */
     private $attributeCodes = [];
 
+    /**
+     * @var CollectionProcessorInterface
+     */
+    private $collectionProcessor;
+
     /**
      * @param CollectionFactory $childCollectionFactory
-     * @param ProductFactory $productFactory
      * @param SearchCriteriaBuilder $searchCriteriaBuilder
-     * @param DataProvider $productDataProvider
      * @param MetadataPool $metadataPool
-     * @param Stock $stockHelper
-     * @param StockConfigurationInterface $stockConfig
+     * @param CollectionProcessorInterface $collectionProcessor
      */
     public function __construct(
         CollectionFactory $childCollectionFactory,
-        ProductFactory $productFactory,
         SearchCriteriaBuilder $searchCriteriaBuilder,
-        DataProvider $productDataProvider,
         MetadataPool $metadataPool,
-        Stock $stockHelper,
-        StockConfigurationInterface $stockConfig
+        CollectionProcessorInterface $collectionProcessor
     ) {
         $this->childCollectionFactory = $childCollectionFactory;
-        $this->productFactory = $productFactory;
         $this->searchCriteriaBuilder = $searchCriteriaBuilder;
-        $this->productDataProvider = $productDataProvider;
         $this->metadataPool = $metadataPool;
-        $this->stockHelper = $stockHelper;
-        $this->stockConfig = $stockConfig;
+        $this->collectionProcessor = $collectionProcessor;
     }
 
     /**
@@ -161,18 +134,16 @@ private function fetch() : array
             return $this->childrenMap;
         }
 
-        $showOutOfStock = $this->stockConfig->isShowOutOfStock();
-
         foreach ($this->parentProducts as $product) {
             $attributeData = $this->getAttributesCodes($product);
             /** @var ChildCollection $childCollection */
             $childCollection = $this->childCollectionFactory->create();
             $childCollection->setProductFilter($product);
-            $childCollection->addAttributeToSelect($attributeData);
-
-            if (!$showOutOfStock) {
-                $this->stockHelper->addInStockFilterToCollection($childCollection);
-            }
+            $this->collectionProcessor->process(
+                $childCollection,
+                $this->searchCriteriaBuilder->create(),
+                $attributeData
+            );
 
             /** @var Product $childProduct */
             foreach ($childCollection->getItems() as $childProduct) {

dev/tests/api-functional/testsuite/Magento/GraphQl/ConfigurableProduct/ConfigurableProductStockStatusTest.php

@@ -0,0 +1,99 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\GraphQl\ConfigurableProduct;
+
+use Magento\TestFramework\TestCase\GraphQlAbstract;
+use Magento\TestFramework\Helper\Bootstrap;
+use Magento\CatalogInventory\Api\StockRegistryInterface;
+
+/**
+ * Checks if stock status correctly displays for configurable variants.
+ */
+class ConfigurableProductStockStatusTest extends GraphQlAbstract
+{
+    /**
+     * @var StockRegistryInterface
+     */
+    private $stockRegistry;
+
+    /**
+     * @inheritdoc
+     */
+    protected function setUp()
+    {
+        $this->stockRegistry = Bootstrap::getObjectManager()->create(StockRegistryInterface::class);
+    }
+
+    /**
+     * @magentoApiDataFixture Magento/Framework/Search/_files/product_configurable.php
+     * @magentoConfigFixture default_store cataloginventory/options/show_out_of_stock 1
+     */
+    public function testConfigurableProductShowOutOfStock()
+    {
+        $parentSku = 'configurable';
+        $childSkuOutOfStock = 'simple_1010';
+        $stockItem = $this->stockRegistry->getStockItemBySku($childSkuOutOfStock);
+        $stockItem->setQty(0);
+        $this->stockRegistry->updateStockItemBySku($childSkuOutOfStock, $stockItem);
+        $query = $this->getQuery($parentSku);
+        $response = $this->graphQlQuery($query);
+
+        foreach ($response['products']['items'][0]['variants'] as $children) {
+            if ($children['product']['sku'] === $childSkuOutOfStock) {
+                $this->assertEquals('OUT_OF_STOCK', $children['product']['stock_status']);
+            } else {
+                $this->assertEquals('IN_STOCK', $children['product']['stock_status']);
+            }
+        }
+    }
+
+    /**
+     * @magentoApiDataFixture Magento/Framework/Search/_files/product_configurable.php
+     * @magentoConfigFixture default_store cataloginventory/options/show_out_of_stock 0
+     */
+    public function testConfigurableProductDoNotShowOutOfStock()
+    {
+        $parentSku = 'configurable';
+        $childSkuOutOfStock = 'simple_1010';
+        $stockItem = $this->stockRegistry->getStockItemBySku($childSkuOutOfStock);
+        $stockItem->setQty(0);
+        $this->stockRegistry->updateStockItemBySku($childSkuOutOfStock, $stockItem);
+        $query = $this->getQuery($parentSku);
+        $response = $this->graphQlQuery($query);
+        $this->assertEquals(
+            [['product' => ['sku' => 'simple_1020', 'stock_status' => 'IN_STOCK']]],
+            $response['products']['items'][0]['variants']
+        );
+    }
+
+    /**
+     * @param string $sku
+     * @return string
+     */
+    private function getQuery(string $sku)
+    {
+        return <<<QUERY
+        {
+            products(filter: {sku: {eq: "{$sku}"}})
+            {
+                items {
+                    sku
+                    ... on ConfigurableProduct {
+                        variants {
+                            product {
+                                sku
+                                stock_status
+                            }
+                        }
+                    }
+                }
+            }
+        }
+QUERY;
+    }
+}