API: Product Reviews #55

[sky-hub]

Description (*)

Service contracts for product reviews.

As discussed with @paliarush, defined services are implemented similar to MSI implementation and allow bulk operations.
The difference in this implementation is that the service is returning a Response object containing success, failed, retryable object and errors associated to failed or retryable objects. Currently retyrable objects are not returned as I could not identify a specific error for this case (a database deadlock may be a case but furher research is needed)

1. Added validation chain for review validate
2. Added review aggregation service: app/code/Magento/Review/Model/Aggregator.php
3. Updated method names to make them more specific and forwarded magic methods to new methods
   Ex: magic method $review->getStatusId() was forwarded to $review->getStatus()
4. Some methods are not defined using strict types in order to keep backwards compatibility
5. Added updated_at column for Review model
6. Updated review tests
7. Added support for extension attributes for reviews and related entities
8. Added the possibility to save review ratings based on rating name and rating value. This was implemented to allow review ratings to be added without knowing the internal ids and also to align code base with the GraphQl implementation.

Notes:

1. ReviewGraphQl module needs update after this PR is merged
2. CreateReviews service can not be used to insert multiple reviews at the same time because review ratings need the reviewId when saving.
3. Some methods can not enforce strict types as they need to remain backwards compatible

Fixed Issues (if relevant)

1. API: Product Reviews community-features#55 - API: Product Reviews
2. Product Review API #9570 - Product Review API

Manual testing scenarios (*)

1. CREATE Reviews: make a post request to https://store.domain/rest/V1/create-reviews with the following data:

 {"reviews":[{"review_id":1,"related_entity_id":1,"review_entity_id":1,"customer_nickname":"Nickname","title":"Review Summary","review_text":"Review text","ratings":[{"rating_name":"Quality","rating_value":2},{"rating_name":"Price","rating_value":3}],"store_id":1,"stores":[1],"created_at":"0000-00-00 00:00:00","updated_at":"0000-00-00 00:00:00"},{"review_id":2,"related_entity_id":1,"review_entity_id":1,"customer_nickname":"Nickname","title":"2 filter first review","review_text":"Review text","ratings":[{"rating_name":"Price","rating_value":3}],"store_id":1,"stores":[1],"created_at":"0000-00-00 00:00:00","updated_at":"0000-00-00 00:00:00"}]}

2. CREATE Reviews: make a post request to https://store.domain/rest/V1/create-reviews with the following data:

{"reviews":[{"review_id":1,"related_entity_id":1,"review_entity_id":1,"customer_nickname":"Updated Nickname","title":"Updated Review Summary","review_text":"Updated Review Text","ratings":[{"rating_name":"Quality","rating_value":2},{"rating_name":"Price","rating_value":3}],"store_id":1,"stores":[1],"created_at":"0000-00-00 00:00:00","updated_at":"0000-00-00 00:00:00"},{"review_id":2,"related_entity_id":1,"review_entity_id":1,"customer_nickname":"Updated Customer Nickname","title":"Updated Review Title","review_text":"Updated Review Comment","ratings":[{"rating_name":"Price","rating_value":3}],"store_id":1,"stores":[1],"created_at":"0000-00-00 00:00:00","updated_at":"0000-00-00 00:00:00"}]}

3. GET Reviews: make a POST request to https://store.domain/rest/V1/get-reviews?searchCriteria[filterGroups][0][filters][0][field]=sku&searchCriteria[filterGroups][0][filters][0][value]='SOME-SKU'

4. DELETE Reviews: make a POST request to https://store.domain/rest/V1/delete-reviews with the following data:

{"reviews":[{"review_id":1,"related_entity_id":1,"customer_nickname":"Nickname","title":"Review Summary","review_text":"Review text","created_at":"0000-00-00 00:00:00","updated_at":"0000-00-00 00:00:00"},{"review_id":2,"related_entity_id":1,"customer_nickname":"Nickname","title":"2 filter first review","review_text":"Review text","created_at":"0000-00-00 00:00:00","updated_at":"0000-00-00 00:00:00"}]}

