Skip to content

Commit 0d69677

Browse files
devaruldevarul
committed
ACP2E-72: Search results suggestion give total count of 0 even though there are products
 - Fixed the CR comments.
1 parent 74ed374 commit 0d69677

File tree

6 files changed

+247
-83
lines changed

6 files changed

+247
-83
lines changed

‎app/code/Magento/Elasticsearch/Model/DataProvider/Base/GetSuggestionFrequency.php

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
<?php
2+
/**
3+
* Copyright © Magento, Inc. All rights reserved.
4+
* See COPYING.txt for license details.
5+
*/
6+
declare(strict_types=1);
7+
8+
namespace Magento\Elasticsearch\Model\DataProvider\Base;
9+
10+
use Magento\Framework\Api\FilterBuilder;
11+
use Magento\Framework\Api\Search\SearchCriteriaBuilder;
12+
use Magento\Framework\App\ObjectManager;
13+
use Magento\Search\Api\SearchInterface;
14+
15+
/**
16+
* Get the search suggestion result count
17+
*/
18+
class GetSuggestionFrequency implements GetSuggestionFrequencyInterface
19+
{
20+
/**
21+
* @var FilterBuilder
22+
*/
23+
private $filterBuilder;
24+
25+
/**
26+
* @var SearchCriteriaBuilder
27+
*/
28+
private $searchCriteriaBuilder;
29+
30+
/**
31+
* @var SearchInterface
32+
*/
33+
private $search;
34+
35+
/**
36+
* Search suggestion frequency constructor.
37+
*
38+
* @param FilterBuilder|null $filterBuilder
39+
* @param SearchCriteriaBuilder|null $searchCriteriaBuilder
40+
* @param SearchInterface|null $search
41+
*/
42+
public function __construct(
43+
?FilterBuilder $filterBuilder = null,
44+
?SearchCriteriaBuilder $searchCriteriaBuilder = null,
45+
?SearchInterface $search = null
46+
) {
47+
$this->filterBuilder = $filterBuilder ?:
48+
ObjectManager::getInstance()->get(FilterBuilder::class);
49+
$this->searchCriteriaBuilder = $searchCriteriaBuilder ?:
50+
ObjectManager::getInstance()->get(SearchCriteriaBuilder::class);
51+
$this->search = $search ?:
52+
ObjectManager::getInstance()->get(SearchInterface::class);
53+
}
54+
/**
55+
* Get the search suggestion frequency
56+
*
57+
* @param string $text
58+
* @return int
59+
*/
60+
public function execute(string $text): int
61+
{
62+
$this->filterBuilder->setField('search_term');
63+
$this->filterBuilder->setValue($text);
64+
$this->searchCriteriaBuilder->addFilter($this->filterBuilder->create());
65+
$searchCriteria = $this->searchCriteriaBuilder->create();
66+
$searchCriteria->setRequestName('quick_search_container');
67+
$searchCriteria->setCurrentPage(1);
68+
$searchCriteria->setPageSize(1);
69+
$searchCriteria->setSortOrders([]);
70+
$searchResult = $this->search->search($searchCriteria);
71+
return $searchResult->getTotalCount();
72+
}
73+
}

‎app/code/Magento/Elasticsearch/Model/DataProvider/Base/GetSuggestionFrequencyInterface.php

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<?php
2+
/**
3+
* Copyright © Magento, Inc. All rights reserved.
4+
* See COPYING.txt for license details.
5+
*/
6+
declare(strict_types=1);
7+
8+
namespace Magento\Elasticsearch\Model\DataProvider\Base;
9+
10+
/**
11+
* Get the search suggestion result count
12+
*/
13+
interface GetSuggestionFrequencyInterface
14+
{
15+
/**
16+
* Get the search suggestion frequency
17+
*
18+
* @param string $text
19+
* @return int
20+
*/
21+
public function execute(string $text): int;
22+
}

‎app/code/Magento/Elasticsearch/Model/DataProvider/Base/Suggestions.php

Lines changed: 12 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
*/
66
namespace Magento\Elasticsearch\Model\DataProvider\Base;
77

