MAGETWO-69130: Non effective query for catalog search & layered navigation

Author: AVoskoboinikov

app/code/Magento/Bundle/Model/ResourceModel/Indexer/BundleOptionStockDataSelectBuilder.php

@@ -9,6 +9,12 @@
 use Magento\Catalog\Api\Data\ProductInterface;
 use Magento\Framework\DB\Select;
 
+/**
+ * Class BundleOptionStockDataSelectBuilder
+ * Is used to create Select object that is used for Bundle product stock status indexation
+ *
+ * @see \Magento\Bundle\Model\ResourceModel\Indexer\Stock::_prepareBundleOptionStockData
+ */
 class BundleOptionStockDataSelectBuilder
 {
     /**

app/code/Magento/Bundle/Model/ResourceModel/Indexer/StockStatusSelectBuilder.php

@@ -10,6 +10,12 @@
 use Magento\Catalog\Api\Data\ProductInterface;
 use Magento\Catalog\Model\Product\Attribute\Source\Status as ProductStatus;
 
+/**
+ * Class StockStatusSelectBuilder
+ * Is used to create Select object that is used for Bundle product stock status indexation
+ *
+ * @see \Magento\Bundle\Model\ResourceModel\Indexer\Stock::_getStockStatusSelect
+ */
 class StockStatusSelectBuilder
 {
 

app/code/Magento/CatalogSearch/Model/Search/CustomAttributeFilterCheck.php

@@ -46,6 +46,8 @@ public function isCustom(FilterInterface $filter)
     }
 
     /**
+     * Return attribute by its code
+     *
      * @param string $field
      * @return \Magento\Catalog\Model\ResourceModel\Eav\Attribute
      * @throws \Magento\Framework\Exception\LocalizedException

app/code/Magento/CatalogSearch/Model/Search/FilterMapper/CustomAttributeFilter.php

@@ -96,23 +96,19 @@ public function apply(Select $select, FilterInterface ... $filters)
 
             $attributes[] = $attributeId;
 
-            $joinConditions = $this->createQueryConditions($attributeId, $filterJoinAlias);
-
-            array_unshift(
-                $joinConditions,
-                sprintf('%s.entity_id = %s.entity_id', $mainTableAlias, $filterJoinAlias),
-                sprintf('%s.source_id = %s.source_id', $mainTableAlias, $filterJoinAlias)
-            );
-
             $select->joinInner(
                 [$filterJoinAlias => $this->resourceConnection->getTableName('catalog_product_index_eav')],
-                $this->conditionManager->combineQueries($joinConditions, Select::SQL_AND),
+                $this->conditionManager->combineQueries(
+                    $this->getJoinConditions($attributeId, $mainTableAlias, $filterJoinAlias),
+                    Select::SQL_AND
+                ),
                 []
             );
         }
 
         if (count($attributes) === 1) {
             // forces usage of PRIMARY key in main table
+            // is required to boost performance in case when we have just one filter by custom attribute
             $attribute = reset($attributes);
             $filter = reset($filters);
             $select->where(
@@ -134,27 +130,34 @@ public function apply(Select $select, FilterInterface ... $filters)
     }
 
     /**
-     * @param int $attributeId
-     * @param string $mainTableAlias
+     * Returns Joins conditions for table catalog_product_index_eav
+     *
+     * @param int $attrId
+     * @param string $mainTable
+     * @param string $joinTable
      * @return array
      */
-    private function createQueryConditions($attributeId, $mainTableAlias)
+    private function getJoinConditions($attrId, $mainTable, $joinTable)
     {
         return [
+            sprintf('`%s`.`entity_id` = `%s`.`entity_id`', $mainTable, $joinTable),
+            sprintf('`%s`.`source_id` = `%s`.`source_id`', $mainTable, $joinTable),
             $this->conditionManager->generateCondition(
-                sprintf('%s.attribute_id', $mainTableAlias),
+                sprintf('%s.attribute_id', $joinTable),
                 '=',
-                $attributeId
+                $attrId
             ),
             $this->conditionManager->generateCondition(
-                sprintf('%s.store_id', $mainTableAlias),
+                sprintf('%s.store_id', $joinTable),
                 '=',
                 (int) $this->storeManager->getStore()->getId()
             )
         ];
     }
 
     /**
+     * Returns attribute id by code
+     *
      * @param string $field
      * @return int|null
      * @throws \Magento\Framework\Exception\LocalizedException

app/code/Magento/CatalogSearch/Model/Search/FilterMapper/DimensionsProcessor.php

@@ -64,6 +64,8 @@ public function processDimensions(SelectContainer $selectContainer)
     }
 
     /**
+     * Prepares where conditions from dimensions
+     *
      * @param Dimension[] $dimensions
      * @return string[]
      */

app/code/Magento/CatalogSearch/Model/Search/FilterMapper/ExclusionStrategy.php

@@ -56,7 +56,7 @@ public function apply(
         \Magento\Framework\Search\Request\FilterInterface $filter,
         \Magento\Framework\DB\Select $select
     ) {
-        if (!in_array($filter->getField(), $this->validFields)) {
+        if (!in_array($filter->getField(), $this->validFields, true)) {
             return false;
         }
 
@@ -68,6 +68,8 @@ public function apply(
     }
 
     /**
+     * Applies filter bt price field
+     *
      * @param \Magento\Framework\Search\Request\FilterInterface $filter
      * @param \Magento\Framework\DB\Select $select
      * @return bool
@@ -97,6 +99,8 @@ private function applyPriceFilter(
     }
 
     /**
+     * Applies filter by category
+     *
      * @param \Magento\Framework\Search\Request\FilterInterface $filter
      * @param \Magento\Framework\DB\Select $select
      * @return bool

app/code/Magento/CatalogSearch/Model/Search/FilterMapper/FilterMapper.php

@@ -8,7 +8,6 @@
 
 use Magento\CatalogSearch\Model\Search\SelectContainer\SelectContainer;
 use Magento\CatalogSearch\Model\Adapter\Mysql\Filter\AliasResolver;
-use Magento\CatalogSearch\Model\Search\FilterMapper\StockStatusFilter;
 use Magento\CatalogInventory\Model\Stock;
 
 /**
@@ -96,7 +95,6 @@ public function applyFilters(SelectContainer $selectContainer)
         $appliedFilters = [];
 
         if ($selectContainer->hasVisibilityFilter()) {
-
             $filterType = VisibilityFilter::FILTER_BY_WHERE;
             if ($selectContainer->hasCustomAttributesFilters()) {
                 $filterType = VisibilityFilter::FILTER_BY_JOIN;
@@ -120,19 +118,4 @@ public function applyFilters(SelectContainer $selectContainer)
         $selectContainer = $selectContainer->updateSelect($select);
         return $selectContainer;
     }
-
-    /**
-     * This method is deprecated.
-     * Please use \Magento\CatalogSearch\Model\Adapter\Mysql\Filter\AliasResolver::getAlias() instead.
-     *
-     * @deprecated
-     * @see AliasResolver::getAlias()
-     *
-     * @param \Magento\Framework\Search\Request\FilterInterface $filter
-     * @return string
-     */
-    public function getMappingAlias(\Magento\Framework\Search\Request\FilterInterface $filter)
-    {
-        return $this->aliasResolver->getAlias($filter);
-    }
 }

app/code/Magento/CatalogSearch/Model/Search/FilterMapper/StockStatusFilter.php

@@ -24,9 +24,19 @@ class StockStatusFilter
     private $resourceConnection;
 
     /**
-     * Defines strategies of how filter should be applied
+     * Defines strategy of how filter should be applied
+     *
+     * Stock status filter will be applied only on parent products
+     * (e.g. only for configurable products, without options)
      */
     const FILTER_JUST_ENTITY = 'general_filter';
+
+    /**
+     * Defines strategy of how filter should be applied
+     *
+     * Stock status filter will be applied on parent products with its child
+     * (e.g. for configurable products and options)
+     */
     const FILTER_ENTITY_AND_SUB_PRODUCTS = 'filter_with_sub_products';
 
     /**

app/code/Magento/CatalogSearch/Model/Search/FilterMapper/VisibilityFilter.php

@@ -26,8 +26,18 @@ class VisibilityFilter
 
     /**
      * Defines strategies of how filter should be applied
+     *
+     * Visibility filter will be applied through the additional inner join condition
+     * This strategy is used when general Select query contains filters by other eav attributes
      */
     const FILTER_BY_JOIN = 'join_filter';
+
+    /**
+     * Defines strategies of how filter should be applied
+     *
+     * Visibility filter will be applied through the additional where condition
+     * This strategy is used when general Select query does not contain any other filters by eav attributes
+     */
     const FILTER_BY_WHERE = 'where_filter';
 
     /**
@@ -171,6 +181,8 @@ private function applyFilterByWhere(FilterInterface $filter, Select $select)
     }
 
     /**
+     * Returns visibility attribute id
+     *
      * @return int
      * @throws \Magento\Framework\Exception\LocalizedException
      * @throws \InvalidArgumentException
@@ -183,7 +195,7 @@ private function getVisibilityAttributeId()
         );
 
         if ($attr === null) {
-            throw new \InvalidArgumentException('Wrong id for visibility attribute');
+            throw new \InvalidArgumentException('Wrong code for visibility attribute');
         }
 
         return (int) $attr->getId();

app/code/Magento/CatalogSearch/Model/Search/SelectContainer/SelectContainer.php

@@ -56,24 +56,24 @@ class SelectContainer
     private $dimensions;
 
     /**
+     * @param Select $select
      * @param array $nonCustomAttributesFilters
      * @param array $customAttributesFilters
-     * @param FilterInterface $visibilityFilter
+     * @param array $dimensions
      * @param bool $isFullTextSearchRequired
      * @param bool $isShowOutOfStockEnabled
-     * @param Select $select
      * @param string $usedIndex
-     * @param array $dimensions
+     * @param FilterInterface|null $visibilityFilter
      */
     public function __construct(
+        Select $select,
         array $nonCustomAttributesFilters,
         array $customAttributesFilters,
-        $visibilityFilter,
+        array $dimensions,
         bool $isFullTextSearchRequired,
         bool $isShowOutOfStockEnabled,
         $usedIndex,
-        array $dimensions,
-        Select $select
+        FilterInterface $visibilityFilter = null
     ) {
         $this->nonCustomAttributesFilters = $nonCustomAttributesFilters;
         $this->customAttributesFilters = $customAttributesFilters;
@@ -180,15 +180,21 @@ public function getSelect()
      */
     public function updateSelect(Select $select)
     {
-        return new self(
+        $data = [
+            clone $select,
             $this->nonCustomAttributesFilters,
             $this->customAttributesFilters,
-            $this->visibilityFilter,
+            $this->dimensions,
             $this->isFullTextSearchRequired,
             $this->isShowOutOfStockEnabled,
-            $this->usedIndex,
-            $this->dimensions,
-            clone $select
-        );
+            $this->usedIndex
+
+        ];
+
+        if ($this->visibilityFilter !== null) {
+            $data[] = clone $this->visibilityFilter;
+        }
+
+        return new self(...$data);
     }
 }