fix: Start session replay without a UIWindow (#3911)

If there is no UIWindow available during SDK initialization, wait for a UISceneDidActivateNotification

Author: brustolin

Sentry.xcodeproj/project.pbxproj

@@ -859,6 +859,7 @@
 		D8ACE3CE2762187D00F5A213 /* SentryNSDataTracker.h in Headers */ = {isa = PBXBuildFile; fileRef = D8ACE3CB2762187D00F5A213 /* SentryNSDataTracker.h */; };
 		D8ACE3CF2762187D00F5A213 /* SentryFileIOTrackingIntegration.h in Headers */ = {isa = PBXBuildFile; fileRef = D8ACE3CC2762187D00F5A213 /* SentryFileIOTrackingIntegration.h */; };
 		D8AFC0012BD252B900118BE1 /* SentryOnDemandReplayTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = D8AFC0002BD252B900118BE1 /* SentryOnDemandReplayTests.swift */; };
+		D8AFC0622BDBEE4200118BE1 /* SentrySessionReplayIntegration+Private.h in Headers */ = {isa = PBXBuildFile; fileRef = D8AFC0612BDBEDF100118BE1 /* SentrySessionReplayIntegration+Private.h */; };
 		D8B0542E2A7D2C720056BAF6 /* PrivacyInfo.xcprivacy in Resources */ = {isa = PBXBuildFile; fileRef = D8B0542D2A7D2C720056BAF6 /* PrivacyInfo.xcprivacy */; };
 		D8B088B629C9E3FF00213258 /* SentryTracerConfiguration.h in Headers */ = {isa = PBXBuildFile; fileRef = D8B088B429C9E3FF00213258 /* SentryTracerConfiguration.h */; };
 		D8B088B729C9E3FF00213258 /* SentryTracerConfiguration.m in Sources */ = {isa = PBXBuildFile; fileRef = D8B088B529C9E3FF00213258 /* SentryTracerConfiguration.m */; };
@@ -1889,6 +1890,7 @@
 		D8ACE3CB2762187D00F5A213 /* SentryNSDataTracker.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = SentryNSDataTracker.h; path = include/SentryNSDataTracker.h; sourceTree = "<group>"; };
 		D8ACE3CC2762187D00F5A213 /* SentryFileIOTrackingIntegration.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = SentryFileIOTrackingIntegration.h; path = include/SentryFileIOTrackingIntegration.h; sourceTree = "<group>"; };
 		D8AFC0002BD252B900118BE1 /* SentryOnDemandReplayTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryOnDemandReplayTests.swift; sourceTree = "<group>"; };
+		D8AFC0612BDBEDF100118BE1 /* SentrySessionReplayIntegration+Private.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = "SentrySessionReplayIntegration+Private.h"; path = "include/SentrySessionReplayIntegration+Private.h"; sourceTree = "<group>"; };
 		D8B0542D2A7D2C720056BAF6 /* PrivacyInfo.xcprivacy */ = {isa = PBXFileReference; lastKnownFileType = text.xml; path = PrivacyInfo.xcprivacy; sourceTree = "<group>"; };
 		D8B088B429C9E3FF00213258 /* SentryTracerConfiguration.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = SentryTracerConfiguration.h; path = include/SentryTracerConfiguration.h; sourceTree = "<group>"; };
 		D8B088B529C9E3FF00213258 /* SentryTracerConfiguration.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = SentryTracerConfiguration.m; sourceTree = "<group>"; };
@@ -3540,6 +3542,7 @@
 				D820CDB12BB1886100BA339D /* SentrySessionReplay.h */,
 				D820CDB22BB1886100BA339D /* SentrySessionReplay.m */,
 				D820CDB52BB1895F00BA339D /* SentrySessionReplayIntegration.h */,
+				D8AFC0612BDBEDF100118BE1 /* SentrySessionReplayIntegration+Private.h */,
 				D820CDB62BB1895F00BA339D /* SentrySessionReplayIntegration.m */,
 				D820CE112BB2F13C00BA339D /* SentryCoreGraphicsHelper.h */,
 				D820CE122BB2F13C00BA339D /* SentryCoreGraphicsHelper.m */,
@@ -3935,6 +3938,7 @@
 				6383953623ABA42C000C1594 /* SentryHttpTransport.h in Headers */,
 				84A8891C28DBD28900C51DFD /* SentryDevice.h in Headers */,
 				8E564AEF267AF24400FE117D /* SentryNetworkTracker.h in Headers */,
+				D8AFC0622BDBEE4200118BE1 /* SentrySessionReplayIntegration+Private.h in Headers */,
 				63FE715120DA4C1100CDBAE8 /* SentryCrashDebug.h in Headers */,
 				63FE70F520DA4C1000CDBAE8 /* SentryCrashMonitor_System.h in Headers */,
 				7B31C291277B04A000337126 /* SentryCrashPlatformSpecificDefines.h in Headers */,

