bug-1918223: fix moz_crash_reason and reason formatting in create bug Description field. #6728
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… Description field.
biancadanforth
force-pushed
the
bug-1918223
branch
from
634b552
to
91d6f29
Compare
relud
approved these changes
Sep 20, 2024
willkg
reviewed
Sep 23, 2024
| @@ -134,10 +134,12 @@ def crash_report_to_description(crash_report_url, processed_crash): | |||
| ] | |||
| if processed_crash.get("moz_crash_reason"): | |||
| lines.append("") | |||
| lines.append(f"MOZ_CRASH Reason: ```{processed_crash['moz_crash_reason']}```") | |||
| lines.append( | |||
| f"MOZ_CRASH Reason:\n```\n{processed_crash['moz_crash_reason'].strip()}\n```\n" | |||
There was a problem hiding this comment.
The lines array is joined using \n as a separator, so I probably would have done this like we do the stack below:
lines.append("```")
lines.append(processed_crash("moz_crash_reason").strip())
lines.append("```")
There was a problem hiding this comment.
Ah okay -- yeah that would have been a little cleaner. Would you like me to open another PR to update this?
This was referenced Sep 26, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Because:
moz_crash_reasonvalue (and similarly, thereasonvalue) was not displaying properly in the Bugzilla create bug page due to some extra whitespace and missing newline characters in the value of thecommentquery parameter passed in the create bug URL.This commit:
Note: Shortly after bug-1919789 was fixed (which temporarily blocked this bug), I can no longer reproduce the issue in this bug locally or in prod, however, it makes sense to make these changes anyway, so that the formatting will reflect standard Markdown formatting regardless of the current Bugzilla create bug URL implementation.
Here's a screenshot of what the Preview looks like in the Bugzilla create bug page with the crash from the ticket (
2827f0eb-4a80-421e-a287-4c77f0240911) in local development: