Skip to content

Commit de38c4c

Browse files
author
Anna Bukatar
committed
Merge branch 'ACP2E-72' of https://github.com/magento-l3/magento2ce into PR-2022-03-11
2 parents c8c65b7 + 8b0623e commit de38c4c

File tree

5 files changed

+245
-2
lines changed

5 files changed

+245
-2
lines changed

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

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
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\Search\Api\SearchInterface;
13+
14+
/**
15+
* Get the search suggestion result count
16+
*/
17+
class GetSuggestionFrequency implements GetSuggestionFrequencyInterface
18+
{
19+
/**
20+
* @var FilterBuilder
21+
*/
22+
private $filterBuilder;
23+
24+
/**
25+
* @var SearchCriteriaBuilder
26+
*/
27+
private $searchCriteriaBuilder;
28+
29+
/**
30+
* @var SearchInterface
31+
*/
32+
private $search;
33+
34+
/**
35+
* Search suggestion frequency constructor.
36+
*
37+
* @param FilterBuilder $filterBuilder
38+
* @param SearchCriteriaBuilder $searchCriteriaBuilder
39+
* @param SearchInterface $search
40+
*/
41+
public function __construct(
42+
FilterBuilder $filterBuilder,
43+
SearchCriteriaBuilder $searchCriteriaBuilder,
44+
SearchInterface $search
45+
) {
46+
$this->filterBuilder = $filterBuilder;
47+
$this->searchCriteriaBuilder = $searchCriteriaBuilder;
48+
$this->search = $search;
49+
}
50+
/**
51+
* Get the search suggestion frequency
52+
*
53+
* @param string $text
54+
* @return int
55+
*/
56+
public function execute(string $text): int
57+
{
58+
$this->filterBuilder->setField('search_term');
59+
$this->filterBuilder->setValue($text);
60+
$this->searchCriteriaBuilder->addFilter($this->filterBuilder->create());
61+
$searchCriteria = $this->searchCriteriaBuilder->create();
62+
$searchCriteria->setRequestName('quick_search_container');
63+
$searchCriteria->setCurrentPage(1);
64+
$searchCriteria->setPageSize(1);
65+
$searchCriteria->setSortOrders([]);
66+
$searchResult = $this->search->search($searchCriteria);
67+
return $searchResult->getTotalCount();
68+
}
69+
}

‎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: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,11 @@ class Suggestions implements SuggestedQueriesInterface
6565
*/
6666
private $logger;
6767

68+
/**
69+
* @var GetSuggestionFrequencyInterface
70+
*/
71+
private $getSuggestionFrequency;
72+
6873
/**
6974
* Suggestions constructor.
7075
*
@@ -76,6 +81,7 @@ class Suggestions implements SuggestedQueriesInterface
7681
* @param StoreManager $storeManager
7782
* @param FieldProviderInterface $fieldProvider
7883
* @param LoggerInterface|null $logger
84+
* @param GetSuggestionFrequencyInterface|null $getSuggestionFrequency
7985
*/
8086
public function __construct(
8187
ScopeConfigInterface $scopeConfig,
@@ -85,7 +91,8 @@ public function __construct(
8591
SearchIndexNameResolver $searchIndexNameResolver,
8692
StoreManager $storeManager,
8793
FieldProviderInterface $fieldProvider,
88-
LoggerInterface $logger = null
94+
LoggerInterface $logger = null,
95+
?GetSuggestionFrequencyInterface $getSuggestionFrequency = null
8996
) {
9097
$this->queryResultFactory = $queryResultFactory;
9198
$this->connectionManager = $connectionManager;
@@ -95,6 +102,8 @@ public function __construct(
95102
$this->storeManager = $storeManager;
96103
$this->fieldProvider = $fieldProvider;
97104
$this->logger = $logger ?: ObjectManager::getInstance()->get(LoggerInterface::class);
105+
$this->getSuggestionFrequency = $getSuggestionFrequency ?:
106+
ObjectManager::getInstance()->get(GetSuggestionFrequencyInterface::class);
98107
}
99108

100109
/**
@@ -115,7 +124,12 @@ public function getItems(QueryInterface $query)
115124
foreach ($suggestions as $suggestion) {
116125
$count = null;
117126
if ($isResultsCountEnabled) {
118-
$count = isset($suggestion['freq']) ? $suggestion['freq'] : null;
127+
try {
128+
$count = $this->getSuggestionFrequency->execute($suggestion['text']);
129+
} catch (\Exception $e) {
130+
$this->logger->critical($e);
131+
}
132+
119133
}
120134
$result[] = $this->queryResultFactory->create(
121135
[

‎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+
}

‎app/code/Magento/Elasticsearch/etc/di.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
<preference for="Magento\Elasticsearch\Model\Adapter\FieldMapper\Product\FieldProviderInterface" type="Magento\Elasticsearch\Model\Adapter\FieldMapper\Product\CompositeFieldProvider" />
1616
<preference for="Magento\Framework\Search\Dynamic\DataProviderInterface" type="Magento\Elasticsearch\SearchAdapter\Dynamic\DataProvider" />
1717
<preference for="Magento\CatalogSearch\Model\ResourceModel\Fulltext\Collection\SearchResultApplierInterface" type="Magento\Elasticsearch\Model\ResourceModel\Fulltext\Collection\SearchResultApplier"/>
18+
<preference for="Magento\Elasticsearch\Model\DataProvider\Base\GetSuggestionFrequencyInterface" type="Magento\Elasticsearch\Model\DataProvider\Base\GetSuggestionFrequency"/>
1819
<type name="Magento\Catalog\Model\Indexer\Category\Product\Action\Rows">
1920
<plugin name="catalogsearchFulltextProductAssignment" type="Magento\Elasticsearch\Model\Indexer\Fulltext\Plugin\Category\Product\Action\Rows"/>
2021
</type>

0 commit comments

Comments
 (0)