Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Copy crash report to the description when it is attached #281

Open
misode opened this issue May 23, 2020 · 8 comments · May be fixed by #627
Open

Copy crash report to the description when it is attached #281

misode opened this issue May 23, 2020 · 8 comments · May be fixed by #627
Assignees
Labels
enhancement New feature or request module This issue would require a new module

Comments

@misode
Copy link

misode commented May 23, 2020

The Problem

It is often useful to search for stack traces from crashes. Since Jira does not search through attachments, putting the head of the stack trace in the description is a good idea. Arisa could do this automatically when a crash report is attached.

Possible Implementation

When a crash report is attached to a report for the first time, Arisa should check if the crash report isn't already present in the description. Detecting the Java exception name in a code block could be a good start. The crash report would be added at the bottom of the description

The crash report should be formatted as follows:

{code:title=(VERSION) [^CRASH_REPORT_NAME]}
Description: XYZ
Exception: XYZ
  at ...
  at ...
{code}

Example: https://bugs.mojang.com/browse/MC-181313

@misode misode added enhancement New feature or request module This issue would require a new module labels May 23, 2020
@Marcono1234
Copy link
Contributor

if the crash report isn't already present in the description

Probably rather "if a crash report", otherwise it might add crash reports for multiple versions (unless that is desired).

@urielsalis
Copy link
Member

mc-crash-lib returns all the info to the crash module, so should be easy :D

@violine1101
Copy link
Member

Can it also extract only the relevant strack trace? Because optimally the description should not contain the entire crash report, but just the stack trace.

@urielsalis
Copy link
Member

the exception field contains only the stacktrace

@urielsalis urielsalis self-assigned this May 11, 2021
@Marcono1234
Copy link
Contributor

Should Arisa consider crash reports attached by any users, or only by the reporter (and maybe helpers and moderators)?
I think it would be best to only consider crash reports attached by the reporter, otherwise it could be abused, or by accident the issue a report is about could be changed.

Additionally, it would probably good to only consider Minecraft crash reports, but ignore JVM ones, since they might contain sensitive data and once included in the description it would be permanently in the history of the issue.

@violine1101
Copy link
Member

Personally I'd say it should only copy the stack trace initially after the bug report is first created. AKA only the reporter's crash report should be included. Afterwards we can take care of it manually.

@urielsalis
Copy link
Member

Im going to add them as a comment, not description, so it can be hidden but its still searchable

@urielsalis
Copy link
Member

And if its a comment I dont mind if new ones are added, we can always just restrict it and a lot of the crash reports are added after the fact

@urielsalis urielsalis linked a pull request May 11, 2021 that will close this issue
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request module This issue would require a new module
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants