ref: Convert SentryFileIOTrackingIntegration to swift (#7252)

* chore: Convert `SentryNSDataSwizzling` and `SentryNSFileManagerSwizzling` to Swift

* refactor: Remove legacy swizzling imports and add new helper classes for swizzling functionality

* Add tests for SentryNSDataSwizzlingHelper

* Add SentryNSFileManagerSwizzlingHelper and corresponding tests

* Use weak reference for tracker

* refactor: remove unused tracker property from SentryNSDataSwizzling and SentryNSFileManagerSwizzling

* ref: Convert SentryFileIOTrackingIntegration to swift

* Remove duplicate references

* Remove unused options property

Author: itaybre

Sentry.xcodeproj/project.pbxproj

@@ -821,9 +821,7 @@
 		D8A3649D2C91AA3300AC569B /* SentryReplayApi.h in Headers */ = {isa = PBXBuildFile; fileRef = D8A3649A2C91AA3300AC569B /* SentryReplayApi.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		D8A65B5D2C98656800974B74 /* SentryReplayView.swift in Sources */ = {isa = PBXBuildFile; fileRef = D8A65B5C2C98656000974B74 /* SentryReplayView.swift */; };
 		D8ACE3C82762187200F5A213 /* SentryFileIOTrackerHelper.m in Sources */ = {isa = PBXBuildFile; fileRef = D8ACE3C52762187200F5A213 /* SentryFileIOTrackerHelper.m */; };
-		D8ACE3C92762187200F5A213 /* SentryFileIOTrackingIntegration.m in Sources */ = {isa = PBXBuildFile; fileRef = D8ACE3C62762187200F5A213 /* SentryFileIOTrackingIntegration.m */; };
 		D8ACE3CE2762187D00F5A213 /* SentryFileIOTrackerHelper.h in Headers */ = {isa = PBXBuildFile; fileRef = D8ACE3CB2762187D00F5A213 /* SentryFileIOTrackerHelper.h */; };
-		D8ACE3CF2762187D00F5A213 /* SentryFileIOTrackingIntegration.h in Headers */ = {isa = PBXBuildFile; fileRef = D8ACE3CC2762187D00F5A213 /* SentryFileIOTrackingIntegration.h */; };
 		D8AE48BF2C578D540092A2A6 /* SentrySDKLog.swift in Sources */ = {isa = PBXBuildFile; fileRef = D8AE48BE2C578D540092A2A6 /* SentrySDKLog.swift */; };
 		D8AE48C12C57B1550092A2A6 /* SentryLevelTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = D8AE48C02C57B1550092A2A6 /* SentryLevelTests.swift */; };
 		D8AFC0012BD252B900118BE1 /* SentryOnDemandReplayTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = D8AFC0002BD252B900118BE1 /* SentryOnDemandReplayTests.swift */; };
@@ -1978,9 +1976,7 @@
 		D8A3649B2C91AA3300AC569B /* SentryReplayApi.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = SentryReplayApi.m; sourceTree = "<group>"; };
 		D8A65B5C2C98656000974B74 /* SentryReplayView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryReplayView.swift; sourceTree = "<group>"; };
 		D8ACE3C52762187200F5A213 /* SentryFileIOTrackerHelper.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SentryFileIOTrackerHelper.m; sourceTree = "<group>"; };
-		D8ACE3C62762187200F5A213 /* SentryFileIOTrackingIntegration.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SentryFileIOTrackingIntegration.m; sourceTree = "<group>"; };
 		D8ACE3CB2762187D00F5A213 /* SentryFileIOTrackerHelper.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = SentryFileIOTrackerHelper.h; path = include/SentryFileIOTrackerHelper.h; sourceTree = "<group>"; };
-		D8ACE3CC2762187D00F5A213 /* SentryFileIOTrackingIntegration.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = SentryFileIOTrackingIntegration.h; path = include/SentryFileIOTrackingIntegration.h; sourceTree = "<group>"; };
 		D8AE48B12C5786AA0092A2A6 /* SentryLogC.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = SentryLogC.h; path = include/SentryLogC.h; sourceTree = "<group>"; };
 		D8AE48BE2C578D540092A2A6 /* SentrySDKLog.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentrySDKLog.swift; sourceTree = "<group>"; };
 		D8AE48C02C57B1550092A2A6 /* SentryLevelTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryLevelTests.swift; sourceTree = "<group>"; };
@@ -4107,8 +4103,6 @@
 			children = (
 				D8ACE3CB2762187D00F5A213 /* SentryFileIOTrackerHelper.h */,
 				D8ACE3C52762187200F5A213 /* SentryFileIOTrackerHelper.m */,
-				D8ACE3CC2762187D00F5A213 /* SentryFileIOTrackingIntegration.h */,
-				D8ACE3C62762187200F5A213 /* SentryFileIOTrackingIntegration.m */,
 			);
 			name = IO;
 			sourceTree = "<group>";
