Merge pull request #4457 from magento-mpi/PR-07-10-2019

[mpi] MAGETWO-99716: Limit list of type ahead suggested terms for Search keyword; currently the list can go over 100

Author: dhorytskyi

app/code/Magento/CatalogSearch/Model/Autocomplete/DataProvider.php

@@ -10,9 +10,16 @@
 use Magento\Search\Model\QueryFactory;
 use Magento\Search\Model\Autocomplete\DataProviderInterface;
 use Magento\Search\Model\Autocomplete\ItemFactory;
+use Magento\Framework\App\Config\ScopeConfigInterface as ScopeConfig;
+use Magento\Store\Model\ScopeInterface;
 
 class DataProvider implements DataProviderInterface
 {
+    /**
+     * Autocomplete limit
+     */
+    private static $CONFIG_AUTOCOMPLETE_LIMIT = 'catalog/search/autocomplete_limit';
+
     /**
      * Query factory
      *
@@ -27,16 +34,25 @@ class DataProvider implements DataProviderInterface
      */
     protected $itemFactory;
 
+    /**
+     * Scope Config Object
+     *
+     * @var ScopeConfig
+     */
+    private $scopeConfig;
+
     /**
      * @param QueryFactory $queryFactory
      * @param ItemFactory $itemFactory
      */
     public function __construct(
         QueryFactory $queryFactory,
-        ItemFactory $itemFactory
+        ItemFactory $itemFactory,
+        ScopeConfig $scopeConfig
     ) {
         $this->queryFactory = $queryFactory;
         $this->itemFactory = $itemFactory;
+        $this->scopeConfig = $scopeConfig;
     }
 
     /**
@@ -46,6 +62,10 @@ public function getItems()
     {
         $collection = $this->getSuggestCollection();
         $query = $this->queryFactory->get()->getQueryText();
+        $limit = (int) $this->scopeConfig->getValue(
+            static::$CONFIG_AUTOCOMPLETE_LIMIT,
+            ScopeInterface::SCOPE_STORE
+        );
         $result = [];
         foreach ($collection as $item) {
             $resultItem = $this->itemFactory->create([
@@ -58,7 +78,7 @@ public function getItems()
                 $result[] = $resultItem;
             }
         }
-        return $result;
+        return ($limit) ? array_splice($result, 0, $limit) : $result;
     }
 
     /**

app/code/Magento/CatalogSearch/Test/Unit/Model/Autocomplete/DataProviderTest.php

@@ -25,6 +25,11 @@ class DataProviderTest extends \PHPUnit\Framework\TestCase
      */
     private $itemFactory;
 
+    /**
+     * @var Magento\Framework\App\Config\ScopeConfigInterface |\PHPUnit_Framework_MockObject_MockObject
+     */
+    private $scopeConfig;
+
     /**
      * @var \Magento\Search\Model\ResourceModel\Query\Collection |\PHPUnit_Framework_MockObject_MockObject
      */
@@ -60,18 +65,25 @@ protected function setUp()
             ->setMethods(['create'])
             ->getMock();
 
+        $this->scopeConfig = $this->getMockBuilder(\Magento\Framework\App\Config\ScopeConfigInterface::class)
+            ->setMethods(['getValue'])
+            ->disableOriginalConstructor()
+            ->getMockForAbstractClass();
+
         $this->model = $helper->getObject(
             \Magento\CatalogSearch\Model\Autocomplete\DataProvider::class,
             [
                 'queryFactory' => $queryFactory,
-                'itemFactory' => $this->itemFactory
+                'itemFactory' => $this->itemFactory,
+                'scopeConfig' => $this->scopeConfig
             ]
         );
     }
 
     public function testGetItems()
     {
         $queryString = 'string';
+        $limit = 3;
         $expected = ['title' => $queryString, 'num_results' => 100500];
         $collection = [
             ['query_text' => 'string1', 'num_results' => 1],
@@ -80,6 +92,8 @@ public function testGetItems()
             ['query_text' => 'string100', 'num_results' => 100],
             ['query_text' => $queryString, 'num_results' => 100500]
         ];
+        $this->scopeConfig->method('getValue')
+            ->willReturn($limit);
         $this->buildCollection($collection);
         $this->query->expects($this->once())
             ->method('getQueryText')
@@ -105,6 +119,7 @@ public function testGetItems()
         $this->itemFactory->expects($this->any())->method('create')->willReturn($itemMock);
         $result = $this->model->getItems();
         $this->assertEquals($expected, $result[0]->toArray());
+        $this->assertEquals($limit, count($result));
     }
 
     /**

app/code/Magento/CatalogSearch/etc/adminhtml/system.xml

@@ -34,6 +34,10 @@
                     <comment>Number of popular search terms to be cached for faster response. Use “0” to cache all results after a term is searched for the second time.</comment>
                     <validate>validate-digits</validate>
                 </field>
+                <field id="autocomplete_limit" translate="label" type="text" sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
+                    <label>Autocomplete Limit</label>
+                    <validate>validate-digits</validate>
+                </field>
                 <field id="enable_eav_indexer" translate="label" type="select" sortOrder="18" showInDefault="1" showInWebsite="0" showInStore="0">
                     <label>Enable EAV Indexer</label>
                     <comment>Enable/Disable Product EAV indexer to improve indexation speed. Make sure that indexer is not used by 3rd party extensions.</comment>

app/code/Magento/CatalogSearch/etc/config.xml

@@ -16,6 +16,7 @@
                 <min_query_length>3</min_query_length>
                 <max_query_length>128</max_query_length>
                 <max_count_cacheable_search_terms>100</max_count_cacheable_search_terms>
+                <autocomplete_limit>8</autocomplete_limit>
                 <enable_eav_indexer>1</enable_eav_indexer>
             </search>
         </catalog>

app/code/Magento/Payment/view/frontend/web/js/view/payment/iframe.js

@@ -144,7 +144,7 @@ define([
          * {Function}
          */
         setPaymentInformation: function () {
-            setPaymentInformationAction(
+            return setPaymentInformationAction(
                 this.messageContainer,
                 {
                     method: this.getCode()