Adding Product Reviews GraphQl support

app/code/Magento/Review/Model/Review/AddRatingVotesToCustomerReviews.php

@@ -0,0 +1,55 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Review\Model\Review;
+
+use Magento\Review\Model\ResourceModel\Rating\Option\Vote\Collection as OptionVoteCollection;
+use Magento\Review\Model\ResourceModel\Rating\Option\Vote\CollectionFactory as OptionVoteCollectionFactory;
+use Magento\Review\Model\ResourceModel\Review\Product\Collection;
+
+/**
+ * The model that adds the rating votes to reviews
+ */
+class AddRatingVotesToCustomerReviews
+{
+    /**
+     * @var RatingOptionCollectionFactory
+     */
+    private $ratingOptionCollectionFactory;
+
+    /**
+     * @param OptionVoteCollectionFactory $ratingOptionCollectionFactory
+     */
+    public function __construct(OptionVoteCollectionFactory $ratingOptionCollectionFactory)
+    {
+        $this->ratingOptionCollectionFactory = $ratingOptionCollectionFactory;
+    }
+
+    /**
+     * Add rating votes to customer reviews
+     *
+     * @param Collection $collection
+     */
+    public function execute(Collection $collection): void
+    {
+        $connection = $collection->getConnection();
+
+        foreach ($collection->getItems() as &$item) {
+            /** @var OptionVoteCollection $votesCollection */
+            $votesCollection = $this->ratingOptionCollectionFactory->create();
+
+            $votesCollection->addFieldToFilter('main_table.review_id', $item->getData('review_id'));
+            $votesCollection->getSelect()
+                ->join(
+                    ['rating' => $connection->getTableName('rating')],
+                    'rating.rating_id = main_table.rating_id',
+                    ['rating_code']
+                );
+            $item->setRatingVotes($votesCollection);
+        }
+    }
+}

app/code/Magento/Review/Service/GetReviewAverageRatingService.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Review\Service;
+
+/**
+ * Get review average rating
+ */
+class GetReviewAverageRatingService
+{
+    /**
+     * Get average rating per review
+     *
+     * @param array $ratingVotes
+     *
+     * @return float
+     */
+    public function execute(array $ratingVotes): float
+    {
+        $averageRating = 0;
+
+        foreach ($ratingVotes as $ratingVote) {
+            $averageRating += (int) $ratingVote->getData('value');
+        }
+
+        return $averageRating > 0 ? (float) number_format($averageRating / count($ratingVotes), 2) : 0;
+    }
+}

app/code/Magento/ReviewGraphQl/Mapper/ReviewDataMapper.php

@@ -0,0 +1,36 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\ReviewGraphQl\Mapper;
+
+use Magento\Catalog\Model\Product;
+use Magento\Review\Model\Review;
+
+/**
+ * Converts the review data from review object to an associative array
+ */
+class ReviewDataMapper
+{
+    /**
+     * Mapping the review data
+     *
+     * @param Review|Product $review
+     *
+     * @return array
+     */
+    public function map($review): array
+    {
+        return [
+            'summary' => $review->getData('title'),
+            'text' => $review->getData('detail'),
+            'nickname' => $review->getData('nickname'),
+            'created_at' => $review->getData('created_at'),
+            'rating_votes' => $review->getData('rating_votes'),
+            'sku' => $review->getSku()
+        ];
+    }
+}

app/code/Magento/ReviewGraphQl/Model/DataProvider/AggregatedReviewsDataProvider.php

@@ -0,0 +1,75 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\ReviewGraphQl\Model\DataProvider;
+
+use Magento\Framework\GraphQl\Exception\GraphQlInputException;
+use Magento\Review\Model\ResourceModel\Review\Collection as ReviewCollection;
+use Magento\Review\Model\ResourceModel\Review\Product\Collection as ProductCollection;
+use Magento\ReviewGraphQl\Mapper\ReviewDataMapper;
+
+/**
+ * Provides aggregated reviews result
+ *
+ * The following class prepares the GraphQl endpoints' result for Customer and Product reviews
+ */
+class AggregatedReviewsDataProvider
+{
+    /**
+     * @var ReviewDataMapper
+     */
+    private $reviewDataMapper;
+
+    /**
+     * @param ReviewDataMapper $reviewDataMapper
+     */
+    public function __construct(ReviewDataMapper $reviewDataMapper)
+    {
+        $this->reviewDataMapper = $reviewDataMapper;
+    }
+
+    /**
+     * Get reviews result
+     *
+     * @param ProductCollection|ReviewCollection $reviewsCollection
+     *
+     * @return array
+     */
+    public function getData($reviewsCollection): array
+    {
+        if ($reviewsCollection->getPageSize()) {
+            $maxPages = ceil($reviewsCollection->getSize() / $reviewsCollection->getPageSize());
+        } else {
+            $maxPages = 0;
+        }
+
+        $currentPage = $reviewsCollection->getCurPage();
+        if ($reviewsCollection->getCurPage() > $maxPages && $reviewsCollection->getSize() > 0) {
+            $currentPage = new GraphQlInputException(
+                __(
+                    'currentPage value %1 specified is greater than the number of pages available.',
+                    [$maxPages]
+                )
+            );
+        }
+
+        $items = [];
+        foreach ($reviewsCollection->getItems() as $item) {
+            $items[] = $this->reviewDataMapper->map($item);
+        }
+
+        return [
+            'total_count' => $reviewsCollection->getSize(),
+            'items' => $items,
+            'page_info' => [
+                'page_size' => $reviewsCollection->getPageSize(),
+                'current_page' => $currentPage,
+                'total_pages' => $maxPages
+            ]
+        ];
+    }
+}