@@ -4208,7 +4202,6 @@
 				03F84D2527DD414C008FE43F /* SentryThreadState.hpp in Headers */,
 				8E4E7C6D25DAAAFE006AB9E2 /* SentryTransaction.h in Headers */,
 				FAE2DABA2E1F318900262307 /* SentryProfilingSwiftHelpers.h in Headers */,
-				D8ACE3CF2762187D00F5A213 /* SentryFileIOTrackingIntegration.h in Headers */,
 				FA27ECA12EBA325A00F2ECF7 /* SentryTraceContext+Private.h in Headers */,
 				7BECF42226145C5D00D9826E /* SentryMechanismContext.h in Headers */,
 				63FE718920DA4C1100CDBAE8 /* SentryCrash.h in Headers */,
@@ -4367,6 +4360,8 @@
 				6271ADF32BA06D9B0098D2E9 /* SentryInternalSerializable.h in Headers */,
 				D8853C842833EABC00700D64 /* SentryANRTrackerV1.h in Headers */,
 				63FE715B20DA4C1100CDBAE8 /* SentryCrashSignalInfo.h in Headers */,
+				F4F33D502F1F35C500753FE2 /* SentryNSDataSwizzlingHelper.h in Headers */,
+				F4F33D512F1F35C500753FE2 /* SentryNSFileManagerSwizzlingHelper.h in Headers */,
 				63FE70E520DA4C1000CDBAE8 /* SentryCrashMonitor_CPPException.h in Headers */,
 				D867063E27C3BC2400048851 /* SentryCoreDataSwizzling.h in Headers */,
 				7D9B07A023D1E89900C5FC8E /* SentryMeta.h in Headers */,
@@ -4839,12 +4834,11 @@
 				7B63459B280EB9E200CFA05A /* SentryUIEventTrackingIntegration.m in Sources */,
 				15E0A8ED240F2CB000F044E3 /* SentrySerialization.m in Sources */,
 				7BC85235245880AE005A70F0 /* SentryDataCategoryMapper.m in Sources */,
-				D8ACE3C92762187200F5A213 /* SentryFileIOTrackingIntegration.m in Sources */,
 				63FE713B20DA4C1100CDBAE8 /* SentryCrashFileUtils.c in Sources */,
 				63FE716920DA4C1100CDBAE8 /* SentryCrashStackCursor.c in Sources */,
 				7BA61CCA247D128B00C130A8 /* SentryDefaultThreadInspector.m in Sources */,
 				63FE718D20DA4C1100CDBAE8 /* SentryCrashReportStore.c in Sources */,
-				F440C1B12F23C24800C52354 /* SentryNSDataSwizzlingHelper.m in Sources */,
+				F440C1B12F23C24800C52354 /* SentryNSDatawizzlingHelper.m in Sources */,
 				F440C1B22F23C24800C52354 /* SentryNSFileManagerSwizzlingHelper.m in Sources */,
 				7BA0C0482805600A003E0326 /* SentryTransportAdapter.m in Sources */,
 				63FE712920DA4C1000CDBAE8 /* SentryCrashCPU_arm.c in Sources */,
@@ -4888,6 +4882,8 @@
 				7D082B8323C628790029866B /* SentryMeta.m in Sources */,
 				63FE710720DA4C1000CDBAE8 /* SentryCrashStackCursor_SelfThread.m in Sources */,
 				63FE711120DA4C1000CDBAE8 /* SentryCrashDebug.c in Sources */,
+				F4F33D482F1F358400753FE2 /* SentryNSFileManagerSwizzling.swift in Sources */,
+				F4F33D492F1F358400753FE2 /* SentryNSDataSwizzling.swift in Sources */,
 				7B883F49253D714C00879E62 /* SentryCrashUUIDConversion.c in Sources */,
 				843FB3232D0CD04D00558F18 /* SentryUserAccess.m in Sources */,
 				63FE716720DA4C1100CDBAE8 /* SentryCrashCPU.c in Sources */,

Sources/Sentry/SentryFileIOTrackingIntegration.m

@@ -6,7 +6,6 @@
 #import "SentryClient+Private.h"
 #import "SentryCoreDataTrackingIntegration.h"
 #import "SentryCrash.h"
-#import "SentryFileIOTrackingIntegration.h"
 #import "SentryHub+Private.h"
 #import "SentryInternalDefines.h"
 #import "SentryLogC.h"
@@ -505,7 +504,7 @@ + (void)endSession
         [SentryUIEventTrackingIntegration class],
 #endif // SENTRY_HAS_UIKIT
         [SentryAutoBreadcrumbTrackingIntegration class], [SentryCoreDataTrackingIntegration class],
-        [SentryFileIOTrackingIntegration class], nil];
+        nil];
 
     return defaultIntegrations;
 }

Sources/Sentry/SentrySDKInternal.m

@@ -69,7 +69,9 @@
 #import "SentryInstallation.h"
 #import "SentryMeta.h"
 #import "SentryMsgPackSerializer.h"
+#import "SentryNSDataSwizzlingHelper.h"
 #import "SentryNSDictionarySanitize.h"
+#import "SentryNSFileManagerSwizzlingHelper.h"
 #import "SentryPerformanceTracker.h"
 #import "SentryProfiler+Private.h"
 #import "SentrySDKInternal.h"

