Skip to content

replay: add sensitive content widget to default masking #2989

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
Draft
wants to merge 11 commits into
base: main
Choose a base branch
from
Draft

replay: add sensitive content widget to default masking #2989

wants to merge 11 commits into from
+96 −9

Conversation

buenaflor
Copy link
Contributor

@buenaflor buenaflor commented Jun 13, 2025 •
edited
Loading

📜 Description

Masks the SensitiveContent widget ootb for replay

TBD: check how we can add backwards compat

💡 Motivation and Context

Closes #2987

💚 How did you test it?

📝 Checklist

  • I reviewed submitted code
  • I added tests to verify changes
  • No new PII added or SDK only sends newly added PII if sendDefaultPii is enabled
  • I updated the docs if needed
  • All tests passing
  • No breaking changes

🔮 Next steps

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jun 13, 2025 •
edited
Loading

Fails
🚫 Please consider adding a changelog entry for the next release.

Instructions and example for changelog

Please add an entry to CHANGELOG.md to the "Unreleased" section. Make sure the entry includes this PR's number.

Example:

## Unreleased

- add sensitive content widget to default masking ([#2989](https://github.com/getsentry/sentry-dart/pull/2989))

If none of the above apply, you can opt out of this check by adding #skip-changelog to the PR description.

Generated by 🚫 dangerJS against f76a31d

@codecov Codecov
Copy link

codecov bot commented Jun 13, 2025 •
edited
Loading

Codecov Report

Attention: Patch coverage is 81.25000% with 3 lines in your changes missing coverage. Please review.

Project coverage is 88.80%. Comparing base (6d23889) to head (f76a31d).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
flutter/lib/src/sentry_privacy_options.dart 78.57% 3 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #2989      +/-   ##
==========================================
+ Coverage   87.88%   88.80%   +0.92%     
==========================================
  Files         287       97     -190     
  Lines        9754     3537    -6217     
==========================================
- Hits         8572     3141    -5431     
+ Misses       1182      396     -786

☔ 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.

ueman
ueman reviewed Jun 17, 2025
View reviewed changes
flutter/lib/src/sentry_privacy_options.dart Outdated
@@ -41,6 +41,20 @@ class SentryPrivacyOptions {
mask: false,
name: 'SentryUnmask',
));
// TODO: check for Flutter version and make this testable
Copy link
Collaborator

@ueman ueman Jun 17, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

sentry-dart/dart/lib/src/event_processor/enricher/flutter_runtime.dart

Line 44 in 9e18a68

static const String? version = bool.hasEnvironment('FLUTTER_VERSION')
should be at least 3.33.0-0.2.pre or higher.

Ideally, you also make a check for bool.hasEnvironment('FLUTTER_VERSION') so that it tree shakes better. Calling a property on dynamic basically disables tree shaking for that property on any class. And the FLUTTER_VERSION dart define was introduced just one major Flutter version before this, which should already improve tree shaking quite a lot for most Flutter versions.

@github-actions GitHub Actions
Copy link
Contributor

iOS Performance metrics 🚀

  Plain With Sentry Diff
Startup time 1271.55 ms 1281.62 ms 10.07 ms
Size 7.86 MiB 9.44 MiB 1.58 MiB

Baseline results on branch: main

Startup times

Revision Plain With Sentry Diff
e2d675d 1238.48 ms 1242.76 ms 4.28 ms
aeb02f2 1244.29 ms 1256.55 ms 12.26 ms
6ba4675 1223.12 ms 1238.17 ms 15.04 ms
9b99523 1256.06 ms 1270.33 ms 14.27 ms
2d34233 1258.19 ms 1268.92 ms 10.73 ms
b6c8720 1252.65 ms 1266.61 ms 13.96 ms
73a3c38 1263.37 ms 1277.90 ms 14.53 ms
93b7728 1247.23 ms 1264.87 ms 17.64 ms
0fb3800 1256.60 ms 1266.28 ms 9.68 ms
ec78888 1251.37 ms 1269.40 ms 18.04 ms

App size

Revision Plain With Sentry Diff
e2d675d 7.86 MiB 9.44 MiB 1.58 MiB
aeb02f2 7.86 MiB 9.44 MiB 1.58 MiB
6ba4675 7.86 MiB 9.44 MiB 1.58 MiB
9b99523 7.86 MiB 9.44 MiB 1.58 MiB
2d34233 7.86 MiB 9.44 MiB 1.58 MiB
b6c8720 7.86 MiB 9.44 MiB 1.58 MiB
73a3c38 7.86 MiB 9.44 MiB 1.58 MiB
93b7728 7.86 MiB 9.44 MiB 1.58 MiB
0fb3800 7.86 MiB 9.44 MiB 1.58 MiB
ec78888 7.86 MiB 9.44 MiB 1.58 MiB

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jul 11, 2025 •
edited
Loading

Android Performance metrics 🚀

  Plain With Sentry Diff
Startup time 441.09 ms 504.78 ms 63.69 ms
Size 6.54 MiB 7.69 MiB 1.15 MiB

Baseline results on branch: main

Startup times

Revision Plain With Sentry Diff
575ebaa 478.00 ms 585.76 ms 107.76 ms
ec78888 457.94 ms 519.96 ms 62.02 ms
81f83eb 471.40 ms 522.14 ms 50.74 ms
0fb3800 465.64 ms 536.77 ms 71.13 ms
e2d675d 457.92 ms 529.17 ms 71.25 ms
9b99523 456.91 ms 490.55 ms 33.64 ms
c8596a6 474.00 ms 492.96 ms 18.96 ms
73dca78 476.53 ms 522.21 ms 45.68 ms
793f4dc 462.68 ms 544.21 ms 81.53 ms
93b7728 475.28 ms 489.13 ms 13.86 ms

App size

Revision Plain With Sentry Diff
575ebaa 6.54 MiB 7.69 MiB 1.15 MiB
ec78888 6.54 MiB 7.69 MiB 1.15 MiB
81f83eb 6.54 MiB 7.69 MiB 1.15 MiB
0fb3800 6.54 MiB 7.69 MiB 1.15 MiB
e2d675d 6.54 MiB 7.69 MiB 1.15 MiB
9b99523 6.54 MiB 7.69 MiB 1.15 MiB
c8596a6 6.54 MiB 7.53 MiB 1015.27 KiB
73dca78 6.54 MiB 7.69 MiB 1.15 MiB
793f4dc 6.54 MiB 7.69 MiB 1.15 MiB
93b7728 6.54 MiB 7.69 MiB 1.15 MiB

Previous results on branch: replay/add-sensitive-content

Startup times

Revision Plain With Sentry Diff
5ce2839 462.72 ms 519.61 ms 56.89 ms

App size

Revision Plain With Sentry Diff
5ce2839 6.54 MiB 7.69 MiB 1.15 MiB

@github-actions GitHub Actions
Copy link
Contributor

🚨 Detected changes in high risk code 🚨

High-risk code has higher potential to break the SDK and may be hard to test. To prevent severe bugs, apply the rollout process for releasing such changes and be extra careful when changing and reviewing these files:

  • flutter/lib/src/screenshot/recorder.dart

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ueman ueman ueman left review comments

@stefanosiano stefanosiano Awaiting requested review from stefanosiano stefanosiano will be requested when the pull request is marked ready for review stefanosiano is a code owner

@denrase denrase Awaiting requested review from denrase denrase will be requested when the pull request is marked ready for review denrase is a code owner

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Support SensitiveContent
2 participants
@buenaflor @ueman