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

feat: fail screenshot/replay creation when a potentially sensitive widget is not masked #2375

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

Conversation

vaind
Copy link
Collaborator

@vaind vaind commented Oct 24, 2024

📜 Description

When a potentionally sensitive-content-containing widget is encountered and it is not masked (or unmasked explicitly), fail capturing replay in debug build by throwing an exception.

💡 Motivation and Context

This should help point users that they need to make adjustments to the privacy configuration. The code is only included in debug builds so it won't affect release builds in any way.

💚 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

Copy link
Contributor

github-actions bot commented Oct 24, 2024

Fails
🚫 Please consider adding a changelog entry for the next release.
Messages
📖 Do not forget to update Sentry-docs with your feature once the pull request gets approved.

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

- fail screenshot/replay creation when a potentially sensitive widget is not masked ([#2375](https://github.com/getsentry/sentry-dart/pull/2375))

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 4708fe6

Copy link

codecov bot commented Oct 24, 2024

Codecov Report

Attention: Patch coverage is 80.00000% with 1 line in your changes missing coverage. Please review.

Project coverage is 84.83%. Comparing base (7c7c64f) to head (4708fe6).

Files with missing lines Patch % Lines
flutter/lib/src/sentry_replay_options.dart 80.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2375      +/-   ##
==========================================
+ Coverage   84.72%   84.83%   +0.11%     
==========================================
  Files         253       79     -174     
  Lines        9097     2809    -6288     
==========================================
- Hits         7707     2383    -5324     
+ Misses       1390      426     -964     

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

Copy link
Contributor

github-actions bot commented Oct 24, 2024

Android Performance metrics 🚀

  Plain With Sentry Diff
Startup time 447.49 ms 503.76 ms 56.27 ms
Size 6.49 MiB 7.57 MiB 1.08 MiB

Baseline results on branch: main

Startup times

Revision Plain With Sentry Diff
1a93825 347.31 ms 424.54 ms 77.23 ms
a510d1d 295.63 ms 344.65 ms 49.03 ms
a7acb24 301.00 ms 357.38 ms 56.38 ms
6034b0a 406.35 ms 475.93 ms 69.59 ms
2d74010 400.42 ms 466.50 ms 66.08 ms
4b5a4f6 394.19 ms 471.81 ms 77.62 ms
bf8d36c 505.00 ms 563.18 ms 58.18 ms
e82709a 361.18 ms 423.50 ms 62.32 ms
c732386 316.84 ms 390.62 ms 73.78 ms
24f71aa 358.49 ms 455.90 ms 97.41 ms

App size

Revision Plain With Sentry Diff
1a93825 6.27 MiB 7.20 MiB 956.36 KiB
a510d1d 5.94 MiB 6.96 MiB 1.02 MiB
a7acb24 5.94 MiB 6.95 MiB 1.01 MiB
6034b0a 6.34 MiB 7.29 MiB 970.36 KiB
2d74010 6.33 MiB 7.26 MiB 943.41 KiB
4b5a4f6 6.34 MiB 7.28 MiB 962.57 KiB
bf8d36c 6.49 MiB 7.56 MiB 1.07 MiB
e82709a 6.34 MiB 7.29 MiB 970.37 KiB
c732386 6.26 MiB 7.20 MiB 958.78 KiB
24f71aa 6.06 MiB 7.03 MiB 990.30 KiB

Previous results on branch: feat/fail-unmasked-sensitive-widgets

Startup times

Revision Plain With Sentry Diff
bb49dd5 523.42 ms 570.79 ms 47.37 ms
16bd19d 543.83 ms 574.56 ms 30.73 ms

App size

Revision Plain With Sentry Diff
bb49dd5 6.49 MiB 7.57 MiB 1.08 MiB
16bd19d 6.49 MiB 7.57 MiB 1.08 MiB

Copy link
Contributor

github-actions bot commented Oct 24, 2024

iOS Performance metrics 🚀

  Plain With Sentry Diff
Startup time 1261.65 ms 1288.62 ms 26.97 ms
Size 8.38 MiB 9.75 MiB 1.37 MiB

Baseline results on branch: main

Startup times

Revision Plain With Sentry Diff
d4d0807 1246.94 ms 1260.69 ms 13.75 ms
f9d18f3 1240.20 ms 1242.78 ms 2.57 ms
04bd9e6 1230.78 ms 1250.71 ms 19.94 ms
051e97a 1245.94 ms 1249.51 ms 3.57 ms
b8562d0 1249.92 ms 1267.56 ms 17.64 ms
affcf07 1240.61 ms 1266.49 ms 25.88 ms
2e8b1e1 1247.45 ms 1263.67 ms 16.22 ms
0f067d3 1245.71 ms 1269.59 ms 23.88 ms
f1314d5 1246.46 ms 1270.92 ms 24.46 ms
e239c83 1248.40 ms 1269.28 ms 20.89 ms

App size

Revision Plain With Sentry Diff
d4d0807 8.33 MiB 9.64 MiB 1.31 MiB
f9d18f3 8.29 MiB 9.36 MiB 1.07 MiB
04bd9e6 8.33 MiB 9.61 MiB 1.27 MiB
051e97a 8.28 MiB 9.34 MiB 1.06 MiB
b8562d0 8.33 MiB 9.54 MiB 1.22 MiB
affcf07 8.38 MiB 9.70 MiB 1.33 MiB
2e8b1e1 8.33 MiB 9.64 MiB 1.31 MiB
0f067d3 8.32 MiB 9.52 MiB 1.20 MiB
f1314d5 8.10 MiB 9.08 MiB 1004.30 KiB
e239c83 8.38 MiB 9.74 MiB 1.36 MiB

Previous results on branch: feat/fail-unmasked-sensitive-widgets

Startup times

Revision Plain With Sentry Diff
bb49dd5 1249.61 ms 1282.61 ms 33.00 ms
16bd19d 1223.20 ms 1234.47 ms 11.27 ms

App size

Revision Plain With Sentry Diff
bb49dd5 8.38 MiB 9.75 MiB 1.37 MiB
16bd19d 8.38 MiB 9.75 MiB 1.37 MiB

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