Merge branch 'next-37095/avoid-negative-review-offset' into 'trunk'

NEXT-37095 - avoid negative offset in review call See merge request shopware/6/product/platform!14207
pweyck · Jul 19, 2024 · f7ae5a6 · f7ae5a6
2 parents 678ce7c + 41191f3
commit f7ae5a6
Show file tree

Hide file tree

Showing 3 changed files with 140 additions and 34 deletions.
diff --git a/changelog/_unreleased/2024-07-10-avoid-negative-reviews-offset.md b/changelog/_unreleased/2024-07-10-avoid-negative-reviews-offset.md
@@ -0,0 +1,6 @@
+---
+title: Avoid negative reviews offset 
+issue: NEXT-37095
+---
+# Storefront
+* Changed `Shopware\Storefront\Page\Product\Review\ProductReviewLoader::createCriteria` to avoid negative offset for review pagination.
diff --git a/src/Storefront/Page/Product/Review/ProductReviewLoader.php b/src/Storefront/Page/Product/Review/ProductReviewLoader.php
@@ -86,7 +86,7 @@ private function createCriteria(Request $request, SalesChannelContext $context):
     {
         $limit = (int) $request->get('limit', self::LIMIT);
         $page = (int) $request->get('p', self::DEFAULT_PAGE);
-        $offset = $limit * ($page - 1);
+        $offset = max(0, $limit * ($page - 1));
 
         $criteria = new Criteria();
         $criteria->setLimit($limit);

diff --git a/tests/unit/Storefront/Page/Product/Review/ProductReviewLoaderTest.php b/tests/unit/Storefront/Page/Product/Review/ProductReviewLoaderTest.php
@@ -53,7 +53,9 @@ public function testExceptionWithoutProductId(): void
         $request = new Request([], [], []);
         $salesChannelContext = $this->getSalesChannelContext();
 
-        $productReviewLoader = $this->getProductReviewLoader(null, $request, $salesChannelContext);
+        $productReviewRouteMock = $this->createMock(ProductReviewRoute::class);
+
+        $productReviewLoader = $this->getProductReviewLoader($productReviewRouteMock);
 
         $this->expectException(RoutingException::class);
 
@@ -73,12 +75,94 @@ public function testItLoadsReviewsWithProductId(): void
             $review,
         ]);
 
-        $productReviewLoader = $this->getProductReviewLoader($reviews, $request, $salesChannelContext);
+        $productReviewRouteMock = $this->createMock(ProductReviewRoute::class);
+        $productReviewLoader = $this->getProductReviewLoader($productReviewRouteMock);
+
+        $reviewResult = $this->getDefaultResult($reviews, $request, $salesChannelContext);
+
+        $productReviewRouteMock
+            ->method('load')
+            ->willReturn(
+                new ProductReviewRouteResponse($reviewResult)
+            );
+
+        $result = $productReviewLoader->load($request, $salesChannelContext);
+
+        static::assertInstanceOf(ProductReviewEntity::class, $result->first());
+        static::assertEquals($result->first()->getId(), $reviewId);
+        static::assertCount(1, $result);
+        static::assertNull($result->getCustomerReview());
+    }
+
+    public function testItLoadsReviewsPagination(): void
+    {
+        $reviewId = Uuid::randomHex();
+        $productId = Uuid::randomHex();
+        $request = new Request([], [], ['productId' => $productId, 'p' => 2]);
+        $salesChannelContext = $this->getSalesChannelContext(false);
+
+        $review = $this->getReviewEntity($reviewId);
+
+        $reviews = new ProductReviewCollection([
+            $review,
+        ]);
+
+        $productReviewRouteMock = $this->createMock(ProductReviewRoute::class);
+        $productReviewLoader = $this->getProductReviewLoader($productReviewRouteMock);
+
+        $reviewResult = $this->getDefaultResult($reviews, $request, $salesChannelContext);
+
+        $criteria = $this->createCriteria($request, $salesChannelContext);
+
+        $productReviewRouteMock
+            ->method('load')
+            ->with($productId, $request, $salesChannelContext, $criteria)
+            ->willReturn(
+                new ProductReviewRouteResponse($reviewResult)
+            );
+
+        $result = $productReviewLoader->load($request, $salesChannelContext);
+
+        $firstResult = $result->first();
+        static::assertInstanceOf(ProductReviewEntity::class, $firstResult);
+        static::assertEquals($firstResult->getId(), $reviewId);
+        static::assertEquals($result->getCriteria()->getOffset(), 10);
+        static::assertCount(1, $result);
+        static::assertNull($result->getCustomerReview());
+    }
+
+    public function testNegativeOffsetDefaultsToZero(): void
+    {
+        $reviewId = Uuid::randomHex();
+        $productId = Uuid::randomHex();
+        $request = new Request([], [], ['productId' => $productId, 'p' => -2]);
+        $salesChannelContext = $this->getSalesChannelContext(false);
+
+        $review = $this->getReviewEntity($reviewId);
+
+        $reviews = new ProductReviewCollection([
+            $review,
+        ]);
+
+        $productReviewRouteMock = $this->createMock(ProductReviewRoute::class);
+        $productReviewLoader = $this->getProductReviewLoader($productReviewRouteMock);
+
+        $reviewResult = $this->getDefaultResult($reviews, $request, $salesChannelContext);
+
+        $criteria = $this->createCriteria($request, $salesChannelContext);
+
+        $productReviewRouteMock
+            ->method('load')
+            ->with($productId, $request, $salesChannelContext, $criteria)
+            ->willReturn(
+                new ProductReviewRouteResponse($reviewResult)
+            );
 
         $result = $productReviewLoader->load($request, $salesChannelContext);
 
         static::assertInstanceOf(ProductReviewEntity::class, $result->first());
         static::assertEquals($result->first()->getId(), $reviewId);
+        static::assertEquals($result->getCriteria()->getOffset(), 0);
         static::assertCount(1, $result);
         static::assertNull($result->getCustomerReview());
     }
