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

vaind · 2024-10-24T18:10:41Z

📜 Description

When a potentionally sensitive-content-containing widget is encountered and it is not masked (or unmasked explicitly), print a warning (in debug mode).

While testing this I noticed we don't have a TextField in tests which doesn't inherit from Text or FormField so added it although it's unrelated to this PR

💡 Motivation and Context

This should help users realize 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

…dget is not masked

github-actions · 2024-10-24T18:11:17Z

	Messages
📖	Do not forget to update Sentry-docs with your feature once the pull request gets approved.

Generated by 🚫 dangerJS against 5b706f4

codecov · 2024-10-24T18:11:46Z

Codecov Report

Attention: Patch coverage is 87.50000% with 2 lines in your changes missing coverage. Please review.

Project coverage is 91.48%. Comparing base (3cc7034) to head (5b706f4).
Report is 24 commits behind head on main.

Files with missing lines	Patch %	Lines
flutter/lib/src/screenshot/recorder.dart	71.42%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2375      +/-   ##
==========================================
+ Coverage   86.92%   91.48%   +4.55%     
==========================================
  Files         264       87     -177     
  Lines        9376     3040    -6336     
==========================================
- Hits         8150     2781    -5369     
+ Misses       1226      259     -967

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

github-actions · 2024-10-24T18:21:24Z

Android Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	470.52 ms	542.74 ms	72.22 ms
Size	6.49 MiB	7.57 MiB	1.08 MiB

Baseline results on branch: main

Startup times

Revision	Plain	With Sentry	Diff
`6e083bb`	327.96 ms	381.39 ms	53.43 ms
`4829ad3`	381.55 ms	455.45 ms	73.90 ms
`9a604e8`	470.65 ms	485.90 ms	15.24 ms
`a40bb7c`	477.10 ms	553.90 ms	76.80 ms
`0ceb89c`	304.57 ms	357.18 ms	52.61 ms
`ebfead1`	298.44 ms	374.28 ms	75.84 ms
`f9d18f3`	430.94 ms	497.59 ms	66.65 ms
`25161f4`	353.98 ms	431.94 ms	77.96 ms
`732a7b4`	371.98 ms	423.19 ms	51.21 ms
`d7758e8`	300.12 ms	349.88 ms	49.76 ms

App size

Revision	Plain	With Sentry	Diff
`6e083bb`	5.94 MiB	6.97 MiB	1.03 MiB
`4829ad3`	6.33 MiB	7.26 MiB	943.11 KiB
`9a604e8`	6.49 MiB	7.57 MiB	1.08 MiB
`a40bb7c`	6.52 MiB	7.61 MiB	1.09 MiB
`0ceb89c`	5.94 MiB	6.95 MiB	1.01 MiB
`ebfead1`	6.06 MiB	7.03 MiB	989.24 KiB
`f9d18f3`	6.15 MiB	7.13 MiB	1000.49 KiB
`25161f4`	6.27 MiB	7.20 MiB	960.44 KiB
`732a7b4`	6.33 MiB	7.27 MiB	954.02 KiB
`d7758e8`	5.94 MiB	6.95 MiB	1.01 MiB

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

Startup times

Revision	Plain	With Sentry	Diff
`905aa01`	448.54 ms	496.00 ms	47.46 ms
`4708fe6`	447.49 ms	503.76 ms	56.27 ms
`bb49dd5`	523.42 ms	570.79 ms	47.37 ms
`1c71a86`	478.22 ms	521.78 ms	43.55 ms
`16bd19d`	543.83 ms	574.56 ms	30.73 ms

App size

Revision	Plain	With Sentry	Diff
`905aa01`	6.49 MiB	7.57 MiB	1.08 MiB
`4708fe6`	6.49 MiB	7.57 MiB	1.08 MiB
`bb49dd5`	6.49 MiB	7.57 MiB	1.08 MiB
`1c71a86`	6.49 MiB	7.57 MiB	1.08 MiB
`16bd19d`	6.49 MiB	7.57 MiB	1.08 MiB

github-actions · 2024-10-24T18:31:48Z

iOS Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	1256.51 ms	1280.98 ms	24.47 ms
Size	8.38 MiB	9.78 MiB	1.41 MiB

Baseline results on branch: main

Startup times

Revision	Plain	With Sentry	Diff
`09c1f55`	1258.11 ms	1280.45 ms	22.34 ms
`613760b`	1263.10 ms	1277.27 ms	14.16 ms
`2e93bab`	1237.08 ms	1258.41 ms	21.33 ms
`e0f6628`	1250.57 ms	1274.86 ms	24.29 ms
`0a23f98`	1252.98 ms	1276.76 ms	23.78 ms
`955541a`	1230.22 ms	1252.96 ms	22.73 ms
`6078ddc`	1207.84 ms	1224.10 ms	16.27 ms
`3f3ef0b`	1223.73 ms	1237.67 ms	13.94 ms
`3de8b9b`	1234.22 ms	1251.94 ms	17.72 ms
`3f23617`	1261.93 ms	1286.10 ms	24.17 ms

App size

