feat: Session replay masking preview for SwiftUI #4737

brustolin · 2025-01-21T15:03:56Z

📜 Description

Allows the user to preview how its app session replay will be masked during development.

💡 Motivation and Context

closes #4633

💚 How did you test it?

Sample

📝 Checklist

You have to check all boxes before merging:

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.
I updated the wizard if needed.
Review from the native team if needed.
No breaking change or entry added to the changelog.
No breaking change for hybrid SDKs or communicated to hybrid SDKs.

🔮 Next steps

github-actions · 2025-01-21T15:08:37Z

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

Generated by 🚫 dangerJS against f0a3ba7

github-actions · 2025-01-21T15:21:02Z

Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	1224.00 ms	1247.29 ms	23.29 ms
Size	22.31 KiB	775.80 KiB	753.48 KiB

Baseline results on branch: main

Startup times

Revision	Plain	With Sentry	Diff
`c151c14`	1223.18 ms	1246.56 ms	23.38 ms
`9324d27`	1242.25 ms	1255.15 ms	12.90 ms
`a176fc4`	1250.29 ms	1257.88 ms	7.59 ms
`e19cca3`	1211.69 ms	1231.04 ms	19.35 ms
`c586015`	1221.20 ms	1236.80 ms	15.59 ms
`279841c`	1237.29 ms	1254.12 ms	16.83 ms
`1a4da1b`	1222.14 ms	1239.50 ms	17.36 ms
`9f57953`	1232.83 ms	1249.87 ms	17.04 ms
`e71cf92`	1201.69 ms	1226.52 ms	24.83 ms
`5c6ef23`	1237.33 ms	1252.58 ms	15.25 ms

App size

Revision	Plain	With Sentry	Diff
`c151c14`	21.58 KiB	678.19 KiB	656.61 KiB
`9324d27`	21.58 KiB	707.43 KiB	685.85 KiB
`a176fc4`	22.84 KiB	403.24 KiB	380.39 KiB
`e19cca3`	21.58 KiB	669.74 KiB	648.16 KiB
`c586015`	21.58 KiB	616.73 KiB	595.15 KiB
`279841c`	22.84 KiB	403.19 KiB	380.34 KiB
`1a4da1b`	21.58 KiB	418.33 KiB	396.75 KiB
`9f57953`	22.31 KiB	773.84 KiB	751.53 KiB
`e71cf92`	20.76 KiB	419.85 KiB	399.10 KiB
`5c6ef23`	21.90 KiB	708.96 KiB	687.05 KiB

Previous results on branch: feat/sr-masking-preview

Startup times

Revision	Plain	With Sentry	Diff
`1c17d33`	1231.41 ms	1249.06 ms	17.65 ms
`6afd6ed`	1230.51 ms	1251.27 ms	20.76 ms

App size

Revision	Plain	With Sentry	Diff
`1c17d33`	22.31 KiB	775.80 KiB	753.48 KiB
`6afd6ed`	22.31 KiB	775.64 KiB	753.32 KiB

codecov · 2025-01-21T15:21:27Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.202%. Comparing base (ba3679b) to head (f0a3ba7).

Additional details and impacted files

@@              Coverage Diff              @@
##              main     #4737       +/-   ##
=============================================
+ Coverage   91.194%   91.202%   +0.007%     
=============================================
  Files          623       623               
  Lines        72498     72507        +9     
  Branches     26411     26413        +2     
=============================================
+ Hits         66114     66128       +14     
+ Misses        6285      6280        -5     
  Partials        99        99

Files with missing lines	Coverage Δ
Sources/Sentry/SentrySDK.m	`87.613% <100.000%> (ø)`
Sources/Swift/Protocol/SentryRedactOptions.swift	`100.000% <100.000%> (ø)`
Sources/Swift/Tools/SentryViewPhotographer.swift	`89.090% <100.000%> (ø)`
Tests/SentryTests/SentrySDKTests.swift	`96.778% <100.000%> (+0.032%)`	⬆️

... and 12 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 ba3679b...f0a3ba7. Read the comment docs.

Samples/iOS-SwiftUI/iOS-SwiftUI/SwiftUIApp.swift