Sources/Sentry/include/SentryPrivate.h

@@ -52,7 +52,8 @@ private struct AnyIntegration {
             .init(SentryAutoSessionTrackingIntegration.self),
             .init(SentryNetworkTrackingIntegration.self),
             .init(SentryHangTrackerIntegrationObjC.self),
-            .init(SentryMetricsIntegration.self)
+            .init(SentryMetricsIntegration.self),
+            .init(SentryFileIOTrackingIntegration.self)
         ])
 
         #if (os(iOS) || os(tvOS) || targetEnvironment(macCatalyst) || os(visionOS)) && !SENTRY_NO_UIKIT

Sources/Swift/Core/Integrations/Integrations.swift

@@ -0,0 +1,51 @@
+@_implementationOnly import _SentryPrivate
+
+typealias FileIOTrackingIntegrationProvider = FileIOTrackerProvider & NSDataSwizzlingProvider & NSFileManagerSwizzlingProvider
+
+final class SentryFileIOTrackingIntegration<Dependencies: FileIOTrackingIntegrationProvider>: NSObject, SwiftIntegration {
+    private let tracker: SentryFileIOTracker
+    private let nsDataSwizzling: SentryNSDataSwizzling
+    private let nsFileManagerSwizzling: SentryNSFileManagerSwizzling
+
+    init?(with options: Options, dependencies: Dependencies) {
+        // Check if tracing is enabled
+        guard options.isTracingEnabled else {
+            SentrySDKLog.debug("Not going to enable \(Self.name) because isTracingEnabled is disabled.")
+            return nil
+        }
+
+        // Check if auto performance tracing is enabled
+        guard options.enableAutoPerformanceTracing else {
+            SentrySDKLog.debug("Not going to enable \(Self.name) because enableAutoPerformanceTracing is disabled.")
+            return nil
+        }
+
+        // Check if file IO tracing is enabled
+        guard options.enableFileIOTracing else {
+            SentrySDKLog.debug("Not going to enable \(Self.name) because enableFileIOTracing is disabled.")
+            return nil
+        }
+
+        self.tracker = dependencies.fileIOTracker
+        self.nsDataSwizzling = dependencies.nsDataSwizzling
+        self.nsFileManagerSwizzling = dependencies.nsFileManagerSwizzling
+
+        super.init()
+
+        tracker.enable()
+
+        nsDataSwizzling.start(withOptions: options, tracker: tracker)
+        nsFileManagerSwizzling.start(withOptions: options, tracker: tracker)
+    }
+
+    func uninstall() {
+        tracker.disable()
+
+        nsDataSwizzling.stop()
+        nsFileManagerSwizzling.stop()
+    }
+
+    static var name: String {
+        "SentryFileIOTrackingIntegration"
+    }
+}

Sources/Swift/Integrations/Performance/IO/SentryFileIOTrackingIntegration.swift

@@ -331,6 +331,22 @@ extension SentryDependencyContainer: DateProviderProvider {}
 
 extension SentryDependencyContainer: AutoSessionTrackingProvider { }
 
+protocol FileIOTrackerProvider {
+    var fileIOTracker: SentryFileIOTracker { get }
+}
+
+protocol NSDataSwizzlingProvider {
+    var nsDataSwizzling: SentryNSDataSwizzling { get }
+}
+
+protocol NSFileManagerSwizzlingProvider {
+    var nsFileManagerSwizzling: SentryNSFileManagerSwizzling { get }
+}
+
+extension SentryDependencyContainer: FileIOTrackerProvider { }
+extension SentryDependencyContainer: NSDataSwizzlingProvider { }
+extension SentryDependencyContainer: NSFileManagerSwizzlingProvider { }
+
 #if (os(iOS) || os(tvOS) || os(visionOS)) && !SENTRY_NO_UIKIT
 protocol FramesTrackingProvider {
     var framesTracker: SentryFramesTracker { get }

Sources/Swift/SentryDependencyContainer.swift

@@ -1,14 +1,13 @@
-import Sentry
+@_spi(Private) @testable import Sentry
 import XCTest
 
 class SentryFileIoTrackingUnitTests: XCTestCase {
 
     func test_FileIOTracking_Disabled() {
         let options = Options()
         options.enableFileIOTracing = false
-        let sut = SentryFileIOTrackingIntegration()
-        let result = sut.install(with: options)
+        let sut = SentryFileIOTrackingIntegration(with: options, dependencies: SentryDependencyContainer.sharedInstance())
 
-        XCTAssertFalse(result)
+        XCTAssertNil(sut)
     }
 }

Tests/SentryTests/Integrations/Performance/IO/SentryFileIoTrackingUnitTests.swift

@@ -95,7 +95,6 @@
 #import "SentryEnvelopeRateLimit.h"
 #import "SentryEvent+Private.h"
 #import "SentryFileIOTrackerHelper.h"
-#import "SentryFileIOTrackingIntegration.h"
 #import "SentryFileManager+Test.h"
 #import "SentryFileManagerHelper.h"
 #import "SentryFormatter.h"