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

Provide a mechanism for surfacing highlights from attachments #119

Open
NickEntin opened this issue May 11, 2021 · 0 comments · May be fixed by #124
Open

Provide a mechanism for surfacing highlights from attachments #119

NickEntin opened this issue May 11, 2021 · 0 comments · May be fixed by #124
Labels
enhancement Request for a new feature or improvement to an existing feature

Comments

@NickEntin
Copy link
Collaborator

NickEntin commented May 11, 2021

This stems from a desire to have bug reporters (in particular the ARKEmailBugReporter) treat the log store as just another attachment, rather than special casing it. Currently the only major behavioral difference between the log stores and the other attachments is that the reporter pulls the recent errors out of the logs and surfaces them at the top level. This is vital behavior in the case where attachments aren't available, but it's also very useful when there are attachments to provide a quick hint as to what the problem might be before digging into each attachment.

I think it would be fairly straightforward to introduce a highlightsSummary property (exact naming TBD) to ARKBugReportAttachment so that any attachment could optionally surface highlights at the top level. This would also unblock making the log store be a regular attachment, since the recent error logic could be easily moved to the LogStoreAttachmentGenerator.

@NickEntin NickEntin added the enhancement Request for a new feature or improvement to an existing feature label May 11, 2021
@NickEntin NickEntin linked a pull request Jul 12, 2021 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Request for a new feature or improvement to an existing feature
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant