Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix issue #30270 Product Reviews can not be sorted by Admin on the Product edit page #30477

Merged
merged 11 commits into from
Dec 10, 2020

Conversation

Chandresh22
Copy link
Contributor

@Chandresh22 Chandresh22 commented Oct 13, 2020

Description (*)

Product Reviews can not be sorted by Admin on the Product edit page so that resolve this issue.
after changes code Records of "Product Reviews" grid are sorted.

Related Pull Requests

Fixed Issues (if relevant)

  1. Create a few reviews for the product

  2. Create an object of ReviewDataProvider with request param with some sorting order and current_product_id

  3. Assert that sorting order will be applied for review items by calling
    Review/Ui/DataProvider/Product/ReviewDataProvider::getData()

    Fixes “Product Reviews” can not be sorted by Admin on the Product page #30270 Product Reviews can not be sorted by Admin on the Product Edit page

Manual testing scenarios (*)

  1. "Steps to reproduce" from the “Product Reviews” can not be sorted by Admin on the Product page #30270 Product Reviews can not be sorted by Admin on the Product Edit page

Questions or comments

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 are green)

@m2-assistant
Copy link

m2-assistant bot commented Oct 13, 2020

Hi @Chandresh22. 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.

⚠️ According to the Magento Contribution requirements, all Pull Requests must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.

🕙 You can find the schedule on the Magento Community Calendar page.

📞 The triage of Pull Requests happens in the queue order. If you want to speed up the delivery of your contribution, please join the Community Contributions Triage session to discuss the appropriate ticket.

🎥 You can find the recording of the previous Community Contributions Triage on the Magento Youtube Channel

✏️ Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel

@eduard13
Copy link
Contributor

@magento run all tests

Copy link
Contributor

@eduard13 eduard13 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Chandresh22, thank you for your contribution. However, due to Magento Definition of Done the changes should be covered by tests. Could you please cover your fix by a MFTF test, that will pass through all the steps and then assert that the grid sorting works?

Thank you.

@ghost ghost moved this from Pending Review to Changes Requested in Pull Requests Dashboard Oct 13, 2020
@eduard13 eduard13 added Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Severity: S3 Affects non-critical data or functionality and does not force users to employ a workaround. Auto-Tests: Not Covered Changes in Pull Request requires coverage by auto-tests labels Oct 13, 2020
@Chandresh22
Copy link
Contributor Author

@eduard13 can you help me what is mean Auto Test not covered? and how to resolve this thanks.

@Chandresh22 Chandresh22 changed the title Update ReviewDataProvider.php Fix issue #30270 Product Reviews can not be sorted by Admin on the Product edit page Oct 13, 2020
@eduard13
Copy link
Contributor

@Chandresh22 as mentioned in my previous comment, in order to deliver this fix, it should be covered by automated tests. I suggest adding a simple MFTF test, that will make sure that the grid sorting works as expected.
Also could you additionally check and fix the failing Static Tests, they aren’t related to your changes, however would be great to have all the checks green ✅

@Chandresh22
Copy link
Contributor Author

@magento run Static Tests

@Chandresh22
Copy link
Contributor Author

@magento run all tests

1 similar comment
@Chandresh22
Copy link
Contributor Author

@magento run all tests

Copy link
Contributor

@eduard13 eduard13 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please check my comments below. Additionally, as far there is already a Unit Test that covers this class, please update accordingly your test cases.

Thanks.

