Skip to content

feat: track errors using Sentry #1495

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 26 commits into from
Aug 12, 2025
Merged

feat: track errors using Sentry #1495

merged 26 commits into from
Aug 12, 2025

Conversation

adil192
Copy link
Member

@adil192 adil192 commented Aug 3, 2025 •
edited
Loading

I will be adding Sentry to help me identify and fix errors much more easily. It will be opt-in.
Please do not run the app from this branch unless you are aware and consenting to its current data collection, since it doesn't currently have consent screens etc.
I will be taking steps to remove sensitive or identifiable information, both locally and on Sentry's console.

TODO:

  • Install sentry
  • Filter out sensitive information (ongoing)
    • Filter out strings that looks like emails, domains, file names, etc
    • Explicitly filter out username/email/password like with GitHub secrets
  • Add opt-in consent dialog
  • Add consent to settings page
  • Remove sentry from FOSS builds
  • Update privacy policy
  • Make sure github build/test workflows succeed
  • Replace "Logs are only kept until you close the app" message since shared errors are kept longer than that
  • Test on all platforms
    • Linux: Doesn't work so I've disabled Sentry in linux builds
    • macOS: Works
    • Windows: Works
    • Android: Works
    • iOS: Works
  • Update app stores' data privacy information

@adil192 adil192 self-assigned this Aug 3, 2025
@adil192 adil192 force-pushed the feat/sentry-error-tracking branch 2 times, most recently from c7dbd13 to f81649f Compare August 5, 2025 21:28
@codecov Codecov
Copy link

codecov bot commented Aug 5, 2025 •
edited
Loading

Codecov Report

❌ Patch coverage is 67.36111% with 47 lines in your changes missing coverage. Please review.
✅ Project coverage is 48.72%. Comparing base (5a4158c) to head (878ef98).
⚠️ Report is 26 commits behind head on main.

Files with missing lines Patch % Lines
lib/components/settings/settings_sentry.dart 4.54% 21 Missing ⚠️
lib/components/home/sentry_consent_dialog.dart 74.41% 11 Missing ⚠️
lib/data/sentry/sentry_init.dart 60.71% 11 Missing ⚠️
lib/components/settings/app_info.dart 0.00% 2 Missing ⚠️
lib/pages/home/home.dart 66.66% 2 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #1495      +/-   ##
==========================================
+ Coverage   47.99%   48.72%   +0.72%     
==========================================
  Files         118      124       +6     
  Lines        8724     8969     +245     
==========================================
+ Hits         4187     4370     +183     
- Misses       4537     4599      +62

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@adil192 adil192 force-pushed the feat/sentry-error-tracking branch from 3a995ec to f756c50 Compare August 8, 2025 19:07
@adil192
Copy link
Member Author

adil192 commented Aug 10, 2025

For those interested in what I see:

Screenshot of the Sentry web interface image

adil192 added 24 commits August 10, 2025 20:40
@adil192
feat: add Sentry for error tracking
0b8554e
@adil192
feat: filter out sensitive data from sentry
7e7acfd
@adil192
feat(sentry): redact domain names and local files
00a42c9
@adil192
feat(sentry): redact login flow urls
bf375a1
@adil192
tweak(sentry): disable some breadcrumbs and tracing
57c3aed
@adil192
chore: hide sentry folder in vscode
328a03a
@adil192
feat(sentry): remove sentry with foss patch
ddde795
@adil192
chore: install curl in github actions
b0c2782
@adil192
chore: install curl-dev in github actions
92988c8
@adil192
feat: opt-in to sentry analytics
02ed128
@adil192
test: disable sentry consent dialog in tests
3b98b29
@adil192
feat: add sentry consent to settings
0ab453e
@adil192
tweak: don't show "ask me later" if already answered
396883b
@adil192
privacy: Saber nc server is hosted in UK
ecdc5a8
@adil192
privacy: add Sentry info to privacy policy
a999ce2
@adil192
feat: no further error tracking after opting out
e1487d3
@adil192
test: no further error tracking after opting out
69f903f
@adil192
feat: redact current user credentials
863c8f8
@adil192
test: logs page goldens
37caa6f
@adil192
tweak: don't say logs are temporary
b3f55be 
Logs are shared with Sentry if consented, so the old message was replaced to avoid confusion
@adil192
test: sentry consent dialog goldens
f5876c6
@adil192
feat: link to privacy policy in consent dialog
84b120d
@adil192
tweak: use non-github link for privacy policy
e1e1d73
@adil192
chore: disable sentry on linux
0e0921f
@adil192 adil192 force-pushed the feat/sentry-error-tracking branch from 5d448db to e9f879d Compare August 10, 2025 19:40
@adil192 adil192 marked this pull request as ready for review August 12, 2025 09:20
@adil192 adil192 merged commit 878ef98 into main Aug 12, 2025
2 checks passed
@adil192 adil192 deleted the feat/sentry-error-tracking branch August 12, 2025 09:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@adil192 adil192

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@adil192 @ceskyDJ