Merge pull request #7131 from magento-l3/L3_PR_21-10-10

L3_PR_21-10-10

Author: viktym

app/code/Magento/CatalogGraphQl/Model/QueryProcessor.php

@@ -0,0 +1,63 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\CatalogGraphQl\Model;
+
+use Magento\Framework\Exception\NoSuchEntityException;
+use Magento\Framework\Stdlib\StringUtils as StdlibString;
+use Magento\GraphQl\Model\Query\ContextInterface;
+use Magento\Search\Model\Query;
+use Magento\Search\Model\QueryFactory;
+
+/**
+ * Prepares search query based on search text.
+ */
+class QueryProcessor
+{
+    /**
+     * @var QueryFactory
+     */
+    private $queryFactory;
+
+    /**
+     * @var StdlibString
+     */
+    private $string;
+
+    /**
+     * @param QueryFactory $queryFactory
+     * @param StdlibString $string
+     */
+    public function __construct(
+        QueryFactory $queryFactory,
+        StdlibString $string
+    ) {
+        $this->queryFactory  = $queryFactory;
+        $this->string = $string;
+    }
+
+    /**
+     * Prepare Query object based on search text
+     *
+     * @param ContextInterface $context
+     * @param string $queryText
+     * @throws NoSuchEntityException
+     * @return Query
+     */
+    public function prepare(ContextInterface $context, string $queryText) : Query
+    {
+        $query = $this->queryFactory->create();
+        $maxQueryLength = (int) $query->getMaxQueryLength();
+        if ($maxQueryLength && $this->string->strlen($queryText) > $maxQueryLength) {
+            $queryText = $this->string->substr($queryText, 0, $maxQueryLength);
+        }
+        $query->setQueryText($queryText);
+        $store = $context->getExtensionAttributes()->getStore();
+        $query->setStoreId($store->getId());
+        return $query;
+    }
+}

app/code/Magento/CatalogGraphQl/Model/Resolver/Products.php

