Skip to content

Simplified media gallery AssetDetailsProvider implementation #29449

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

Merged
merged 6 commits into from
Aug 14, 2020
Merged

Simplified media gallery AssetDetailsProvider implementation #29449

merged 6 commits into from
Aug 14, 2020

Conversation

sivaschenko
Copy link
Member

Description (*)

Simplified media gallery AssetDetailsProvider implementation

Fixed Issues (if relevant)

  1. Fixes Remove AssetDetailsProviderPool adobe-stock-integration#1726

Manual testing scenarios (*)

  1. Add images from Media Gallery to Page, Block, Category and Product content
  2. Go to Media Gallery (check on both embedded (opened from wysiwyg) and standalone (Content -> Media Gallery menu) Media Gallery)
  3. View details of the images - the "Used In" information in View Details panel should be displayed correctly
  4. Delete the images - entities, where the image is used in, should be mentioned in the deletion warning popup

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 Aug 9, 2020

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

@sivaschenko sivaschenko added Auto-Tests: Covered All changes in Pull Request is covered by auto-tests Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Project: ASI Severity: S2 Major restrictions or short-term circumventions are required until a fix is available. and removed Release Line: 2.4 labels Aug 9, 2020
@sivaschenko
Copy link
Member Author

@magento run all tests

Copy link
Contributor

@lbajsarowicz lbajsarowicz left a comment

Choose a reason for hiding this comment

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

Please review the comments.

*/
private function formatSize(int $imageSize): string
{
return $imageSize === 0 ? '' : sprintf('%sKb', $imageSize / 1000);
Copy link
Contributor

Choose a reason for hiding this comment

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

Kb is not a valid unit. Also - 1kB is 1024B
https://en.wikipedia.org/wiki/Kilobyte

Suggested change
return $imageSize === 0 ? '' : sprintf('%sKb', $imageSize / 1000);
return $imageSize === 0 ? '' : sprintf('%sKB', $imageSize / 1024);

Copy link
Contributor

@lbajsarowicz lbajsarowicz Aug 9, 2020

Choose a reason for hiding this comment

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

Are you aware that when image size is 333B, then it'll display:
image

But also sprintf can format number of digits?
Eg. "%.2f"

image

Copy link
Contributor

Choose a reason for hiding this comment

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

What is more - \Zend\Validator\File\Size::toByteString offers exactly what you have done there.

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks, went with $size === 0 ? '' : sprintf('%.2f KB', $size / 1024);

@sivaschenko
Copy link
Member Author

@magento run all tests

@sivaschenko
Copy link
Member Author

Thanks for the review @lbajsarowicz please check my updates/responses

lbajsarowicz
lbajsarowicz previously approved these changes Aug 10, 2020
Copy link
Contributor

@lbajsarowicz lbajsarowicz left a comment

Choose a reason for hiding this comment

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

✔️ Looks fine for me.
We still need to wait for automated tests to finish.

@magento-engcom-team
Copy link
Contributor

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

@engcom-Lima engcom-Lima self-assigned this Aug 10, 2020
Copy link
Contributor

@engcom-Lima engcom-Lima left a comment

Choose a reason for hiding this comment

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

❌ QA Failed
Steps to Reproduce:

  1. Add image from Media Gallery to Page, Block, Category and Product content
  2. Go to Content -> Media Gallery
  3. View details of the image
  4. Click on the "Products" link in the "Used In" attribute

Expected Result: Products greed is opened
Actual Result: Page reloads (because of wrong url)
Peek 2020-08-10 15-14
Note: With Blocks, Pages and Categories behavior the same. Enable the "Add secret key to URLs" option does not affect this

@ghost ghost dismissed lbajsarowicz’s stale review August 10, 2020 12:27

Pull Request state was updated. Re-review required.

@sivaschenko
Copy link
Member Author

Thanks for testing, @engcom-Lima , the link URLs have been fixed

@magento-engcom-team
Copy link
Contributor

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

@sivaschenko
Copy link
Member Author

@magento run all tests

@engcom-Lima
Copy link
Contributor

✔️ QA Passed
The "Used In" information in View Details panel is displayed correctly
Screenshot_70
Correct URLs
Peek 2020-08-10 20-08
Delete the image
Screenshot_69
Screenshot_71
All cases covered by manual testing scenario

@engcom-Lima engcom-Lima added the QA: Added to Regression Scope Scenario was analysed and added to Regression Testing Scope label Aug 10, 2020
@sivaschenko
Copy link
Member Author

@magento run all tests

@slavvka
Copy link
Member

slavvka commented Aug 13, 2020

@magento run all tests

@magento-engcom-team magento-engcom-team merged commit c71f911 into magento:2.4-develop Aug 14, 2020
@m2-assistant
Copy link

m2-assistant bot commented Aug 14, 2020

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

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 Component: MediaGalleryCmsUi Component: MediaGalleryUi Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Progress: accept Project: ASI QA: Added to Regression Scope Scenario was analysed and added to Regression Testing Scope Release Line: 2.4 Severity: S2 Major restrictions or short-term circumventions are required until a fix is available.
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Remove AssetDetailsProviderPool
6 participants