1421032 - Detect Markdown attachment files as text/plain so Firefox can display the content

Status: RESOLVED FIXED

(bugzilla.mozilla.org :: General, enhancement, P2)

Description

[François Marier [:francois]]

Markdown files that end with .md are given the wrong mimetype (application/x-genesis-rom) and therefore cannot be viewed inline in Bugzilla:

  https://bugzilla.mozilla.org/attachment.cgi?id=8932125&action=edit

even though they're really plaintext files.

It would be great to add an override to text/plain at least because all new telemetry requests / data reviews now require attaching a .md file to a bug.

Comment 1

[Emma Humphries ☕️🎸🧞‍♀️✨ (she/they) [:emceeaich] (Pacific Time) use needinfo]

This is blocking telemetry work, so marking as a P1.

Comment 2

[Dylan Hardison [:dylan] (he/him)]

This is a very small change indeed, just special-casing the filename is probably sufficient. I'll take a look at this shortly.

Comment 3

[Kohei Yoshino]

I think I have already solved this as part of Bug 602313. :francois, can you verify?

https://github.com/mozilla-bteam/bmo/blob/master/js/attachment.js#L417-L418

Comment 4

[François Marier [:francois]]

Attachment: review.md

Comment 5

[François Marier [:francois]]

No, it's still not fixed, see attachment 9011511 [details].

Comment 6

[Kohei Yoshino]

Will figure out why.

Comment 7

[Kohei Yoshino]

Looks like the original issue has been solved. The MIME type of the attached review.md is text/markdown, but Firefox cannot show the content while Chrome can. That’s a different issue: Bug 1319262. It’s possible for Bugzilla to detect .md file as text/plain, but given that the official MIME type is text/markdown, we should probably keep it, close this bug and fix the Firefox bug.

Comment 8

[Kohei Yoshino]

So... closing.

Comment 9

[François Marier [:francois]]

Given that the majority of people using our instance of Bugzilla are using Firefox, I think the work-around you mention makes sense (sending the text/plain mimetype when it's set to text/markdown). Bug 1319262 is P3, it's not going to get fixed anytime soon.

Comment 10

[Kohei Yoshino]

Yeah, the workaround is simple, but I’m still not sure what’s the best. Firefox (and other browsers) cannot preview Markdown files so some people may just want to download it and preview it in their favourite viewer, e.g. VS Code.

Comment 11

[Kohei Yoshino]

Maybe the best UX here is letting Bugzilla preview/render Markdown files instead showing the raw content, just like GitHub. Bugzilla already has a Markdown library for the Markdown comment support, so it should be possible to implement the Markdown file preview functionality.

Comment 12

[François Marier [:francois]]

Rendering Markdown files could be nice, but since Markdown files are already quite readable and it's way easier to just display them as text, I'd personally go with that as a first step and revisit later if there's time/desire to enhance.

Given that Paolo has confirmed that it's unlikely to get fixed in Firefox in the near term, let's reopen this bug until a decision is made on the work-around.

Comment 13

[Kohei Yoshino]

Okay, let’s add a quick workaround to Bugzilla while waiting for the fix in Firefox.

Comment 14

[Kohei Yoshino]

Attachment: GitHub Pull Request

Comment 15

[Kohei Yoshino]

My PR doesn’t change the MIME type of the currently attached Markdown files. There are 46 bugs (only 5 open bugs) having Markdown file(s) so we can update them manually if needed.

Comment 16

[Kohei Yoshino]

Merged to master.