perf(session-replay): Reduce capture stutters #7851
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,126 @@ | ||
| #if canImport(UIKit) && !SENTRY_NO_UI_FRAMEWORK | ||
| #if os(iOS) || os(tvOS) | ||
| import UIKit | ||
|
|
||
| // Centralizes subtree traversal and exclusion matching for redaction and capture activity checks. | ||
| // | ||
| // The final decision is computed at runtime using the formula: | ||
| // | ||
| // Default View Classes + Excluded View Classes - Included View Classes | ||
| // | ||
| // SDK users can add exclusions via options.excludedViewClasses and remove defaults via options.includedViewClasses. | ||
| // Matching rules: | ||
| // - Excluded patterns use partial matching (contains): "MyView" matches "MyApp.MyView", "MyViewSubclass", etc. | ||
| // - Included patterns use exact matching (Set.contains): "MyViewSubclass" only matches exactly "MyViewSubclass" | ||
| // | ||
| // This prevents accidental matches where "ChromeCameraUI" is excluded but "Camera" is included from causing crashes. | ||
| enum SentryViewSubtreeTraversal { | ||
|
Member
There was a problem hiding this comment.
Member
Author
|
||
| /// Class identifier for ``CameraUI.ChromeSwiftUIView``, if it exists. | ||
| /// | ||
| /// This class name is used to identify views of this class type during subtree exclusion. | ||
| /// This workaround is specifically for Xcode 16 building for iOS 26 where accessing CameraUI.ModeLoupeLayer | ||
| /// causes a crash due to unimplemented init(layer:) initializer. | ||
| private static let cameraChromeSwiftUIViewClassPattern = "CameraUI.ChromeSwiftUIView" | ||
|
|
||
| static func isExcluded(_ view: UIView, options: SentryRedactOptions) -> Bool { | ||
| isExcluded( | ||
| view, | ||
| excludedViewClassPatterns: defaultExcludedViewClassPatterns.union(options.excludedViewClasses), | ||
| includedViewClassPatterns: options.includedViewClasses | ||
| ) | ||
|
cursor[bot] marked this conversation as resolved.
|
||
| } | ||
|
|
||
| @discardableResult | ||
| static func traverse(_ view: UIView, options: SentryRedactOptions, _ visit: (UIView) -> Bool) -> Bool { | ||
| traverse( | ||
| view, | ||
| excludedViewClassPatterns: defaultExcludedViewClassPatterns.union(options.excludedViewClasses), | ||
| includedViewClassPatterns: options.includedViewClasses, | ||
| visit | ||
| ) | ||
| } | ||
|
|
||
| @discardableResult | ||
| private static func traverse( | ||
| _ view: UIView, | ||
| excludedViewClassPatterns: Set<String>, | ||
| includedViewClassPatterns: Set<String>, | ||
| _ visit: (UIView) -> Bool | ||
| ) -> Bool { | ||
| if isExcluded( | ||
| view, | ||
| excludedViewClassPatterns: excludedViewClassPatterns, | ||
| includedViewClassPatterns: includedViewClassPatterns | ||
| ) { | ||
| return false | ||
| } | ||
|
|
||
| if visit(view) { | ||
| return true | ||
| } | ||
|
|
||
| return view.subviews.contains { | ||
| traverse( | ||
| $0, | ||
| excludedViewClassPatterns: excludedViewClassPatterns, | ||
| includedViewClassPatterns: includedViewClassPatterns, | ||
| visit | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| static var defaultExcludedViewClassPatterns: Set<String> { | ||
| var result: Set<String> = [] | ||
| #if os(iOS) | ||
| if #available(iOS 26.0, *) { | ||
| result.insert(cameraChromeSwiftUIViewClassPattern) | ||
| } | ||
| #endif | ||
| return result | ||
| } | ||
|
|
||
| static func isExcluded( | ||
| _ view: UIView, | ||
| excludedViewClassPatterns: Set<String>, | ||
| includedViewClassPatterns: Set<String> | ||
| ) -> Bool { | ||
| // We intentionally avoid using `NSClassFromString` or directly referencing class objects here, | ||
| // because both approaches can trigger the Objective-C `+initialize` method on the class. | ||
| // This has side effects and can cause crashes, especially when performed off the main thread | ||
| // or with UIKit classes that expect to be initialized on the main thread. | ||
| // | ||
| // Instead, we use the string description of the type (i.e., `type(of: view).description()`) | ||
| // for comparison. This is a safer, more "Swifty" approach that avoids the pitfalls of | ||
| // class initialization side effects. | ||
| // | ||
| // We have previously encountered related issues: | ||
| // - In EmergeTools' snapshotting code where using `NSClassFromString` led to crashes [1] | ||
| // - In Sentry's own SubClassFinder where storing or accessing class objects on a background thread caused crashes due to `+initialize` being called on UIKit classes [2] | ||
| // | ||
| // [1] https://github.com/EmergeTools/SnapshotPreviews/blob/main/Sources/SnapshotPreviewsCore/View%2BSnapshot.swift#L248 | ||
| // [2] Sources/Swift/Core/Integrations/Performance/SentrySubClassFinder.swift | ||
| let viewTypeId = type(of: view).description() | ||
|
Member
There was a problem hiding this comment.
|
||
|
|
||
| // Check if the view type id is in the list of included view classes (exact matching). | ||
| // If yes we can exit early as this list overrules other matchings. | ||
| if includedViewClassPatterns.contains(viewTypeId) { | ||
| // Matches included pattern exactly, so don't ignore subtree | ||
| return false | ||
| } | ||
|
|
||
| // Check excluded patterns using partial matching, with overruling using the included patterns with exact matching. | ||
| // | ||
| // For example, excluding "ChromeCameraUI" will match "MyApp.ChromeCameraUI", "ChromeCameraUISubclass", etc. | ||
| // | ||
| // However, if "ChromeCameraUI" is excluded and "Camera" is included, "ChromeCameraUI" will | ||
| // still be excluded because "Camera" doesn't exactly match "ChromeCameraUI". | ||
| for pattern in excludedViewClassPatterns where viewTypeId.contains(pattern) { | ||
| // Matches excluded but not exactly included, so ignore subtree | ||
| return true | ||
| } | ||
|
|
||
| return false | ||
| } | ||
| } | ||
| #endif | ||
| #endif | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -25,15 +25,7 @@ import UIKit | |
| displayLink?.invalidate() | ||
| displayLink = nil | ||
| } | ||
| } | ||
|
|
||
| #endif | ||
| // swiftlint:enable missing_docs | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
l: You removed quite some context from the comment block of why we usetype(of:)here. Is that intentional?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nope, was just slop, addressed in a00514d