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

enh(debugArchive): Add reminder to redact before sharing #6238

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

joshtrichards
Copy link
Member

Closes #3189

Adds a reminder, when a debug archive is created, that information deemed sensitive should be redacted before sharing.

@nextcloud-desktop-bot
Copy link

AppImage file: nextcloud-PR-6238-00a13dd2424bbbcef8bdaa6cf39fdb4f3c27090f-x86_64.AppImage

To test this change/fix you can simply download above AppImage file and test it.

Please make sure to quit your existing Nextcloud app and backup your data.

Copy link

sonarcloud bot commented Nov 22, 2023

SonarCloud Quality Gate failed.    Quality Gate failed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell C 1 Code Smell

0.0% 0.0% Coverage
0.0% 0.0% Duplication

idea Catch issues before they fail your Quality Gate with our IDE extension sonarlint SonarLint

@joshtrichards joshtrichards added 2. to review enhancement enhancement of a already implemented feature/code feature: ⚙️ settings Settings panel functionalities. labels Nov 22, 2023
@@ -501,7 +501,7 @@ void GeneralSettings::slotCreateDebugArchive()
}

createDebugArchive(filename);
QMessageBox::information(this, tr("Debug Archive Created"), tr("Debug archive is created at %1").arg(filename));
QMessageBox::information(this, tr("Debug Archive Created"), tr("Redact information deemed sensitive before sharing! Debug archive created at %1").arg(filename));
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that what would be better is to warn that this may have sensitive data and people should be considerate before sharing (and may want to redact some info if needed)
I am pretty sure as an user I would be so afraid of sharing the debug archive once I would have read this text
if that means that the bug affecting me cannot be solved, then there is an lost opportunity

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if maybe we tackle this problem in two parts (aiming to achieve all three of: better bug reports + streamlining log request while triaging + increased comfort with providing logs to reduce lost opportunities) by doing something like:

  • Add a README section that is about providing debug logs that encourages people to reproduce on a test account if they're hesitant (which will have less privacy concerns); also provides a convenient spot to direct people to on "how to get logs" (and where, if we so choose down the road, to add maybe a few key bits to search and replace out if one is concerned with sensitive details when they can't use a test account or whatever)
  • Make the message in this PR softer (which I think is what you're proposing)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2. to review enhancement enhancement of a already implemented feature/code feature: ⚙️ settings Settings panel functionalities.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Inform users, that 'Create debug archive' contains personal data.
4 participants