8-
use Countable;
98
use Elasticsearch\Common\Exceptions\BadRequest400Exception;
109
use Magento\AdvancedSearch\Model\SuggestedQueriesInterface;
1110
use Magento\Elasticsearch\Model\Adapter\FieldMapper\Product\FieldProviderInterface;
@@ -14,14 +13,11 @@
1413
use Magento\Elasticsearch\SearchAdapter\SearchIndexNameResolver;
1514
use Magento\Framework\App\Config\ScopeConfigInterface;
1615
use Magento\Framework\App\ObjectManager;
17-
use Magento\Framework\Search\ResponseInterface;
1816
use Magento\Search\Model\QueryInterface;
1917
use Magento\Search\Model\QueryResultFactory;
2018
use Magento\Store\Model\ScopeInterface;
2119
use Magento\Store\Model\StoreManagerInterface as StoreManager;
2220
use Psr\Log\LoggerInterface;
23-
use Magento\Framework\Search\Request\Builder;
24-
use Magento\Framework\Search\SearchEngineInterface;
2521

2622
/**
2723
* Default implementation to provide suggestions mechanism for Elasticsearch
@@ -70,14 +66,9 @@ class Suggestions implements SuggestedQueriesInterface
7066
private $logger;
7167

7268
/**
73-
* @var Builder
69+
* @var GetSuggestionFrequencyInterface
7470
*/
75-
private $requestBuilder;
76-
77-
/**
78-
* @var SearchEngineInterface
79-
*/
80-
private $searchEngine;
71+
private $getSuggestionFrequency;
8172