app/code/Magento/ReviewGraphQl/Model/DataProvider/CustomerReviewsDataProvider.php

@@ -0,0 +1,62 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\ReviewGraphQl\Model\DataProvider;
+
+use Magento\Review\Model\ResourceModel\Review\Product\Collection as ProductReviewsCollection;
+use Magento\Review\Model\ResourceModel\Review\Product\CollectionFactory;
+use Magento\Review\Model\Review\AddRatingVotesToCustomerReviews;
+
+/**
+ * Provides customer reviews
+ */
+class CustomerReviewsDataProvider
+{
+    /**
+     * @var CollectionFactory
+     */
+    private $collectionFactory;
+
+    /**
+     * @var AddRatingVotesToCustomerReviews
+     */
+    private $addRatingVotesToCustomerReviews;
+
+    /**
+     * @param CollectionFactory $collectionFactory
+     * @param AddRatingVotesToCustomerReviews $addRatingVotesToCustomerReviews
+     */
+    public function __construct(
+        CollectionFactory $collectionFactory,
+        AddRatingVotesToCustomerReviews $addRatingVotesToCustomerReviews
+    ) {
+        $this->collectionFactory = $collectionFactory;
+        $this->addRatingVotesToCustomerReviews = $addRatingVotesToCustomerReviews;
+    }
+
+    /**
+     * Get customer reviews
+     *
+     * @param int $customerId
+     * @param int $currentPage
+     * @param int $pageSize
+     *
+     * @return ProductReviewsCollection
+     */
+    public function getData(int $customerId, int $currentPage, int $pageSize): ProductReviewsCollection
+    {
+        /** @var ProductReviewsCollection $reviewsCollection */
+        $reviewsCollection = $this->collectionFactory->create();
+        $reviewsCollection->addCustomerFilter($customerId)
+            ->setPageSize($pageSize)
+            ->setCurPage($currentPage)
+            ->setDateOrder();
+        $this->addRatingVotesToCustomerReviews->execute($reviewsCollection);
+
+        return $reviewsCollection;
+    }
+}

app/code/Magento/ReviewGraphQl/Model/DataProvider/ProductReviewsDataProvider.php

@@ -0,0 +1,60 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\ReviewGraphQl\Model\DataProvider;
+
+use Magento\Review\Model\ResourceModel\Review\Collection;
+use Magento\Review\Model\ResourceModel\Review\CollectionFactory;
+use Magento\Review\Model\Review;
+
+/**
+ * Provides product reviews
+ */
+class ProductReviewsDataProvider
+{
+    /**
+     * @var CollectionFactory
+     */
+    private $collectionFactory;
+
+    /**
+     * @param CollectionFactory $collectionFactory
+     */
+    public function __construct(
+        CollectionFactory $collectionFactory
+    ) {
+        $this->collectionFactory = $collectionFactory;
+    }
+
+    /**
+     * Get product reviews
+     *
+     * @param int $productId
+     * @param int $currentPage
+     * @param int $pageSize
+     *
+     * @return Collection
+     */
+    public function getData(int $productId, int $currentPage, int $pageSize): Collection
+    {
+        /** @var Collection $reviewsCollection */
+        $reviewsCollection = $this->collectionFactory->create()
+            ->addStatusFilter(Review::STATUS_APPROVED)
+            ->addEntityFilter(Review::ENTITY_PRODUCT_CODE, $productId)
+            ->setPageSize($pageSize)
+            ->setCurPage($currentPage)
+            ->setDateOrder();
+        $reviewsCollection->getSelect()->join(
+            ['cpe' => $reviewsCollection->getTable('catalog_product_entity')],
+            'cpe.entity_id = main_table.entity_pk_value',
+            ['sku']
+        );
+        $reviewsCollection->addRateVotes();
+
+        return $reviewsCollection;
+    }
+}

app/code/Magento/ReviewGraphQl/Model/DataProvider/ReviewRatingsDataProvider.php

@@ -0,0 +1,35 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\ReviewGraphQl\Model\DataProvider;
+
+/**
+ * Provides rating votes
+ */
+class ReviewRatingsDataProvider
+{
+    /**
+     * Providing rating votes
+     *
+     * @param array $ratingVotes
+     *
+     * @return array
+     */
+    public function getData(array $ratingVotes): array
+    {
+        $data = [];
+
+        foreach ($ratingVotes as $ratingVote) {
+            $data[] = [
+                'name' => $ratingVote->getData('rating_code'),
+                'value' => $ratingVote->getData('value')
+            ];
+        }
+
+        return $data;
+    }
+}