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.

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

Draft
wants to merge 25 commits into
base: main
Choose a base branch
from
Draft

Conversation

adil192
Copy link
Member

@adil192 adil192 commented Aug 3, 2025

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: ?
    • 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
Copy link

codecov bot commented Aug 5, 2025

Codecov Report

❌ Patch coverage is 58.74126% with 59 lines in your changes missing coverage. Please review.
✅ Project coverage is 48.56%. Comparing base (54ff513) to head (5d448db).
⚠️ Report is 3 commits behind head on main.

Files with missing lines Patch % Lines
lib/data/sentry/sentry_init.dart 14.81% 23 Missing ⚠️
lib/components/settings/settings_sentry.dart 4.54% 21 Missing ⚠️
lib/components/home/sentry_consent_dialog.dart 74.41% 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.56%   +0.56%     
==========================================
  Files         118      124       +6     
  Lines        8723     8968     +245     
==========================================
+ Hits         4187     4355     +168     
- Misses       4536     4613      +77     

☔ 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant