MSI: #302 (Refactoring CatalogSearch Module)

app/code/Magento/CatalogSearch/Model/Adapter/Mysql/Aggregation/DataProvider.php

@@ -6,7 +6,6 @@
 namespace Magento\CatalogSearch\Model\Adapter\Mysql\Aggregation;
 
 use Magento\Catalog\Model\Product;
-use Magento\CatalogInventory\Model\Stock;
 use Magento\Customer\Model\Session;
 use Magento\Eav\Model\Config;
 use Magento\Framework\App\ResourceConnection;
@@ -16,7 +15,6 @@
 use Magento\Framework\DB\Select;
 use Magento\Framework\Search\Adapter\Mysql\Aggregation\DataProviderInterface;
 use Magento\Framework\Search\Request\BucketInterface;
-use Magento\Framework\App\ObjectManager;
 
 /**
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
@@ -48,23 +46,31 @@ class DataProvider implements DataProviderInterface
      */
     private $connection;
 
+    /**
+     * @var StockSelectProviderInterface
+     */
+    private $selectProvider;
+
     /**
      * @param Config $eavConfig
      * @param ResourceConnection $resource
      * @param ScopeResolverInterface $scopeResolver
      * @param Session $customerSession
+     * @param StockSelectProviderInterface $selectProvider
      */
     public function __construct(
         Config $eavConfig,
         ResourceConnection $resource,
         ScopeResolverInterface $scopeResolver,
-        Session $customerSession
+        Session $customerSession,
+        StockSelectProviderInterface $selectProvider
     ) {
         $this->eavConfig = $eavConfig;
         $this->resource = $resource;
         $this->connection = $resource->getConnection();
         $this->scopeResolver = $scopeResolver;
         $this->customerSession = $customerSession;
+        $this->selectProvider = $selectProvider;
     }
 
     /**
@@ -99,25 +105,7 @@ public function getDataSet(
                 ->where('main_table.customer_group_id = ?', $this->customerSession->getCustomerGroupId())
                 ->where('main_table.website_id = ?', $store->getWebsiteId());
         } else {
-            $currentScopeId = $this->scopeResolver->getScope($currentScope)
-                ->getId();
-            $table = $this->resource->getTableName(
-                'catalog_product_index_eav' . ($attribute->getBackendType() === 'decimal' ? '_decimal' : '')
-            );
-            $subSelect = $select;
-            $subSelect->from(['main_table' => $table], ['main_table.entity_id', 'main_table.value'])
-                ->distinct()
-                ->joinLeft(
-                    ['stock_index' => $this->resource->getTableName('cataloginventory_stock_status')],
-                    'main_table.source_id = stock_index.product_id',
-                    []
-                )
-                ->where('main_table.attribute_id = ?', $attribute->getAttributeId())
-                ->where('main_table.store_id = ? ', $currentScopeId)
-                ->where('stock_index.stock_status = ?', Stock::STOCK_IN_STOCK);
-            $parentSelect = $this->getSelect();
-            $parentSelect->from(['main_table' => $subSelect], ['main_table.value']);
-            $select = $parentSelect;
+            $select = $this->selectProvider->get($currentScope, $attribute, $select);
         }
 
         return $select;

app/code/Magento/CatalogSearch/Model/Adapter/Mysql/Aggregation/StockSelectProvider.php

@@ -0,0 +1,70 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\CatalogSearch\Model\Adapter\Mysql\Aggregation;
+
+use Magento\CatalogInventory\Model\Stock;
+use Magento\Eav\Model\Entity\Attribute\AbstractAttribute;
+use Magento\Framework\App\ResourceConnection;
+use Magento\Framework\App\ScopeResolverInterface;
+use Magento\Framework\DB\Select;
+
+/**
+ * @inheritdoc
+ */
+class StockSelectProvider implements StockSelectProviderInterface
+{
+
+    /**
+     * @var Resource
+     */
+    private $resource;
+
+    /**
+     * @var ScopeResolverInterface
+     */
+    private $scopeResolver;
+
+    /**
+     * @param ResourceConnection $resource
+     * @param ScopeResolverInterface $scopeResolver
+     */
+    public function __construct(
+        ResourceConnection $resource,
+        ScopeResolverInterface $scopeResolver
+    ) {
+        $this->resource = $resource;
+        $this->scopeResolver = $scopeResolver;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function get(int $currentScope, AbstractAttribute $attribute, Select $select): Select
+    {
+        $connection = $this->resource->getConnection();
+        $currentScopeId = $this->scopeResolver->getScope($currentScope)
+            ->getId();
+        $table = $this->resource->getTableName(
+            'catalog_product_index_eav' . ($attribute->getBackendType() === 'decimal' ? '_decimal' : '')
+        );
+        $subSelect = $select;
+        $subSelect->from(['main_table' => $table], ['main_table.entity_id', 'main_table.value'])
+            ->distinct()
+            ->joinLeft(
+                ['stock_index' => $this->resource->getTableName('cataloginventory_stock_status')],
+                'main_table.source_id = stock_index.product_id',
+                []
+            )
+            ->where('main_table.attribute_id = ?', $attribute->getAttributeId())
+            ->where('main_table.store_id = ? ', $currentScopeId)
+            ->where('stock_index.stock_status = ?', Stock::STOCK_IN_STOCK);
+        $parentSelect = $connection->select();
+        $parentSelect->from(['main_table' => $subSelect], ['main_table.value']);
+        $select = $parentSelect;
+        return $select;
+    }
+}

app/code/Magento/CatalogSearch/Model/Adapter/Mysql/Aggregation/StockSelectProviderInterface.php

@@ -0,0 +1,26 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\CatalogSearch\Model\Adapter\Mysql\Aggregation;
+
+use Magento\Eav\Model\Entity\Attribute\AbstractAttribute;
+use Magento\Framework\DB\Select;
+
+/**
+ * Allow to use different stock query (Service Provider Interface - SPI)
+ * @api
+ */
+interface StockSelectProviderInterface
+{
+    /**
+     * Returns the stock select by current scope
+     *
+     * @param int $currentScope
+     * @param AbstractAttribute $attribute
+     * @param Select $select
+     * @return Select
+     */
+    public function get(int $currentScope, AbstractAttribute $attribute, Select $select): Select;
+}

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

@@ -37,7 +37,7 @@ class FilterMapper
     private $visibilityFilter;
 
     /**
-     * @var StockStatusFilter
+     * @var StockStatusFilterInterface
      */
     private $stockStatusFilter;
 
@@ -46,14 +46,14 @@ class FilterMapper
      * @param CustomAttributeFilter $customAttributeFilter
      * @param FilterStrategyInterface $filterStrategy
      * @param VisibilityFilter $visibilityFilter
-     * @param StockStatusFilter $stockStatusFilter
+     * @param StockStatusFilterInterface $stockStatusFilter
      */
     public function __construct(
         AliasResolver $aliasResolver,
         CustomAttributeFilter $customAttributeFilter,
         FilterStrategyInterface $filterStrategy,
         VisibilityFilter $visibilityFilter,
-        StockStatusFilter $stockStatusFilter
+        StockStatusFilterInterface $stockStatusFilter
     ) {
         $this->aliasResolver = $aliasResolver;
         $this->customAttributeFilter = $customAttributeFilter;

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

@@ -0,0 +1,42 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\CatalogSearch\Model\Search\FilterMapper;
+
+use Magento\CatalogSearch\Model\Adapter\Mysql\Filter\AliasResolver;
+use Magento\Framework\App\ResourceConnection;
+use Magento\Framework\DB\Select;
+
+class StockJoinProvider implements StockJoinProviderInterface
+{
+    /**
+     * @var ResourceConnection
+     */
+    private $resourceConnection;
+
+    /**
+     * @param ResourceConnection $resourceConnection
+     */
+    public function __construct(ResourceConnection $resourceConnection)
+    {
+        $this->resourceConnection = $resourceConnection;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function add(Select $select, $alias)
+    {
+        $stockAlias = $alias . AliasResolver::STOCK_FILTER_SUFFIX;
+        $select->joinLeft(
+            [
+                $stockAlias => $this->resourceConnection->getTableName('cataloginventory_stock_status'),
+            ],
+            sprintf('%2$s.product_id = %1$s.source_id', $alias, $stockAlias),
+            []
+        );
+    }
+}

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

@@ -0,0 +1,25 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\CatalogSearch\Model\Search\FilterMapper;
+
+use Magento\Framework\DB\Select;
+
+/**
+ * SPI Interface to change the stock join
+ */
+interface StockJoinProviderInterface
+{
+
+    /**
+     * Add stock join to the given select.
+     *
+     * @param Select $select
+     * @param $alias
+     * @return void
+     */
+    public function add(Select $select, $alias);
+}

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

@@ -16,29 +16,13 @@
  * Class StockStatusFilter
  * Adds filter by stock status to base select
  */
-class StockStatusFilter
+class StockStatusFilter implements StockStatusFilterInterface
 {
     /**
      * @var ResourceConnection
      */
     private $resourceConnection;
 
-    /**
-     * 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';
-
     /**
      * @var ConditionManager
      */
@@ -84,7 +68,7 @@ public function __construct(
      */
     public function apply(Select $select, $stockValues, $type, $showOutOfStockFlag)
     {
-        if ($type !== self::FILTER_JUST_ENTITY && $type !== self::FILTER_ENTITY_AND_SUB_PRODUCTS) {
+        if ($type !== static::FILTER_JUST_ENTITY && $type !== static::FILTER_ENTITY_AND_SUB_PRODUCTS) {
             throw new \InvalidArgumentException(sprintf('Invalid filter type: %s', $type));
         }
 

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

@@ -0,0 +1,38 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\CatalogSearch\Model\Search\FilterMapper;
+
+use Magento\Framework\DB\Select;
+
+/**
+ * Adds filter by stock status to base select (SPI)
+ * @api
+ */
+interface StockStatusFilterInterface
+{
+    /**
+     * 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';
+    const FILTER_ENTITY_AND_SUB_PRODUCTS = 'filter_with_sub_products';
+    const FILTER_JUST_SUB_PRODUCTS = 'filter_just_sub_products';
+
+    /**
+     * Adds filter by stock status to base select
+     *
+     * @param Select $select
+     * @param mixed $stockValues
+     * @param string $type
+     * @param bool $showOutOfStockFlag
+     * @return Select
+     * @throws \InvalidArgumentException
+     */
+    public function apply(Select $select, $stockValues, $type, $showOutOfStockFlag);
+}