2.4.7 breaks uploads of additional file type to CMS media gallery

adamlavery commented 3 months ago

Preconditions and environment

M2.4.7

Steps to reproduce

Implement DI overrides to allow more than just jpeg, jpg, png, gif files to be uploaded to the CMS media gallery e.g. add PDF

Expected result

PDF files can be uploaded and used in CMS content.

Actual result

PDF files are now disallowed again in 2.4.7

Additional information

Why are they now disallowed? Simple - some developer decided to "fix" a check for allowed files types in the media-uploader.js script. Instead of supplying allowed types to the script, as specified in DI, s/he hardcoded the allowed extensions in the script.

        _create: function () {
            let self = this,
                arrayFromObj = Array.from,
                progressTmpl = mageTemplate('[data-template="uploader"]'),
                uploaderElement = '#fileUploader',
                targetElement = this.element.find('.fileinput-button.form-buttons')[0],
                uploadUrl = $(uploaderElement).attr('data-url'),
                fileId = null,
                allowedExt = ['jpeg', 'jpg', 'png', 'gif'],
                allowedResize = false,
                options = {

In fact someone thought of doing this in earlier versions but never followed it through - acceptFileTypes is never used:

                dropZone: '[data-tab-panel=image-management]',
                sequentialUploads: true,
                acceptFileTypes: /(\.|\/)(gif|jpe?g|png)$/i,
                maxFileSize: this.options.maxFileSize,

Come on, how does this kind of schoolboy error make it into production? We learnt in the '80s that you never duplicate code/constants. If you do then your code is wrong and needs to be restructured to remove duplication.

Now, in addition to adding multiple DI entries to allow more file types in CMS content (which is also very poor code design), we have to override Magento_Backend/js/media-uploader.js to allow them, and manage core changes going forward.

Magento developers - you must do better! The time and cost of your errors is considerable.

Release note

Fix error introduced in 2,4.7 that negates DI changes to allow additional file types in CMS pages/blocks.

Triage and priority

[ ] Severity: S0 - Affects critical data or functionality and leaves users without workaround.
[X] Severity: S1 - Affects critical data or functionality and forces users to employ a workaround.
[ ] Severity: S2 - Affects non-critical data or functionality and forces users to employ a workaround.
[ ] Severity: S3 - Affects non-critical data or functionality and does not force users to employ a workaround.
[ ] Severity: S4 - Affects aesthetics, professional look and feel, “quality” or “usability”.

m2-assistant[bot] commented 3 months ago

Hi @adamlavery. Thank you for your report. To speed up processing of this issue, make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, Add a comment to the issue:

@magento give me 2.4-develop instance - upcoming 2.4.x release
For more details, review the Magento Contributor Assistant documentation.
Add a comment to assign the issue: @magento I am working on this
To learn more about issue processing workflow, refer to the Code Contributions.

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, join the Community Contributions Triage session to discuss the appropriate ticket.

hostep commented 3 months ago

There once was (back in 2017) a suggestion to be able to upload pdf files through a separate "file upload" mechanism that wouldn't abuse the "media gallery upload" (because pdf files aren't images that need to be resized to show a thumbnail): https://github.com/magento/magento2/issues/9850

Maybe that idea should get picked up again?

m2-assistant[bot] commented 3 months ago

Hi @engcom-Hotel. 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).
[ ] 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue.
[ ] 3. Add Area: XXXXX label to the ticket, indicating the functional areas 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-Hotel commented 3 months ago

Hello @adamlavery,

Thanks for the report and collaboration!

We have tried to reproduce this issue in the latest development branch i.e. 2.4-develop and the issue seems reproducible for us. Currently, there is no way to upload files other than the ones mentioned in the existing module, need to override Magento_Backend/js/media-uploader.js to allow it.

Hence confirming the issue.

Thanks

github-jira-sync-bot commented 3 months ago

:white_check_mark: Jira issue https://jira.corp.adobe.com/browse/AC-12718 is successfully created for this GitHub issue.

m2-assistant[bot] commented 3 months ago

:white_check_mark: Confirmed by @engcom-Hotel. Thank you for verifying the issue.
Issue Available: @engcom-Hotel, You will be automatically unassigned. Contributors/Maintainers can claim this issue to continue. To reclaim and continue work, reassign the ticket to yourself.

adamlavery commented 3 months ago

@hostep this needs to be more flexible. It was already ridiculous how many duplicate DI entries needed to added. Poor design means each module needed to be told to allow additional types. There should be one single source of allowed CMS file types and it should be in admin, not require code changes. And it should be Media not Images; some sites need to use more than just images on CMS pages and want to use modern image formats nowadays (WEBP, AVIF) . For one of my customer stores we need the following. It's a print store and they provide templates in various formats for their customers to use.

                <item name="allowed" xsi:type="array">
                    <item name="pdf" xsi:type="string">application/pdf</item>
                    <item name="eps" xsi:type="string">application/postscript</item>
                    <item name="idml" xsi:type="string">application/octet-stream</item>
                    <item name="ai" xsi:type="string">application/postscript</item>
                    <item name="psd" xsi:type="string">application/octet-stream</item>
                    <item name="zip" xsi:type="string">application/zip</item>
                </item>

We already had to repeat this 3 times, now it's 5 times as each module has it's own separate config; as well as now also having to override the upload script!

Modern image converters can handle much more than just basic image files to generate thumbnails, including PDFs. If a format can't be converted, display a generic image type thumb.

magento / magento2