Revert "Fix crash in file manager (getsentry#5535)"

This reverts commit aa0b738.

Author: philipsawyerdd

SentryTestUtils/ClearTestState.swift

@@ -39,7 +39,7 @@ class TestCleanup: NSObject {
         SentryAppStartTracker.load()
         SentryDependencyContainer.sharedInstance().uiViewControllerPerformanceTracker.alwaysWaitForFullDisplay = false
         SentryDependencyContainer.sharedInstance().swizzleWrapper.removeAllCallbacks()
-        SentryDependencyContainer.sharedInstance().fileManager?.clearDiskState()
+        SentryDependencyContainer.sharedInstance().fileManager.clearDiskState()
 
         #endif // os(iOS) || os(tvOS) || targetEnvironment(macCatalyst)
 

Sources/Sentry/SentryDependencyContainer.m

@@ -211,7 +211,7 @@ - (instancetype)init
     return self;
 }
 
-- (nullable SentryFileManager *)fileManager SENTRY_THREAD_SANITIZER_DOUBLE_CHECKED_LOCK
+- (SentryFileManager *)fileManager SENTRY_THREAD_SANITIZER_DOUBLE_CHECKED_LOCK
 {
     SENTRY_LAZY_INIT(_fileManager, ({
         NSError *error;

Sources/Sentry/SentrySessionReplayIntegration.m

@@ -434,12 +434,9 @@ - (void)startWithOptions:(SentryReplayOptions *)replayOptions
                          options:replayOptions];
 }
 
-- (nullable NSURL *)replayDirectory
+- (NSURL *)replayDirectory
 {
     NSString *sentryPath = [SentryDependencyContainer.sharedInstance.fileManager sentryPath];
-    if (!sentryPath) {
-        return nil;
-    }
     NSURL *dir = [NSURL fileURLWithPath:sentryPath];
     return [dir URLByAppendingPathComponent:SENTRY_REPLAY_FOLDER];
 }

Sources/Sentry/include/HybridPublic/SentryDependencyContainer.h

@@ -105,7 +105,7 @@ SENTRY_NO_INIT
 
 #pragma mark - Lazy Dependencies
 
-@property (nonatomic, strong, nullable) SentryFileManager *fileManager;
+@property (nonatomic, strong) SentryFileManager *fileManager;
 @property (nonatomic, strong) SentryAppStateManager *appStateManager;
 @property (nonatomic, strong) SentryThreadInspector *threadInspector;
 @property (nonatomic, strong) SentryFileIOTracker *fileIOTracker;

Sources/Swift/Persistence/SentryScopeContextPersistentStore.swift

@@ -1,50 +1,55 @@
 @_implementationOnly import _SentryPrivate
 
+@_spi(Private) @objc public protocol SentryFileManagerProtocol {
+  func moveState(_ stateFilePath: String, toPreviousState previousStateFilePath: String)
+    func readData(fromPath path: String) throws -> Data
+    @objc(writeData:toPath:)
+    @discardableResult func write(_ data: Data, toPath path: String) -> Bool
+    func removeFile(atPath path: String)
+    func getSentryPathAsURL() -> URL
+}
+
 @objcMembers
 @_spi(Private) public class SentryScopeContextPersistentStore: NSObject {
-    private let fileManager: SentryFileManager
+    private let fileManager: SentryFileManagerProtocol
 
-    init(fileManager: SentryFileManager) {
+    public init(fileManager: SentryFileManagerProtocol) {
         self.fileManager = fileManager
     }
 
     // MARK: - Context
-
-<<<<<<< HEAD
-    func moveCurrentFileToPreviousFile() {
-=======
+    
     public func moveCurrentFileToPreviousFile() {
->>>>>>> parent of 2609f7a4 ([Structured Logging] Rename SentryLog to SentrySDKLog (#5473))
-        SentryLog.debug("Moving context file to previous context file")
+        SentrySDKLog.debug("Moving context file to previous context file")
         self.fileManager.moveState(contextFileURL.path, toPreviousState: previousContextFileURL.path)
     }
 
     public func readPreviousContextFromDisk() -> [String: [String: Any]]? {
-        SentryLog.debug("Reading previous context file at path: \(previousContextFileURL.path)")
+        SentrySDKLog.debug("Reading previous context file at path: \(previousContextFileURL.path)")
         do {
             let data = try fileManager.readData(fromPath: previousContextFileURL.path)
             return decodeContext(from: data)
         } catch {
-            SentryLog.error("Failed to read previous context file at path: \(previousContextFileURL.path), reason: \(error)")
+            SentrySDKLog.error("Failed to read previous context file at path: \(previousContextFileURL.path), reason: \(error)")
             return nil
         }
     }
 
     func writeContextToDisk(context: [String: [String: Any]]) {
-        SentryLog.debug("Writing context to disk at path: \(contextFileURL.path)")
+        SentrySDKLog.debug("Writing context to disk at path: \(contextFileURL.path)")
         guard let data = encode(context: context) else {
             return
         }
         fileManager.write(data, toPath: contextFileURL.path)
     }
 
     func deleteContextOnDisk() {
-        SentryLog.debug("Deleting context file at path: \(contextFileURL.path)")
+        SentrySDKLog.debug("Deleting context file at path: \(contextFileURL.path)")
         fileManager.removeFile(atPath: contextFileURL.path)
     }
 
     func deletePreviousContextOnDisk() {
-        SentryLog.debug("Deleting context file at path: \(contextFileURL.path)")
+        SentrySDKLog.debug("Deleting context file at path: \(contextFileURL.path)")
         fileManager.removeFile(atPath: previousContextFileURL.path)
     }
 
@@ -55,19 +60,19 @@
         // Otherwise it will throw an unhandled `NSInvalidArgumentException` exception.
         // The error handler is required due but seems not to be executed.
         guard let sanitizedContext = sentry_sanitize(context) else {
-            SentryLog.error("Failed to sanitize context, reason: context is not valid json: \(context)")
+            SentrySDKLog.error("Failed to sanitize context, reason: context is not valid json: \(context)")
             return nil
         }
         guard let data = SentrySerialization.data(withJSONObject: sanitizedContext) else {
-            SentryLog.error("Failed to serialize context, reason: context is not valid json: \(context)")
+            SentrySDKLog.error("Failed to serialize context, reason: context is not valid json: \(context)")
             return nil
         }
         return data
     }
 
     private func decodeContext(from data: Data) -> [String: [String: Any]]? {
         guard let deserialized = SentrySerialization.deserializeDictionary(fromJsonData: data) else {
-            SentryLog.error("Failed to deserialize context, reason: data is not valid json")
+            SentrySDKLog.error("Failed to deserialize context, reason: data is not valid json")
             return nil
         }
 
@@ -87,7 +92,7 @@
         // additional memory (like when mapping values).
         for (key, value) in deserialized {
             guard value is [String: Any] else {
-                SentryLog.error("Failed to deserialize context, reason: value for key \(key) is not a valid dictionary")
+                SentrySDKLog.error("Failed to deserialize context, reason: value for key \(key) is not a valid dictionary")
                 return nil
             }
         }

Tests/SentryTests/Helper/SentryFileManagerTests.swift

@@ -177,8 +177,8 @@ class SentryFileManagerTests: XCTestCase {
 
     func testDeleteOldEnvelopes_LogsIgnoreDSStoreFiles() throws {
         let logOutput = TestLogOutput()
-        SentryLog.setLogOutput(logOutput)
-        SentryLog.configureLog(true, diagnosticLevel: .debug)
+        SentrySDKLog.setLogOutput(logOutput)
+        SentrySDKLog.configureLog(true, diagnosticLevel: .debug)
 
         let dsStoreFile = "\(sut.basePath)/.DS_Store"
 
@@ -198,8 +198,8 @@ class SentryFileManagerTests: XCTestCase {
 
     func testDeleteOldEnvelopes_LogsDebugForTextFiles() throws {
         let logOutput = TestLogOutput()
-        SentryLog.setLogOutput(logOutput)
-        SentryLog.configureLog(true, diagnosticLevel: .debug)
+        SentrySDKLog.setLogOutput(logOutput)
+        SentrySDKLog.configureLog(true, diagnosticLevel: .debug)
 
         let sut = fixture.getSut()
 
@@ -221,8 +221,8 @@ class SentryFileManagerTests: XCTestCase {
 
     func testGetEnvelopesPath_ForNonExistentPath_LogsWarning() throws {
         let logOutput = TestLogOutput()
-        SentryLog.setLogOutput(logOutput)
-        SentryLog.configureLog(true, diagnosticLevel: .debug)
+        SentrySDKLog.setLogOutput(logOutput)
+        SentrySDKLog.configureLog(true, diagnosticLevel: .debug)
 
         let sut = fixture.getSut()
 
@@ -302,7 +302,7 @@ class SentryFileManagerTests: XCTestCase {
 
     func testDeleteFileNotExists() {
         let logOutput = TestLogOutput()
-        SentryLog.setLogOutput(logOutput)
+        SentrySDKLog.setLogOutput(logOutput)
         sut.removeFile(atPath: "x")
         XCTAssertFalse(logOutput.loggedMessages.contains(where: { $0.contains("[error]") }))
     }
@@ -642,8 +642,8 @@ class SentryFileManagerTests: XCTestCase {
 
     func testGetAllEnvelopesWhenNoEnvelopesPath_LogsInfoMessage() {
         let logOutput = TestLogOutput()
-        SentryLog.setLogOutput(logOutput)
-        SentryLog.configureLog(true, diagnosticLevel: .debug)
+        SentrySDKLog.setLogOutput(logOutput)
+        SentrySDKLog.configureLog(true, diagnosticLevel: .debug)
 
         sut.deleteAllFolders()
         sut.getAllEnvelopes()
@@ -850,13 +850,13 @@ class SentryFileManagerTests: XCTestCase {
 
     func testReadPreviousBreadcrumbs() throws {
         let breadcrumbProcessor = SentryWatchdogTerminationBreadcrumbProcessor(maxBreadcrumbs: 2, fileManager: sut)
-        let attributesProcessor = try SentryWatchdogTerminationAttributesProcessor(
+        let contextProcessor = SentryWatchdogTerminationContextProcessor(
             withDispatchQueueWrapper: SentryDispatchQueueWrapper(),
-            scopePersistentStore: XCTUnwrap(SentryScopePersistentStore(fileManager: sut))
+            scopeContextStore: SentryScopeContextPersistentStore(fileManager: sut)
         )
         let observer = SentryWatchdogTerminationScopeObserver(
             breadcrumbProcessor: breadcrumbProcessor,
-            attributesProcessor: attributesProcessor
+            contextProcessor: contextProcessor
         )
 
         for count in 0..<3 {
@@ -880,13 +880,13 @@ class SentryFileManagerTests: XCTestCase {
 
     func testReadPreviousBreadcrumbsCorrectOrderWhenFileTwoHasMoreCrumbs() throws {
         let breadcrumbProcessor = SentryWatchdogTerminationBreadcrumbProcessor(maxBreadcrumbs: 2, fileManager: sut)
-        let attributesProcessor = try SentryWatchdogTerminationAttributesProcessor(
+        let contextProcessor = SentryWatchdogTerminationContextProcessor(
             withDispatchQueueWrapper: TestSentryDispatchQueueWrapper(),
-            scopePersistentStore: XCTUnwrap(SentryScopePersistentStore(fileManager: sut))
+            scopeContextStore: SentryScopeContextPersistentStore(fileManager: sut)
         )
         let observer = SentryWatchdogTerminationScopeObserver(
             breadcrumbProcessor: breadcrumbProcessor,
-            attributesProcessor: attributesProcessor
+            contextProcessor: contextProcessor
         )
 
         for count in 0..<5 {
@@ -1044,8 +1044,8 @@ class SentryFileManagerTests: XCTestCase {
     func testCreateDirectoryIfNotExists_successful_shouldNotLogError() throws {
         // -- Arrange -
         let logOutput = TestLogOutput()
-        SentryLog.setLogOutput(logOutput)
-        SentryLog.configureLog(true, diagnosticLevel: .debug)
+        SentrySDKLog.setLogOutput(logOutput)
+        SentrySDKLog.configureLog(true, diagnosticLevel: .debug)
 
         let path = fixture.getValidDirectoryPath()
         var error: NSError?
@@ -1059,8 +1059,8 @@ class SentryFileManagerTests: XCTestCase {
     func testCreateDirectoryIfNotExists_pathTooLogError_shouldLogError() throws {
         // -- Arrange -
         let logOutput = TestLogOutput()
-        SentryLog.setLogOutput(logOutput)
-        SentryLog.configureLog(true, diagnosticLevel: .debug)
+        SentrySDKLog.setLogOutput(logOutput)
+        SentrySDKLog.configureLog(true, diagnosticLevel: .debug)
 
         let path = fixture.getTooLongPath()
         var error: NSError?
@@ -1076,8 +1076,8 @@ class SentryFileManagerTests: XCTestCase {
     func testCreateDirectoryIfNotExists_otherError_shouldNotLogError() throws {
         // -- Arrange -
         let logOutput = TestLogOutput()
-        SentryLog.setLogOutput(logOutput)
-        SentryLog.configureLog(true, diagnosticLevel: .debug)
+        SentrySDKLog.setLogOutput(logOutput)
+        SentrySDKLog.configureLog(true, diagnosticLevel: .debug)
 
         let path = fixture.getInvalidPath()
         var error: NSError?
@@ -1121,7 +1121,7 @@ class SentryFileManagerTests: XCTestCase {
         let data = Data("<TEST DATA>".utf8)
 
         let logOutput = TestLogOutput()
-        SentryLog.setLogOutput(logOutput)
+        SentrySDKLog.setLogOutput(logOutput)
 
         // Check pre-conditions
         let fm = FileManager.default
@@ -1167,7 +1167,7 @@ extension SentryFileManagerTests {
             profilesSampleRate: expectedProfilesSampleRate,
             profilesSampleRand: expectedProfilesSampleRand
         )
-        let config = sentry_persistedLaunchProfileConfigurationOptions()
+        let config = sentry_appLaunchProfileConfiguration()
 
         // -- Assert --
         let actualTracesSampleRate = try XCTUnwrap(config?[kSentryLaunchProfileConfigKeyTracesSampleRate]).doubleValue
@@ -1183,7 +1183,7 @@ extension SentryFileManagerTests {
     // if a file isn't present when we expect it to be, like if there was an issue when we went to write it to disk
     func testsentry_appLaunchProfileConfiguration_noConfigurationExists() throws {
         try ensureAppLaunchProfileConfig(exists: false)
-        XCTAssertNil(sentry_persistedLaunchProfileConfigurationOptions())
+        XCTAssertNil(sentry_appLaunchProfileConfiguration())
     }
 
     func testWriteAppLaunchProfilingConfigFile_noCurrentFileExists() throws {
@@ -1200,10 +1200,9 @@ extension SentryFileManagerTests {
             kSentryLaunchProfileConfigKeyProfilesSampleRate: expectedProfilesSampleRate,
             kSentryLaunchProfileConfigKeyProfilesSampleRand: expectedProfilesSampleRand
         ])
-
-        let configURL = try XCTUnwrap(launchProfileConfigFileURL())
-        let config = NSDictionary(contentsOf: configURL)
-
+        
+        let config = NSDictionary(contentsOf: launchProfileConfigFileURL())
+        
         let actualTracesSampleRate = try XCTUnwrap(config?[kSentryLaunchProfileConfigKeyTracesSampleRate] as? NSNumber).doubleValue
         let actualTracesSampleRand = try XCTUnwrap(config?[kSentryLaunchProfileConfigKeyTracesSampleRand] as? NSNumber).doubleValue
         let actualProfilesSampleRate = try XCTUnwrap(config?[kSentryLaunchProfileConfigKeyProfilesSampleRate] as? NSNumber).doubleValue
@@ -1233,9 +1232,8 @@ extension SentryFileManagerTests {
         ])
 
         // -- Assert --
-        let configURL = try XCTUnwrap(launchProfileConfigFileURL())
-        let config = NSDictionary(contentsOf: configURL)
-
+        let config = NSDictionary(contentsOf: launchProfileConfigFileURL())
+        
         let actualTracesSampleRate = try XCTUnwrap(config?[kSentryLaunchProfileConfigKeyTracesSampleRate] as? NSNumber).doubleValue
         let actualTracesSampleRand = try XCTUnwrap(config?[kSentryLaunchProfileConfigKeyTracesSampleRand] as? NSNumber).doubleValue
         let actualProfilesSampleRate = try XCTUnwrap(config?[kSentryLaunchProfileConfigKeyProfilesSampleRate] as? NSNumber).doubleValue
@@ -1248,17 +1246,17 @@ extension SentryFileManagerTests {
 
     func testRemoveAppLaunchProfilingConfigFile() throws {
         try ensureAppLaunchProfileConfig(exists: true)
-        XCTAssertNotNil(NSDictionary(contentsOf: try XCTUnwrap(launchProfileConfigFileURL())))
+        XCTAssertNotNil(NSDictionary(contentsOf: launchProfileConfigFileURL()))
         removeAppLaunchProfilingConfigFile()
-        XCTAssertNil(NSDictionary(contentsOf: try XCTUnwrap(launchProfileConfigFileURL())))
+        XCTAssertNil(NSDictionary(contentsOf: launchProfileConfigFileURL()))
     }
 
     // if there's not a file when we expect one, just make sure we don't crash
     func testRemoveAppLaunchProfilingConfigFile_noFileExists() throws {
         try ensureAppLaunchProfileConfig(exists: false)
-        XCTAssertNil(NSDictionary(contentsOf: try XCTUnwrap(launchProfileConfigFileURL())))
+        XCTAssertNil(NSDictionary(contentsOf: launchProfileConfigFileURL()))
         removeAppLaunchProfilingConfigFile()
-        XCTAssertNil(NSDictionary(contentsOf: try XCTUnwrap(launchProfileConfigFileURL())))
+        XCTAssertNil(NSDictionary(contentsOf: launchProfileConfigFileURL()))
     }
 
     func testCheckForLaunchProfilingConfigFile_URLDoesNotExist() {
@@ -1272,7 +1270,7 @@ extension SentryFileManagerTests {
         XCTAssertFalse(appLaunchProfileConfigFileExists())
 
         // set the original value back so other tests don't crash
-        sentryLaunchConfigFileURL = (originalURL as? NSURL)
+        sentryLaunchConfigFileURL = (originalURL as NSURL)
     }
 
     func testSentryGetScopedCachesDirectory_targetIsNotMacOS_shouldReturnSamePath() throws {
@@ -1385,7 +1383,7 @@ extension SentryFileManagerTests {
 // MARK: Private profiling tests
 private extension SentryFileManagerTests {
     func ensureAppLaunchProfileConfig(exists: Bool = true, tracesSampleRate: Double = 1, tracesSampleRand: Double = 1.0, profilesSampleRate: Double = 1, profilesSampleRand: Double = 1.0) throws {
-        let url = try XCTUnwrap(launchProfileConfigFileURL())
+        let url = launchProfileConfigFileURL()
 
         if exists {
             let dict = [