ACP2E-464: Remove wildcard and LIKE operator and replace with equal operator in customer grid filter search

Author: bubasuma

app/code/Magento/Customer/Model/Config/Source/FilterConditionType.php

@@ -12,8 +12,8 @@
 class FilterConditionType implements OptionSourceInterface
 {
     public const PARTIAL_MATCH = 0;
-
     public const FULL_MATCH = 1;
+    public const PREFIX_MATCH = 2;
 
     /**
      * @inheritdoc
@@ -22,7 +22,8 @@ public function toOptionArray()
     {
         return [
             ['value' => self::PARTIAL_MATCH, 'label' => __('Partial Match')],
-            ['value' => self::FULL_MATCH, 'label' => __('Full Match')]
+            ['value' => self::PREFIX_MATCH, 'label' => __('Prefix Match')],
+            ['value' => self::FULL_MATCH, 'label' => __('Full Match')],
         ];
     }
 }

app/code/Magento/Customer/Model/Indexer/AttributeProvider.php

@@ -95,18 +95,14 @@ protected function convert(array $attributes, array $fieldset)
                         'dataType' => $attribute->getBackendType(),
                         'filters' => [],
                         'entity' => static::ENTITY,
-                        'bind' => isset($fieldset['references']['customer']['to'])
-                            ? $fieldset['references']['customer']['to']
-                            : null,
-                        'index' => $attribute->canBeFilterableInGrid()
-                            && (int) $attribute->getGridFilterConditionType() === FilterConditionType::FULL_MATCH
+                        'bind' => $fieldset['references']['customer']['to'] ?? null,
+                        'index' => $this->getIndex($attribute)
                     ];
                 }
             } else {
                 $fields[$attribute->getName()] = [
                     'type' => $this->getType($attribute),
-                    'index' => $attribute->canBeFilterableInGrid()
-                        && (int) $attribute->getGridFilterConditionType() === FilterConditionType::FULL_MATCH
+                    'index' => $this->getIndex($attribute)
                 ];
             }
         }
@@ -156,4 +152,20 @@ protected function merge(array $dataFields, array $searchableFields)
 
         return $dataFields;
     }
+
+    /**
+     * Checks whether the attribute should be indexed
+     *
+     * @param Attribute $attribute
+     * @return bool
+     */
+    private function getIndex(Attribute $attribute): bool
+    {
+        return $attribute->canBeFilterableInGrid()
+            && in_array(
+                (int) $attribute->getGridFilterConditionType(),
+                [FilterConditionType::FULL_MATCH, FilterConditionType::PREFIX_MATCH],
+                true
+            );
+    }
 }

app/code/Magento/Customer/Test/Unit/Ui/Component/Listing/Filter/TextFilterConfigProviderTest.php

@@ -30,23 +30,35 @@ public function getConfigDataProvider(): array
             [
                 [],
                 [
-                    'conditionType' => 'like'
+                    'conditionType' => 'like',
+                    'valueExpression' => '%%%s%%'
                 ]
             ],
             [
                 [
                     'grid_filter_condition_type' => 0
                 ],
                 [
-                    'conditionType' => 'like'
+                    'conditionType' => 'like',
+                    'valueExpression' => '%%%s%%'
                 ]
             ],
             [
                 [
                     'grid_filter_condition_type' => 1
                 ],
                 [
-                    'conditionType' => 'eq'
+                    'conditionType' => 'eq',
+                    'valueExpression' => null
+                ]
+            ],
+            [
+                [
+                    'grid_filter_condition_type' => 2
+                ],
+                [
+                    'conditionType' => 'like',
+                    'valueExpression' => '%s%%'
                 ]
             ]
         ];

app/code/Magento/Customer/Ui/Component/Listing/Filter/TextFilterConfigProvider.php

