ACP2E-72: Search results suggestion give total count of 0 even though there are products

 - Fixed the solution and test coverage.

Author: devarul

app/code/Magento/AdvancedSearch/Plugin/Model/SearchSuggestionResultsCount.php

@@ -40,7 +40,4 @@
         </arguments>
     </type>
     <preference for="Magento\AdvancedSearch\Model\Adapter\DataMapper\AdditionalFieldsProviderInterface" type="Magento\AdvancedSearch\Model\Adapter\DataMapper\AdditionalFieldsProvider" />
-    <type name="Magento\Search\Model\QueryResult">
-        <plugin name="getSearchSuggestionResultsCount" type="Magento\AdvancedSearch\Plugin\Model\SearchSuggestionResultsCount" sortOrder="1"/>
-    </type>
 </config>

app/code/Magento/AdvancedSearch/Test/Unit/Plugin/Model/SearchSuggestionResultsCountTest.php

@@ -5,6 +5,7 @@
  */
 namespace Magento\Elasticsearch\Model\DataProvider\Base;
 
+use Countable;
 use Elasticsearch\Common\Exceptions\BadRequest400Exception;
 use Magento\AdvancedSearch\Model\SuggestedQueriesInterface;
 use Magento\Elasticsearch\Model\Adapter\FieldMapper\Product\FieldProviderInterface;
@@ -13,11 +14,14 @@
 use Magento\Elasticsearch\SearchAdapter\SearchIndexNameResolver;
 use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Framework\App\ObjectManager;
+use Magento\Framework\Search\ResponseInterface;
 use Magento\Search\Model\QueryInterface;
 use Magento\Search\Model\QueryResultFactory;
 use Magento\Store\Model\ScopeInterface;
 use Magento\Store\Model\StoreManagerInterface as StoreManager;
 use Psr\Log\LoggerInterface;
+use Magento\Framework\Search\Request\Builder;
+use Magento\Framework\Search\SearchEngineInterface;
 
 /**
  * Default implementation to provide suggestions mechanism for Elasticsearch
@@ -65,6 +69,16 @@ class Suggestions implements SuggestedQueriesInterface
      */
     private $logger;
 
