ENGCOM-6388: Fix SearchResult isCacheable performance #25851

Author: slavvka

app/code/Magento/Search/Model/PopularSearchTerms.php

@@ -7,7 +7,7 @@
 namespace Magento\Search\Model;
 
 /**
- * Popular search terms
+ * Finds top search results in search
  */
 class PopularSearchTerms
 {
@@ -29,7 +29,7 @@ class PopularSearchTerms
 
     /**
      * @param \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig
-     * @param \Magento\Search\Model\ResourceModel\Query\Collection
+     * @param \Magento\Search\Model\ResourceModel\Query\Collection $queryCollection
      */
     public function __construct(
         \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig,
@@ -48,13 +48,8 @@ public function __construct(
      */
     public function isCacheable(string $term, int $storeId)
     {
-        $terms = $this->queryCollection
-            ->setPopularQueryFilter($storeId)
-            ->setPageSize($this->getMaxCountCacheableSearchTerms($storeId))
-            ->load()
-            ->getColumnValues('query_text');
-
-        return in_array($term, $terms);
+        $maxCountCacheableSearchTerms = $this->getMaxCountCacheableSearchTerms($storeId);
+        return $this->queryCollection->isTopSearchResult($term, $storeId, $maxCountCacheableSearchTerms);
     }
 
     /**

app/code/Magento/Search/Model/ResourceModel/Query/Collection.php

@@ -5,15 +5,25 @@
  */
 namespace Magento\Search\Model\ResourceModel\Query;
 
+use Magento\Framework\Data\Collection\Db\FetchStrategyInterface;
+use Magento\Framework\Data\Collection\EntityFactoryInterface;
+use Magento\Framework\DB\Adapter\AdapterInterface;
+use Magento\Framework\DB\Helper;
+use Magento\Framework\Event\ManagerInterface;
+use Magento\Framework\Model\ResourceModel\Db\AbstractDb;
+use Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection;
 use Magento\Store\Model\Store;
+use Magento\Store\Model\StoreManagerInterface;
+use Psr\Log\LoggerInterface;
 
 /**
  * Search query collection
  *
  * @api
  * @since 100.0.2
+ * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
-class Collection extends \Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection
+class Collection extends AbstractCollection
 {
     /**
      * Store for filter
@@ -25,36 +35,38 @@ class Collection extends \Magento\Framework\Model\ResourceModel\Db\Collection\Ab
     /**
      * Store manager
      *
-     * @var \Magento\Store\Model\StoreManagerInterface
+     * @var StoreManagerInterface
      */
     protected $_storeManager;
 
     /**
      * Search resource helper
      *
-     * @var \Magento\Framework\DB\Helper
+     * @var Helper
      */
     protected $_resourceHelper;
 
     /**
-     * @param \Magento\Framework\Data\Collection\EntityFactory $entityFactory
-     * @param \Psr\Log\LoggerInterface $logger
-     * @param \Magento\Framework\Data\Collection\Db\FetchStrategyInterface $fetchStrategy
-     * @param \Magento\Framework\Event\ManagerInterface $eventManager
-     * @param \Magento\Store\Model\StoreManagerInterface $storeManager
-     * @param \Magento\Framework\DB\Helper $resourceHelper
-     * @param \Magento\Framework\DB\Adapter\AdapterInterface $connection
-     * @param \Magento\Framework\Model\ResourceModel\Db\AbstractDb $resource
+     * Constructor
+     *
+     * @param EntityFactoryInterface $entityFactory
+     * @param LoggerInterface $logger
+     * @param FetchStrategyInterface $fetchStrategy
+     * @param ManagerInterface $eventManager
+     * @param StoreManagerInterface $storeManager
+     * @param Helper $resourceHelper
+     * @param AdapterInterface $connection
+     * @param AbstractDb $resource
      */
     public function __construct(
-        \Magento\Framework\Data\Collection\EntityFactoryInterface $entityFactory,
-        \Psr\Log\LoggerInterface $logger,
-        \Magento\Framework\Data\Collection\Db\FetchStrategyInterface $fetchStrategy,
-        \Magento\Framework\Event\ManagerInterface $eventManager,
-        \Magento\Store\Model\StoreManagerInterface $storeManager,
-        \Magento\Framework\DB\Helper $resourceHelper,
-        \Magento\Framework\DB\Adapter\AdapterInterface $connection = null,
-        \Magento\Framework\Model\ResourceModel\Db\AbstractDb $resource = null
+        EntityFactoryInterface $entityFactory,
+        LoggerInterface $logger,
+        FetchStrategyInterface $fetchStrategy,
+        ManagerInterface $eventManager,
+        StoreManagerInterface $storeManager,
+        Helper $resourceHelper,
+        AdapterInterface $connection = null,
+        AbstractDb $resource = null
     ) {
         $this->_storeManager = $storeManager;
         $this->_resourceHelper = $resourceHelper;
@@ -149,6 +161,36 @@ public function setPopularQueryFilter($storeIds = null)
         return $this;
     }
 
+    /**
+     * Determines whether a Search Term belongs to the top results for given storeId
+     *
+     * @param string $term
+     * @param int $storeId
+     * @param int $maxCountCacheableSearchTerms
+     * @return bool
+     */
+    public function isTopSearchResult(string $term, int $storeId, int $maxCountCacheableSearchTerms):bool
+    {
+        $select = $this->getSelect();
+        $select->reset(\Magento\Framework\DB\Select::FROM);
+        $select->reset(\Magento\Framework\DB\Select::COLUMNS);
+        $select->distinct(true);
+        $select->from(['main_table' => $this->getTable('search_query')], ['query_text']);
+        $select->where('main_table.store_id IN (?)', $storeId);
+        $select->where('num_results > 0');
+        $select->order(['popularity desc']);
+
+        $select->limit($maxCountCacheableSearchTerms);
+
+        $subQuery = new \Zend_Db_Expr('(' . $select->assemble() . ')');
+
+        $select->reset();
+        $select->from(['result' =>  $subQuery ], []);
+        $select->where('result.query_text = ?', $term);
+
+        return $this->getSize() > 0;
+    }
+
     /**
      * Set Recent Queries Order
      *

app/code/Magento/Search/Test/Unit/Model/PopularSearchTermsTest.php

@@ -49,47 +49,27 @@ protected function setUp()
     /**
      * Test isCacheableDataProvider method
      *
-     * @dataProvider isCacheableDataProvider
-     *
-     * @param string $term
-     * @param array $terms
-     * @param $expected $terms
-     *
      * @return void
      */
-    public function testIsCacheable($term, $terms, $expected)
+    public function testIsCacheable()
     {
-        $storeId = 7;
-        $pageSize = 25;
+        $term = 'test1';
+        $storeId = 1;
+        $pageSize = 35;
 
-        $this->scopeConfigMock->expects($this->once())->method('getValue')
+        $this->scopeConfigMock->expects($this->exactly(2))
+            ->method('getValue')
             ->with(
                 PopularSearchTerms::XML_PATH_MAX_COUNT_CACHEABLE_SEARCH_TERMS,
                 ScopeInterface::SCOPE_STORE,
                 $storeId
             )->willReturn($pageSize);
-        $this->queryCollectionMock->expects($this->once())->method('setPopularQueryFilter')->with($storeId)
-            ->willReturnSelf();
-        $this->queryCollectionMock->expects($this->once())->method('setPageSize')->with($pageSize)
-            ->willReturnSelf();
-        $this->queryCollectionMock->expects($this->once())->method('load')->willReturnSelf();
-        $this->queryCollectionMock->expects($this->once())->method('getColumnValues')->with('query_text')
-            ->willReturn($terms);
-
-        $actual = $this->popularSearchTerms->isCacheable($term, $storeId);
-        self::assertEquals($expected, $actual);
-    }
+        $this->queryCollectionMock->expects($this->exactly(2))
+            ->method('isTopSearchResult')
+            ->with($term, $storeId, $pageSize)
+            ->willReturn(true, false);
 
-    /**
-     * @return array
-     */
-    public function isCacheableDataProvider()
-    {
-        return [
-            ['test01', [], false],
-            ['test02', ['test01', 'test02'], true],
-            ['test03', ['test01', 'test02'], false],
-            ['test04', ['test04'], true],
-        ];
+        $this->assertTrue($this->popularSearchTerms->isCacheable($term, $storeId));
+        $this->assertFalse($this->popularSearchTerms->isCacheable($term, $storeId));
     }
 }