ENGCOM-7011: #26986 REST API Pagination issue #26988

magento · Apr 7, 2020 · 3ef84ef · 3ef84ef
2 parents d69c242 + 7e6ad1d
commit 3ef84ef
Show file tree

Hide file tree

Showing 12 changed files with 424 additions and 188 deletions.
diff --git a/app/code/Magento/Catalog/Model/ResourceModel/Product/Collection.php b/app/code/Magento/Catalog/Model/ResourceModel/Product/Collection.php
@@ -1180,9 +1180,33 @@ protected function _getSelectCountSql(?Select $select = null, $resetLeftJoins =
         if ($resetLeftJoins) {
             $countSelect->resetJoinLeft();
         }
+
+        $this->removeEntityIdentifierFromGroupBy($countSelect);
+
         return $countSelect;
     }
 
+    /**
+     * Using `entity_id` for `GROUP BY` causes COUNT() return {n} rows of value = 1 instead of 1 row of value {n}
+     *
+     * @param Select $select
+     * @throws \Zend_Db_Select_Exception
+     */
+    private function removeEntityIdentifierFromGroupBy(Select $select): void
+    {
+        $originalGroupBy = $select->getPart(Select::GROUP);
+
+        if (!is_array($originalGroupBy)) {
+            return;
+        }
+
+        $groupBy = array_filter($originalGroupBy, function ($field) {
+            return false === strpos($field, $this->getIdFieldName());
+        });
+
+        $select->setPart(Select::GROUP, $groupBy);
+    }
+
     /**
      * Prepare statistics data
      *
@@ -1768,30 +1792,19 @@ public function addAttributeToSort($attribute, $dir = self::SORT_ORDER_ASC)
      */
     protected function _prepareProductLimitationFilters()
     {
-        if (isset(
-            $this->_productLimitationFilters['visibility']
-        ) && !isset(
-            $this->_productLimitationFilters['store_id']
-        )
-        ) {
+        if (isset($this->_productLimitationFilters['visibility'])
+            && !isset($this->_productLimitationFilters['store_id'])) {
             $this->_productLimitationFilters['store_id'] = $this->getStoreId();
         }
-        if (isset(
-            $this->_productLimitationFilters['category_id']
-        ) && !isset(
-            $this->_productLimitationFilters['store_id']
-        )
-        ) {
+
+        if (isset($this->_productLimitationFilters['category_id'])
+            && !isset($this->_productLimitationFilters['store_id'])) {
             $this->_productLimitationFilters['store_id'] = $this->getStoreId();
         }
-        if (isset(
-            $this->_productLimitationFilters['store_id']
-        ) && isset(
-            $this->_productLimitationFilters['visibility']
-        ) && !isset(
-            $this->_productLimitationFilters['category_id']
-        )
-        ) {
+
+        if (isset($this->_productLimitationFilters['store_id'])
+            && isset($this->_productLimitationFilters['visibility'])
+            && !isset($this->_productLimitationFilters['category_id'])) {
             $this->_productLimitationFilters['category_id'] = $this->_storeManager->getStore(
                 $this->_productLimitationFilters['store_id']
             )->getRootCategoryId();
@@ -1822,14 +1835,8 @@ protected function _productLimitationJoinWebsite()
                 $filters['website_ids'],
                 'int'
             );
-        } elseif (isset(
-            $filters['store_id']
-        ) && (!isset(
-            $filters['visibility']
-        ) && !isset(
-            $filters['category_id']
-        )) && !$this->isEnabledFlat()
-        ) {
+        } elseif (isset($filters['store_id']) && !$this->isEnabledFlat()
+            && (!isset($filters['visibility']) && !isset($filters['category_id']))) {
             $joinWebsite = true;
             $websiteId = $this->_storeManager->getStore($filters['store_id'])->getWebsiteId();
             $conditions[] = $this->getConnection()->quoteInto('product_website.website_id = ?', $websiteId, 'int');
@@ -1904,9 +1911,9 @@ protected function _productLimitationJoinPrice()
     /**
      * Join Product Price Table with left-join possibility
      *
-     * @see \Magento\Catalog\Model\ResourceModel\Product\Collection::_productLimitationJoinPrice()
      * @param bool $joinLeft
      * @return $this
+     * @see \Magento\Catalog\Model\ResourceModel\Product\Collection::_productLimitationJoinPrice()
      * @SuppressWarnings(PHPMD.CyclomaticComplexity)
      */
     protected function _productLimitationPrice($joinLeft = false)

diff --git a/...code/Magento/Catalog/Test/Mftf/ActionGroup/AssertStorefrontNoProductsFoundActionGroup.xml b/...code/Magento/Catalog/Test/Mftf/ActionGroup/AssertStorefrontNoProductsFoundActionGroup.xml
@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ /**
+  * Copyright © Magento, Inc. All rights reserved.
+  * See COPYING.txt for license details.
+  */
+-->
+<actionGroups xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+              xsi:noNamespaceSchemaLocation="urn:magento:mftf:Test/etc/actionGroupSchema.xsd">
+    <actionGroup name="AssertStorefrontNoProductsFoundActionGroup">
+        <see userInput="We can't find products matching the selection." stepKey="seeEmptyNotice"/>
+    </actionGroup>
+</actionGroups>
diff --git a/app/code/Magento/Catalog/Test/Mftf/Data/CatalogStorefrontConfigData.xml b/app/code/Magento/Catalog/Test/Mftf/Data/CatalogStorefrontConfigData.xml
@@ -69,4 +69,12 @@
         <data key="path">catalog/frontend/grid_per_page_values</data>
         <data key="value">1,2</data>
     </entity>
+    <entity name="DefaultGridPerPageDefaultConfigData">
+        <data key="path">catalog/frontend/grid_per_page</data>
+        <data key="value">12</data>
+    </entity>
+    <entity name="CustomGridPerPageDefaultConfigData">
+        <data key="path">catalog/frontend/grid_per_page</data>
+        <data key="value">1</data>
+    </entity>
 </entities>
diff --git a/app/code/Magento/Catalog/Test/Mftf/Test/AdminMoveProductBetweenCategoriesTest.xml b/app/code/Magento/Catalog/Test/Mftf/Test/AdminMoveProductBetweenCategoriesTest.xml
@@ -158,7 +158,7 @@
 
         <!-- # Category should open successfully # <product1> should be absent on the page -->
         <see userInput="$$createAnchoredCategory1.name$$" selector="{{StorefrontCategoryMainSection.CategoryTitle}}" stepKey="seeCategory1Name"/>
-        <see userInput="We can't find products matching the selection." stepKey="seeEmptyNotice"/>
+        <actionGroup ref="AssertStorefrontNoProductsFoundActionGroup" stepKey="seeEmptyNotice"/>
         <dontSee userInput="$$simpleProduct.name$$" selector="{{StorefrontCategoryMainSection.productName}}" stepKey="dontseeProduct"/>
 
         <!-- Log in to the backend: Admin user is logged in-->

diff --git a/.../Magento/Catalog/Test/Mftf/Test/AdminProductCategoryIndexerInUpdateOnScheduleModeTest.xml b/.../Magento/Catalog/Test/Mftf/Test/AdminProductCategoryIndexerInUpdateOnScheduleModeTest.xml
@@ -91,7 +91,7 @@
 
         <!-- The category is still empty -->
         <see userInput="$$createCategoryA.name$$" selector="{{StorefrontCategoryMainSection.CategoryTitle}}" stepKey="seeCategoryA1Name"/>
-        <see userInput="We can't find products matching the selection." stepKey="seeEmptyNotice"/>
+        <actionGroup ref="AssertStorefrontNoProductsFoundActionGroup" stepKey="seeEmptyNotice"/>
         <dontSee userInput="$$createProductA1.name$$" selector="{{StorefrontCategoryMainSection.productName}}" stepKey="dontseeProductA1"/>
 
         <!-- 4. Run cron to reindex -->
@@ -132,7 +132,7 @@
 
         <!-- Category A is empty now -->
         <see userInput="$$createCategoryA.name$$" selector="{{StorefrontCategoryMainSection.CategoryTitle}}" stepKey="seeOnPageCategoryAName"/>
-        <see userInput="We can't find products matching the selection." stepKey="seeOnPageEmptyNotice"/>
+        <actionGroup ref="AssertStorefrontNoProductsFoundActionGroup" stepKey="seeOnPageEmptyNotice"/>
         <dontSee userInput="$$createProductA1.name$$" selector="{{StorefrontCategoryMainSection.productName}}" stepKey="dontseeProductA1OnPage"/>
 
         <!-- Case: change product status -->

diff --git a/app/code/Magento/Catalog/view/frontend/web/js/product/list/toolbar.js b/app/code/Magento/Catalog/view/frontend/web/js/product/list/toolbar.js
@@ -23,6 +23,7 @@ define([
             direction: 'product_list_dir',
             order: 'product_list_order',
             limit: 'product_list_limit',
+            page: 'p',
             modeDefault: 'grid',
             directionDefault: 'asc',
             orderDefault: 'position',
@@ -81,24 +82,63 @@ define([
         },
 
         /**
-         * @param {String} paramName
-         * @param {*} paramValue
-         * @param {*} defaultValue
+         * @private
          */
-        changeUrl: function (paramName, paramValue, defaultValue) {
+        getUrlParams: function () {
             var decode = window.decodeURIComponent,
                 urlPaths = this.options.url.split('?'),
-                baseUrl = urlPaths[0],
                 urlParams = urlPaths[1] ? urlPaths[1].split('&') : [],
-                paramData = {},
-                parameters, i, form, params, key, input, formKey;
+                params = {},
+                parameters, i;
 
             for (i = 0; i < urlParams.length; i++) {
                 parameters = urlParams[i].split('=');
-                paramData[decode(parameters[0])] = parameters[1] !== undefined ?
+                params[decode(parameters[0])] = parameters[1] !== undefined ?
                     decode(parameters[1].replace(/\+/g, '%20')) :
                     '';
             }
+
+            return params;
+        },
+
+        /**
+         * @returns {String}
+         * @private
+         */
+        getCurrentLimit: function () {
+            return this.getUrlParams()[this.options.limit] || this.options.limitDefault;
+        },
+
+        /**
+         * @returns {String}
+         * @private
+         */
+        getCurrentPage: function () {
+            return this.getUrlParams()[this.options.page] || 1;
+        },
+
+        /**
+         * @param {String} paramName
+         * @param {*} paramValue
+         * @param {*} defaultValue
+         */
+        changeUrl: function (paramName, paramValue, defaultValue) {
+            var urlPaths = this.options.url.split('?'),
+                baseUrl = urlPaths[0],
+                paramData = this.getUrlParams(),
+                currentPage = this.getCurrentPage(),
+                form, params, key, input, formKey, newPage;
+
+            if (currentPage > 1 && paramName === this.options.limit) {
+                newPage = Math.floor(this.getCurrentLimit() * (currentPage - 1) / paramValue) + 1;
+
+                if (newPage > 1) {
+                    paramData[this.options.page] = newPage;
+                } else {
+                    delete paramData[this.options.page];
+                }
+            }
+
             paramData[paramName] = paramValue;
 
             if (this.options.post) {
@@ -130,6 +170,7 @@ define([
                 if (paramValue == defaultValue) { //eslint-disable-line eqeqeq
                     delete paramData[paramName];
                 }
+
                 paramData = $.param(paramData);
                 location.href = baseUrl + (paramData.length ? '?' + paramData : '');
             }

diff --git a/.../Magento/Elasticsearch/Model/ResourceModel/Fulltext/Collection/SearchCriteriaResolver.php b/.../Magento/Elasticsearch/Model/ResourceModel/Fulltext/Collection/SearchCriteriaResolver.php
@@ -80,6 +80,9 @@ public function resolve(): SearchCriteria
         $searchCriteria->setRequestName($this->searchRequestName);
         $searchCriteria->setSortOrders($this->orders);
         $searchCriteria->setCurrentPage($this->currentPage - 1);
+        if ($this->size) {
+            $searchCriteria->setPageSize($this->size);
+        }
 
         return $searchCriteria;
     }

diff --git a/...nto/Elasticsearch6/Test/Mftf/Test/StorefrontProductQuickSearchUsingElasticSearch6Test.xml b/...nto/Elasticsearch6/Test/Mftf/Test/StorefrontProductQuickSearchUsingElasticSearch6Test.xml
@@ -30,12 +30,16 @@
                 <field key="name">Product Simple AAA</field>
             </createData>
             <magentoCLI command="config:set {{CustomGridPerPageValuesConfigData.path}} {{CustomGridPerPageValuesConfigData.value}}" stepKey="setCustomGridPerPageValues"/>
+            <magentoCLI command="config:set {{CustomGridPerPageDefaultConfigData.path}} {{CustomGridPerPageDefaultConfigData.value}}" stepKey="setCustomGridPerPageDefaults"/>
+            <magentoCLI stepKey="flushConfigCache" command="cache:flush config"/>
+            <magentoCron groups="index" stepKey="runCronIndex"/>
         </before>
 
         <after>
             <deleteData createDataKey="createFirstProduct" stepKey="deleteFirstProduct"/>
             <deleteData createDataKey="createSecondProduct" stepKey="deleteSecondProduct"/>
             <magentoCLI command="config:set {{DefaultGridPerPageValuesConfigData.path}} {{DefaultGridPerPageValuesConfigData.value}}" stepKey="setDefaultGridPerPageValues"/>
+            <magentoCLI command="config:set {{DefaultGridPerPageDefaultConfigData.path}} {{DefaultGridPerPageDefaultConfigData.value}}" stepKey="setDefaultGridPerPageDefaults"/>
         </after>
 
         <actionGroup ref="StorefrontOpenHomePageActionGroup" stepKey="openStorefrontHomePage"/>
@@ -57,6 +61,9 @@
         </actionGroup>
         <selectOption selector="{{StorefrontCategoryBottomToolbarSection.perPage}}" userInput="2" stepKey="selectDisplayedProductInGridPerPage"/>
         <waitForPageLoad stepKey="waitForPageLoad"/>
+
+        <dontSeeInCurrentUrl stepKey="assertRedirectedToFirstPage" url="?p=2"/>
+
         <actionGroup ref="AssertProductOnCategoryPageActionGroup" stepKey="assertFirstProductDisplayedOnCatalogSearchPage">
             <argument name="product" value="$createFirstProduct$"/>
         </actionGroup>

diff --git a/...est/Mftf/Test/StorefrontProductQuickSearchUsingElasticSearch6WithNotAvailablePageTest.xml b/...est/Mftf/Test/StorefrontProductQuickSearchUsingElasticSearch6WithNotAvailablePageTest.xml
@@ -25,22 +25,11 @@
         <remove keyForRemoval="selectDisplayedProductInGridPerPage"/>
         <remove keyForRemoval="assertFirstProductDisplayedOnCatalogSearchPage"/>
         <remove keyForRemoval="assertSecondProductDisplayedOnCatalogSearchPage"/>
-        <grabTextFrom selector="{{StorefrontCategoryBottomToolbarSection.currentPage}}" stepKey="grabNumberOfLastPage"/>
-        <actionGroup ref="StorefrontQuickSearchWithPaginationActionGroup" stepKey="navigateToUnavailableCatalogSearchResultPage">
+        <remove keyForRemoval="selectDisplayedProductInGridPerPage"/>
+        <remove keyForRemoval="assertStillOnSecondPage"/>
+        <actionGroup ref="StorefrontQuickSearchWithPaginationActionGroup" stepKey="navigateToUnavailableCatalogSearchResultPage" before="waitForPageLoad">
             <argument name="phrase" value="AAA"/>
             <argument name="pageNumber" value="999"/>
         </actionGroup>
-        <scrollTo selector="{{StorefrontCategoryBottomToolbarSection.currentPage}}" stepKey="scrollToBottomToolbarPager"/>
-        <grabTextFrom selector="{{StorefrontCategoryBottomToolbarSection.currentPage}}" stepKey="grabNumberOfCurrentPage"/>
-        <assertEquals stepKey="assertCurrentPageIsLastPageOfCatalogSearchResult">
-            <expectedResult type="variable">grabNumberOfLastPage</expectedResult>
-            <actualResult type="variable">grabNumberOfCurrentPage</actualResult>
-        </assertEquals>
-        <actionGroup ref="AssertProductOnCategoryPageActionGroup" stepKey="assertProductOnLastCatalogSearchPage">
-            <argument name="product" value="$createSecondProduct$"/>
-        </actionGroup>
-        <actionGroup ref="StorefrontCheckProductIsMissingInCategoryProductsPageActionGroup" stepKey="assertFirstProductIsMissingOnLastCatalogSearchPage">
-            <argument name="productName" value="$createFirstProduct.name$"/>
-        </actionGroup>
     </test>
 </tests>