Merge pull request #33632 from andrewbess/CE-33626-refactor-keyword-match

The codebase has been refactored to eliminate keyword "match" from code

Author: andrewbess

app/code/Magento/Elasticsearch/Elasticsearch5/SearchAdapter/Mapper.php

@@ -3,19 +3,22 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 namespace Magento\Elasticsearch\Elasticsearch5\SearchAdapter;
 
-use Magento\Framework\Search\RequestInterface;
-use Magento\Framework\Search\Request\QueryInterface as RequestQueryInterface;
-use Magento\Framework\Search\Request\Query\BoolExpression as BoolQuery;
-use Magento\Framework\Search\Request\Query\Filter as FilterQuery;
-use Magento\Framework\Search\Request\Query\Match as MatchQuery;
+use InvalidArgumentException;
 use Magento\Elasticsearch\Elasticsearch5\SearchAdapter\Query\Builder as QueryBuilder;
-use Magento\Elasticsearch\SearchAdapter\Query\Builder\Match as MatchQueryBuilder;
 use Magento\Elasticsearch\SearchAdapter\Filter\Builder as FilterBuilder;
+use Magento\Elasticsearch\SearchAdapter\Query\Builder\MatchQuery as MatchQueryBuilder;
+use Magento\Framework\Search\Request\Query\BoolExpression as BoolQuery;
+use Magento\Framework\Search\Request\Query\Filter as FilterQuery;
+use Magento\Framework\Search\Request\Query\MatchQuery;
+use Magento\Framework\Search\Request\QueryInterface as RequestQueryInterface;
+use Magento\Framework\Search\RequestInterface;
 
 /**
- * Mapper class
+ * Mapper class for Elasticsearch5
+ *
  * @api
  * @since 100.2.2
  */
@@ -77,8 +80,7 @@ public function buildQuery(RequestInterface $request)
             $searchQuery['body']['query']['bool']['minimum_should_match'] = 1;
         }
 
