ref: centralize frames tracker access (#3119)

SentryTestUtils/ClearTestState.swift

@@ -25,7 +25,7 @@ class TestCleanup: NSObject {
         setTestDefaultLogLevel()
 
         #if os(iOS) || os(tvOS) || targetEnvironment(macCatalyst)
-        let framesTracker = SentryFramesTracker.sharedInstance()
+        let framesTracker = SentryDependencyContainer.sharedInstance().framesTracker
         framesTracker.stop()
         framesTracker.resetFrames()
 

Sources/Sentry/PrivateSentrySDKOnly.m

@@ -131,12 +131,12 @@ + (void)setFramesTrackingMeasurementHybridSDKMode:(BOOL)framesTrackingMeasuremen
 
 + (BOOL)isFramesTrackingRunning
 {
-    return [SentryFramesTracker sharedInstance].isRunning;
+    return SentryDependencyContainer.sharedInstance.framesTracker.isRunning;
 }
 
 + (SentryScreenFrames *)currentScreenFrames
 {
-    return [SentryFramesTracker sharedInstance].currentFrames;
+    return SentryDependencyContainer.sharedInstance.framesTracker.currentFrames;
 }
 
 + (NSArray<NSData *> *)captureScreenshots

Sources/Sentry/SentryDependencyContainer.m

@@ -1,6 +1,8 @@
 #import "SentryANRTracker.h"
 #import "SentryDefaultCurrentDateProvider.h"
 #import "SentryDispatchQueueWrapper.h"
+#import "SentryDisplayLinkWrapper.h"
+#import "SentryFramesTracker.h"
 #import "SentryNSProcessInfoWrapper.h"
 #import "SentryUIApplication.h"
 #import <SentryAppStateManager.h>
@@ -168,7 +170,20 @@ - (SentryUIApplication *)application
     }
     return _application;
 }
-#endif
+
+- (SentryFramesTracker *)framesTracker
+{
+    if (_framesTracker == nil) {
+        @synchronized(sentryDependencyContainerLock) {
+            if (_framesTracker == nil) {
+                _framesTracker = [[SentryFramesTracker alloc]
+                    initWithDisplayLinkWrapper:[[SentryDisplayLinkWrapper alloc] init]];
+            }
+        }
+    }
+    return _framesTracker;
+}
+#endif // SENTRY_HAS_UIKIT
 
 - (SentrySwizzleWrapper *)swizzleWrapper
 {
@@ -242,6 +257,6 @@ - (SentryMXManager *)metricKitManager
     return _metricKitManager;
 }
 
-#endif
+#endif // SENTRY_HAS_METRIC_KIT
 
 @end

Sources/Sentry/SentryFramesTracker.m

@@ -50,18 +50,6 @@ @implementation SentryFramesTracker {
     unsigned int _frozenFrames;
 }
 
