ref: SentryUIViewControllerPerformanceTracker in Swift (#6422)

Author: noahsmartin

Sentry.xcodeproj/project.pbxproj

@@ -712,9 +712,9 @@
 		8EA9AF492665AC48002771B4 /* SentryPerformanceTrackerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8EA9AF482665AC48002771B4 /* SentryPerformanceTrackerTests.swift */; };
 		8EAC7FF8265C8910005B44E5 /* SentryTracerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8EAC7FF7265C8910005B44E5 /* SentryTracerTests.swift */; };
 		8EAE8E5E2681768000D6958B /* URLSessionTaskMock.m in Sources */ = {isa = PBXBuildFile; fileRef = 8EAE8E5D2681768000D6958B /* URLSessionTaskMock.m */; };
-		8EAE9806261E87120073B6B3 /* SentryUIViewControllerPerformanceTracker.m in Sources */ = {isa = PBXBuildFile; fileRef = 8EAE9804261E87120073B6B3 /* SentryUIViewControllerPerformanceTracker.m */; };
+		8EAE9806261E87120073B6B3 /* SentryDefaultUIViewControllerPerformanceTracker.m in Sources */ = {isa = PBXBuildFile; fileRef = 8EAE9804261E87120073B6B3 /* SentryDefaultUIViewControllerPerformanceTracker.m */; };
 		8EAE980B261E9F530073B6B3 /* SentryPerformanceTracker.h in Headers */ = {isa = PBXBuildFile; fileRef = 8EAE9809261E9F530073B6B3 /* SentryPerformanceTracker.h */; };
-		8EAE980C261E9F530073B6B3 /* SentryUIViewControllerPerformanceTracker.h in Headers */ = {isa = PBXBuildFile; fileRef = 8EAE980A261E9F530073B6B3 /* SentryUIViewControllerPerformanceTracker.h */; };
+		8EAE980C261E9F530073B6B3 /* SentryDefaultUIViewControllerPerformanceTracker.h in Headers */ = {isa = PBXBuildFile; fileRef = 8EAE980A261E9F530073B6B3 /* SentryDefaultUIViewControllerPerformanceTracker.h */; };
 		8EBF870926140D37001A6853 /* SentryPerformanceTracker.m in Sources */ = {isa = PBXBuildFile; fileRef = 8EBF870726140D37001A6853 /* SentryPerformanceTracker.m */; };
 		8EC3AE7A25CA23B600E7591A /* SentrySpan.m in Sources */ = {isa = PBXBuildFile; fileRef = 8EC3AE7925CA23B600E7591A /* SentrySpan.m */; };
 		8EC4CF4A25C38DAA0093DEE9 /* SentrySpanStatus.h in Headers */ = {isa = PBXBuildFile; fileRef = 8EC4CF4725C38CAF0093DEE9 /* SentrySpanStatus.h */; settings = {ATTRIBUTES = (Public, ); }; };
@@ -1114,6 +1114,7 @@
 		FAAB2EE02E4BE97500FE8B7E /* TestSentryNSApplication.swift in Sources */ = {isa = PBXBuildFile; fileRef = FAAB2EDF2E4BE96F00FE8B7E /* TestSentryNSApplication.swift */; };
 		FAAB2F972E4D345800FE8B7E /* SentryUIDeviceWrapper.swift in Sources */ = {isa = PBXBuildFile; fileRef = FAAB2F962E4D344F00FE8B7E /* SentryUIDeviceWrapper.swift */; };
 		FAAB30F32E4E8F2C00FE8B7E /* SentryInAppLogic.swift in Sources */ = {isa = PBXBuildFile; fileRef = FAAB30F22E4E8F2C00FE8B7E /* SentryInAppLogic.swift */; };
+		FAB007362E9EF8D3001C806A /* SentryUIViewControllerPerformanceTracker.swift in Sources */ = {isa = PBXBuildFile; fileRef = FAB007302E9EF8CB001C806A /* SentryUIViewControllerPerformanceTracker.swift */; };
 		FAB359982E05D7E90083D5E3 /* SentryEventSwiftHelper.h in Headers */ = {isa = PBXBuildFile; fileRef = FAB359972E05D7E90083D5E3 /* SentryEventSwiftHelper.h */; };
 		FAB3599A2E05D8080083D5E3 /* SentryEventSwiftHelper.m in Sources */ = {isa = PBXBuildFile; fileRef = FAB359992E05D8080083D5E3 /* SentryEventSwiftHelper.m */; };
 		FAB7BBA92E2577A6007301E1 /* SentryModels+Serializable.h in Headers */ = {isa = PBXBuildFile; fileRef = FAB7BBA82E2577A2007301E1 /* SentryModels+Serializable.h */; };
