Adding Product Reviews GraphQl support

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

@@ -0,0 +1,37 @@
+<?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 $review
+     *
+     * @return array
+     */
+    public function map(Review $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(),
+            'model' => $review
+        ];
+    }
+}

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,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 as ReviewsCollection;
+use Magento\Review\Model\ResourceModel\Review\CollectionFactory as ReviewsCollectionFactory;
+use Magento\Review\Model\Review;
+
+/**
+ * Provides customer reviews
+ */
+class CustomerReviewsDataProvider
+{
+    /**
+     * @var ReviewsCollectionFactory
+     */
+    private $collectionFactory;
+
+    /**
+     * @param ReviewsCollectionFactory $collectionFactory
+     */
+    public function __construct(
+        ReviewsCollectionFactory $collectionFactory
+    ) {
+        $this->collectionFactory = $collectionFactory;
+    }
+
+    /**
+     * Get customer reviews
+     *
+     * @param int $customerId
+     * @param int $currentPage
+     * @param int $pageSize
+     *
+     * @return ReviewsCollection
+     */
+    public function getData(int $customerId, int $currentPage, int $pageSize): ReviewsCollection
+    {
+        /** @var ReviewsCollection $reviewsCollection */
+        $reviewsCollection = $this->collectionFactory->create();
+        $reviewsCollection->addStatusFilter(Review::STATUS_APPROVED)
+            ->addCustomerFilter($customerId)
+            ->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/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,56 @@
+<?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\Rating\Option\Vote\Collection as VoteCollection;
+use Magento\Review\Model\ResourceModel\Rating\Option\Vote\CollectionFactory as VoteCollectionFactory;
+
+/**
+ * Provides rating votes
+ */
+class ReviewRatingsDataProvider
+{
+    /**
+     * @var VoteCollectionFactory
+     */
+    private $voteCollectionFactory;
+
+    /**
+     * @param VoteCollectionFactory $voteCollectionFactory
+     */
+    public function __construct(VoteCollectionFactory $voteCollectionFactory)
+    {
+        $this->voteCollectionFactory = $voteCollectionFactory;
+    }
+
+    /**
+     * Providing rating votes
+     *
+     * @param int $reviewId
+     *
+     * @return array
+     */
+    public function getData(int $reviewId): array
+    {
+        /** @var VoteCollection $ratingVotes */
+        $ratingVotes = $this->voteCollectionFactory->create();
+        $ratingVotes->setReviewFilter($reviewId);
+        $ratingVotes->addRatingInfo();
+
+        $data = [];
+
+        foreach ($ratingVotes->getItems() as $ratingVote) {
+            $data[] = [
+                'name' => $ratingVote->getData('rating_code'),
+                'value' => $ratingVote->getData('value')
+            ];
+        }
+
+        return $data;
+    }
+}

app/code/Magento/ReviewGraphQl/Model/Resolver/CreateProductReview.php

@@ -0,0 +1,105 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\ReviewGraphQl\Model\Resolver;
+
+use Magento\Framework\GraphQl\Config\Element\Field;
+use Magento\Framework\GraphQl\Exception\GraphQlAuthorizationException;
+use Magento\Framework\GraphQl\Exception\GraphQlNoSuchEntityException;
+use Magento\Framework\GraphQl\Query\Resolver\ContextInterface;
+use Magento\Framework\GraphQl\Query\Resolver\Value;
+use Magento\Framework\GraphQl\Query\ResolverInterface;
+use Magento\Framework\GraphQl\Schema\Type\ResolveInfo;
+use Magento\Review\Helper\Data as ReviewHelper;
+use Magento\ReviewGraphQl\Mapper\ReviewDataMapper;
+use Magento\ReviewGraphQl\Model\Review\AddReviewToProduct;
+use Magento\Store\Api\Data\StoreInterface;
+
+/**
+ * Create product review resolver
+ */
+class CreateProductReview implements ResolverInterface
+{
+    /**
+     * @var ReviewHelper
+     */
+    private $reviewHelper;
+
+    /**
+     * @var AddReviewToProduct
+     */
+    private $addReviewToProduct;
+
+    /**
+     * @var ReviewDataMapper
+     */
+    private $reviewDataMapper;
+
+    /**
+     * @param AddReviewToProduct $addReviewToProduct
+     * @param ReviewDataMapper $reviewDataMapper
+     * @param ReviewHelper $reviewHelper
+     */
+    public function __construct(
+        AddReviewToProduct $addReviewToProduct,
+        ReviewDataMapper $reviewDataMapper,
+        ReviewHelper $reviewHelper
+    ) {
+
+        $this->addReviewToProduct = $addReviewToProduct;
+        $this->reviewDataMapper = $reviewDataMapper;
+        $this->reviewHelper = $reviewHelper;
+    }
+
+    /**
+     * Resolve product review ratings
+     *
+     * @param Field $field
+     * @param ContextInterface $context
+     * @param ResolveInfo $info
+     * @param array|null $value
+     * @param array|null $args
+     *
+     * @return array[]|Value|mixed
+     *
+     * @throws GraphQlAuthorizationException
+     * @throws GraphQlNoSuchEntityException
+     *
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
+    public function resolve(
+        Field $field,
+        $context,
+        ResolveInfo $info,
+        array $value = null,
+        array $args = null
+    ) {
+        $input = $args['input'];
+        $customerId = null;
+
+        if (false !== $context->getExtensionAttributes()->getIsCustomer()) {
+            $customerId = (int) $context->getUserId();
+        }
+
+        if (!$customerId && !$this->reviewHelper->getIsGuestAllowToWrite()) {
+            throw new GraphQlAuthorizationException(__('Guest customers aren\'t allowed to add product reviews.'));
+        }
+
+        $sku = $input['sku'];
+        $ratings = $input['ratings'];
+        $data = [
+            'nickname' => $input['nickname'],
+            'title' => $input['summary'],
+            'detail' => $input['text'],
+        ];
+        /** @var StoreInterface $store */
+        $store = $context->getExtensionAttributes()->getStore();
+        $review = $this->addReviewToProduct->execute($data, $ratings, $sku, $customerId, (int) $store->getId());
+
+        return ['review' => $this->reviewDataMapper->map($review)];
+    }
+}