Sources/Sentry/SentrySessionReplayIntegration.m

@@ -1,4 +1,4 @@
-#import "SentrySessionReplayIntegration.h"
+#import "SentrySessionReplayIntegration+Private.h"
 
 #if SENTRY_HAS_UIKIT && !TARGET_OS_VISION
 
@@ -8,12 +8,14 @@
 #    import "SentryFileManager.h"
 #    import "SentryGlobalEventProcessor.h"
 #    import "SentryHub+Private.h"
+#    import "SentryNSNotificationCenterWrapper.h"
 #    import "SentryOptions.h"
 #    import "SentryRandom.h"
 #    import "SentrySDK+Private.h"
 #    import "SentrySessionReplay.h"
 #    import "SentrySwift.h"
 #    import "SentryUIApplication.h"
+#    import <UIKit/UIKit.h>
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -23,6 +25,7 @@
 @interface
 SentrySessionReplayIntegration ()
 @property (nonatomic, strong) SentrySessionReplay *sessionReplay;
+- (void)newSceneActivate;
 @end
 
 API_AVAILABLE(ios(16.0), tvos(16.0))
@@ -33,9 +36,13 @@
 API_AVAILABLE(ios(16.0), tvos(16.0))
 @interface
 SentryOnDemandReplay (SentryReplayMaker) <SentryReplayMaker>
+
 @end
 
-@implementation SentrySessionReplayIntegration
+@implementation SentrySessionReplayIntegration {
+    BOOL _startedAsFullSession;
+    SentryReplayOptions *_replayOptions;
+}
 
 - (BOOL)installWithOptions:(nonnull SentryOptions *)options
 {
@@ -44,15 +51,41 @@ - (BOOL)installWithOptions:(nonnull SentryOptions *)options
     }
 
     if (@available(iOS 16.0, tvOS 16.0, *)) {
-        SentryReplayOptions *replayOptions = options.experimental.sessionReplay;
+        _replayOptions = options.experimental.sessionReplay;
 
-        BOOL shouldReplayFullSession =
-            [self shouldReplayFullSession:replayOptions.sessionSampleRate];
+        _startedAsFullSession = [self shouldReplayFullSession:_replayOptions.sessionSampleRate];
 
-        if (!shouldReplayFullSession && replayOptions.errorSampleRate == 0) {
+        if (!_startedAsFullSession && _replayOptions.errorSampleRate == 0) {
             return NO;
         }
 
+        if (SentryDependencyContainer.sharedInstance.application.windows.count > 0) {
+            // If a window its already available start replay right away
+            [self startWithOptions:_replayOptions fullSession:_startedAsFullSession];
+        } else {
+            // Wait for a scene to be available to started the replay
+            [SentryDependencyContainer.sharedInstance.notificationCenterWrapper
+                addObserver:self
+                   selector:@selector(newSceneActivate)
+                       name:UISceneDidActivateNotification];
+        }
+
+        return YES;
+    } else {
+        return NO;
+    }
+}
+
+- (void)newSceneActivate
+{
+    [SentryDependencyContainer.sharedInstance.notificationCenterWrapper removeObserver:self];
+    [self startWithOptions:_replayOptions fullSession:_startedAsFullSession];
+}
+
+- (void)startWithOptions:(SentryReplayOptions *)replayOptions
+             fullSession:(BOOL)shouldReplayFullSession
+{
+    if (@available(iOS 16.0, tvOS 16.0, *)) {
         NSURL *docs = [NSURL
             fileURLWithPath:[SentryDependencyContainer.sharedInstance.fileManager sentryPath]];
         docs = [docs URLByAppendingPathComponent:SENTRY_REPLAY_FOLDER];
@@ -97,10 +130,6 @@ - (BOOL)installWithOptions:(nonnull SentryOptions *)options
                 [self.sessionReplay captureReplayForEvent:event];
                 return event;
             }];
-
-        return YES;
-    } else {
-        return NO;
     }
 }
 

Sources/Sentry/include/SentrySessionReplayIntegration+Private.h

@@ -0,0 +1,12 @@
+#import "SentryBaseIntegration.h"
+#import "SentrySessionReplayIntegration.h"
+#import "SentrySwift.h"
+
+#if SENTRY_HAS_UIKIT && !TARGET_OS_VISION
+
+@interface
+SentrySessionReplayIntegration () <SentryIntegrationProtocol>
+
+@end
+
+#endif

Tests/SentryTests/Integrations/SessionReplay/SentrySessionReplayIntegrationTests.swift

