1918223 - "Create a bug" template has broken triple-backtick markdown formatting (missing newlines) for MOZ_CRASH Reason

Status: VERIFIED FIXED

(Socorro :: General, defect, P2)

Description

[Daniel Holbert [:dholbert]]

STR:

1. View the Bugzilla tab for a crash report with a "MOZ_CRASH Reason" field, like
   https://crash-stats.mozilla.org/report/index/2827f0eb-4a80-421e-a287-4c77f0240911#tab-bugzilla
2. Next to "Create a Bug", click "Core"
3. Click "Preview" on the initial comment of the bug to see how it would look if you filed it.

ACTUAL RESULTS:
The triple-backtick markdown formatting is wrong, because the triple-backtick didn't get its own line. Specifically: the "MOZ_CRASH Reason" has three backticks and then the value, shown directly as regular text (the triple-backtick doesn't start a source code block). Then the triple-backtick that's meant to end that source block ends up starting a block instead, etc.

EXPECTED RESULTS:
The pre-populated text should include a newline character before and after the triple-backtick sequence just before the "MOZ_CRASH Reason" value.

Comment 1

[Daniel Holbert [:dholbert]]

Attachment: screenshot of the incorrect results (from following STR)

Comment 2

[Daniel Holbert [:dholbert]]

The special Bugzilla URL that Soccorro offers is here.

You can reproduce this issue just by directly clicking that^ link (and then clicking "Preview").

And here's a manually edited version of that link where I've inserted %0A (URL-encoded newline) before and after the first %60%60%60 (which is the URL-encoded triple-backtick). This avoids the issue.

Comment 3

[Will Kahn-Greene [:willkg] ET needinfo? me]

Looks like the moz_cras_reason for that crash report has a \n at the end so then the fenced code block gets interpreted differently and that messes it up.

We should strip the moz crash reason of whitespace at the beginning and ending in the template.

Then we could switch to single-backtick code for that string or triple-backtick single-line fenced-block or triple-backtick multi-line fenced-block like you suggested. I think any of those would work, though I think we've had instances where there are single-backticks in the moz crash reason for whatever reason which is why we went with triple-backtick single-line.

Comment 4

[Bianca Danforth [:bdanforth]]

Looks like there's been a change more recently somewhere that's caused the Description field to be empty now. I'll have to look into that first and come back to this one to see if it's still an issue.

Comment 5

[Bianca Danforth [:bdanforth]]

Okay there was an upstream Bugzilla bug with the comment query parameter in the create bug URL that has since been fixed (Bug 1919789, listed as a regressing bug for Bug 1919823 that this bug depends on), so I can now reproduce this issue. I will start working on a fix.

Edit: Actually I can't reproduce this issue anymore -- the formatting looks correct to me now. I've submitted a patch anyway to have the desired effect with Markdown formatting.

Comment 6

[Bianca Danforth [:bdanforth]]

Attachment: [mozilla-services/socorro] bug-1918223: fix moz_crash_reason and reason formatting in create bug Description field. (#6728)

Comment 7

[Bianca Danforth [:bdanforth]]

biancadanforth merged PR [mozilla-services/socorro]: bug-1918223: fix moz_crash_reason and reason formatting in create bug Description field. (#6728) in 7ff1b0e.

Comment 8

[Bianca Danforth [:bdanforth]]

Hoping to deploy this to production next week. When I do, I'll add a comment here linking to the deploy bug.

Comment 9

[Bianca Danforth [:bdanforth]]

This was deployed in bug #1920566 tag v2024.09.23.

Just tried the STR and the resulting formatting in the bug Preview looks to be fixed. Marking this as resolved.

Comment 10

[Daniel Holbert [:dholbert]]

I just retested, and it's fixed for me, too. Thanks!