@@ -2053,9 +2054,9 @@
 		8EAC7FF7265C8910005B44E5 /* SentryTracerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryTracerTests.swift; sourceTree = "<group>"; };
 		8EAE8E5C2681768000D6958B /* URLSessionTaskMock.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = URLSessionTaskMock.h; sourceTree = "<group>"; };
 		8EAE8E5D2681768000D6958B /* URLSessionTaskMock.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = URLSessionTaskMock.m; sourceTree = "<group>"; };
-		8EAE9804261E87120073B6B3 /* SentryUIViewControllerPerformanceTracker.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = SentryUIViewControllerPerformanceTracker.m; sourceTree = "<group>"; };
+		8EAE9804261E87120073B6B3 /* SentryDefaultUIViewControllerPerformanceTracker.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = SentryDefaultUIViewControllerPerformanceTracker.m; sourceTree = "<group>"; };
 		8EAE9809261E9F530073B6B3 /* SentryPerformanceTracker.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = SentryPerformanceTracker.h; path = include/SentryPerformanceTracker.h; sourceTree = "<group>"; };
-		8EAE980A261E9F530073B6B3 /* SentryUIViewControllerPerformanceTracker.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = SentryUIViewControllerPerformanceTracker.h; path = include/SentryUIViewControllerPerformanceTracker.h; sourceTree = "<group>"; };
+		8EAE980A261E9F530073B6B3 /* SentryDefaultUIViewControllerPerformanceTracker.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = SentryDefaultUIViewControllerPerformanceTracker.h; path = include/SentryDefaultUIViewControllerPerformanceTracker.h; sourceTree = "<group>"; };
 		8EBF870726140D37001A6853 /* SentryPerformanceTracker.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = SentryPerformanceTracker.m; sourceTree = "<group>"; };
 		8EC3AE7925CA23B600E7591A /* SentrySpan.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = SentrySpan.m; sourceTree = "<group>"; };
 		8EC4CF4725C38CAF0093DEE9 /* SentrySpanStatus.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = SentrySpanStatus.h; path = Public/SentrySpanStatus.h; sourceTree = "<group>"; };
@@ -2476,6 +2477,7 @@
 		FAAB2EDF2E4BE96F00FE8B7E /* TestSentryNSApplication.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TestSentryNSApplication.swift; sourceTree = "<group>"; };
 		FAAB2F962E4D344F00FE8B7E /* SentryUIDeviceWrapper.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryUIDeviceWrapper.swift; sourceTree = "<group>"; };
 		FAAB30F22E4E8F2C00FE8B7E /* SentryInAppLogic.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryInAppLogic.swift; sourceTree = "<group>"; };
+		FAB007302E9EF8CB001C806A /* SentryUIViewControllerPerformanceTracker.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryUIViewControllerPerformanceTracker.swift; sourceTree = "<group>"; };
 		FAB359972E05D7E90083D5E3 /* SentryEventSwiftHelper.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = SentryEventSwiftHelper.h; path = include/SentryEventSwiftHelper.h; sourceTree = "<group>"; };
 		FAB359992E05D8080083D5E3 /* SentryEventSwiftHelper.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = SentryEventSwiftHelper.m; sourceTree = "<group>"; };
 		FAB7BBA82E2577A2007301E1 /* SentryModels+Serializable.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = "SentryModels+Serializable.h"; path = "include/SentryModels+Serializable.h"; sourceTree = "<group>"; };
@@ -3740,8 +3742,8 @@
 			children = (
 				8EA1ED0C2669028C00E62B98 /* SentryUIViewControllerSwizzling.h */,
 				8EA1ED092668F8C400E62B98 /* SentryUIViewControllerSwizzling.m */,
-				8EAE980A261E9F530073B6B3 /* SentryUIViewControllerPerformanceTracker.h */,
-				8EAE9804261E87120073B6B3 /* SentryUIViewControllerPerformanceTracker.m */,
+				8EAE980A261E9F530073B6B3 /* SentryDefaultUIViewControllerPerformanceTracker.h */,
+				8EAE9804261E87120073B6B3 /* SentryDefaultUIViewControllerPerformanceTracker.m */,
 				8EAE9809261E9F530073B6B3 /* SentryPerformanceTracker.h */,
 				8EBF870726140D37001A6853 /* SentryPerformanceTracker.m */,
 				D8BFE37029A3782F002E73F3 /* SentryTimeToDisplayTracker.h */,
