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

#1833: Add ability to disable renditions functionality to stores configuration #30057

Conversation

joweecaquicla
Copy link

@joweecaquicla joweecaquicla commented Sep 15, 2020

Introduction of Media Gallery Renditions functionality is approved in https://jira.corp.magento.com/browse/MC-37383 (SVC failure is approved)

Description (*)

This PR will introduce the ability to disable renditions functionality to stores configuration and additional conditions to rendition-related classes.

Related Pull Requests

Fixed Issues (if relevant)

  1. Fixes Add ability to disable renditions functionality to stores configuration adobe-stock-integration#1833

Manual testing scenarios (*)

Previously Rendition functionality was enabled/disabled based on Enhanced Media Gallery enable/disable value.
Currently t has a separate switch in stores configuration.

"Enable Image Optimization" select with "Yes/No" options is added as the first field of "Media Gallery Image Optimization" fieldset
"Enable Image Optimization" is enabled by default
If renditions are disabled - renditions should not be generated during insertion of the image and during the width/height change.
When renditions are enabled - all renditions should be regenerated.
Renditions functionality should work for both old and new media gallery.

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)

…ns functionality to stores configuration - added enable disable renditions to stores configuration
@m2-assistant
Copy link

m2-assistant bot commented Sep 15, 2020

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

…ns functionality to stores configuration - added conditions to renditions-related classes
@joweecaquicla
Copy link
Author

@magento run all tests

@joweecaquicla joweecaquicla changed the title [WIP] #1833: Add ability to disable renditions functionality to stores configuration #1833: Add ability to disable renditions functionality to stores configuration Sep 16, 2020
@sivaschenko sivaschenko added Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Severity: S2 Major restrictions or short-term circumventions are required until a fix is available. labels Sep 16, 2020
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 pull request @joweecaquicla ! Please see my comments

As for the test coverage:
Can you please add an ActionGroup enabling the renditions and use this action group for existing New Media Gallery test suites. I believe that should be enough

@@ -19,6 +19,7 @@ class Config
{
private const TABLE_CORE_CONFIG_DATA = 'core_config_data';
private const XML_PATH_ENABLED = 'system/media_gallery/enabled';
Copy link
Member

Choose a reason for hiding this comment

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

This constant is no longer needed and can be removed

*
* @return bool
*/
public function isMediaGalleryRenditionsEnabled(): bool
Copy link
Member

Choose a reason for hiding this comment

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

New method introduction is not necessary, isEnabled method should be now based on system/media_gallery_renditions/enabled value

@@ -91,7 +91,7 @@ public function beforeExecute(
$storeId
];

if (!$this->config->isEnabled()) {
if (!$this->config->isEnabled() || !$this->config->isMediaGalleryRenditionsEnabled()) {
Copy link
Member

Choose a reason for hiding this comment

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

no change is needed here

joweecaquicla added 2 commits September 16, 2020 22:11
…ns functionality to stores configuration - modifications based on request changes
…ns functionality to stores configuration - additional action group and modifications on media gallery test suites
@joweecaquicla
Copy link
Author

@magento run all tests

@sivaschenko
Copy link
Member

@magento run all tests

@sivaschenko sivaschenko added the Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests label Sep 16, 2020
sivaschenko
sivaschenko previously approved these changes Sep 16, 2020
@sivaschenko
Copy link
Member

sivaschenko commented Sep 16, 2020

Introduction of Media Gallery Renditions functionality is approved in https://jira.corp.magento.com/browse/MC-37383 (SVC failure is approved)

Copy link
Contributor

@engcom-Bravo engcom-Bravo left a comment

Choose a reason for hiding this comment

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

✔️ QA Passed

Enable Image Optimization option is added under Stores - Configuration - Advanced - System - Media Gallery Renditions
endis_im_optim

The default value is Yes

When the value is set to Yes, the images added to the content are optimized to the size set in Maximum Width and Maximum Height fields

When the value is set to No, the original image size is inserted into the Content of an Entity

When No and Yes values are changed, and bin/magento queue:consumers:start media.gallery.renditions.update is performed, the images that have already been inserted with original size, are NOT reduced or enlarged.

Manual testing scenario - https://studio.cucumber.io/projects/131313/test-plan/folders/1507933/scenarios/5219418

@sivaschenko
Copy link
Member

@magento run all tests

@joweecaquicla
Copy link
Author

@magento run all tests

@sidolov
Copy link
Contributor

sidolov commented Sep 18, 2020

@sivaschenko SVC failures must be approved.

@sivaschenko
Copy link
Member

Introduction of Media Gallery Renditions functionality is approved in https://jira.corp.magento.com/browse/MC-37383 (SVC failure is approved)

magento-engcom-team pushed a commit that referenced this pull request Sep 23, 2020
@magento-engcom-team magento-engcom-team merged commit 95ba128 into magento:2.4-develop Sep 23, 2020
@m2-assistant
Copy link

m2-assistant bot commented Sep 23, 2020

Hi @joweecaquicla, 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: MediaGalleryRenditions Component: MediaGalleryUi Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Progress: accept Project: ASI 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.

Add ability to disable renditions functionality to stores configuration
5 participants