5. Related Links:

• Review GraphQL implementation: GraphQl-51: [Query] My Account > My Product Reviews / GraphQl-201: Product Ratings and Reviews graphql-ce#227

Contribution checklist (*)

• Pull request has a meaningful description of its purpose
• All commits are accompanied by meaningful commit messages
• All new or changed code is covered with unit/integration tests (if applicable)
• All automated tests passed successfully (all builds on Travis CI are green)

[magento-cicd2]

All committers have signed the CLA.

[magento-engcom-team]

Hi @sky-hub. Thank you for your contribution
Here is some useful tips how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:

• @magento-engcom-team give me test instance - deploy test instance based on PR changes
• @magento-engcom-team give me 2.3-develop instance - deploy vanilla Magento instance

For more details, please, review the Magento Contributor Assistant documentation

[okorshenko]

Hi @sky-hub
Could you please sign Contributor License Agreement so that we can proceed with PR review
https://cla.dev.magento.com/magento/magento2?pullRequest=19266

[sky-hub]

Hi @sky-hub
Could you please sign Contributor License Agreement so that we can proceed with PR review
https://cla.dev.magento.com/magento/magento2?pullRequest=19266

Hello @okobchenko, sorry, fortgot about it. I would like to point that this PR is just a preview at what needs to be done on the long run. There is also the option to define APIs and implement them but I wouldn't take that approach since the current implementation is far from what it should be and most probably it would complicate things on long term if we keep postpone refactoring it.

I have added some TODOs where I considered that code needs to be updated.

[sivaschenko]

Hi @sky-hub are you still working on this pull request? Please let us know when it's ready for review.

[nuzil]

Hi @sivaschenko , @sky-hub needed some support to define main direction of current implementation. We had several talks with @paliarush and I guess now @sky-hub could proceed with this PR 👍

[sky-hub]

Due to holidays, etc, this PR is going to be put on hold until 15th of January 2019. I will continue working after that date.

[sivaschenko]

Hi @sky-hub thanks for the contribution! I've done a partial brief review at this point, however, as I can see there is still work to be done on this pull request. Please see my code review comments

[sidolov]

Hi @sky-hub , are you still working on the pull request?

[sky-hub]

Hi @sky-hub , are you still working on the pull request?

Yes. Starting from today I will continue working on this pull request.

[PiotrSiejczuk]

Hi @sky-hub are you still planning to continue the great work you are doing on this topic? I am currently facing a requirement @ one project to have such Reviews API in place. Would be good to know if you are planning to finish this PR :) Thank you in advance for your replay!

[lenaorobei]

Unfortunately, due to changes in requirements this feature was implemented in the scope #27882 based on architectural design from magento/architecture#298.

[m2-assistant]

Hi @sky-hub, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

[m2-assistant]

Hi @sky-hub. Thank you for your contribution
Here is some useful tips how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:

• @magento give me test instance - deploy test instance based on PR changes
• @magento give me 2.4-develop instance - deploy vanilla Magento instance

❗ Automated tests can be triggered manually with an appropriate comment:

• @magento run all tests - run or re-run all required tests against the PR changes
• @magento run <test-build(s)> - run or re-run specific test build(s)
  For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names. Allowed build names are:

1. Database Compare
2. Functional Tests CE
3. Functional Tests EE,
4. Functional Tests B2B
5. Integration Tests
6. Magento Health Index
7. Sample Data Tests CE
8. Sample Data Tests EE
9. Sample Data Tests B2B
10. Static Tests
11. Unit Tests
12. WebAPI Tests

You can find more information about the builds here

ℹ️ Please run only needed test builds instead of all when developing. Please run all test builds before sending your PR for review.

For more details, please, review the Magento Contributor Guide documentation.

[m2-assistant]

Hi @sky-hub, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.