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

#1711: Use product model instead of data object for catalog image helper init #29435

Conversation

jmonteros422
Copy link
Contributor

@jmonteros422 jmonteros422 commented Aug 7, 2020

Description (*)

This PR applies improvement changes for issue magento/adobe-stock-integration#1711: Use product model instead of data object for catalog image helper init

  • DataObject should be replaced with product model usage in \Magento\MediaGalleryCatalogUi\Ui\Component\Listing\Columns\Thumbnail::prepareDataSource

Related Pull Requests

Fixed Issues (if relevant)

  1. Fixes Incorrect implementation of Thumbnail::prepareDataSource adobe-stock-integration#1711: Use product model instead of data object for catalog image helper init

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)

Sorry, something went wrong.

@m2-assistant
Copy link

m2-assistant bot commented Aug 7, 2020

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

@jmonteros422
Copy link
Contributor Author

@magento run all tests

Copy link
Member

@sivaschenko sivaschenko left a comment

Choose a reason for hiding this comment

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

Thanks for the PR @jmonteros422 ! Please check my comment

@@ -64,7 +72,7 @@ public function prepareDataSource(array $dataSource)
if (isset($item[$fieldName])) {
$item[$fieldName . '_src'] = $this->getUrl($item[$fieldName]);
} else {
$category = new DataObject($item);
$category = $this->productFactory->create($item);
Copy link
Member

Choose a reason for hiding this comment

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

I think it should be:

Suggested change
$category = $this->productFactory->create($item);
$category = $this->productFactory->create(['data' => $item]);

Can you please check

…ta object for catalog image helper init - Apply PR suggestion
@jmonteros422
Copy link
Contributor Author

@magento run all tests

Copy link
Member

@sivaschenko sivaschenko left a comment

Choose a reason for hiding this comment

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

@jmonteros422 Please check out my comment after an additional review :)

@@ -64,7 +72,7 @@ public function prepareDataSource(array $dataSource)
if (isset($item[$fieldName])) {
$item[$fieldName . '_src'] = $this->getUrl($item[$fieldName]);
} else {
$category = new DataObject($item);
Copy link
Member

Choose a reason for hiding this comment

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

Hey, @jmonteros422 , after a closer look the approach appears to be completely invalid: this class is responsible to prepare the image for category, not for the product, so CategoryFactory and Category\ImageFactory should be used. Also we have to find out how to get a placeholder image in case category does not have one assigned.

Here is how the method should look like based on my understanding:

    public function prepareDataSource(array $dataSource)
    {
        if (!isset($dataSource['data']['items'])) {
            return $dataSource;
        }

        $fieldName = $this->getData('name');
        foreach ($dataSource['data']['items'] as & $item) {
            if (isset($item[$fieldName])) {
                $item[$fieldName . '_src'] = $this->getUrl($item[$fieldName]);
                continue;
            }

            if (isset($item['entity_id'])) {
                $src = $this->imageFactory->create()->getUrl(
                    $this->categoryRepository->get($item['entity_id'])
                );
                $item[$fieldName . '_src'] = $src;
                continue;
            }

            $item[$fieldName . '_src'] = $defaultImage;
        }
    }

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok Sergii, will check that one out. Thank you!

…ta object for catalog image helper init - Revised approach based from pr suggestion
@jmonteros422
Copy link
Contributor Author

@magento run all tests

Copy link
Member

@sivaschenko sivaschenko left a comment

Choose a reason for hiding this comment

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

Thanks for updates @jmonteros422 ! The implementation looks good. Can you please add a verification of image presence to the AdminAssertCategoryGridPageDetailsActionGroup

…se-product-model-instead-of-data-object-for-catalog-image-helper-init
…ta object for catalog image helper init - Update MFTF for image placeholder verification, update branch
@jmonteros422
Copy link
Contributor Author

@magento run all tests

@sivaschenko sivaschenko added Priority: P3 May be fixed according to the position in the backlog. Severity: S3 Affects non-critical data or functionality and does not force users to employ a workaround. Auto-Tests: Covered All changes in Pull Request is covered by auto-tests labels Aug 11, 2020
@magento-engcom-team
Copy link
Contributor

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

@engcom-Lima
Copy link
Contributor

engcom-Lima commented Aug 12, 2020

✔️ QA Passed
The following cases was successfully checked:

  1. Delete images via Mass action
  2. Searching in the Adobe Stock and Saving an image Preview
  3. Add images from Media Gallery to Page, Block, Category and Product content
  4. Correct displays details of the images
  5. Editing image (adding description, change title, adding and deleting tags)
  6. Adding and deleting folders
  7. Filters
  8. Licensed images
  9. Go to http://yourdomain.com/admin/media_gallery_catalog/category/index in order to view the media gallery category grid.
  • If category does not have image - placeholder shows
  • If category has image - it shows there.

Screenshot_78
10. Asset filter
Screenshot_77

All cases are covered by manual test scenarios

@engcom-Lima engcom-Lima added the QA: Added to Regression Scope Scenario was analysed and added to Regression Testing Scope label Aug 12, 2020
@magento-engcom-team magento-engcom-team merged commit 4793e47 into magento:2.4-develop Aug 19, 2020
@m2-assistant
Copy link

m2-assistant bot commented Aug 19, 2020

Hi @jmonteros422, 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 added this to the 2.4.2 milestone Aug 20, 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 Component: MediaGalleryCatalogUi Priority: P3 May be fixed according to the position in the backlog. Progress: accept Project: ASI 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
Archived in project
Development

Successfully merging this pull request may close these issues.

Incorrect implementation of Thumbnail::prepareDataSource
5 participants