Comment on lines 69 to 71
$params = $this->request->getParams();
if (isset($params['sorting'])) {
$sorting = $this->request->getParam('sorting');
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please check a more simplified version that should also work.

Suggested change
$params = $this->request->getParams();
if (isset($params['sorting'])) {
$sorting = $this->request->getParam('sorting');
if ($sorting = $this->request->getParam('sorting', null)) {

@@ -79,7 +87,8 @@ public function getData()
}

/**
* {@inheritdoc}
* @inheritdoc
* @return mixed
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As far as I can see it doesn't return anything. Am I missing something? This change should fix the Static Tests and Semantic Version Checker.

Suggested change
* @return mixed
* @return void

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@eduard13 thanks for suggestion

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@eduard13 check the screenshot it shows error http://prntscr.com/uz4ukj
but i don't change in it. this function has as it is.

@Chandresh22
Copy link
Contributor Author

@magento run all tests

@eduard13
Copy link
Contributor

@magento run Static Tests, Semantic Version Checker

@eduard13
Copy link
Contributor

eduard13 commented Oct 14, 2020

@Chandresh22 please fix the rest of static fails, and adjust the Unit Test that is currently failing.
Then could you please squash your commits into one and force push it? Looks like something went wrong with the build, it doesn't see the latest updates.

Unfortunately you're not using a branch for these changes, so I cannot help you updating the code 😞 .

@Chandresh22
Copy link
Contributor Author

okay @eduard13 i will check

@Chandresh22
Copy link
Contributor Author

@magento run all tests

@eduard13
Copy link
Contributor

@magento run Static Tests, Unit Tests, Semantic Version Checker.

@Chandresh22 any reasons of why have you reverted the changes I suggested? Also have you had any problems with squashing the commits into one commit, in order to have a clean history?
Moreover, there is a failing Unit Test that you have to adjust including your changes.

Let me know if you have any questions on my feedback.
Thanks.

@Chandresh22
Copy link
Contributor Author

@magento run Static Tests, Unit Tests

@magento-engcom-team
Copy link
Contributor

Hi @eduard13, thank you for the review.
ENGCOM-8501 has been created to process this Pull Request

@engcom-Alfa
Copy link
Contributor

✔️ QA Passed

Manual testing scenario:

  1. Go to the Storefront as a guest
  2. Go to the created Product page
  3. Add at least 2 reviews
  4. Go to Magento Admin > Marketing > Pending Reviews
  5. Approve the added reviews
  6. Go to Magento Admin > Ctalog > Products
  7. Select the created Product
  8. Click on the “Edit” link
  9. Open the “Product Reviews” section
  10. Sort “Product Reviews” for example, by ID, click the “ID” cell

Before: ✖️ Records of “Product Reviews” grid are not sorted

Peek 2020-12-01 15-50

After: ✔️ All records of “Product Reviews” were sorted by selected parameter

Peek 2020-12-01 16-11

✔️ Also was checked Filters functionality and everything works as expected.
Peek 2020-12-01 16-31

@engcom-Alfa engcom-Alfa added the QA: Added to Regression Scope Scenario was analysed and added to Regression Testing Scope label Dec 3, 2020
@m2-community-project m2-community-project bot moved this from Testing in Progress to Ready for Testing in High Priority Pull Requests Dashboard Dec 3, 2020
@engcom-Alfa engcom-Alfa moved this from Ready for Testing to Testing in Progress in High Priority Pull Requests Dashboard Dec 3, 2020
@engcom-Alfa engcom-Alfa moved this from Testing in Progress to Extended Testing (optional) in High Priority Pull Requests Dashboard Dec 3, 2020
@engcom-Alfa engcom-Alfa moved this from Extended Testing (optional) to Merge in Progress in High Priority Pull Requests Dashboard Dec 3, 2020
magento-engcom-team pushed a commit that referenced this pull request Dec 10, 2020
@magento-engcom-team magento-engcom-team merged commit 0b893ee into magento:2.4-develop Dec 10, 2020
@m2-assistant
Copy link

m2-assistant bot commented Dec 10, 2020

Hi @Chandresh22, 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.

@sidolov sidolov moved this from Merge in Progress to Recently Merged in High Priority Pull Requests Dashboard Dec 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Auto-Tests: Covered All changes in Pull Request is covered by auto-tests Award: bug fix Component: Review Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Progress: accept QA: Added to Regression Scope Scenario was analysed and added to Regression Testing Scope Release Line: 2.4 Severity: S3 Affects non-critical data or functionality and does not force users to employ a workaround.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

“Product Reviews” can not be sorted by Admin on the Product page
6 participants