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

Rename session replay redact options and APIs to mask #4373

Open
wants to merge 13 commits into
base: main
Choose a base branch
from

Conversation

brustolin
Copy link
Contributor

📜 Description

Renaming SR redact to mask and ignoretounmask`

📝 Checklist

You have to check all boxes before merging:

  • I reviewed the submitted code.
  • I added tests to verify the changes.
  • No new PII added or SDK only sends newly added PII if sendDefaultPII is enabled.
  • I updated the docs if needed.
  • Review from the native team if needed.
  • No breaking change or entry added to the changelog. - This is an experimental feature breaking change
  • No breaking change for hybrid SDKs or communicated to hybrid SDKs.

🔮 Next steps

Copy link

github-actions bot commented Sep 26, 2024

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

Generated by 🚫 dangerJS against bbc5a2f

Copy link
Member

@philipphofmann philipphofmann left a comment

Choose a reason for hiding this comment

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

LGTM, if the SR team is on board with this.

Copy link

github-actions bot commented Sep 27, 2024

Performance metrics 🚀

  Plain With Sentry Diff
Startup time 1234.04 ms 1249.45 ms 15.41 ms
Size 21.58 KiB 736.49 KiB 714.91 KiB

Baseline results on branch: main

Startup times

Revision Plain With Sentry Diff
1bf8571 1250.96 ms 1255.36 ms 4.40 ms
2ccbd03 1225.13 ms 1247.51 ms 22.39 ms
d011484 1220.86 ms 1237.18 ms 16.33 ms
6001822 1220.82 ms 1245.02 ms 24.20 ms
3723833 1205.22 ms 1216.94 ms 11.71 ms
ff09c7e 1240.94 ms 1262.66 ms 21.72 ms
b9d59f7 1250.71 ms 1257.78 ms 7.06 ms
94d8eb3 1234.02 ms 1249.63 ms 15.60 ms
e773cad 1219.86 ms 1238.26 ms 18.40 ms
90d17d3 1261.18 ms 1278.18 ms 17.00 ms

App size

Revision Plain With Sentry Diff
1bf8571 20.76 KiB 437.12 KiB 416.36 KiB
2ccbd03 21.58 KiB 546.20 KiB 524.62 KiB
d011484 21.58 KiB 616.14 KiB 594.56 KiB
6001822 22.85 KiB 410.98 KiB 388.13 KiB
3723833 21.58 KiB 424.34 KiB 402.76 KiB
ff09c7e 20.76 KiB 427.76 KiB 407.00 KiB
b9d59f7 22.85 KiB 405.77 KiB 382.93 KiB
94d8eb3 21.58 KiB 417.86 KiB 396.28 KiB
e773cad 21.58 KiB 681.75 KiB 660.17 KiB
90d17d3 20.76 KiB 432.17 KiB 411.41 KiB

Previous results on branch: feat/SwiftSR-Unmask

Startup times

Revision Plain With Sentry Diff
221bac5 1230.65 ms 1263.98 ms 33.32 ms
fced421 1205.98 ms 1231.35 ms 25.37 ms

App size

Revision Plain With Sentry Diff
221bac5 21.58 KiB 737.55 KiB 715.97 KiB
fced421 21.58 KiB 737.56 KiB 715.98 KiB

Copy link

codecov bot commented Sep 27, 2024

Codecov Report

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

Project coverage is 91.461%. Comparing base (e88fe9a) to head (2a7a73a).
Report is 3 commits behind head on main.

Files with missing lines Patch % Lines
Sources/SentrySwiftUI/SentryReplayView.swift 50.000% 1 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@              Coverage Diff              @@
##              main     #4373       +/-   ##
=============================================
+ Coverage   91.450%   91.461%   +0.010%     
=============================================
  Files          629       629               
  Lines        50625     50619        -6     
  Branches     18346     18338        -8     
=============================================
  Hits         46297     46297               
+ Misses        4235      4228        -7     
- Partials        93        94        +1     
Files with missing lines Coverage Δ
Sources/Sentry/SentryReplayApi.m 25.000% <100.000%> (ø)
Sources/Swift/Extensions/UIViewExtensions.swift 100.000% <100.000%> (ø)
...tegrations/SessionReplay/SentryReplayOptions.swift 93.103% <100.000%> (ø)
Sources/Swift/Tools/UIRedactBuilder.swift 96.491% <100.000%> (ø)
...onReplay/SentrySessionReplayIntegrationTests.swift 98.636% <100.000%> (ø)
...entryTests/SwiftUI/SentryRedactModifierTests.swift 100.000% <100.000%> (ø)
Tests/SentryTests/UIRedactBuilderTests.swift 100.000% <100.000%> (ø)
Sources/SentrySwiftUI/SentryReplayView.swift 20.000% <50.000%> (ø)

... and 5 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e88fe9a...2a7a73a. Read the comment docs.

@@ -62,11 +62,11 @@ class UIRedactBuilder {
init(options: SentryRedactOptions) {
var redactClasses = [AnyClass]()

if options.redactAllText {
if options.maskAllText {
Copy link
Collaborator

Choose a reason for hiding this comment

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

redactAllText is still present in comments & method docs

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.

4 participants