Image filename not necessarily set when logging file not found error

chris-pook commented 3 years ago

Preconditions (*)

Magento 2.4.2

Steps to reproduce (*)

In extension code use \Magento\Framework\Image\Factory::create($filePath) where $filePath is not a valid file.
View var/log/exception.log. Filepath is empty in exception log file.

Description (*)

This appears to be a problem with the Magento Framework GD2 library assuming $this->_fileName has been set where it may not necessarily be the case.

https://github.com/magento/magento2/blob/2.4-develop/lib/internal/Magento/Framework/Image/Adapter/Gd2.php#L66

The file_exists check is on $fileName (which does have a valid value in the bug scenario here), so I would expect the exception message to use the same value for consistency and to log the correct value.

Expected result (*)

There should be a log entry: main.ERROR: File "filePath" does not exist.

Actual result (*)

There is a log entry: main.ERROR: File "" does not exist.
The file path is empty and it is not clear what file was attempted to be found.

[x] Severity: S4 - Affects aesthetics, professional look and feel, “quality” or “usability”.

m2-assistant[bot] commented 3 years ago

Hi @chris-pook. Thank you for your report. To help us process this issue please make sure that you provided the following information:

Summary of the issue
Information on your environment
Steps to reproduce
Expected and actual results

Please make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, please, add a comment to the issue:

@magento give me 2.4-develop instance - upcoming 2.4.x release

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

Please, add a comment to assign the issue: @magento I am working on this

Join Magento Community Engineering Slack and ask your questions in #github channel.

:warning: According to the Magento Contribution requirements, all issues must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.

:clock10: You can find the schedule on the Magento Community Calendar page.

:telephone_receiver: The triage of issues 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.

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

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

chris-pook commented 3 years ago

This appears to be a problem with the Magento Framework GD2 library assuming $this->_fileName has been set where it may not necessarily be the case.

https://github.com/magento/magento2/blob/2.4-develop/lib/internal/Magento/Framework/Image/Adapter/Gd2.php#L66

The file_exists check is on $fileName (which does have a valid value in the bug scenario here), so I would expect the exception message to use the same value for consistency and to log the correct value.

m2-assistant[bot] commented 3 years ago

Hi @engcom-Lima. Thank you for working on this issue. In order to make sure that issue has enough information and ready for development, please read and check the following instruction: :point_down:

[ ] 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).
Details
If the issue has a valid description, the label Issue: Format is valid will be added to the issue automatically. Please, edit issue description if needed, until label Issue: Format is valid appears.
[ ] 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue. If the report is valid, add Issue: Clear Description label to the issue by yourself.
[ ] 3. Add Component: XXXXX label(s) to the ticket, indicating the components it may be related to.
[ ] 4. Verify that the issue is reproducible on 2.4-develop branch
Details
- Add the comment @magento give me 2.4-develop instance to deploy test instance on Magento infrastructure.
- If the issue is reproducible on 2.4-develop branch, please, add the label Reproduced on 2.4.x.
- If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!
[ ] 5. Add label Issue: Confirmed once verification is complete.
[ ] 6. Make sure that automatic system confirms that report has been added to the backlog.

engcom-Lima commented 3 years ago

Verified the issue on Magento 2.4-develop branch and the issue is reproducible:

Found $this->_fileName to be written while trying to log exception. File: lib/internal/Magento/Framework/Image/Adapter/Gd2.php
Filepath is empty in exception log file.