8273
/**
8374
* Suggestions constructor.
@@ -90,10 +81,7 @@ class Suggestions implements SuggestedQueriesInterface
9081
* @param StoreManager $storeManager
9182
* @param FieldProviderInterface $fieldProvider
9283
* @param LoggerInterface|null $logger
93-
* @param Builder|null $requestBuilder
94-
* @param SearchEngineInterface|null $searchEngine
95-
*
96-
* @SuppressWarnings(PHPMD.ExcessiveParameterList)
84+
* @param GetSuggestionFrequencyInterface|null $getSuggestionFrequency
9785
*/
9886
public function __construct(
9987
ScopeConfigInterface $scopeConfig,
@@ -104,8 +92,7 @@ public function __construct(
10492
StoreManager $storeManager,
10593
FieldProviderInterface $fieldProvider,
10694
LoggerInterface $logger = null,
107-
Builder $requestBuilder = null,
108-
SearchEngineInterface $searchEngine = null
95+
?GetSuggestionFrequencyInterface $getSuggestionFrequency = null
10996
) {
11097
$this->queryResultFactory = $queryResultFactory;
11198
$this->connectionManager = $connectionManager;
@@ -115,8 +102,8 @@ public function __construct(
115102
$this->storeManager = $storeManager;
116103
$this->fieldProvider = $fieldProvider;
117104
$this->logger = $logger ?: ObjectManager::getInstance()->get(LoggerInterface::class);
118-
$this->requestBuilder = $requestBuilder ?: ObjectManager::getInstance()->get(Builder::class);
119-
$this->searchEngine = $searchEngine ?: ObjectManager::getInstance()->get(SearchEngineInterface::class);
105+
$this->getSuggestionFrequency = $getSuggestionFrequency ?:
106+
ObjectManager::getInstance()->get(GetSuggestionFrequencyInterface::class);
120107
}
121108

122109
/**
@@ -137,12 +124,12 @@ public function getItems(QueryInterface $query)
137124
foreach ($suggestions as $suggestion) {
138125
$count = null;
139126
if ($isResultsCountEnabled) {
140-
$this->requestBuilder->setRequestName('quick_search_container');
141-
$this->requestBuilder->bind('search_term', $suggestion['text']);
142-
$request = $this->requestBuilder->create();
143-
/** @var ResponseInterface|Countable $searchResult */
144-
$searchResult = $this->searchEngine->search($request);
145-
$count = $searchResult->count();
127+
try {
128+
$count = $this->getSuggestionFrequency->execute($suggestion['text']);
129+
} catch (\Exception $e) {
130+
$this->logger->critical($e);
131+
}
132+
146133
}
147134
$result[] = $this->queryResultFactory->create(
148135
[

‎app/code/Magento/Elasticsearch/Test/Unit/Model/DataProvider/Base/GetSuggestionFrequencyTest.php

Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
<?php
2+
/**
3+
* Copyright © Magento, Inc. All rights reserved.
4+
* See COPYING.txt for license details.
5+
*/
6+
declare(strict_types=1);
7+
8+
namespace Magento\Elasticsearch\Test\Unit\Model\DataProvider\Base;
9+
10+
use Magento\Elasticsearch\Model\DataProvider\Base\GetSuggestionFrequency;
11+
use Magento\Framework\Api\FilterBuilder;
12+
use Magento\Framework\Api\Search\SearchCriteriaBuilder;
13+
use Magento\Search\Api\SearchInterface;
14+
use Magento\Framework\Api\Search\SearchCriteria;
15+
use Magento\Framework\Api\Search\SearchResultInterface;
16+
use Magento\Framework\Api\Filter;
17+
use Magento\Framework\TestFramework\Unit\Helper\ObjectManager as ObjectManagerHelper;
18+
use PHPUnit\Framework\TestCase;
19+
20+
/**
21+
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
22+
*/
23+
class GetSuggestionFrequencyTest extends TestCase
24+
{
25+
/**
26+
* @var GetSuggestionFrequency
27+
*/
28+
private $model;
29+
30+
/**
31+
* @var FilterBuilder
32+
*/
33+
private $filterBuilder;
34+
35+
/**
36+
* @var SearchCriteriaBuilder
37+
*/
38+
private $searchCriteriaBuilder;
39+
40+
/**
41+
* @var SearchInterface
42+
*/
43+
private $search;
44+
45+
/**
46+
* @var Filter
47+
*/
48+
private $filterMock;
49+
50+
/**
51+
* @var SearchCriteria
52+
*/
53+
private $searchCriteria;
54+
55+
/**
56+
* @var SearchResultInterface
57+
*/
58+
private $searchResult;
59+
60+
/**
61+
* Set up test environment
62+
*
63+
* @return void
64+
*/
65+
protected function setUp(): void
66+
{
67+
$this->filterBuilder = $this->getMockBuilder(FilterBuilder::class)
68+
->disableOriginalConstructor()
69+
->getMock();
70+
71+
$this->searchCriteriaBuilder = $this->getMockBuilder(SearchCriteriaBuilder::class)
72+
->disableOriginalConstructor()
73+
->getMock();
74+
75+
$this->search = $this->getMockBuilder(SearchInterface::class)
76+
->disableOriginalConstructor()
77+
->getMock();
78+
79+
$this->filterMock = $this->getMockBuilder(Filter::class)
80+
->disableOriginalConstructor()
81+
->getMock();
82+
83+
$this->searchCriteria = $this->getMockBuilder(SearchCriteria::class)
84+
->disableOriginalConstructor()
85+
->getMock();
86+
87+
$this->searchResult = $this->getMockBuilder(SearchResultInterface::class)
88+
->disableOriginalConstructor()
89+
->onlyMethods(['getTotalCount'])
90+
->getMockForAbstractClass();
91+
92+
$objectManager = new ObjectManagerHelper($this);
93+
94+
$this->model = $objectManager->getObject(
95+
GetSuggestionFrequency::class,
96+
[
97+
'filterBuilder' => $this->filterBuilder,
98+
'searchCriteriaBuilder' => $this->searchCriteriaBuilder,
99+
'search' => $this->search
100+
]
101+
);
102+
}
103+
104+
/**
105+
* Test search suggestion frequency.
106+
* @return void
107+
*/
108+
public function testGetItemsWithDisabledSearchSuggestion(): void
109+
{
110+
$this->filterBuilder->expects($this->once())
111+
->method('setField')
112+
->with('search_term')
113+
->willReturnSelf();
114+
$this->filterBuilder->expects($this->once())
115+
->method('setValue')
116+
->with('mint')
117+
->willReturnSelf();
118+
$this->filterBuilder->expects($this->once())
119+
->method('create')
120+
->willReturn($this->filterMock);
121+
$this->searchCriteriaBuilder->expects($this->once())
122+
->method('addFilter')
123+
->with($this->filterMock)
124+
->willReturnSelf();
125+
$this->searchCriteriaBuilder->expects($this->once())
126+
->method('create')
127+
->willReturn($this->searchCriteria);
128+
$this->search->expects($this->once())
129+
->method('search')
130+
->with($this->searchCriteria)
131+
->willReturn($this->searchResult);
132+
$this->searchResult->expects($this->once())
133+
->method('getTotalCount')
134+
->willReturn(5);
135+
$this->model->execute('mint');
136+
}
137+
}

0 commit comments

Comments
 (0)