ENGCOM-2966: Improve graphql product pagination #175

 - Merge Pull Request magento/graphql-ce#175 from Spaggel/graphql-ce:improve-graphql-product-pagination
 - Merged commits:
   1. 651ee47
   2. 5f05572
   3. 4edafcf
   4. d0231e8
   5. 096e37e
   6. 2e3d4b0
   7. 9ad5a2c
   8. 541098b
   9. 2296d84

Author: magento-engcom-team

app/code/Magento/CatalogGraphQl/Model/Resolver/Products.php

@@ -7,6 +7,7 @@
 
 namespace Magento\CatalogGraphQl\Model\Resolver;
 
+use Magento\CatalogGraphQl\Model\Resolver\Layer\DataProvider\Filters;
 use Magento\Framework\GraphQl\Schema\Type\ResolveInfo;
 use Magento\CatalogGraphQl\Model\Resolver\Products\Query\Filter;
 use Magento\CatalogGraphQl\Model\Resolver\Products\Query\Search;
@@ -51,13 +52,15 @@ class Products implements ResolverInterface
      * @param Builder $searchCriteriaBuilder
      * @param Search $searchQuery
      * @param Filter $filterQuery
+     * @param SearchFilter $searchFilter
+     * @param Filters $filtersDataProvider
      */
     public function __construct(
         Builder $searchCriteriaBuilder,
         Search $searchQuery,
         Filter $filterQuery,
         SearchFilter $searchFilter,
-        \Magento\CatalogGraphQl\Model\Resolver\Layer\DataProvider\Filters $filtersDataProvider
+        Filters $filtersDataProvider
     ) {
         $this->searchCriteriaBuilder = $searchCriteriaBuilder;
         $this->searchQuery = $searchQuery;
@@ -100,10 +103,10 @@ public function resolve(
 
         $currentPage = $searchCriteria->getCurrentPage();
         if ($searchCriteria->getCurrentPage() > $maxPages && $searchResult->getTotalCount() > 0) {
-            $currentPage = new GraphQlInputException(
+            throw new GraphQlInputException(
                 __(
-                    'currentPage value %1 specified is greater than the number of pages available.',
-                    [$maxPages]
+                    'currentPage value %1 specified is greater than the %2 page(s) available.',
+                    [$currentPage, $maxPages]
                 )
             );
         }
@@ -113,7 +116,8 @@ public function resolve(
             'items' => $searchResult->getProductsSearchResult(),
             'page_info' => [
                 'page_size' => $searchCriteria->getPageSize(),
-                'current_page' => $currentPage
+                'current_page' => $currentPage,
+                'total_pages' => $maxPages
             ],
             'filters' => $this->filtersDataProvider->getData($layerType)
         ];

app/code/Magento/GraphQl/etc/schema.graphqls

@@ -29,6 +29,7 @@ input FilterTypeInput @doc(description: "FilterTypeInput specifies which action
 type SearchResultPageInfo @doc(description: "SearchResultPageInfo provides navigation for the query response") {
     page_size: Int @doc(description: "Specifies the maximum number of items to return")
     current_page: Int @doc(description: "Specifies which page of results to return")
+    total_pages: Int @doc(description: "Total pages")
 }
 
 enum SortEnum @doc(description: "This enumeration indicates whether to return results in ascending or descending order") {

dev/tests/api-functional/testsuite/Magento/GraphQl/Catalog/ProductSearchTest.php

@@ -381,84 +381,11 @@ public function testSearchWithFilterWithPageSizeEqualTotalCount()
 }
 QUERY;
         $this->expectException(\Exception::class);
-        $this->expectExceptionMessage('GraphQL response contains errors: currentPage value 1 specified is greater ' .
-            'than the number of pages available.');
+        $this->expectExceptionMessage('GraphQL response contains errors: currentPage value 2 specified is greater ' .
+            'than the 1 page(s) available');
         $this->graphQlQuery($query);
     }
 
-    /**
-     * The query returns a total_count of 2 records; setting the pageSize = 1 and currentPage2
-     * Expected result is to get the second product on the list on the second page
-     *
-     * @magentoApiDataFixture Magento/Catalog/_files/multiple_products.php
-     */
-    public function testSearchWithFilterPageSizeLessThanCurrentPage()
-    {
-
-        $query
-            = <<<QUERY
-{
-    products(
-     search : "simple"
-        filter:
-        {
-          special_price:{neq:"null"}
-          price:{lt:"60"}
-          or:
-          {
-           sku:{like:"%simple%"}
-           name:{like:"%configurable%"}
-          }
-           weight:{eq:"1"}
-        }
-        pageSize:1
-        currentPage:2
-        sort:
-       {
-        price:DESC
-       }
-    )
-    {
-        items
-         {
-           sku
-           price {
-            minimalPrice {
-                amount {
-                    value
-                    currency
-                }
-            }
-           }
-           name
-           ... on PhysicalProductInterface {
-            weight
-           }
-           type_id
-           attribute_set_id
-         }
-        total_count
-        page_info
-        {
-          page_size
-        }
-    }
-}
-QUERY;
-        /**
-         * @var ProductRepositoryInterface $productRepository
-         */
-        $productRepository = ObjectManager::getInstance()->get(ProductRepositoryInterface::class);
-        // when pagSize =1 and currentPage = 2, it should have simple2 on first page and simple1 on 2nd page
-        // since sorting is done on price in the DESC order
-        $product = $productRepository->get('simple1');
-        $filteredProducts = [$product];
-
-        $response = $this->graphQlQuery($query);
-        $this->assertEquals(1, $response['products']['total_count']);
-        $this->assertProductItems($filteredProducts, $response);
-    }
-
     /**
      * Requesting for items that match a specific SKU or NAME within a certain price range sorted by Price in ASC order
      *
@@ -549,71 +476,55 @@ public function testQueryProductsInCurrentPageSortedByPriceASC()
     }
 
     /**
-     * Verify the items in the second page is correct after sorting their name in ASC order
+     * Verify the items is correct after sorting their name in ASC order
      *
      * @magentoApiDataFixture Magento/Catalog/_files/multiple_mixed_products_2.php
-     * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
      */
-    public function testFilterProductsInNextPageSortedByNameASC()
+    public function testQueryProductsSortedByNameASC()
     {
         $query
             = <<<QUERY
 {
     products(
         filter:
         {
-            price:{gt: "5", lt: "50"}
-            or:
-            {
-                sku:{eq:"simple1"}
-                name:{like:"configurable%"}
-            }
+            sku:{in:["simple2", "simple1"]}
         }
-         pageSize:4
+         pageSize:1
          currentPage:2
          sort:
          {
-          name:ASC
+             name:ASC
          }
     )
     {
       items
       {
         sku
-        price {
-            minimalPrice {
-                amount {
-                    value
-                    currency
-                }
-            }
-        }
         name
-        type_id
-        ... on PhysicalProductInterface {
-            weight
-           }
-           attribute_set_id
-         }
-        total_count
-        page_info
-        {
+      }
+      total_count
+      page_info
+      {
           page_size
-        }
+          current_page
+      }
     }
 }
 QUERY;
         /**
          * @var ProductRepositoryInterface $productRepository
          */
         $productRepository = ObjectManager::getInstance()->get(ProductRepositoryInterface::class);
-        $product = $productRepository->get('simple1');
-        $filteredProducts = [$product];
+        $product = $productRepository->get('simple2');
 
         $response = $this->graphQlQuery($query);
-        $this->assertEquals(1, $response['products']['total_count']);
-        $this->assertProductItems($filteredProducts, $response);
-        $this->assertEquals(4, $response['products']['page_info']['page_size']);
+        $this->assertEquals(2, $response['products']['total_count']);
+        $this->assertEquals(['page_size' => 1, 'current_page' => 2], $response['products']['page_info']);
+        $this->assertEquals(
+            [['sku' => $product->getSku(), 'name' => $product->getName()]],
+            $response['products']['items']
+        );
     }
 
     /**
@@ -1132,8 +1043,8 @@ public function testQueryPageOutOfBoundException()
 QUERY;
 
         $this->expectException(\Exception::class);
-        $this->expectExceptionMessage('GraphQL response contains errors: currentPage value 1 specified is greater ' .
-            'than the number of pages available.');
+        $this->expectExceptionMessage('GraphQL response contains errors: currentPage value 2 specified is greater ' .
+            'than the 1 page(s) available.');
         $this->graphQlQuery($query);
     }