Prevent resizing an image if it was already resized before

[hostep]

Description (*)

Images shouldn't get resized again if they were already resized before when running bin/magento catalog:images:resize.
In Magento 2.1 they didn't get resized when they were already resized before. Somewhere between Magento 2.1.18 and 2.2.11 that got changed for some reason.

I also added some cleanup to that class in a second commit, because some use statements were missing meaningful aliases and some member variables weren't being used.

Related Pull Requests

Fixed Issues (if relevant)

1. Running 'bin/magento catalog:images:resize' doesn't check if an image was already resized before, therefore it is superslow as it always resizes all images #26796: Running 'bin/magento catalog:images:resize' doesn't check if an image was already resized before, therefore it is superslow as it always resizes all images

Manual testing scenarios (*)

1. Have a product with an image
2. Remove the directory pub/media/catalog/product/cache/
3. Run bin/magento catalog:images:resize
4. Look at the generated images in pub/media/catalog/product/cache/ and check their modified timestamps
5. Wait a bit
6. Run bin/magento catalog:images:resize again
7. Look at the generated images in pub/media/catalog/product/cache/ and check their modified timestamps

Please also test when using media storage in the database, I haven't tested that but the code should work I believe.

Questions or comments

I know the unit tests will fail, will take a look later, not that much time currently. Feel free to pick this up yourselves, I don't mind 🙂 - Update: Already Done

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]

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

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

[hostep]

Rebased on 2.4-develop and force pushed because 2 recent commits caused merge conflicts:

• 3cddeba66d7
• e88833b0a4f

[hostep]

Rebased and force pushed again to fix static tests (hopefully).

[hostep]

Rebased again, because a new commit caused a merge conflict yet again: c093733

[magento-engcom-team]

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

[engcom-Alfa]

✔️ QA Passed

Tested with File System and Database media storages

Case 1.

File System

1. Have a product with an image
2. Remove the directory pub/media/catalog/product/cache/
3. Run bin/magento catalog:images:resize
4. Look at the generated images in pub/media/catalog/product/cache/ and check their modified timestamps
5. Wait a bit
6. Run bin/magento catalog:images:resize again

✔️ The images didn't resize and the timestamp didn't change

Case 2.

DB media storage

1. Configure media storage to Database;
2. Have a product with an image
3. Go to Admin->System->Cache Management;
4. Click on Flush Catalog Images Cache button;
5. Run bin/magento catalog:images:resize;
6. Look at the generated images in pub/media/catalog/product/cache/ and check their modified timestamps
7. Wait a bit
8. Run bin/magento catalog:images:resize again

✔️ The images didn't resize and the timestamp didn't change

[m2-assistant]

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

[VivekShingala]

We are on Magento 2.3.5-p2. This patch is a lifesaver when images are stored in the file system, however, it doesn't work when we have CDN (S3 Bucket) enabled for our website.

Any help to fix it would be very helpful.

[hostep]

@VivekShingala: can you open a new issue for this with as much information as possible like how you are connecting with S3 and such? Thanks!

[VivekShingala]

Hi @hostep

This patch is working fine for Magento 2.3.5 but not for 2.3.2. Any solution for M2.3.2 available?

[hostep]

@VivekShingala

What you can try is:

• Clone the Magento 2 repository on a local machine
• Checkout the 2.3.2 tag
• Download the https://patch-diff.githubusercontent.com/raw/magento/magento2/pull/26801.diff patch
• Apply that patch on the Magento 2 repository using something like git apply -v 26801.diff
• If it doesn't work, try to resolve conflicts somehow until it works (or apply the changes manually line by line)
• Then generate a new patch out of the changed files in a new file using something like git diff app/code/Magento/MediaStorage > my-new-patch.diff

That's how I usually try to backport patches that can't be applied cleanly.
It might be that it won't work in this particular case, I don't know, but you could try, good luck! 🙂

[hostep]

Ow, you're in luck, it looks like we do have a patch for this for Magento 2.3.2, it's an earlier version of the commits I pushed here, but it probably works equally as well:

PR-26801-MediaStorage.txt

Please test very well, no guarantees that it is flawless, but I think it should work ok if you don't store the media files in the database 🙂

[VivekShingala]

Hi @hostep

The patch you provided works perfectly on Magento 2.3.2 setup. Thank you very much.