ref: Create file io tracker Swift interface

noahsmartin · noahsmartin · commit ff34dd419b69 · 2025-09-25T17:15:19.000-07:00
diff --git a/Sentry.xcodeproj/project.pbxproj b/Sentry.xcodeproj/project.pbxproj
@@ -1089,6 +1089,7 @@
 		FA7206DF2E0B37850072FDD4 /* SentryProfileCollector.h in Headers */ = {isa = PBXBuildFile; fileRef = FA7206DE2E0B37780072FDD4 /* SentryProfileCollector.h */; };
 		FA7206E12E0B37C80072FDD4 /* SentryProfileCollector.mm in Sources */ = {isa = PBXBuildFile; fileRef = FA7206E02E0B37C60072FDD4 /* SentryProfileCollector.mm */; };
 		FA8A36182DEAA1EB0058D883 /* SentryThread+Private.h in Headers */ = {isa = PBXBuildFile; fileRef = FA8A36172DEAA1EB0058D883 /* SentryThread+Private.h */; };
+		FA8AFCEF2E843903007A0E18 /* SentryFileIOTracking.swift in Sources */ = {isa = PBXBuildFile; fileRef = FA8AFCEE2E8438FF007A0E18 /* SentryFileIOTracking.swift */; };
 		FA8E58F12E0AD4270049F69D /* SentryDispatchQueueWrapper.swift in Sources */ = {isa = PBXBuildFile; fileRef = FA8E58F02E0AD4220049F69D /* SentryDispatchQueueWrapper.swift */; };
 		FA90FAA82E06614E008CAAE8 /* SentryExtraPackages.swift in Sources */ = {isa = PBXBuildFile; fileRef = FA90FAA72E06614B008CAAE8 /* SentryExtraPackages.swift */; };
 		FA90FAFD2E070A3B008CAAE8 /* SentryURLRequestFactory.swift in Sources */ = {isa = PBXBuildFile; fileRef = FA90FAFC2E070A3B008CAAE8 /* SentryURLRequestFactory.swift */; };
@@ -2433,6 +2434,7 @@
 		FA7206DE2E0B37780072FDD4 /* SentryProfileCollector.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = SentryProfileCollector.h; sourceTree = "<group>"; };
 		FA7206E02E0B37C60072FDD4 /* SentryProfileCollector.mm */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.cpp.objcpp; path = SentryProfileCollector.mm; sourceTree = "<group>"; };
 		FA8A36172DEAA1EB0058D883 /* SentryThread+Private.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = "SentryThread+Private.h"; path = "include/SentryThread+Private.h"; sourceTree = "<group>"; };
+		FA8AFCEE2E8438FF007A0E18 /* SentryFileIOTracking.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryFileIOTracking.swift; sourceTree = "<group>"; };
 		FA8E58F02E0AD4220049F69D /* SentryDispatchQueueWrapper.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryDispatchQueueWrapper.swift; sourceTree = "<group>"; };
 		FA90FAA72E06614B008CAAE8 /* SentryExtraPackages.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryExtraPackages.swift; sourceTree = "<group>"; };
 		FA90FAFC2E070A3B008CAAE8 /* SentryURLRequestFactory.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryURLRequestFactory.swift; sourceTree = "<group>"; };
@@ -4252,6 +4254,7 @@
 		D468C0602D36699700964230 /* IO */ = {
 			isa = PBXGroup;
 			children = (
+				FA8AFCEE2E8438FF007A0E18 /* SentryFileIOTracking.swift */,
 				D4EDF9832D0B2A1D0071E7B3 /* Data+SentryTracing.swift */,
 				D473ACD62D8090FC000F1CC6 /* FileManager+SentryTracing.swift */,
 				D468C0612D3669A200964230 /* SentryFileIOTracker+SwiftHelpers.swift */,
@@ -5623,6 +5626,7 @@
 				03F84D3727DD4191008FE43F /* SentrySamplingProfiler.cpp in Sources */,
 				8453421628BE8A9500C22EEC /* SentrySpanStatus.m in Sources */,
 				6292585B2DAFA5F70049388F /* SentryCrashCxaThrowSwapper.c in Sources */,
+				FA8AFCEF2E843903007A0E18 /* SentryFileIOTracking.swift in Sources */,
 				92D957732E05A44600E20E66 /* SentryAsyncLog.m in Sources */,
 				7B08A3472924CF9C0059603A /* SentryMetricKitIntegration.m in Sources */,
 				623FD9022D3FA5E000803EDA /* SentryFrameCodable.swift in Sources */,
diff --git a/Sources/Sentry/SentryDependencyContainer.m b/Sources/Sentry/SentryDependencyContainer.m
@@ -61,9 +61,13 @@
 @interface SentryFileManager () <SentryFileManagerProtocol>
 @end
 
+@interface SentryFileIOTracker () <SentryFileIOTracking>
+@end
+
 @interface SentryDependencyContainer ()
 
 @property (nonatomic, strong) id<SentryANRTracker> anrTracker;
+@property (nonatomic, strong) SentryFileIOTracker *fileIOTracker;
 
 @end
 
@@ -221,6 +225,11 @@ - (SentryThreadInspector *)threadInspector SENTRY_THREAD_SANITIZER_DOUBLE_CHECKE
         [[SentryThreadInspector alloc] initWithOptions:SentrySDKInternal.options]);
 }
 
+- (id<SentryFileIOTracking>)fileIOTracking
+{
+    return [self fileIOTracker];
+}
+
 - (SentryFileIOTracker *)fileIOTracker SENTRY_THREAD_SANITIZER_DOUBLE_CHECKED_LOCK
 {
     SENTRY_LAZY_INIT(_fileIOTracker,
diff --git a/Sources/Sentry/SentryFileIOTracker.m b/Sources/Sentry/SentryFileIOTracker.m
@@ -33,15 +33,15 @@ @implementation SentryFileIOTracker
 
 NSString *const SENTRY_TRACKING_COUNTER_KEY = @"SENTRY_TRACKING_COUNTER_KEY";
 
-+ (instancetype _Nullable)sharedInstance
++ (id<SentryFileIOTracking> _Nullable)sharedInstance
 {
     // It is necessary to check if the SDK is enabled because accessing the tracker will otherwise
     // initialize the depency container without any configured SDK options. This is a known issue
     // and needs to be fixed in general.
     if (!SentrySDK.isEnabled) {
         return nil;
     }
-    return SentryDependencyContainer.sharedInstance.fileIOTracker;
+    return SentryDependencyContainer.sharedInstance.fileIOTracking;
 }
 
 - (instancetype)initWithThreadInspector:(SentryThreadInspector *)threadInspector
diff --git a/Sources/Sentry/SentryFileIOTrackingIntegration.m b/Sources/Sentry/SentryFileIOTrackingIntegration.m
@@ -3,11 +3,12 @@
 #import "SentryFileIOTracker.h"
 #import "SentryNSDataSwizzling.h"
 #import "SentryNSFileManagerSwizzling.h"
+#import "SentrySwift.h"
 #import "SentryThreadInspector.h"
 
 @interface SentryFileIOTrackingIntegration ()
 
-@property (nonatomic, strong) SentryFileIOTracker *tracker;
+@property (nonatomic, strong) id<SentryFileIOTracking> tracker;
 
 @end
 
@@ -19,7 +20,7 @@ - (BOOL)installWithOptions:(SentryOptions *)options
         return NO;
     }
 
-    self.tracker = [[SentryDependencyContainer sharedInstance] fileIOTracker];
+    self.tracker = [[SentryDependencyContainer sharedInstance] fileIOTracking];
     [self.tracker enable];
 
     [SentryNSDataSwizzling.shared startWithOptions:options tracker:self.tracker];
diff --git a/Sources/Sentry/SentryNSDataSwizzling.m b/Sources/Sentry/SentryNSDataSwizzling.m
@@ -7,7 +7,7 @@
 
 @interface SentryNSDataSwizzling ()
 
-@property (nonatomic, strong) SentryFileIOTracker *tracker;
+@property (nonatomic, strong) id<SentryFileIOTracking> tracker;
 
 @end
 
@@ -21,7 +21,7 @@ + (SentryNSDataSwizzling *)shared
     return instance;
 }
 
-- (void)startWithOptions:(SentryOptions *)options tracker:(SentryFileIOTracker *)tracker
+- (void)startWithOptions:(SentryOptions *)options tracker:(id<SentryFileIOTracking>)tracker
 {
     self.tracker = tracker;
 
diff --git a/Sources/Sentry/SentryNSFileManagerSwizzling.m b/Sources/Sentry/SentryNSFileManagerSwizzling.m
@@ -7,7 +7,7 @@
 
 @interface SentryNSFileManagerSwizzling ()
 
-@property (nonatomic, strong) SentryFileIOTracker *tracker;
+@property (nonatomic, strong) id<SentryFileIOTracking> tracker;
 
 @end
 
@@ -21,7 +21,7 @@ + (SentryNSFileManagerSwizzling *)shared
     return instance;
 }
 