@@ -8,12 +8,25 @@ import XCTest
 
 class SentrySessionReplayIntegrationTests: XCTestCase {
 
+    private class TestSentryUIApplication: SentryUIApplication {
+        var windowsMock: [UIWindow]? = [UIWindow()]
+        override var windows: [UIWindow]? {
+            windowsMock
+        }
+    }
+    
     override func setUpWithError() throws {
         guard #available(iOS 16.0, tvOS 16.0, *)  else {
             throw XCTSkip("iOS version not supported")
         }
     }
 
+    private var uiApplication = TestSentryUIApplication()
+    
+    override func setUp() {
+        SentryDependencyContainer.sharedInstance().application = uiApplication
+    }
+    
     override func tearDown() {
         super.tearDown()
         clearTestState()
@@ -68,6 +81,21 @@ class SentrySessionReplayIntegrationTests: XCTestCase {
         expect(SentrySDK.currentHub().trimmedInstalledIntegrationNames().count) == 1
         expect(SentryGlobalEventProcessor.shared().processors.count) == 1
     }
+    
+    func testWaitForNotificationWithNoWindow() {
+        uiApplication.windowsMock = nil
+        startSDK(sessionSampleRate: 1, errorSampleRate: 0)
+        
+        guard let sut = SentrySDK.currentHub().installedIntegrations().first as? SentrySessionReplayIntegration else {
+            fail("Did not installed replay integration")
+            return
+        }
+        
+        expect(Dynamic(sut).sessionReplay.asObject) == nil
+        uiApplication.windowsMock = [UIWindow()]
+        NotificationCenter.default.post(name: UIScene.didActivateNotification, object: nil)
+        expect(Dynamic(sut).sessionReplay.asObject) != nil
+    }
 }
 
 #endif

Tests/SentryTests/PrivateSentrySDKOnlyTests.swift

@@ -222,12 +222,12 @@ class PrivateSentrySDKOnlyTests: XCTestCase {
         guard #available(iOS 16.0, tvOS 16.0, *) else { return }
 
         let options = Options()
-        options.setIntegrations([SentrySessionReplayIntegrationTest.self])
+        options.setIntegrations([TestSentrySessionReplayIntegration.self])
         SentrySDK.start(options: options)
 
         PrivateSentrySDKOnly.captureReplay()
 
-        XCTAssertTrue(SentrySessionReplayIntegrationTest.captureReplayShouldBeCalledAtLeastOnce())
+        XCTAssertTrue(TestSentrySessionReplayIntegration.captureReplayShouldBeCalledAtLeastOnce())
     }
 
     func testGetReplayIdShouldBeNil() {
@@ -245,31 +245,31 @@ class PrivateSentrySDKOnlyTests: XCTestCase {
 
     func testAddReplayIgnoreClassesShouldNotFailWhenReplayIsAvailable() {
         let options = Options()
-        options.setIntegrations([SentrySessionReplayIntegrationTest.self])
+        options.setIntegrations([TestSentrySessionReplayIntegration.self])
         SentrySDK.start(options: options)
 
         PrivateSentrySDKOnly.addReplayIgnoreClasses([UILabel.self])
     }
 
     func testAddReplayRedactShouldNotFailWhenReplayIsAvailable() {
         let options = Options()
-        options.setIntegrations([SentrySessionReplayIntegrationTest.self])
+        options.setIntegrations([TestSentrySessionReplayIntegration.self])
         SentrySDK.start(options: options)
 
         PrivateSentrySDKOnly.addReplayRedactClasses([UILabel.self])
     }
 
     let VALID_REPLAY_ID = "0eac7ab503354dd5819b03e263627a29"
 
-    final class SentrySessionReplayIntegrationTest: SentrySessionReplayIntegration {
+    private class TestSentrySessionReplayIntegration: SentrySessionReplayIntegration {
         static var captureReplayCalledTimes = 0
 
         override func install(with options: Options) -> Bool {
             return true
         }
 
         override func captureReplay() {
-            SentrySessionReplayIntegrationTest.captureReplayCalledTimes += 1
+            TestSentrySessionReplayIntegration.captureReplayCalledTimes += 1
         }
 
         static func captureReplayShouldBeCalledAtLeastOnce() -> Bool {

Tests/SentryTests/SentryTests-Bridging-Header.h

@@ -13,7 +13,7 @@
 #    import "MockUIScene.h"
 #    import "SentryFramesTracker+TestInit.h"
 #    import "SentrySessionReplay.h"
-#    import "SentrySessionReplayIntegration.h"
+#    import "SentrySessionReplayIntegration+Private.h"
 #    import "SentryUIApplication+Private.h"
 #    import "SentryUIApplication.h"
 #    import "SentryUIDeviceWrapper.h"