Revision	Plain	With Sentry	Diff
`09c1f55`	8.38 MiB	9.74 MiB	1.36 MiB
`613760b`	8.15 MiB	9.13 MiB	1000.46 KiB
`2e93bab`	8.38 MiB	9.73 MiB	1.36 MiB
`e0f6628`	8.32 MiB	9.50 MiB	1.18 MiB
`0a23f98`	8.10 MiB	9.18 MiB	1.08 MiB
`955541a`	8.28 MiB	9.34 MiB	1.06 MiB
`6078ddc`	8.33 MiB	9.40 MiB	1.07 MiB
`3f3ef0b`	8.32 MiB	9.38 MiB	1.05 MiB
`3de8b9b`	8.28 MiB	9.34 MiB	1.06 MiB
`3f23617`	8.16 MiB	9.17 MiB	1.01 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
`1c71a86`	1259.45 ms	1280.23 ms	20.78 ms
`16bd19d`	1223.20 ms	1234.47 ms	11.27 ms
`905aa01`	1245.10 ms	1265.34 ms	20.24 ms
`4708fe6`	1261.65 ms	1288.62 ms	26.97 ms

App size

Revision	Plain	With Sentry	Diff
`bb49dd5`	8.38 MiB	9.75 MiB	1.37 MiB
`1c71a86`	8.38 MiB	9.78 MiB	1.41 MiB
`16bd19d`	8.38 MiB	9.75 MiB	1.37 MiB
`905aa01`	8.38 MiB	9.78 MiB	1.40 MiB
`4708fe6`	8.38 MiB	9.75 MiB	1.37 MiB

github-actions · 2024-12-10T19:06:31Z

🚨 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

buenaflor

looks good, just one question but not really blockign

buenaflor · 2024-12-10T21:56:43Z

flutter/lib/src/sentry_privacy_options.dart

+
+    // In Debug mode, check if users explicitly mask (or unmask) widgets that
+    // look like they should be masked, e.g. Videos, WebViews, etc.
+    if (kDebugMode) {


wdyt of using options.platformChecker.isDebugMode()?

but doesn't really make a difference I think

only matters if we add an additional test case where we assert that the warning isn't added for release builds, then we can mock it

Thanks, I've made the changes and added test cases for non-debug builds

feat: fail screenshot/replay creation when a potentially sensitive wi…

16bd19d

…dget is not masked

vaind and others added 2 commits October 25, 2024 19:12

fix tests for web

bb49dd5

Merge branch 'main' into feat/fail-unmasked-sensitive-widgets

4708fe6

vaind mentioned this pull request Nov 11, 2024

feat: Flutter replay custom masking warning getsentry/sentry-docs#11778

Merged

6 tasks

vaind added 4 commits December 10, 2024 13:09

Merge branch 'main' into feat/fail-unmasked-sensitive-widgets

1c3ae5a

improve text

905aa01

warn instead of throwin an exception

5f4fad1

Merge branch 'main' into feat/fail-unmasked-sensitive-widgets

1c71a86

vaind changed the title ~~feat: fail screenshot/replay creation when a potentially sensitive widget is not masked~~ feat: warning in screenshot/replay creation when a potentially sensitive widget is not masked Dec 10, 2024

chore: changelog

aca8e1e

vaind marked this pull request as ready for review December 10, 2024 19:23

vaind requested review from krystofwoldrich, stefanosiano, buenaflor and martinhaintz as code owners December 10, 2024 19:23

buenaflor approved these changes Dec 10, 2024

View reviewed changes

vaind and others added 3 commits December 11, 2024 09:26

test: add debug/profile/release mode tests

d184bb4

test assertion

6bf6945

Merge branch 'main' into feat/fail-unmasked-sensitive-widgets

5b706f4

vaind merged commit ab99a31 into main Dec 11, 2024
48 checks passed

vaind deleted the feat/fail-unmasked-sensitive-widgets branch December 11, 2024 09:55

vaind added the Session Replay label Dec 19, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

vaind commented Oct 24, 2024 •

edited

Loading

github-actions bot commented Oct 24, 2024 •

edited

Loading

codecov bot commented Oct 24, 2024 •

edited

Loading

github-actions bot commented Oct 24, 2024 •

edited

Loading

Baseline results on branch: main

Startup times

App size

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

Startup times

App size

github-actions bot commented Oct 24, 2024 •

edited

Loading

Baseline results on branch: main

Startup times

App size

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

Startup times

App size

github-actions bot commented Dec 10, 2024

buenaflor left a comment

buenaflor Dec 10, 2024

vaind Dec 11, 2024

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

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

Conversation

vaind commented Oct 24, 2024 • edited Loading

📜 Description

💡 Motivation and Context

💚 How did you test it?

📝 Checklist

🔮 Next steps

github-actions bot commented Oct 24, 2024 • edited Loading

codecov bot commented Oct 24, 2024 • edited Loading

Codecov Report

github-actions bot commented Oct 24, 2024 • edited Loading

Android Performance metrics 🚀

Baseline results on branch: main

Startup times

App size

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

Startup times

App size

github-actions bot commented Oct 24, 2024 • edited Loading

iOS Performance metrics 🚀

Baseline results on branch: main

Startup times

App size

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

Startup times

App size

github-actions bot commented Dec 10, 2024

🚨 Detected changes in high risk code 🚨

buenaflor left a comment

Choose a reason for hiding this comment

buenaflor Dec 10, 2024

Choose a reason for hiding this comment

vaind Dec 11, 2024

Choose a reason for hiding this comment

vaind commented Oct 24, 2024 •

edited

Loading

github-actions bot commented Oct 24, 2024 •

edited

Loading

codecov bot commented Oct 24, 2024 •

edited

Loading

github-actions bot commented Oct 24, 2024 •

edited

Loading

github-actions bot commented Oct 24, 2024 •

edited

Loading