@@ -4577,6 +4579,7 @@
 		D8739CF72BECFF92007D2F66 /* Performance */ = {
 			isa = PBXGroup;
 			children = (
+				FAB007302E9EF8CB001C806A /* SentryUIViewControllerPerformanceTracker.swift */,
 				FAE57BF12E83049900B710F9 /* SentryDisplayLinkWrapper.swift */,
 				D468C0602D36699700964230 /* IO */,
 			);
@@ -5015,7 +5018,7 @@
 				D8ACE3CD2762187D00F5A213 /* SentryNSDataSwizzling.h in Headers */,
 				7B08A3452924CF6C0059603A /* SentryMetricKitIntegration.h in Headers */,
 				0A2D8DA8289BC905008720F6 /* SentryViewHierarchyProviderHelper.h in Headers */,
-				8EAE980C261E9F530073B6B3 /* SentryUIViewControllerPerformanceTracker.h in Headers */,
+				8EAE980C261E9F530073B6B3 /* SentryDefaultUIViewControllerPerformanceTracker.h in Headers */,
 				63FE717D20DA4C1100CDBAE8 /* SentryCrashCachedData.h in Headers */,
 				03BCC38A27E1BF49003232C7 /* SentryTime.h in Headers */,
 				925824C22CB5897700C9B20B /* SentrySessionReplayIntegration-Hybrid.h in Headers */,
@@ -5996,9 +5999,10 @@
 				8ECC674925C23A20000E2BF6 /* SentrySpanId.m in Sources */,
 				6344DDB51EC309E000D9160D /* SentryCrashReportSink.m in Sources */,
 				D43B26D62D70964C007747FD /* SentrySpanOperation.m in Sources */,
-				8EAE9806261E87120073B6B3 /* SentryUIViewControllerPerformanceTracker.m in Sources */,
+				8EAE9806261E87120073B6B3 /* SentryDefaultUIViewControllerPerformanceTracker.m in Sources */,
 				D81988C72BEC18E20020E36C /* SentryRRWebVideoEvent.swift in Sources */,
 				621F61F12BEA073A005E654F /* SentryEnabledFeaturesBuilder.swift in Sources */,
+				FAB007362E9EF8D3001C806A /* SentryUIViewControllerPerformanceTracker.swift in Sources */,
 				D88817D826D7149100BF2251 /* SentryTraceContext.m in Sources */,
 				D8F67B1B2BE9728600C9197B /* SentrySRDefaultBreadcrumbConverter.swift in Sources */,
 				8EBF870926140D37001A6853 /* SentryPerformanceTracker.m in Sources */,

SentryTestUtils/SentryTestUtils-ObjC-BridgingHeader.h

@@ -8,8 +8,8 @@
 
 #if SENTRY_HAS_UIKIT
 #    import "SentryAppStartTracker.h"
+#    import "SentryDefaultUIViewControllerPerformanceTracker.h"
 #    import "SentryFramesTracker+TestInit.h"
-#    import "SentryUIViewControllerPerformanceTracker.h"
 #endif // SENTRY_HAS_UIKIT
 
 #import "SentryProfilingConditionals.h"

Sources/Sentry/SentryUIViewControllerPerformanceTracker.m renamed to Sources/Sentry/SentryDefaultUIViewControllerPerformanceTracker.m

@@ -1,4 +1,4 @@
-#import "SentryUIViewControllerPerformanceTracker.h"
+#import "SentryDefaultUIViewControllerPerformanceTracker.h"
 #import "SentryInternalDefines.h"
 
 #if SENTRY_HAS_UIKIT
@@ -23,7 +23,10 @@ @interface SentryTimeToDisplayTracker () <SentryInitialDisplayReporting>
 
 @end
 
-@implementation SentrySwiftUISpanHelper
+@interface SentryObjCSwiftUISpanHelper ()
+@end
+
+@implementation SentryObjCSwiftUISpanHelper
 
 - (instancetype)initWithHasSpan:(BOOL)hasSpan
         initialDisplayReporting:(id<SentryInitialDisplayReporting>)initialDisplayReporting
@@ -63,7 +66,7 @@ - (instancetype)initWithHasSpan:(BOOL)hasSpan
 // remove any entries with weak keys that have been deallocated. This will ensure that we don't
 // keep any references to deallocated objects in the map tables and have a memory leak.
 
-@interface SentryUIViewControllerPerformanceTracker ()
+@interface SentryDefaultUIViewControllerPerformanceTracker ()
 
 @property (nonatomic, strong) SentryPerformanceTracker *tracker;
 @property (nullable, nonatomic, weak) SentryTimeToDisplayTracker *currentTTDTracker;
@@ -79,7 +82,7 @@ @interface SentryUIViewControllerPerformanceTracker ()
 
 @end
 
-@implementation SentryUIViewControllerPerformanceTracker
+@implementation SentryDefaultUIViewControllerPerformanceTracker
 
 - (instancetype)initWithTracker:(SentryPerformanceTracker *)tracker
            dispatchQueueWrapper:(SentryDispatchQueueWrapper *)dispatchQueueWrapper
@@ -276,7 +279,7 @@ - (SentrySwiftUISpanHelper *)startTimeToDisplayTrackerForScreen:(NSString *)scre
 {
     id<SentrySpan> span = [SentryPerformanceTracker.shared getSpan:transactionId];
     if (span != nil && [span isKindOfClass:[SentryTracer class]]) {
-        id<SentryInitialDisplayReporting> displayReporting =
+        SentryTimeToDisplayTracker *displayReporting =
             [self startTimeToDisplayTrackerForScreen:screenName
                                   waitForFullDisplay:waitforFullDisplay
                                               tracer:(SentryTracer *)span];
@@ -286,6 +289,20 @@ - (SentrySwiftUISpanHelper *)startTimeToDisplayTrackerForScreen:(NSString *)scre
     return [[SentrySwiftUISpanHelper alloc] initWithHasSpan:NO initialDisplayReporting:nil];
 }
 
++ (SentryObjCSwiftUISpanHelper *)startTimeToDisplayTrackerForScreen:(NSString *)screenName
+                                                 waitForFullDisplay:(BOOL)waitforFullDisplay
+                                                      transactionId:(SentrySpanId *)transactionId;
+{
+    id<SentryUIViewControllerPerformanceTracker> vcTracker
+        = SentryDependencyContainer.sharedInstance.uiViewControllerPerformanceTracker;
+    SentrySwiftUISpanHelper *result =
+        [vcTracker startTimeToDisplayTrackerForScreen:screenName
+                                   waitForFullDisplay:waitforFullDisplay
+                                        transactionId:transactionId];
+    return [[SentryObjCSwiftUISpanHelper alloc] initWithHasSpan:result.hasSpan
+                                        initialDisplayReporting:result.initialDisplayReporting];
+}
+
 - (void)viewControllerViewWillAppear:(UIViewController *)controller
                     callbackToOrigin:(void (^)(void))callbackToOrigin
 {

Sources/Sentry/SentryDependencyContainer.m

@@ -13,13 +13,13 @@
 #import <SentryCrash.h>
 #import <SentryDebugImageProvider+HybridSDKs.h>
 #import <SentryDefaultAppStateManager.h>
+#import <SentryDefaultUIViewControllerPerformanceTracker.h>
 #import <SentryDependencyContainer.h>
 #import <SentryPerformanceTracker.h>
 #import <SentrySDK+Private.h>
 #import <SentrySwift.h>
 #import <SentrySwizzleWrapper.h>
 #import <SentryTracer.h>
-#import <SentryUIViewControllerPerformanceTracker.h>
 #import <SentryWatchdogTerminationScopeObserver.h>
 
 #if SENTRY_HAS_UIKIT
@@ -65,6 +65,12 @@ @interface SentryFileManager () <SentryFileManagerProtocol>
 @interface SentryDefaultAppStateManager () <SentryAppStateManager>
 @end
 
+#if SENTRY_HAS_UIKIT
+@interface SentryDefaultUIViewControllerPerformanceTracker () <
+    SentryUIViewControllerPerformanceTracker>
+@end
+#endif
+
 @interface SentryDependencyContainer ()
 
 @property (nonatomic, strong) id<SentryANRTracker> anrTracker;
@@ -315,12 +321,12 @@ - (SentryViewHierarchyProvider *)viewHierarchyProvider SENTRY_THREAD_SANITIZER_D
 #    endif // SENTRY_HAS_UIKIT
 }
 
-- (SentryUIViewControllerPerformanceTracker *)
+- (id<SentryUIViewControllerPerformanceTracker>)
     uiViewControllerPerformanceTracker SENTRY_THREAD_SANITIZER_DOUBLE_CHECKED_LOCK
 {
 #    if SENTRY_HAS_UIKIT
     SENTRY_LAZY_INIT(_uiViewControllerPerformanceTracker,
-        [[SentryUIViewControllerPerformanceTracker alloc]
+        [[SentryDefaultUIViewControllerPerformanceTracker alloc]
                  initWithTracker:SentryPerformanceTracker.shared
             dispatchQueueWrapper:[self dispatchQueueWrapper]]);
 #    else

Sources/Sentry/SentryHub.m

@@ -24,10 +24,6 @@
 #import "SentryTransaction.h"
 #import "SentryTransactionContext+Private.h"
 
-#if SENTRY_HAS_UIKIT
-#    import "SentryUIViewControllerPerformanceTracker.h"
-#endif // SENTRY_HAS_UIKIT
-
 NS_ASSUME_NONNULL_BEGIN
 
 @interface SentryHub ()

Sources/Sentry/SentryPerformanceTrackingIntegration.m

@@ -7,7 +7,6 @@
 #    import "SentryOptions.h"
 #    import "SentrySubClassFinder.h"
 #    import "SentrySwift.h"
-#    import "SentryUIViewControllerPerformanceTracker.h"
 #    import "SentryUIViewControllerSwizzling.h"
 
 @interface SentryPerformanceTrackingIntegration ()
@@ -44,7 +43,7 @@ - (BOOL)installWithOptions:(SentryOptions *)options
           binaryImageCache:[SentryDependencyContainer.sharedInstance binaryImageCache]];
 
     [self.swizzling start];
-    SentryUIViewControllerPerformanceTracker *performanceTracker =
+    id<SentryUIViewControllerPerformanceTracker> performanceTracker =
         [SentryDependencyContainer.sharedInstance uiViewControllerPerformanceTracker];
     performanceTracker.alwaysWaitForFullDisplay = options.enableTimeToFullDisplayTracing;
 

Sources/Sentry/SentrySDKInternal.m

@@ -28,7 +28,6 @@
 #endif // TARGET_OS_MAC
 
 #if SENTRY_HAS_UIKIT
-#    import "SentryUIViewControllerPerformanceTracker.h"
 #    if TARGET_OS_IOS
 #        import "SentryFeedbackAPI.h"
 #    endif // TARGET_OS_IOS

Sources/Sentry/SentryTracer.m

@@ -36,7 +36,6 @@
 #    import "SentryAppStartMeasurement.h"
 #    import "SentryBuildAppStartSpans.h"
 #    import "SentryFramesTracker.h"
-#    import "SentryUIViewControllerPerformanceTracker.h"
 #endif // SENTRY_HAS_UIKIT
 
 NS_ASSUME_NONNULL_BEGIN

Sources/Sentry/SentryUIViewControllerSwizzling.m

@@ -8,7 +8,6 @@
 #    import "SentrySubClassFinder.h"
 #    import "SentrySwift.h"
 #    import "SentrySwizzle.h"
-#    import "SentryUIViewControllerPerformanceTracker.h"
 #    import <SentryOptions.h>
 #    import <UIKit/UIKit.h>
 #    import <UIViewController+Sentry.h>
@@ -111,7 +110,7 @@ - (void)start
     }
 
     [self swizzleUIViewController];
-    SentryUIViewControllerPerformanceTracker *performanceTracker =
+    id<SentryUIViewControllerPerformanceTracker> performanceTracker =
         [SentryDependencyContainer.sharedInstance uiViewControllerPerformanceTracker];
     performanceTracker.inAppLogic = self.inAppLogic;
 }

Sources/Sentry/include/HybridPublic/SentryDependencyContainer.h

@@ -46,9 +46,10 @@
 @class SentryFramesTracker;
 @class SentryScreenshotSource;
 @class SentryViewHierarchyProvider;
-@class SentryUIViewControllerPerformanceTracker;
 @class SentryWatchdogTerminationAttributesProcessor;
+
 @protocol SentryScopeObserver;
+@protocol SentryUIViewControllerPerformanceTracker;
 #endif // SENTRY_UIKIT_AVAILABLE
 
 #if SENTRY_HAS_UIKIT
@@ -128,8 +129,8 @@ SENTRY_NO_INIT
 #if SENTRY_UIKIT_AVAILABLE
 @property (nonatomic, strong) SentryFramesTracker *framesTracker;
 @property (nonatomic, strong) SentryViewHierarchyProvider *viewHierarchyProvider;
-@property (nonatomic, strong)
-    SentryUIViewControllerPerformanceTracker *uiViewControllerPerformanceTracker;
+@property (nonatomic, strong) id<SentryUIViewControllerPerformanceTracker>
+    uiViewControllerPerformanceTracker;
 #endif // SENTRY_UIKIT_AVAILABLE
 
 #if SENTRY_TARGET_REPLAY_SUPPORTED