Extend Debug Archive functionality to simplify sanitization for bug reports
- Dominant language
- C++
- Stars
- 3.9k
- Forks
- 1k
- Avg merge
- 1d 17h
- Merged PRs (30d)
- 123
Description
### How to use GitHub
* Please use the 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to show that you are interested into the same feature.
* Please don't comment if you have no relevant information to add. It's just extra noise for everyone subscribed to this issue.
* Subscribe to receive notifications on status change and new comments.
---
## Feature request
**Which Nextcloud Version are you currently using:** 32.06.
**Is your feature request related to a problem? Please describe.**
Kinda, I wanted to submit a bug but sanitizing the debug archive to avoid leaking information was impossible. So I didn't upload a debug archive.
**Describe the solution you'd like**
When generating a debug archive show a pop up, that asks the user to choose a time frame to be included in the archive, as well as asking if file names should be sanitized. Files and file paths would then get unique identifiers to be able to still distinguish them.
**Describe alternatives you've considered**
Alternatively this can be done by hand, but is extremely tedious. The user needs to now exactly when the problem occurred and then sanitize each file name separately in every log file. To be able to do that the archive and each log needs to be extracted first, which also takes additional effort.
**Additional context**
Maybe this enhancement would improvement the number of times a debug archive is added to bug reports. The question for an affected file in the bug report would be impacted by this, but the popup could also offer a file picker to choose an affected file which then gets a special identifier in the debug archive.
Contributor guide
Research direction
No file or test is named. Start by locating the desktop client's existing debug archive generation and sanitization entry points, then review how archive contents and logs are assembled. Done should include a defined UI for the time range and file-name sanitization, with stable identifiers that preserve distinctions without exposing sensitive paths.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- desktop
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100