+    /**
+     * @var Builder
+     */
+    private $requestBuilder;
+
+    /**
+     * @var SearchEngineInterface
+     */
+    private $searchEngine;
+
     /**
      * Suggestions constructor.
      *
@@ -76,6 +90,8 @@ class Suggestions implements SuggestedQueriesInterface
      * @param StoreManager $storeManager
      * @param FieldProviderInterface $fieldProvider
      * @param LoggerInterface|null $logger
+     * @param Builder|null $requestBuilder
+     * @param SearchEngineInterface|null $searchEngine
      */
     public function __construct(
         ScopeConfigInterface $scopeConfig,
@@ -85,7 +101,9 @@ public function __construct(
         SearchIndexNameResolver $searchIndexNameResolver,
         StoreManager $storeManager,
         FieldProviderInterface $fieldProvider,
-        LoggerInterface $logger = null
+        LoggerInterface $logger = null,
+        Builder $requestBuilder = null,
+        SearchEngineInterface $searchEngine = null
     ) {
         $this->queryResultFactory = $queryResultFactory;
         $this->connectionManager = $connectionManager;
@@ -95,6 +113,8 @@ public function __construct(
         $this->storeManager = $storeManager;
         $this->fieldProvider = $fieldProvider;
         $this->logger = $logger ?: ObjectManager::getInstance()->get(LoggerInterface::class);
+        $this->requestBuilder = $requestBuilder ?: ObjectManager::getInstance()->get(Builder::class);
+        $this->searchEngine = $searchEngine ?: ObjectManager::getInstance()->get(SearchEngineInterface::class);
     }
 
     /**
@@ -115,7 +135,12 @@ public function getItems(QueryInterface $query)
             foreach ($suggestions as $suggestion) {
                 $count = null;
                 if ($isResultsCountEnabled) {
-                    $count = isset($suggestion['freq']) ? $suggestion['freq'] : null;
+                    $this->requestBuilder->setRequestName('quick_search_container');
+                    $this->requestBuilder->bind('search_term', $suggestion['text']);
+                    $request = $this->requestBuilder->create();
+                    /** @var ResponseInterface|Countable $searchResult */
+                    $searchResult = $this->searchEngine->search($request);
+                    $count = $searchResult->count();
                 }
                 $result[] = $this->queryResultFactory->create(
                     [

app/code/Magento/AdvancedSearch/etc/di.xml

@@ -16,6 +16,10 @@
 use Magento\Elasticsearch\SearchAdapter\SearchIndexNameResolver;
 use Magento\Elasticsearch6\Model\Client\Elasticsearch;
 use Magento\Framework\App\Config\ScopeConfigInterface;
+use Magento\Framework\Search\Request\Builder;
+use Magento\Framework\Search\RequestInterface;
+use Magento\Framework\Search\ResponseInterface;
+use Magento\Framework\Search\SearchEngineInterface;
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager as ObjectManagerHelper;
 use Magento\Search\Model\QueryInterface;
 use Magento\Search\Model\QueryResult;
@@ -86,6 +90,16 @@ class SuggestionsTest extends TestCase
      */
     private $query;
 
+    /**
+     * @var Builder|MockObject
+     */
+    protected $requestBuilder;
+
+    /**
+     * @var SearchEngineInterface|MockObject
+     */
+    protected $searchEngine;
+
     /**
      * Set up test environment
      *
@@ -138,6 +152,14 @@ protected function setUp(): void
             ->disableOriginalConstructor()
             ->getMockForAbstractClass();
 
+        $this->requestBuilder = $this->getMockBuilder(Builder::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $this->searchEngine = $this->getMockBuilder(SearchEngineInterface::class)
+            ->disableOriginalConstructor()
+            ->getMockForAbstractClass();
+
         $objectManager = new ObjectManagerHelper($this);
 
         $this->model = $objectManager->getObject(
@@ -151,6 +173,8 @@ protected function setUp(): void
                 'storeManager' => $this->storeManager,
                 'fieldProvider' => $this->fieldProvider,
                 'logger' => $this->logger,
+                'requestBuilder' => $this->requestBuilder,
+                'searchEngine' => $this->searchEngine,
             ]
         );
     }
@@ -197,8 +221,7 @@ public function testGetItemsWithEnabledSearchSuggestion(): void
                             'options' => [
                                 'suggestion' => [
                                     'text' => 'query',
-                                    'score' => 1,
-                                    'freq' => 1,
+                                    'score' => 1
                                 ]
                             ]
                         ]
@@ -215,6 +238,7 @@ public function testGetItemsWithEnabledSearchSuggestion(): void
 
         $this->queryResultFactory->expects($this->once())
             ->method('create')
+            ->with(['queryText' => 'query', 'resultsCount' => 5])
             ->willReturn($query);
 
         $this->assertEquals([$query], $this->model->getItems($this->query));
@@ -291,5 +315,37 @@ private function prepareSearchQuery(): void
         $this->connectionManager->expects($this->once())
             ->method('getConnection')
             ->willReturn($this->client);
+
+        $request = $this->getMockBuilder(RequestInterface::class)
+            ->disableOriginalConstructor()
+            ->getMockForAbstractClass();
+
+        $response = $this->getMockBuilder(ResponseInterface::class)
+            ->disableOriginalConstructor()
+            ->onlyMethods(['count'])
+            ->getMockForAbstractClass();
+
+        $response->expects($this->any())
+            ->method('count')
+            ->willReturn(5);
+
+        $this->requestBuilder->expects($this->any())
+            ->method('setRequestName')
+            ->with('quick_search_container')
+            ->willReturnSelf();
+
+        $this->requestBuilder->expects($this->any())
+            ->method('bind')
+            ->with('search_term', 'query')
+            ->willReturnSelf();
+
+        $this->requestBuilder->expects($this->any())
+            ->method('create')
+            ->willReturn($request);
+
+        $this->searchEngine->expects($this->any())
+            ->method('search')
+            ->with($request)
+            ->willReturn($response);
     }
 }