-+ (instancetype)sharedInstance
-{
-    static SentryFramesTracker *sharedInstance = nil;
-    static dispatch_once_t onceToken;
-    dispatch_once(&onceToken, ^{
-        sharedInstance =
-            [[self alloc] initWithDisplayLinkWrapper:[[SentryDisplayLinkWrapper alloc] init]];
-    });
-    return sharedInstance;
-}
-
-/** Internal constructor for testing */
 - (instancetype)initWithDisplayLinkWrapper:(SentryDisplayLinkWrapper *)displayLinkWrapper
 {
     if (self = [super init]) {

Sources/Sentry/SentryFramesTrackingIntegration.m

@@ -1,5 +1,6 @@
 #import "SentryFramesTrackingIntegration.h"
 #import "PrivateSentrySDKOnly.h"
+#import "SentryDependencyContainer.h"
 #import "SentryFramesTracker.h"
 #import "SentryLog.h"
 
@@ -24,7 +25,7 @@ - (BOOL)installWithOptions:(SentryOptions *)options
         return NO;
     }
 
-    self.tracker = [SentryFramesTracker sharedInstance];
+    self.tracker = SentryDependencyContainer.sharedInstance.framesTracker;
     [self.tracker start];
 
     return YES;

Sources/Sentry/SentryProfiler.mm

@@ -85,9 +85,6 @@
 SentrySystemWrapper *_gCurrentSystemWrapper;
 SentryDispatchFactory *_gDispatchFactory;
 SentryNSTimerWrapper *_gTimeoutTimerWrapper;
-#    if SENTRY_HAS_UIKIT
-SentryFramesTracker *_gCurrentFramesTracker;
-#    endif // SENTRY_HAS_UIKIT
 
 NSString *
 profilerTruncationReasonName(SentryProfilerTruncationReason reason)
@@ -258,17 +255,18 @@
     auto metrics = serializedMetrics;
 
 #    if SENTRY_HAS_UIKIT
+    const auto framesTracker = SentryDependencyContainer.sharedInstance.framesTracker;
     const auto mutableMetrics =
         [NSMutableDictionary<NSString *, id> dictionaryWithDictionary:metrics];
-    const auto slowFrames = sliceGPUData(_gCurrentFramesTracker.currentFrames.slowFrameTimestamps,
+    const auto slowFrames = sliceGPUData(framesTracker.currentFrames.slowFrameTimestamps,
         transaction, /*useMostRecentRecording */ NO);
     if (slowFrames.count > 0) {
         mutableMetrics[@"slow_frame_renders"] =
             @ { @"unit" : @"nanosecond", @"values" : slowFrames };
     }
 
     const auto frozenFrames
-        = sliceGPUData(_gCurrentFramesTracker.currentFrames.frozenFrameTimestamps, transaction,
+        = sliceGPUData(framesTracker.currentFrames.frozenFrameTimestamps, transaction,
             /*useMostRecentRecording */ NO);
     if (frozenFrames.count > 0) {
         mutableMetrics[@"frozen_frame_renders"] =
@@ -277,7 +275,7 @@
 
     if (slowFrames.count > 0 || frozenFrames.count > 0) {
         const auto frameRates
-            = sliceGPUData(_gCurrentFramesTracker.currentFrames.frameRateTimestamps, transaction,
+            = sliceGPUData(framesTracker.currentFrames.frameRateTimestamps, transaction,
                 /*useMostRecentRecording */ YES);
         if (frameRates.count > 0) {
             mutableMetrics[@"screen_frame_rates"] = @ { @"unit" : @"hz", @"values" : frameRates };
@@ -482,7 +480,7 @@ + (void)startWithHub:(SentryHub *)hub
     }
 
 #    if SENTRY_HAS_UIKIT
-    [_gCurrentFramesTracker resetProfilingTimestamps];
+    [SentryDependencyContainer.sharedInstance.framesTracker resetProfilingTimestamps];
 #    endif // SENTRY_HAS_UIKIT
 
     [_gCurrentProfiler start];
@@ -566,14 +564,6 @@ + (void)useTimeoutTimerWrapper:(SentryNSTimerWrapper *)timerWrapper
     _gTimeoutTimerWrapper = timerWrapper;
 }
 
-#    if SENTRY_HAS_UIKIT
-+ (void)useFramesTracker:(SentryFramesTracker *)framesTracker
-{
-    std::lock_guard<std::mutex> l(_gProfilerLock);
-    _gCurrentFramesTracker = framesTracker;
-}
-#    endif // SENTRY_HAS_UIKIT
-
 #    pragma mark - Private
 
 + (NSDictionary<NSString *, id> *)serializeForTransaction:(SentryTransaction *)transaction
@@ -635,7 +625,7 @@ + (void)stopProfilerForReason:(SentryProfilerTruncationReason)reason
     [_gCurrentProfiler stop];
     _gCurrentProfiler->_truncationReason = reason;
 #    if SENTRY_HAS_UIKIT
-    [_gCurrentFramesTracker resetProfilingTimestamps];
+    [SentryDependencyContainer.sharedInstance.framesTracker resetProfilingTimestamps];
 #    endif // SENTRY_HAS_UIKIT
 }
 
@@ -650,11 +640,6 @@ - (void)startMetricProfiler
     if (_gDispatchFactory == nil) {
         _gDispatchFactory = [[SentryDispatchFactory alloc] init];
     }
-#    if SENTRY_HAS_UIKIT
-    if (_gCurrentFramesTracker == nil) {
-        _gCurrentFramesTracker = SentryFramesTracker.sharedInstance;
-    }
-#    endif // SENTRY_HAS_UIKIT
     _metricProfiler =
         [[SentryMetricProfiler alloc] initWithProcessInfoWrapper:_gCurrentProcessInfoWrapper
                                                    systemWrapper:_gCurrentSystemWrapper

Sources/Sentry/SentryTimeToDisplayTracker.m

@@ -1,5 +1,6 @@
 #import "SentryTimeToDisplayTracker.h"
 #import "SentryCurrentDate.h"
+#import "SentryDependencyContainer.h"
 #import "SentryFramesTracker.h"
 #import "SentryMeasurementValue.h"
 #import "SentrySpan.h"
@@ -24,18 +25,15 @@ @implementation SentryTimeToDisplayTracker {
     BOOL _waitForFullDisplay;
     BOOL _isReadyToDisplay;
     BOOL _fullyDisplayedReported;
-    SentryFramesTracker *_frameTracker;
     NSString *_controllerName;
 }
 
 - (instancetype)initForController:(UIViewController *)controller
-                    framesTracker:(SentryFramesTracker *)framestracker
                waitForFullDisplay:(BOOL)waitForFullDisplay
 {
     if (self = [super init]) {
         _controllerName = [SwiftDescriptor getObjectClassName:controller];
         _waitForFullDisplay = waitForFullDisplay;
-        _frameTracker = framestracker;
 
         _isReadyToDisplay = NO;
         _fullyDisplayedReported = NO;
@@ -64,7 +62,7 @@ - (void)startForTracer:(SentryTracer *)tracer
 
     self.initialDisplaySpan.startTimestamp = tracer.startTimestamp;
 
-    [_frameTracker addListener:self];
+    [SentryDependencyContainer.sharedInstance.framesTracker addListener:self];
     [tracer setFinishCallback:^(
         SentryTracer *_tracer) { [self trimTTFDIdNecessaryForTracer:_tracer]; }];
 }
@@ -106,7 +104,7 @@ - (void)framesTrackerHasNewFrame
         [self addTimeToDisplayMeasurement:self.initialDisplaySpan name:@"time_to_initial_display"];
 
         [self.initialDisplaySpan finish];
-        [_frameTracker removeListener:self];
+        [SentryDependencyContainer.sharedInstance.framesTracker removeListener:self];
     }
     if (_waitForFullDisplay && _fullyDisplayedReported && self.fullDisplaySpan.isFinished == NO) {
         self.fullDisplaySpan.timestamp = finishTime;

Sources/Sentry/SentryTracer.m

@@ -138,7 +138,7 @@ - (instancetype)initWithTransactionContext:(SentryTransactionContext *)transacti
 #if SENTRY_HAS_UIKIT
     // Store current amount of frames at the beginning to be able to calculate the amount of
     // frames at the end of the transaction.
-    SentryFramesTracker *framesTracker = [SentryFramesTracker sharedInstance];
+    SentryFramesTracker *framesTracker = SentryDependencyContainer.sharedInstance.framesTracker;
     if (framesTracker.isRunning) {
         SentryScreenFrames *currentFrames = framesTracker.currentFrames;
         initTotalFrames = currentFrames.total;
@@ -737,7 +737,7 @@ - (void)addMeasurements:(SentryTransaction *)transaction
 
 #if SENTRY_HAS_UIKIT
     // Frames
-    SentryFramesTracker *framesTracker = [SentryFramesTracker sharedInstance];
+    SentryFramesTracker *framesTracker = SentryDependencyContainer.sharedInstance.framesTracker;
     if (framesTracker.isRunning && !_startTimeChanged) {
 
         SentryScreenFrames *currentFrames = framesTracker.currentFrames;

Sources/Sentry/SentryUIViewControllerPerformanceTracker.m

@@ -140,7 +140,6 @@ - (void)createTimeToDisplay:(UIViewController *)controller
 
     SentryTimeToDisplayTracker *ttdTracker =
         [[SentryTimeToDisplayTracker alloc] initForController:controller
-                                                framesTracker:SentryFramesTracker.sharedInstance
                                            waitForFullDisplay:self.enableWaitForFullDisplay];
 
     objc_setAssociatedObject(controller, &SENTRY_UI_PERFORMANCE_TRACKER_TTD_TRACKER, ttdTracker,

Sources/Sentry/include/SentryDependencyContainer.h

@@ -2,12 +2,22 @@
 #import "SentryFileManager.h"
 #import "SentryRandom.h"
 
-@class SentryAppStateManager, SentryCrashWrapper, SentryThreadWrapper, SentrySwizzleWrapper,
-    SentryDispatchQueueWrapper, SentryDebugImageProvider, SentryANRTracker,
-    SentryNSNotificationCenterWrapper, SentryMXManager, SentryNSProcessInfoWrapper;
+@class SentryANRTracker;
+@class SentryAppStateManager;
+@class SentryCrashWrapper;
+@class SentryDebugImageProvider;
+@class SentryDispatchQueueWrapper;
+@class SentryFramesTracker;
+@class SentryMXManager;
+@class SentryNSNotificationCenterWrapper;
+@class SentryNSProcessInfoWrapper;
+@class SentrySwizzleWrapper;
+@class SentryThreadWrapper;
 
 #if SENTRY_HAS_UIKIT
-@class SentryScreenshot, SentryUIApplication, SentryViewHierarchy;
+@class SentryScreenshot;
+@class SentryUIApplication;
+@class SentryViewHierarchy;
 #endif
 
 NS_ASSUME_NONNULL_BEGIN
@@ -35,6 +45,7 @@ SENTRY_NO_INIT
 @property (nonatomic, strong) SentryNSProcessInfoWrapper *processInfoWrapper;
 
 #if SENTRY_HAS_UIKIT
+@property (nonatomic, strong) SentryFramesTracker *framesTracker;
 @property (nonatomic, strong) SentryScreenshot *screenshot;
 @property (nonatomic, strong) SentryViewHierarchy *viewHierarchy;
 @property (nonatomic, strong) SentryUIApplication *application;

Sources/Sentry/include/SentryFramesTracker.h

@@ -19,9 +19,8 @@ NS_ASSUME_NONNULL_BEGIN
  * Tracks total, frozen and slow frames for iOS, tvOS, and Mac Catalyst.
  */
 @interface SentryFramesTracker : NSObject
-SENTRY_NO_INIT
 
-+ (instancetype)sharedInstance;
+- (instancetype)initWithDisplayLinkWrapper:(SentryDisplayLinkWrapper *)displayLinkWrapper;
 
 @property (nonatomic, assign, readonly) SentryScreenFrames *currentFrames;
 @property (nonatomic, assign, readonly) BOOL isRunning;

Sources/Sentry/include/SentryTimeToDisplayTracker.h

@@ -4,7 +4,8 @@
 #if SENTRY_HAS_UIKIT
 #    import <UIKit/UIKit.h>
 
-@class SentrySpan, SentryTracer, SentryFramesTracker;
+@class SentrySpan;
+@class SentryTracer;
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -25,7 +26,6 @@ SENTRY_NO_INIT
 @property (nonatomic, readonly) BOOL waitForFullDisplay;
 
 - (instancetype)initForController:(UIViewController *)controller
-                    framesTracker:(SentryFramesTracker *)framestracker
                waitForFullDisplay:(BOOL)waitForFullDisplay;
 
 - (void)startForTracer:(SentryTracer *)tracer;
@@ -38,4 +38,4 @@ SENTRY_NO_INIT
 
 NS_ASSUME_NONNULL_END
 
-#endif
+#endif // SENTRY_HAS_UIKIT

Tests/SentryProfilerTests/SentryProfilerSwiftTests.swift

@@ -56,7 +56,7 @@ class SentryProfilerSwiftTests: XCTestCase {
             systemWrapper.overrides.memoryFootprintBytes = mockMemoryFootprint
 
 #if !os(macOS)
-            SentryProfiler.useFramesTracker(framesTracker)
+            SentryDependencyContainer.sharedInstance().framesTracker = framesTracker
             framesTracker.start()
             displayLinkWrapper.call()
 #endif

Tests/SentryTests/Helper/SentryProfiler+SwiftTest.h

@@ -27,10 +27,6 @@ SentryProfiler ()
 + (void)useTimeoutTimerWrapper:(SentryNSTimerWrapper *)timerWrapper
     NS_SWIFT_NAME(useTimeoutTimerWrapper(_:));
 
-#    if SENTRY_HAS_UIKIT
-+ (void)useFramesTracker:(SentryFramesTracker *)framesTracker NS_SWIFT_NAME(useFramesTracker(_:));
-#    endif // SENTRY_HAS_UIKIT
-
 @end
 
 #endif // SENTRY_TARGET_PROFILING_SUPPORTED

Tests/SentryTests/Integrations/Performance/FramesTracking/SentryFramesTrackingIntegrationTests.swift

@@ -76,7 +76,7 @@ class SentryFramesTrackingIntegrationTests: XCTestCase {
     func testUninstall() {
         sut.install(with: fixture.options)
 
-        SentryFramesTracker.sharedInstance().setDisplayLinkWrapper(fixture.displayLink)
+        SentryDependencyContainer.sharedInstance().framesTracker.setDisplayLinkWrapper(fixture.displayLink)
 
         sut.uninstall()
 

Tests/SentryTests/Integrations/Performance/UIViewController/SentryTimeToDisplayTrackerTest.swift

@@ -16,15 +16,16 @@ class SentryTimeToDisplayTrackerTest: XCTestCase {
 
         init() {
             framesTracker = SentryFramesTracker(displayLinkWrapper: displayLinkWrapper)
+            SentryDependencyContainer.sharedInstance().framesTracker = framesTracker
             framesTracker.start()
         }
 
         func getSut(for controller: UIViewController, waitForFullDisplay: Bool) -> SentryTimeToDisplayTracker {
-            return SentryTimeToDisplayTracker(for: controller, framesTracker: framesTracker, waitForFullDisplay: waitForFullDisplay)
+            return SentryTimeToDisplayTracker(for: controller, waitForFullDisplay: waitForFullDisplay)
         }
     }
 
-    private let fixture = Fixture()
+    private lazy var fixture = Fixture()
 
     override func setUp() {
         super.setUp()

Tests/SentryTests/Integrations/Performance/UIViewController/SentryUIViewControllerPerformanceTrackerTests.swift

@@ -621,7 +621,7 @@ class SentryUIViewControllerPerformanceTrackerTests: XCTestCase {
     }
 
     private func reportFrame() {
-        Dynamic(SentryFramesTracker.sharedInstance()).displayLinkCallback()
+        Dynamic(SentryDependencyContainer.sharedInstance().framesTracker).displayLinkCallback()
     }
 }
 #endif

Tests/SentryTests/PrivateSentrySDKOnlyTests.swift

@@ -122,12 +122,12 @@ class PrivateSentrySDKOnlyTests: XCTestCase {
 
     func testIsFramesTrackingRunning() {
         XCTAssertFalse(PrivateSentrySDKOnly.isFramesTrackingRunning)
-        SentryFramesTracker.sharedInstance().start()
+        SentryDependencyContainer.sharedInstance().framesTracker.start()
         XCTAssertTrue(PrivateSentrySDKOnly.isFramesTrackingRunning)
     }
 
     func testGetFrames() {
-        let tracker = SentryFramesTracker.sharedInstance()
+        let tracker = SentryDependencyContainer.sharedInstance().framesTracker
         let displayLink = TestDisplayLinkWrapper()
 
         tracker.setDisplayLinkWrapper(displayLink)