@@ -16,18 +16,25 @@ class TextFilterConfigProvider implements FilterConfigProviderInterface
     private const FILTER_CONDITION_TYPE_MAP = [
         FilterConditionType::FULL_MATCH => 'eq',
         FilterConditionType::PARTIAL_MATCH => 'like',
+        FilterConditionType::PREFIX_MATCH => 'like',
+    ];
+
+    private const FILTER_CONDITION_TYPE_VALUE_EXPRESSION_MAP = [
+        FilterConditionType::PARTIAL_MATCH => '%%%s%%',
+        FilterConditionType::PREFIX_MATCH => '%s%%',
     ];
 
     /**
      * @inheritdoc
      */
     public function getConfig(array $attributeData): array
     {
-        $value = $attributeData[self::FILTER_CONDITION_TYPE] ?? null;
+        $value = $attributeData[self::FILTER_CONDITION_TYPE] ?? FilterConditionType::PARTIAL_MATCH;
 
         return [
             'conditionType' => self::FILTER_CONDITION_TYPE_MAP[$value]
-                ?? self::FILTER_CONDITION_TYPE_MAP[FilterConditionType::PARTIAL_MATCH]
+                ?? self::FILTER_CONDITION_TYPE_MAP[FilterConditionType::PARTIAL_MATCH],
+            'valueExpression' => self::FILTER_CONDITION_TYPE_VALUE_EXPRESSION_MAP[$value] ?? null,
         ];
     }
 }

app/code/Magento/Customer/i18n/en_US.csv

@@ -545,3 +545,4 @@ Addresses,Addresses
 "The specified customer group id does not exist.","The specified customer group id does not exist."
 "Partial Match","Partial Match"
 "Full Match","Full Match"
+"Prefix Match","Prefix Match"

app/code/Magento/Ui/Component/Filters/Type/Input.php

@@ -17,7 +17,7 @@ class Input extends AbstractFilter
 
     public const COMPONENT = 'input';
 
-    private const DEFAULT_CONDITION_TYPE = 'like';
+    private const CONDITION_LIKE = 'like';
 
     /**
      * @var ElementInput
@@ -66,13 +66,19 @@ protected function applyFilter(): void
     {
         $value = $this->filterData[$this->getName()] ?? '';
         if (strlen($value) > 0) {
-            $conditionType = self::DEFAULT_CONDITION_TYPE;
+            $conditionType = self::CONDITION_LIKE;
+            $valueExpression = null;
             $filterConfig = $this->getData('config/filter');
-            if (is_array($filterConfig) && isset($filterConfig['conditionType'])) {
-                $conditionType = $filterConfig['conditionType'];
+            if (is_array($filterConfig)) {
+                $conditionType = $filterConfig['conditionType'] ?? null;
+                $valueExpression = $filterConfig['valueExpression'] ?? null;
             }
-            if ($conditionType === self::DEFAULT_CONDITION_TYPE) {
-                $value = sprintf('%%%s%%', str_replace(['%', '_'], ['\%', '\_'], $value));
+            if ($conditionType === self::CONDITION_LIKE) {
+                $value = str_replace(['%', '_'], ['\%', '\_'], $value);
+                $valueExpression = $valueExpression ?? '%%%s%%';
+            }
+            if ($valueExpression) {
+                $value = sprintf($valueExpression, $value);
             }
 
             $filter = $this->filterBuilder->setConditionType($conditionType)

app/code/Magento/Ui/Test/Unit/Component/Filters/Type/InputTest.php

@@ -253,6 +253,23 @@ public function getPrepareDataProvider(): array
                     'setValue' => '%something%',
                 ],
             ],
+            [
+                [
+                    'name' => 'text_attr',
+                    'config' => [
+                        'filter' => [
+                            'filterType' => 'text',
+                            'conditionType' => 'like',
+                            'valueExpression' => '%s%%'
+                        ]
+                    ]
+                ],
+                ['text_attr' => 'something'],
+                [
+                    'setConditionType' => 'like',
+                    'setValue' => 'something%',
+                ],
+            ],
         ];
     }
 }