@@ -96,7 +180,16 @@ public function testItLoadsReviewsWithParentId(): void
             $review,
         ]);
 
-        $productReviewLoader = $this->getProductReviewLoader($reviews, $request, $salesChannelContext);
+        $productReviewRouteMock = $this->createMock(ProductReviewRoute::class);
+        $productReviewLoader = $this->getProductReviewLoader($productReviewRouteMock);
+
+        $reviewResult = $this->getDefaultResult($reviews, $request, $salesChannelContext);
+
+        $productReviewRouteMock
+            ->method('load')
+            ->willReturn(
+                new ProductReviewRouteResponse($reviewResult)
+            );
 
         $result = $productReviewLoader->load($request, $salesChannelContext);
 
@@ -120,7 +213,17 @@ public function testItLoadsReviewsWithPointsFilter(): void
             $review,
         ]);
 
-        $productReviewLoader = $this->getProductReviewLoader($reviews, $request, $salesChannelContext);
+        $productReviewRouteMock = $this->createMock(ProductReviewRoute::class);
+        $productReviewLoader = $this->getProductReviewLoader($productReviewRouteMock);
+
+        $reviewResult = $this->getDefaultResult($reviews, $request, $salesChannelContext);
+
+        $productReviewRouteMock
+            ->method('load')
+            ->willReturn(
+                new ProductReviewRouteResponse($reviewResult)
+            );
+
 
         $result = $productReviewLoader->load($request, $salesChannelContext);
 
@@ -142,41 +245,38 @@ private function getReviewEntity(string $reviewId): ProductReviewEntity
     }
 
     private function getProductReviewLoader(
-        ?ProductReviewCollection $reviews,
-        Request $request,
-        SalesChannelContext $salesChannelContext
+        ProductReviewRoute $productReviewRouteMock
     ): ProductReviewLoader {
-        $productReviewRouteMock = $this->createMock(ProductReviewRoute::class);
-
-        $criteria = $this->createCriteria($request, $salesChannelContext);
-
-        if ($reviews !== null) {
-            $reviewResult = new EntitySearchResult(
-                ProductReviewDefinition::ENTITY_NAME,
-                1,
-                $reviews,
-                new AggregationResultCollection(
-                    [
-                        'ratingMatrix' => new TermsResult('ratingMatrix', []),
-                    ]
-                ),
-                $criteria,
-                Context::createDefaultContext()
-            );
-
-            $productReviewRouteMock
-                ->method('load')
-                ->willReturn(
-                    new ProductReviewRouteResponse($reviewResult)
-                );
-        }
-
         return new ProductReviewLoader(
             $productReviewRouteMock,
             $this->createMock(EventDispatcherInterface::class)
         );
     }
 
+    /**
+     * @return EntitySearchResult<ProductReviewCollection>
+     */
+    private function getDefaultResult(
+        ProductReviewCollection $reviews,
+        Request $request,
+        SalesChannelContext $salesChannelContext
+    ): EntitySearchResult {
+        $criteria = $this->createCriteria($request, $salesChannelContext);
+
+        return new EntitySearchResult(
+            ProductReviewDefinition::ENTITY_NAME,
+            1,
+            $reviews,
+            new AggregationResultCollection(
+                [
+                    'ratingMatrix' => new TermsResult('ratingMatrix', []),
+                ]
+            ),
+            $criteria,
+            Context::createDefaultContext()
+        );
+    }
+
     private function getSalesChannelContext(bool $setCustomer = true): SalesChannelContext
     {
         $salesChannelEntity = new SalesChannelEntity();
@@ -211,7 +311,7 @@ private function createCriteria(Request $request, SalesChannelContext $context):
     {
         $limit = (int) $request->get('limit', 10);
         $page = (int) $request->get('p', 1);
-        $offset = $limit * ($page - 1);
+        $offset = max(0, $limit * ($page - 1));
 
         $criteria = new Criteria();
         $criteria->setLimit($limit);