Sources/SentrySwiftUI/Preview/SentryReplayMaskPreview.swift

philprime · 2025-01-23T09:17:41Z

Sources/Swift/Tools/SentryViewPhotographer.swift

@@ -20,24 +20,24 @@ class DefaultViewRenderer: ViewRenderer {
 }

 @objcMembers
-class SentryViewPhotographer: NSObject, SentryViewScreenshotProvider {
+public class SentryViewPhotographer: NSObject, SentryViewScreenshotProvider {


@philipphofmann will probably not agree with changing this to public, we should at least somehow mark this class as "internal use only"

We should stop using hacky solutions and add a lot of "code smells" into the code.
If the user try to use an undocumented class, that is not part of the main product, let them try.

philipphofmann

I see potential, that we can use the solution for debugging any iOS app. If I'm not mistaken we don't need to limit this for SwiftUI Previews. Or am I missing something, @brustolin?

Sources/Sentry/SentrySDK.m

philipphofmann · 2025-01-23T13:22:00Z

Sources/Swift/Protocol/SentryRedactOptions.swift

@@ -1,7 +1,7 @@
 import Foundation

 @objc
-protocol SentryRedactOptions {
+public protocol SentryRedactOptions {


m: I'm a bit confused about why we need a protocol for this and two separate implementations: SentryRedactDefaultOptions and PreviewRedactOptions. Can't we ditch the protocol and have one public final class for this?

IMO protocol is the best approach, it gives a lot of flexibility and separation of concerns.

We can make SentryReplayOptions implement SentryRedactOptionsSentry without the need to have another level in the replay options.

And we can have a simpler object for screenshot redact, and then another one for preview redact, maybe with more options in there specific for preview.

Sources/Sentry/SentrySDK.m

philipphofmann · 2025-01-23T13:30:49Z

Sources/SentrySwiftUI/Preview/SentryReplayMaskPreview.swift

+    func sentryReplayPreviewMask(redactOptions: SentryRedactOptions? = nil, opacity: Float = 1) -> some View {
+        let options = redactOptions ?? SentrySDK.options?.sessionReplay ?? PreviewRedactOptions()


m: What's the use case for passing different redactOptions than the ones from SentrySDK.options?.sessionReplay?

It’s up to the user to decide how they will use this. They might try different configurations directly from the preview without changing the project options.

philipphofmann · 2025-01-23T13:39:09Z

Sources/SentrySwiftUI/Preview/SentryReplayMaskPreviewUIView.swift

+        if ProcessInfo.processInfo.environment[SENTRY_XCODE_PREVIEW_ENVIRONMENT_KEY] == "1" {
+            displayLink = CADisplayLink(target: self, selector: #selector(update))
+            displayLink?.add(to: .main, forMode: .common)
+        } else {
+            print("[SENTRY] [WARNING] SentryReplayMaskPreview is not meant to be used in your app, only with SwiftUI Previews.")
+        }


h: Why limit this functionality only to previews? If somebody wants to use it when running the app on a simulator, let them. I quickly tried it, and it works. Or am I missing something?

If somebody wants to use it...

This could be said for so many things.
I choose to make it harder for the user to forget this on the app by mistake.

We can discuss this approach, but so far we had zero request for it.

Sources/SentrySwiftUI/Preview/SentryReplayMaskPreviewUIView.swift

philipphofmann · 2025-01-23T14:02:46Z

Sources/SentrySwiftUI/Preview/SentryReplayMaskPreviewUIView.swift

+@_implementationOnly import SentryInternal
+#endif
+
+class SentryReplayMaskPreviewUIView: UIView {


h: We can move this to the main Sentry package as it has no dependencies on SwiftUI. @brustolin I think we could also use this for non SwiftUI apps. We could port this so people can use this with an option for any iOS app while debugging. With that we could also keep the SentryViewPhotographer internal.

We could, not sure if we should. It think session replay should have its own lib.
Moving this to main just change what needs to be public, because this would need to be public in order for SentrySwiftUI to use it.

Lets go step-by-step.
After finishing this PR for SwiftUI we can debate debugging it for UIKit that has no preview.

brustolin · 2025-01-24T06:25:34Z

I see potential, that we can use the solution for debugging any iOS app

Yes, technically we could also use it while running in debug.
Step-by-step

Co-authored-by: Philipp Hofmann <philipp.hofmann@sentry.io>

…y/sentry-cocoa into feat/sr-masking-preview

brustolin and others added 3 commits January 21, 2025 16:01

Masking preview for SwiftUI

b893e95

Update CHANGELOG.md

ff2ad50

Merge branch 'main' into feat/sr-masking-preview

5555827

brustolin marked this pull request as ready for review January 22, 2025 12:04

brustolin requested review from philipphofmann, armcknight and philprime as code owners January 22, 2025 12:04

brustolin commented Jan 22, 2025

View reviewed changes

Samples/iOS-SwiftUI/iOS-SwiftUI/SwiftUIApp.swift Outdated Show resolved Hide resolved

Update Samples/iOS-SwiftUI/iOS-SwiftUI/SwiftUIApp.swift

afcb89e

philprime reviewed Jan 23, 2025

View reviewed changes

wip

efdbf25

philipphofmann reviewed Jan 23, 2025

View reviewed changes

brustolin and others added 7 commits January 24, 2025 07:37

Merge branch 'main' into feat/sr-masking-preview

87b1b46

Apply suggestions from code review

ef26620

Co-authored-by: Philipp Hofmann <philipp.hofmann@sentry.io>

more fixes

b402fe6

Merge branch 'feat/sr-masking-preview' of https://github.com/getsentr…

6a9b2ac

…y/sentry-cocoa into feat/sr-masking-preview

Update SentryReplayMaskPreview.swift

88fce2d

Update SentrySDKTests.swift

fd559e9

Update CHANGELOG.md

f0a3ba7

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Session replay masking preview for SwiftUI #4737

feat: Session replay masking preview for SwiftUI #4737

brustolin commented Jan 21, 2025 •

edited

Loading

github-actions bot commented Jan 21, 2025 •

edited

Loading

github-actions bot commented Jan 21, 2025 •

edited

Loading

Baseline results on branch: main

Startup times

App size

Previous results on branch: feat/sr-masking-preview

Startup times

App size

codecov bot commented Jan 21, 2025 •

edited

Loading

philprime Jan 23, 2025

brustolin Jan 23, 2025

philipphofmann left a comment

philipphofmann Jan 23, 2025

brustolin Jan 24, 2025

philipphofmann Jan 23, 2025

brustolin Jan 24, 2025

philipphofmann Jan 23, 2025

brustolin Jan 24, 2025

philipphofmann Jan 23, 2025

brustolin Jan 24, 2025 •

edited

Loading

brustolin commented Jan 24, 2025

		func sentryReplayPreviewMask(redactOptions: SentryRedactOptions? = nil, opacity: Float = 1) -> some View {
		let options = redactOptions ?? SentrySDK.options?.sessionReplay ?? PreviewRedactOptions()

feat: Session replay masking preview for SwiftUI #4737

Are you sure you want to change the base?

feat: Session replay masking preview for SwiftUI #4737

Conversation

brustolin commented Jan 21, 2025 • edited Loading

📜 Description

💡 Motivation and Context

💚 How did you test it?

📝 Checklist

🔮 Next steps

github-actions bot commented Jan 21, 2025 • edited Loading

github-actions bot commented Jan 21, 2025 • edited Loading

Performance metrics 🚀

Baseline results on branch: main

Startup times

App size

Previous results on branch: feat/sr-masking-preview

Startup times

App size

codecov bot commented Jan 21, 2025 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

philipphofmann left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

brustolin Jan 24, 2025 • edited Loading

Choose a reason for hiding this comment

brustolin commented Jan 24, 2025

brustolin commented Jan 21, 2025 •

edited

Loading

github-actions bot commented Jan 21, 2025 •

edited

Loading

github-actions bot commented Jan 21, 2025 •

edited

Loading

codecov bot commented Jan 21, 2025 •

edited

Loading

brustolin Jan 24, 2025 •

edited

Loading