-- (void)startWithOptions:(SentryOptions *)options tracker:(SentryFileIOTracker *)tracker
+- (void)startWithOptions:(SentryOptions *)options tracker:(id<SentryFileIOTracking>)tracker
 {
     self.tracker = tracker;
 
diff --git a/Sources/Sentry/include/HybridPublic/SentryDependencyContainer.h b/Sources/Sentry/include/HybridPublic/SentryDependencyContainer.h
@@ -20,7 +20,6 @@
 @class SentrySystemWrapper;
 @class SentryThreadWrapper;
 @class SentryThreadInspector;
-@class SentryFileIOTracker;
 @class SentryScopePersistentStore;
 @class SentryOptions;
 @class SentrySessionTracker;
@@ -33,6 +32,7 @@
 @protocol SentryApplication;
 @protocol SentryProcessInfoSource;
 @protocol SentryDispatchQueueProviderProtocol;
+@protocol SentryFileIOTracking;
 @protocol SentryNSNotificationCenterWrapper;
 @protocol SentryObjCRuntimeWrapper;
 
@@ -108,8 +108,8 @@ SENTRY_NO_INIT
 
 @property (nonatomic, strong, nullable) SentryFileManager *fileManager;
 @property (nonatomic, strong) SentryAppStateManager *appStateManager;
+- (id<SentryFileIOTracking>)fileIOTracking;
 @property (nonatomic, strong) SentryThreadInspector *threadInspector;
-@property (nonatomic, strong) SentryFileIOTracker *fileIOTracker;
 @property (nonatomic, strong) SentryCrash *crashReporter;
 @property (nonatomic, strong) SentryScopePersistentStore *scopePersistentStore;
 @property (nonatomic, strong) SentryDebugImageProvider *debugImageProvider;
diff --git a/Sources/Sentry/include/SentryFileIOTracker.h b/Sources/Sentry/include/SentryFileIOTracker.h
@@ -3,6 +3,7 @@
 NS_ASSUME_NONNULL_BEGIN
 
 @protocol SentryProcessInfoSource;
+@protocol SentryFileIOTracking;
 @class SentryThreadInspector;
 
 @interface SentryFileIOTracker : NSObject
@@ -16,7 +17,7 @@ SENTRY_NO_INIT
  *
  * @return The shared instance of the tracker.
  */
-+ (instancetype _Nullable)sharedInstance;
++ (SentryFileIOTracker *_Nullable)sharedInstance;
 
 - (instancetype)initWithThreadInspector:(SentryThreadInspector *)threadInspector
                      processInfoWrapper:(id<SentryProcessInfoSource>)processInfoWrapper;
diff --git a/Sources/Sentry/include/SentryNSDataSwizzling.h b/Sources/Sentry/include/SentryNSDataSwizzling.h
@@ -1,16 +1,17 @@
 #import "SentryDefines.h"
-#import "SentryFileIOTracker.h"
 
 NS_ASSUME_NONNULL_BEGIN
 
 @class SentryOptions;
 
+@protocol SentryFileIOTracking;
+
 @interface SentryNSDataSwizzling : NSObject
 SENTRY_NO_INIT
 
 @property (class, readonly) SentryNSDataSwizzling *shared;
 
-- (void)startWithOptions:(SentryOptions *)options tracker:(SentryFileIOTracker *)tracker;
+- (void)startWithOptions:(SentryOptions *)options tracker:(id<SentryFileIOTracking>)tracker;
 
 - (void)stop;
 
diff --git a/Sources/Sentry/include/SentryNSFileManagerSwizzling.h b/Sources/Sentry/include/SentryNSFileManagerSwizzling.h
@@ -1,16 +1,17 @@
 #import "SentryDefines.h"
-#import "SentryFileIOTracker.h"
 
 NS_ASSUME_NONNULL_BEGIN
 
 @class SentryOptions;
 
+@protocol SentryFileIOTracking;
+
 @interface SentryNSFileManagerSwizzling : NSObject
 SENTRY_NO_INIT
 
 @property (class, readonly) SentryNSFileManagerSwizzling *shared;
 
-- (void)startWithOptions:(SentryOptions *)options tracker:(SentryFileIOTracker *)tracker;
+- (void)startWithOptions:(SentryOptions *)options tracker:(id<SentryFileIOTracking>)tracker;
 
 - (void)stop;
 
diff --git a/Sources/Swift/Integrations/Performance/IO/SentryFileIOTracking.swift b/Sources/Swift/Integrations/Performance/IO/SentryFileIOTracking.swift
@@ -0,0 +1,20 @@
+@_spi(Private) @objc public protocol SentryFileIOTracking {
+    func enable()
+    func disable()
+    
+    func measureNSData(_ data: Data, writeToFile path: String, atomically: Bool, origin: String, method: (String, Bool) -> Bool) -> Bool
+    
+    func measureNSData(_ data: Data, writeToFile path: String, options writeOptionsMask: NSData.WritingOptions, origin: String, method: (String, NSData.WritingOptions, NSErrorPointer) -> Bool) throws
+    
+    func measureNSData(fromFile path: String, origin: String, method: (String) -> Data?) -> Data?
+
+    func measureNSData(fromFile path: String, options readOptionsMask: NSData.ReadingOptions, origin: String, method: (String, Data.ReadingOptions, NSErrorPointer) -> Data?) throws -> Data
+
+    func measureNSData(fromURL url: URL, options readOptionsMask: NSData.ReadingOptions, origin: String, method: (URL, NSData.ReadingOptions, NSErrorPointer) -> Data?) throws -> Data
+    
+    func measureNSFileManagerCreateFileAtPath(_ path: String, data: Data, attributes: [FileAttributeKey: Any], origin: String, method: (String, NSData, [FileAttributeKey: Any]) -> Bool) -> Bool
+    
+    func span(forPath path: String, origin: String, operation: String) -> (any Span)?
+
+    func span(forPath path: String, origin: String, operation: String, size: UInt) -> (any Span)?
+}
diff --git a/scripts/.clang-format-version b/scripts/.clang-format-version
@@ -1 +1 @@
-21.1.1
+21.1.2

Original file line number	Diff line number	Diff line change
`@@ -33,15 +33,15 @@ @implementation SentryFileIOTracker`
`33`	`33`
`34`	`34`	`NSString *const SENTRY_TRACKING_COUNTER_KEY = @"SENTRY_TRACKING_COUNTER_KEY";`
`35`	`35`
`36`		`-+ (instancetype _Nullable)sharedInstance`
	`36`	`++ (id<SentryFileIOTracking> _Nullable)sharedInstance`
`37`	`37`	`{`
`38`	`38`	`// It is necessary to check if the SDK is enabled because accessing the tracker will otherwise`
`39`	`39`	`// initialize the depency container without any configured SDK options. This is a known issue`
`40`	`40`	`// and needs to be fixed in general.`
`41`	`41`	`if (!SentrySDK.isEnabled) {`
`42`	`42`	`return nil;`
`43`	`43`	`}`
`44`		`- return SentryDependencyContainer.sharedInstance.fileIOTracker;`
	`44`	`+ return SentryDependencyContainer.sharedInstance.fileIOTracking;`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`- (instancetype)initWithThreadInspector:(SentryThreadInspector *)threadInspector`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`
`8`	`8`	`@interface SentryNSDataSwizzling ()`
`9`	`9`
`10`		`-@property (nonatomic, strong) SentryFileIOTracker *tracker;`
	`10`	`+@property (nonatomic, strong) id<SentryFileIOTracking> tracker;`
`11`	`11`
`12`	`12`	`@end`
`13`	`13`
`@@ -21,7 +21,7 @@ + (SentryNSDataSwizzling *)shared`
`21`	`21`	`return instance;`
`22`	`22`	`}`
`23`	`23`
`24`		`-- (void)startWithOptions:(SentryOptions )options tracker:(SentryFileIOTracker )tracker`
	`24`	`+- (void)startWithOptions:(SentryOptions *)options tracker:(id<SentryFileIOTracking>)tracker`
`25`	`25`	`{`
`26`	`26`	`self.tracker = tracker;`
`27`	`27`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`
`8`	`8`	`@interface SentryNSFileManagerSwizzling ()`
`9`	`9`
`10`		`-@property (nonatomic, strong) SentryFileIOTracker *tracker;`
	`10`	`+@property (nonatomic, strong) id<SentryFileIOTracking> tracker;`
`11`	`11`
`12`	`12`	`@end`
`13`	`13`
`@@ -21,7 +21,7 @@ + (SentryNSFileManagerSwizzling *)shared`
`21`	`21`	`return instance;`
`22`	`22`	`}`
`23`	`23`
`24`		`-- (void)startWithOptions:(SentryOptions )options tracker:(SentryFileIOTracker )tracker`
	`24`	`+- (void)startWithOptions:(SentryOptions *)options tracker:(id<SentryFileIOTracking>)tracker`
`25`	`25`	`{`
`26`	`26`	`self.tracker = tracker;`
`27`	`27`