@@ -70,6 +70,7 @@ public function resolve(
         $data = [
             'total_count' => $searchResult->getTotalCount(),
             'items' => $searchResult->getProductsSearchResult(),
+            'suggestions' => $searchResult->getSuggestions(),
             'page_info' => [
                 'page_size' => $searchResult->getPageSize(),
                 'current_page' => $searchResult->getCurrentPage(),

app/code/Magento/CatalogGraphQl/Model/Resolver/Products/Query/Search.php

@@ -63,6 +63,11 @@ class Search implements ProductQueryInterface
      */
     private $searchCriteriaBuilder;
 
+    /**
+     * @var Suggestions
+     */
+    private $suggestions;
+
     /**
      * @var QueryPopularity
      */
@@ -76,6 +81,7 @@ class Search implements ProductQueryInterface
      * @param ProductSearch $productsProvider
      * @param SearchCriteriaBuilder $searchCriteriaBuilder
      * @param ArgumentsProcessorInterface|null $argsSelection
+     * @param Suggestions|null $suggestions
      * @param QueryPopularity|null $queryPopularity
      */
     public function __construct(
@@ -86,6 +92,7 @@ public function __construct(
         ProductSearch $productsProvider,
         SearchCriteriaBuilder $searchCriteriaBuilder,
         ArgumentsProcessorInterface $argsSelection = null,
+        Suggestions $suggestions = null,
         QueryPopularity $queryPopularity = null
     ) {
         $this->search = $search;
@@ -94,7 +101,10 @@ public function __construct(
         $this->fieldSelection = $fieldSelection;
         $this->productsProvider = $productsProvider;
         $this->searchCriteriaBuilder = $searchCriteriaBuilder;
-        $this->argsSelection = $argsSelection ?: ObjectManager::getInstance()->get(ArgumentsProcessorInterface::class);
+        $this->argsSelection = $argsSelection ?: ObjectManager::getInstance()
+            ->get(ArgumentsProcessorInterface::class);
+        $this->suggestions = $suggestions ?: ObjectManager::getInstance()
+            ->get(Suggestions::class);
         $this->queryPopularity = $queryPopularity ?: ObjectManager::getInstance()->get(QueryPopularity::class);
     }
 
@@ -146,14 +156,21 @@ public function getResult(
             $productArray[$product->getId()]['model'] = $product;
         }
 
+        $suggestions = [];
+        $totalCount = (int) $searchResults->getTotalCount();
+        if ($totalCount === 0 && !empty($args['search'])) {
+            $suggestions = $this->suggestions->execute($context, $args['search']);
+        }
+
         return $this->searchResultFactory->create(
             [
-                'totalCount' => $searchResults->getTotalCount(),
+                'totalCount' => $totalCount,
                 'productsSearchResult' => $productArray,
                 'searchAggregation' => $itemsResults->getAggregations(),
                 'pageSize' => $realPageSize,
                 'currentPage' => $realCurrentPage,
                 'totalPages' => $totalPages,
+                'suggestions' => $suggestions,
             ]
         );
     }

app/code/Magento/CatalogGraphQl/Model/Resolver/Products/Query/Suggestions.php

@@ -0,0 +1,58 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\CatalogGraphQl\Model\Resolver\Products\Query;
+
+use Magento\AdvancedSearch\Model\SuggestedQueries;
+use Magento\GraphQl\Model\Query\ContextInterface;
+use Magento\CatalogGraphQl\Model\QueryProcessor;
+
+/**
+ * Search suggestions implementations for GraphQL
+ */
+class Suggestions
+{
+    /**
+     * @var QueryProcessor
+     */
+    private $queryProcessor;
+
+    /**
+     * @var SuggestedQueries
+     */
+    private $suggestedQueries;
+
+    /**
+     * @param QueryProcessor $queryProcessor
+     * @param SuggestedQueries $suggestedQueries
+     */
+    public function __construct(
+        QueryProcessor $queryProcessor,
+        SuggestedQueries $suggestedQueries
+    ) {
+        $this->queryProcessor = $queryProcessor;
+        $this->suggestedQueries = $suggestedQueries;
+    }
+
+    /**
+     * Return search suggestions for the provided query text
+     *
+     * @param ContextInterface $context
+     * @param string $queryText
+     * @return array
+     */
+    public function execute(ContextInterface $context, string $queryText) : array
+    {
+        $result = [];
+        $query = $this->queryProcessor->prepare($context, $queryText);
+        $suggestionItems = $this->suggestedQueries->getItems($query);
+        foreach ($suggestionItems as $suggestion) {
+            $result[] = ['search' => $suggestion->getQueryText()];
+        }
+        return $result;
+    }
+}

app/code/Magento/CatalogGraphQl/Model/Resolver/Products/SearchResult.php

@@ -14,6 +14,9 @@
  */
 class SearchResult
 {
+    /**
+     * @var array
+     */
     private $data;
 
     /**
@@ -83,4 +86,14 @@ public function getTotalPages(): int
     {
         return $this->data['totalPages'] ?? 0;
     }
+
+    /**
+     * Retrieve an array in the format of GraphQL-readable type containing search suggestions.
+     *
+     * @return array
+     */
+    public function getSuggestions() : array
+    {
+        return $this->data['suggestions'] ?? [];
+    }
 }

app/code/Magento/CatalogGraphQl/Test/Unit/Model/Resolver/Products/Query/SearchTest.php

@@ -13,6 +13,7 @@
 use Magento\CatalogGraphQl\Model\Resolver\Products\Query\Search;
 use Magento\CatalogGraphQl\Model\Resolver\Products\Query\Search\QueryPopularity;
 use Magento\CatalogGraphQl\Model\Resolver\Products\SearchResultFactory;
+use Magento\CatalogGraphQl\Model\Resolver\Products\Query\Suggestions;
 use Magento\Framework\Api\Search\SearchCriteriaInterface;
 use Magento\Framework\Api\Search\SearchResultInterface;
 use Magento\Framework\GraphQl\Query\Resolver\ArgumentsProcessorInterface;
@@ -21,7 +22,6 @@
 use Magento\GraphQl\Model\Query\ContextInterface;
 use Magento\Search\Api\SearchInterface;
 use Magento\Search\Model\Search\PageSizeProvider;
-use Magento\Store\Api\Data\StoreInterface;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 
@@ -67,6 +67,11 @@ class SearchTest extends TestCase
      */
     private $searchCriteriaBuilder;
 
+    /**
+     * @var Suggestions|MockObject
+     */
+    private $suggestions;
+
     /**
      * @var QueryPopularity|MockObject
      */
@@ -104,6 +109,9 @@ protected function setUp(): void
         $this->searchCriteriaBuilder = $this->getMockBuilder(SearchCriteriaBuilder::class)
             ->disableOriginalConstructor()
             ->getMock();
+        $this->suggestions = $this->getMockBuilder(Suggestions::class)
+            ->disableOriginalConstructor()
+            ->getMock();
         $this->queryPopularity = $this->getMockBuilder(QueryPopularity::class)
             ->disableOriginalConstructor()
             ->getMock();
@@ -115,6 +123,7 @@ protected function setUp(): void
             $this->productsProvider,
             $this->searchCriteriaBuilder,
             $this->argsSelection,
+            $this->suggestions,
             $this->queryPopularity
         );
     }

app/code/Magento/CatalogGraphQl/composer.json

@@ -13,7 +13,8 @@
         "magento/module-eav-graph-ql": "*",
         "magento/module-catalog-search": "*",
         "magento/framework": "*",
-        "magento/module-graph-ql": "*"
+        "magento/module-graph-ql": "*",
+        "magento/module-advanced-search": "*"
     },
     "suggest": {
         "magento/module-graph-ql-cache": "*",

app/code/Magento/CatalogGraphQl/etc/schema.graphqls

@@ -322,6 +322,7 @@ type Products @doc(description: "The Products object is the top-level object ret
     filters: [LayerFilter] @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\LayerFilters") @doc(description: "Layered navigation filters array.") @deprecated(reason: "Use aggregations instead")
     aggregations: [Aggregation] @doc(description: "Layered navigation aggregations.") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Aggregations")
     sort_fields: SortFields @doc(description: "An object that includes the default sort field and all available sort fields.") @resolver(class: "Magento\\CatalogGraphQl\\Model\\Resolver\\Category\\SortFields")
+    suggestions: [SearchSuggestion] @doc(description: "An array of search suggestions for case when search query have no results.")
 }
 
 type CategoryProducts @doc(description: "The category products object returned in the Category query.") {
@@ -477,6 +478,10 @@ type Aggregation @doc(description: "A bucket that contains information for each
     position: Int @doc(description: "The relative position of the attribute in a layered navigation block")
 }
 
+type SearchSuggestion @doc(description: "A string that contains search suggestion") {
+    search: String! @doc(description: "The search suggestion of existing product.")
+}
+
 interface AggregationOptionInterface @typeResolver(class: "Magento\\CatalogGraphQl\\Model\\AggregationOptionTypeResolverComposite") {
     count: Int @doc(description: "The number of items that match the aggregation option.")
     label: String @doc(description: "Aggregation option display label.")

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

@@ -171,8 +171,6 @@ class Product extends AbstractEntity
     const URL_KEY = 'url_key';
 
     /**
-     * Attribute cache
-     *
      * @var array
      */
     protected $_attributeCache = [];
@@ -238,8 +236,6 @@ class Product extends AbstractEntity
     ];
 
     /**
-     * Attributes codes which shows as date
-     *
      * @var array
      * @since 100.1.2
      */
@@ -253,8 +249,6 @@ class Product extends AbstractEntity
     ];
 
     /**
-     * Need to log in import history
-     *
      * @var bool
      */
     protected $logInHistory = true;
@@ -267,8 +261,6 @@ class Product extends AbstractEntity
     protected $_mediaGalleryAttributeId = null;
 
     /**
-     * Validation failure message template definitions
-     *
      * @var array
      * @codingStandardsIgnoreStart
      */
@@ -650,7 +642,7 @@ class Product extends AbstractEntity
     private $_logger;
 
     /**
-     * {@inheritdoc}
+     * @var string
      */
     protected $masterAttributeCode = 'sku';
 
@@ -691,15 +683,11 @@ class Product extends AbstractEntity
     protected $rowNumbers = [];
 
     /**
-     * Product entity link field
-     *
      * @var string
      */
     private $productEntityLinkField;
 
     /**
-     * Product entity identifier field
-     *
      * @var string
      */
     private $productEntityIdentifierField;
@@ -726,8 +714,6 @@ class Product extends AbstractEntity
     private $catalogConfig;
 
     /**
-     * Stock Item Importer
-     *
      * @var StockItemImporterInterface
      */
     private $stockItemImporter;
@@ -3161,10 +3147,6 @@ private function formatStockDataForRow(array $rowData): array
         $stockItemDo = $this->stockRegistry->getStockItem($row['product_id'], $row['website_id']);
         $existStockData = $stockItemDo->getData();
 
-        if (isset($rowData['qty']) && $rowData['qty'] == 0 && !isset($rowData['is_in_stock'])) {
-            $rowData['is_in_stock'] = 0;
-        }
-
         $row = array_merge(
             $this->defaultStockData,
             array_intersect_key($existStockData, $this->defaultStockData),
@@ -3173,11 +3155,10 @@ private function formatStockDataForRow(array $rowData): array
         );
 
         if ($this->stockConfiguration->isQty($this->skuProcessor->getNewSku($sku)['type_id'])) {
-            if (isset($rowData['qty']) && $rowData['qty'] == 0) {
-                $row['is_in_stock'] = 0;
-            }
             $stockItemDo->setData($row);
-            $row['is_in_stock'] = $row['is_in_stock'] ?? $this->stockStateProvider->verifyStock($stockItemDo);
+            $row['is_in_stock'] = $this->stockStateProvider->verifyStock($stockItemDo)
+                ? (int) $row['is_in_stock']
+                : 0;
             if ($this->stockStateProvider->verifyNotification($stockItemDo)) {
                 $date = $this->dateTimeFactory->create('now', new \DateTimeZone('UTC'));
                 $row['low_stock_date'] = $date->format(DateTime::DATETIME_PHP_FORMAT);