-        $searchQuery = $this->queryBuilder->initAggregations($request, $searchQuery);
-        return $searchQuery;
+        return $this->queryBuilder->initAggregations($request, $searchQuery);
     }
 
     /**
@@ -88,7 +90,7 @@ public function buildQuery(RequestInterface $request)
      * @param array $selectQuery
      * @param string $conditionType
      * @return array
-     * @throws \InvalidArgumentException
+     * @throws InvalidArgumentException
      * @since 100.2.2
      */
     protected function processQuery(
@@ -114,7 +116,10 @@ protected function processQuery(
                 $selectQuery = $this->processFilterQuery($requestQuery, $selectQuery, $conditionType);
                 break;
             default:
-                throw new \InvalidArgumentException(sprintf('Unknown query type \'%s\'', $requestQuery->getType()));
+                throw new InvalidArgumentException(sprintf(
+                    'Unknown query type \'%s\'',
+                    $requestQuery->getType()
+                ));
         }
 
         return $selectQuery;
@@ -197,7 +202,7 @@ private function processFilterQuery(
                 $filterQuery = $this->filterBuilder->build($query->getReference(), $conditionType);
                 foreach ($filterQuery['bool'] as $condition => $filter) {
                     $selectQuery['bool'][$condition]= array_merge(
-                        isset($selectQuery['bool'][$condition]) ? $selectQuery['bool'][$condition] : [],
+                        $selectQuery['bool'][$condition] ?? [],
                         $filter
                     );
                 }

app/code/Magento/Elasticsearch/SearchAdapter/Mapper.php

@@ -7,12 +7,12 @@
 
 namespace Magento\Elasticsearch\SearchAdapter;
 
-use Magento\Framework\Search\RequestInterface;
-use Magento\Framework\Search\Request\Query\BoolExpression as BoolQuery;
-use Magento\Elasticsearch\SearchAdapter\Query\Builder as QueryBuilder;
-use Magento\Elasticsearch\SearchAdapter\Query\Builder\Match as MatchQueryBuilder;
-use Magento\Elasticsearch\SearchAdapter\Filter\Builder as FilterBuilder;
 use Magento\Elasticsearch\Elasticsearch5\SearchAdapter\Mapper as Elasticsearch5Mapper;
+use Magento\Elasticsearch\SearchAdapter\Filter\Builder as FilterBuilder;
+use Magento\Elasticsearch\SearchAdapter\Query\Builder as QueryBuilder;
+use Magento\Elasticsearch\SearchAdapter\Query\Builder\MatchQuery as MatchQueryBuilder;
+use Magento\Framework\Search\Request\Query\BoolExpression as BoolQuery;
+use Magento\Framework\Search\RequestInterface;
 
 /**
  * Mapper class for Elasticsearch2
@@ -59,7 +59,6 @@ public function buildQuery(RequestInterface $request)
 
         $searchQuery['body']['query']['bool']['minimum_should_match'] = 1;
 
-        $searchQuery = $this->queryBuilder->initAggregations($request, $searchQuery);
-        return $searchQuery;
+        return $this->queryBuilder->initAggregations($request, $searchQuery);
     }
 }

app/code/Magento/Elasticsearch/SearchAdapter/Query/Builder/Match.php renamed to app/code/Magento/Elasticsearch/SearchAdapter/Query/Builder/MatchQuery.php

@@ -3,26 +3,26 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 namespace Magento\Elasticsearch\SearchAdapter\Query\Builder;
 
 use Magento\Elasticsearch\Model\Adapter\FieldMapper\Product\AttributeProvider;
 use Magento\Elasticsearch\Model\Adapter\FieldMapper\Product\FieldProvider\FieldType\ResolverInterface as TypeResolver;
+use Magento\Elasticsearch\Model\Adapter\FieldMapperInterface;
 use Magento\Elasticsearch\Model\Config;
 use Magento\Elasticsearch\SearchAdapter\Query\ValueTransformerPool;
 use Magento\Framework\Search\Request\Query\BoolExpression;
 use Magento\Framework\Search\Request\QueryInterface as RequestQueryInterface;
-use Magento\Elasticsearch\Model\Adapter\FieldMapperInterface;
-use Magento\Framework\Search\Adapter\Preprocessor\PreprocessorInterface;
 
 /**
- * Builder for match query.
+ * Builder for match query
  */
-class Match implements QueryInterface
+class MatchQuery implements QueryInterface
 {
     /**
      * Elasticsearch condition for case when query must not appear in the matching documents.
      */
-    const QUERY_CONDITION_MUST_NOT = 'must_not';
+    public const QUERY_CONDITION_MUST_NOT = 'must_not';
 
     /**
      * @var FieldMapperInterface
@@ -43,6 +43,7 @@ class Match implements QueryInterface
      * @var ValueTransformerPool
      */
     private $valueTransformerPool;
+
     /**
      * @var Config
      */
@@ -78,6 +79,7 @@ public function build(array $selectQuery, RequestQueryInterface $requestQuery, $
         $queries = $this->buildQueries($requestQuery->getMatches(), $queryValue);
         $requestQueryBoost = $requestQuery->getBoost() ?: 1;
         $minimumShouldMatch = $this->config->getElasticsearchConfigData('minimum_should_match');
+
         foreach ($queries as $query) {
             $queryBody = $query['body'];
             $matchKey = array_keys($queryBody)[0];
@@ -95,24 +97,26 @@ public function build(array $selectQuery, RequestQueryInterface $requestQuery, $
     }
 
     /**
-     * Prepare query.
+     * Prepare query
      *
      * @param string $queryValue
      * @param string $conditionType
      * @return array
      */
-    protected function prepareQuery($queryValue, $conditionType)
+    private function prepareQuery(string $queryValue, string $conditionType): array
     {
-        $condition = $conditionType === BoolExpression::QUERY_CONDITION_NOT ?
-            self::QUERY_CONDITION_MUST_NOT : $conditionType;
+        $condition = $conditionType === BoolExpression::QUERY_CONDITION_NOT
+            ? self::QUERY_CONDITION_MUST_NOT
+            : $conditionType;
+
         return [
             'condition' => $condition,
             'value' => $queryValue,
         ];
     }
 
     /**
-     * Creates valid ElasticSearch search conditions from Match queries.
+     * Creates valid ElasticSearch search conditions from Match queries
      *
      * The purpose of this method is to create a structure which represents valid search query
      * for a full-text search.
@@ -125,30 +129,31 @@ protected function prepareQuery($queryValue, $conditionType)
      * @param array $queryValue
      * @return array
      */
-    protected function buildQueries(array $matches, array $queryValue)
+    private function buildQueries(array $matches, array $queryValue): array
     {
         $conditions = [];
 
         // Checking for quoted phrase \"phrase test\", trim escaped surrounding quotes if found
         $count = 0;
         $value = preg_replace('#^"(.*)"$#m', '$1', $queryValue['value'], -1, $count);
         $condition = ($count) ? 'match_phrase' : 'match';
-
         $transformedTypes = [];
+
         foreach ($matches as $match) {
             $resolvedField = $this->fieldMapper->getFieldName(
                 $match['field'],
                 ['type' => FieldMapperInterface::TYPE_QUERY]
             );
-
             $attributeAdapter = $this->attributeProvider->getByAttributeCode($resolvedField);
             $fieldType = $this->fieldTypeResolver->getFieldType($attributeAdapter);
             $valueTransformer = $this->valueTransformerPool->get($fieldType ?? 'text');
             $valueTransformerHash = \spl_object_hash($valueTransformer);
+
             if (!isset($transformedTypes[$valueTransformerHash])) {
                 $transformedTypes[$valueTransformerHash] = $valueTransformer->transform($value);
             }
             $transformedValue = $transformedTypes[$valueTransformerHash];
+
             if (null === $transformedValue) {
                 //Value is incompatible with this field type.
                 continue;
@@ -159,6 +164,7 @@ protected function buildQueries(array $matches, array $queryValue)
                 'query' => $transformedValue,
                 'boost' => $match['boost'] ?? 1,
             ];
+
             if (isset($match['analyzer'])) {
                 $fields[$resolvedField]['analyzer'] = $match['analyzer'];
             }

app/code/Magento/Elasticsearch/Test/Unit/SearchAdapter/MapperTest.php

@@ -7,13 +7,15 @@
 
 namespace Magento\Elasticsearch\Test\Unit\SearchAdapter;
 
+use InvalidArgumentException;
 use Magento\Elasticsearch\SearchAdapter\Filter\Builder as FilterBuilder;
 use Magento\Elasticsearch\SearchAdapter\Mapper;
 use Magento\Elasticsearch\SearchAdapter\Query\Builder as QueryBuilder;
-use Magento\Elasticsearch\SearchAdapter\Query\Builder\Match as MatchQueryBuilder;
+use Magento\Elasticsearch\SearchAdapter\Query\Builder\MatchQuery as MatchQueryBuilder;
 use Magento\Framework\Search\Request\FilterInterface;
 use Magento\Framework\Search\Request\Query\BoolExpression;
 use Magento\Framework\Search\Request\Query\Filter;
+use Magento\Framework\Search\Request\Query\MatchQuery;
 use Magento\Framework\Search\Request\QueryInterface;
 use Magento\Framework\Search\RequestInterface;
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager as ObjectManagerHelper;
@@ -51,20 +53,18 @@ class MapperTest extends TestCase
      */
     protected function setUp(): void
     {
-        $this->queryBuilder = $this->getMockBuilder(\Magento\Elasticsearch\SearchAdapter\Query\Builder::class)
+        $this->queryBuilder = $this->getMockBuilder(QueryBuilder::class)
             ->setMethods([
                 'initQuery',
                 'initAggregations',
             ])
             ->disableOriginalConstructor()
             ->getMock();
-        $this->matchQueryBuilder = $this->getMockBuilder(
-            \Magento\Elasticsearch\SearchAdapter\Query\Builder\Match::class
-        )
+        $this->matchQueryBuilder = $this->getMockBuilder(MatchQueryBuilder::class)
             ->setMethods(['build'])
             ->disableOriginalConstructor()
             ->getMock();
-        $this->filterBuilder = $this->getMockBuilder(\Magento\Elasticsearch\SearchAdapter\Filter\Builder::class)
+        $this->filterBuilder = $this->getMockBuilder(FilterBuilder::class)
             ->disableOriginalConstructor()
             ->getMock();
         $this->queryBuilder->expects($this->any())
@@ -101,7 +101,7 @@ protected function setUp(): void
      */
     public function testBuildQueryFailure()
     {
-        $this->expectException(\InvalidArgumentException::class);
+        $this->expectException(InvalidArgumentException::class);
 
         $request = $this->getMockBuilder(RequestInterface::class)
             ->disableOriginalConstructor()
@@ -137,7 +137,7 @@ public function testBuildQuery($queryType, $queryMock, $referenceType, $filterMo
             ->setMethods(['getMust', 'getMustNot', 'getType', 'getShould', 'getReferenceType', 'getReference'])
             ->disableOriginalConstructor()
             ->getMock();
-        $matchQuery = $this->getMockBuilder(\Magento\Framework\Search\Request\Query\Match::class)
+        $matchQuery = $this->getMockBuilder(MatchQuery::class)
             ->disableOriginalConstructor()
             ->getMock();
         $filterQuery = $this->getMockBuilder($filterMock)
@@ -192,7 +192,7 @@ public function buildQueryDataProvider()
     {
         return [
             [
-                'matchQuery', \Magento\Framework\Search\Request\Query\Match::class,
+                'matchQuery', MatchQuery::class,
                 'query', QueryInterface::class,
             ],
             [

app/code/Magento/Elasticsearch/Test/Unit/SearchAdapter/Query/Builder/MatchTest.php renamed to app/code/Magento/Elasticsearch/Test/Unit/SearchAdapter/Query/Builder/MatchQueryTest.php

@@ -12,18 +12,18 @@
 use Magento\Elasticsearch\Model\Adapter\FieldMapper\Product\FieldProvider\FieldType\ResolverInterface as TypeResolver;
 use Magento\Elasticsearch\Model\Adapter\FieldMapperInterface;
 use Magento\Elasticsearch\Model\Config;
-use Magento\Elasticsearch\SearchAdapter\Query\Builder\Match as MatchQueryBuilder;
+use Magento\Elasticsearch\SearchAdapter\Query\Builder\MatchQuery as MatchQueryBuilder;
 use Magento\Elasticsearch\SearchAdapter\Query\ValueTransformerInterface;
 use Magento\Elasticsearch\SearchAdapter\Query\ValueTransformerPool;
-use Magento\Framework\Search\Request\Query\Match as MatchRequestQuery;
+use Magento\Framework\Search\Request\Query\MatchQuery;
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 
 /**
  * Test Match query builder
  */
-class MatchTest extends TestCase
+class MatchQueryTest extends TestCase
 {
     /**
      * @var AttributeProvider|MockObject
@@ -102,7 +102,7 @@ public function testBuild(
             $this->mockAttribute($field['field']);
         }
 
-        $requestQuery = new MatchRequestQuery('match', $searchQuery, 1, $fields);
+        $requestQuery = new MatchQuery('match', $searchQuery, 1, $fields);
         $query = $this->matchQueryBuilder->build([], $requestQuery, 'should');
 
         $expectedSelectQuery = [

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

@@ -304,7 +304,7 @@
     <type name="Magento\Framework\Indexer\Config\DependencyInfoProvider">
         <plugin name="indexerDependencyUpdaterPlugin" type="Magento\Elasticsearch\Model\Indexer\Plugin\DependencyUpdaterPlugin"/>
     </type>
-    <type name="Magento\Elasticsearch\SearchAdapter\Query\Builder\Match">
+    <type name="Magento\Elasticsearch\SearchAdapter\Query\Builder\MatchQuery">
         <arguments>
             <argument name="preprocessorContainer" xsi:type="array">
                 <item name="stopwordsPreprocessor" xsi:type="object">Magento\Elasticsearch\SearchAdapter\Query\Preprocessor\Stopwords</item>