ref: Convert SentryNSTimerFactory to Swift (#6015)

itaybre · web-flow · commit 1b008eeb8e00 · 2025-08-29T10:00:10.000-03:00
* ref: Convert `SentryNSTimerFactory` to Swift

* Fix build with SPM

* Print sentry error log if not on main thread

* Remove import

* Use `SentryProfilingSwiftHelpers` instead of a new class
diff --git a/Sentry.xcodeproj/project.pbxproj b/Sentry.xcodeproj/project.pbxproj
@@ -660,8 +660,6 @@
 		844EDC70294143B900C86F34 /* SentryNSProcessInfoWrapper.mm in Sources */ = {isa = PBXBuildFile; fileRef = 844EDC6E294143B900C86F34 /* SentryNSProcessInfoWrapper.mm */; };
 		844EDC76294144DB00C86F34 /* SentrySystemWrapper.h in Headers */ = {isa = PBXBuildFile; fileRef = 844EDC74294144DB00C86F34 /* SentrySystemWrapper.h */; };
 		844EDC77294144DB00C86F34 /* SentrySystemWrapper.mm in Sources */ = {isa = PBXBuildFile; fileRef = 844EDC75294144DB00C86F34 /* SentrySystemWrapper.mm */; };
-		844EDCE52947DC3100C86F34 /* SentryNSTimerFactory.h in Headers */ = {isa = PBXBuildFile; fileRef = 844EDCE32947DC3100C86F34 /* SentryNSTimerFactory.h */; };
-		844EDCE62947DC3100C86F34 /* SentryNSTimerFactory.m in Sources */ = {isa = PBXBuildFile; fileRef = 844EDCE42947DC3100C86F34 /* SentryNSTimerFactory.m */; };
 		844EDD6C2949387000C86F34 /* SentryMetricProfiler.h in Headers */ = {isa = PBXBuildFile; fileRef = 844EDD6B2949387000C86F34 /* SentryMetricProfiler.h */; };
 		8453421228BE855D00C22EEC /* SentrySampleDecision.m in Sources */ = {isa = PBXBuildFile; fileRef = 8453421128BE855D00C22EEC /* SentrySampleDecision.m */; };
 		8453421628BE8A9500C22EEC /* SentrySpanStatus.m in Sources */ = {isa = PBXBuildFile; fileRef = 8453421528BE8A9500C22EEC /* SentrySpanStatus.m */; };
@@ -1040,6 +1038,7 @@
 		F458D1172E186DF20028273E /* SentryScopePersistentStore+Fingerprint.swift in Sources */ = {isa = PBXBuildFile; fileRef = F458D1162E186DF20028273E /* SentryScopePersistentStore+Fingerprint.swift */; };
 		F458D1192E186E000028273E /* SentryScopePersistentStore+Extras.swift in Sources */ = {isa = PBXBuildFile; fileRef = F458D1182E186E000028273E /* SentryScopePersistentStore+Extras.swift */; };
 		F46DA6C32E1DBCA000DF6E3B /* SentryScopePersistentStore+Helper.swift in Sources */ = {isa = PBXBuildFile; fileRef = F46DA6C22E1DBCA000DF6E3B /* SentryScopePersistentStore+Helper.swift */; };
+		F48F767C2E60B555009D4E7D /* SentryNSTimerFactory.swift in Sources */ = {isa = PBXBuildFile; fileRef = F48F767B2E60B555009D4E7D /* SentryNSTimerFactory.swift */; };
 		F49D41982DEA27AF00D9244E /* SentryUseNSExceptionCallstackWrapperTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = F49D41972DEA27AF00D9244E /* SentryUseNSExceptionCallstackWrapperTests.swift */; };
 		F49D419A2DEA2FB000D9244E /* SentryCrashExceptionApplicationTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = F49D41992DEA2FB000D9244E /* SentryCrashExceptionApplicationTests.swift */; };
 		F49D419C2DEA30C300D9244E /* SentryCrashExceptionApplicationHelper.h in Headers */ = {isa = PBXBuildFile; fileRef = F49D419B2DEA30B800D9244E /* SentryCrashExceptionApplicationHelper.h */; };
@@ -1964,8 +1963,6 @@
 		844EDC74294144DB00C86F34 /* SentrySystemWrapper.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = SentrySystemWrapper.h; path = include/SentrySystemWrapper.h; sourceTree = "<group>"; };
 		844EDC75294144DB00C86F34 /* SentrySystemWrapper.mm */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.cpp.objcpp; path = SentrySystemWrapper.mm; sourceTree = "<group>"; };
 		844EDC7829415AB300C86F34 /* TestSentrySystemWrapper.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TestSentrySystemWrapper.swift; sourceTree = "<group>"; };
-		844EDCE32947DC3100C86F34 /* SentryNSTimerFactory.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = SentryNSTimerFactory.h; path = include/SentryNSTimerFactory.h; sourceTree = "<group>"; };
-		844EDCE42947DC3100C86F34 /* SentryNSTimerFactory.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = SentryNSTimerFactory.m; sourceTree = "<group>"; };
 		844EDCE72947DCD700C86F34 /* TestSentryNSTimerFactory.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TestSentryNSTimerFactory.swift; sourceTree = "<group>"; };
 		844EDD6B2949387000C86F34 /* SentryMetricProfiler.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = SentryMetricProfiler.h; path = Sources/Sentry/include/SentryMetricProfiler.h; sourceTree = SOURCE_ROOT; };
 		8452E77D2DBC43CF0087020B /* Brewfile-ci-build */ = {isa = PBXFileReference; lastKnownFileType = text; path = "Brewfile-ci-build"; sourceTree = "<group>"; };
@@ -2385,6 +2382,7 @@
 		F458D1162E186DF20028273E /* SentryScopePersistentStore+Fingerprint.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "SentryScopePersistentStore+Fingerprint.swift"; sourceTree = "<group>"; };
 		F458D1182E186E000028273E /* SentryScopePersistentStore+Extras.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "SentryScopePersistentStore+Extras.swift"; sourceTree = "<group>"; };
 		F46DA6C22E1DBCA000DF6E3B /* SentryScopePersistentStore+Helper.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "SentryScopePersistentStore+Helper.swift"; sourceTree = "<group>"; };
+		F48F767B2E60B555009D4E7D /* SentryNSTimerFactory.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryNSTimerFactory.swift; sourceTree = "<group>"; };
 		F49D41972DEA27AF00D9244E /* SentryUseNSExceptionCallstackWrapperTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryUseNSExceptionCallstackWrapperTests.swift; sourceTree = "<group>"; };
 		F49D41992DEA2FB000D9244E /* SentryCrashExceptionApplicationTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryCrashExceptionApplicationTests.swift; sourceTree = "<group>"; };
 		F49D419B2DEA30B800D9244E /* SentryCrashExceptionApplicationHelper.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = SentryCrashExceptionApplicationHelper.h; path = include/SentryCrashExceptionApplicationHelper.h; sourceTree = "<group>"; };
@@ -2600,6 +2598,7 @@
 		621D9F2D2B9B030E003D94DE /* Helper */ = {
 			isa = PBXGroup;
 			children = (
+				F48F767B2E60B555009D4E7D /* SentryNSTimerFactory.swift */,
 				FABE8E162E307A7C0040809A /* Dependencies.swift */,
 				FABE8E142E307A5C0040809A /* SentrySDK.swift */,
 				FA3A42712E1C5F9B00A08C39 /* SentryNSNotificationCenterWrapper.swift */,
@@ -2943,8 +2942,6 @@
 				844EDC6E294143B900C86F34 /* SentryNSProcessInfoWrapper.mm */,
 				844EDC74294144DB00C86F34 /* SentrySystemWrapper.h */,
 				844EDC75294144DB00C86F34 /* SentrySystemWrapper.mm */,
-				844EDCE32947DC3100C86F34 /* SentryNSTimerFactory.h */,
-				844EDCE42947DC3100C86F34 /* SentryNSTimerFactory.m */,
 				FAB359972E05D7E90083D5E3 /* SentryEventSwiftHelper.h */,
 				FAB359992E05D8080083D5E3 /* SentryEventSwiftHelper.m */,
 				33042A0B29DAF5F400C60085 /* SentryExtraContextProvider.h */,
@@ -5121,7 +5118,6 @@
 				7BD86EC5264A63F6005439DB /* SentrySysctl.h in Headers */,
 				63BE85701ECEC6DE00DC44F5 /* SentryDateUtils.h in Headers */,
 				63FE709520DA4C1000CDBAE8 /* SentryCrashReportFilterBasic.h in Headers */,
-				844EDCE52947DC3100C86F34 /* SentryNSTimerFactory.h in Headers */,
 				D8B088B629C9E3FF00213258 /* SentryTracerConfiguration.h in Headers */,
 				7B63459D280EBA6300CFA05A /* SentryUIEventTracker.h in Headers */,
 				7B7D873424864C6600D2ECFF /* SentryCrashDefaultMachineContextWrapper.h in Headers */,
@@ -5799,6 +5795,7 @@
 				FA67DD192DDBD4EA00896B02 /* SwizzleClassNameExclude.swift in Sources */,
 				7B2A70DD27D6083D008B0D15 /* SentryThreadWrapper.m in Sources */,
 				D8ACE3C72762187200F5A213 /* SentryNSDataSwizzling.m in Sources */,
+				F48F767C2E60B555009D4E7D /* SentryNSTimerFactory.swift in Sources */,
 				638DC9A11EBC6B6400A66E41 /* SentryRequestOperation.m in Sources */,
 				63AA767A1EB8D20500D153DE /* SentryLogC.m in Sources */,
 				84B0DFF42CD2CF64007FB332 /* SentryUserFeedbackFormController.swift in Sources */,
@@ -5811,7 +5808,6 @@
 				D4ECA4022E3CBEDE00C757EA /* SentryDummyPrivateEmptyClass.m in Sources */,
 				D80299502BA83A88000F0081 /* SentryPixelBuffer.swift in Sources */,
 				15E0A8F22411A45A00F044E3 /* SentrySession.m in Sources */,
-				844EDCE62947DC3100C86F34 /* SentryNSTimerFactory.m in Sources */,
 				D83D079C2B7F9D1C00CC9674 /* SentryMsgPackSerializer.m in Sources */,
 				D452FCBF2DDB6FD200AFF56F /* SentryWatchdogTerminationAttributesProcessor.swift in Sources */,
 				7B6D1261265F784000C9BE4B /* PrivateSentrySDKOnly.m in Sources */,
diff --git a/SentryTestUtils/SentryTestUtils-ObjC-BridgingHeader.h b/SentryTestUtils/SentryTestUtils-ObjC-BridgingHeader.h
@@ -44,7 +44,6 @@
 #import "SentryHub+Test.h"
 #import "SentryLogC.h"
 #import "SentryNSProcessInfoWrapper.h"
-#import "SentryNSTimerFactory.h"
 #import "SentryNetworkTracker.h"
 #import "SentryPerformanceTracker+Testing.h"
 #import "SentryReachability.h"
diff --git a/SentryTestUtils/TestSentryNSTimerFactory.swift b/SentryTestUtils/TestSentryNSTimerFactory.swift
@@ -3,7 +3,7 @@ import Foundation
 
 // We must not subclass NSTimer, see https://developer.apple.com/documentation/foundation/nstimer#1770465.
 // Therefore we return a NSTimer instance here with TimeInterval.infinity.
-public class TestSentryNSTimerFactory: SentryNSTimerFactory {
+@_spi(Private) public class TestSentryNSTimerFactory: SentryNSTimerFactory {
     public struct Overrides {
         private var _interval: TimeInterval?
         
@@ -44,17 +44,16 @@ public class TestSentryNSTimerFactory: SentryNSTimerFactory {
         self.currentDateProvider = currentDateProvider
         super.init()
     }
-}
 
-// MARK: Superclass overrides
-public extension TestSentryNSTimerFactory {
-    override func scheduledTimer(withTimeInterval interval: TimeInterval, repeats: Bool, block: @escaping (Timer) -> Void) -> Timer {
+    @objc
+    public override func scheduledTimer(withTimeInterval interval: TimeInterval, repeats: Bool, block: @escaping (Timer) -> Void) -> Timer {
         let timer = Timer.scheduledTimer(withTimeInterval: TimeInterval.infinity, repeats: repeats, block: block)
         overrides = Overrides(timer: timer, interval: interval, block: block, lastFireDate: currentDateProvider.date())
         return timer
     }
     
-    override func scheduledTimer(withTimeInterval ti: TimeInterval, target aTarget: Any, selector aSelector: Selector, userInfo: Any?, repeats yesOrNo: Bool) -> Timer {
+    @objc
+    public override func scheduledTimer(withTimeInterval ti: TimeInterval, target aTarget: Any, selector aSelector: Selector, userInfo: Any?, repeats yesOrNo: Bool) -> Timer {
         let timer = Timer.scheduledTimer(timeInterval: ti, target: aTarget, selector: aSelector, userInfo: userInfo, repeats: yesOrNo)
         //swiftlint:disable force_cast
         let invocationInfo = Overrides.InvocationInfo(target: aTarget as! NSObject, selector: aSelector)
diff --git a/Sources/Sentry/Profiling/SentryContinuousProfiler.mm b/Sources/Sentry/Profiling/SentryContinuousProfiler.mm
@@ -5,7 +5,6 @@
 #    import "SentryDependencyContainer.h"
 #    import "SentryLogC.h"
 #    import "SentryMetricProfiler.h"
-#    import "SentryNSTimerFactory.h"
 #    import "SentryProfiler+Private.h"
 #    import "SentryProfilerSerialization.h"
 #    import "SentryProfilerState.h"
@@ -193,12 +192,8 @@ + (void)scheduleTimer
             return;
         }
 
-        _chunkTimer = [SentryDependencyContainer.sharedInstance.timerFactory
-            scheduledTimerWithTimeInterval:kSentryProfilerChunkExpirationInterval
-                                    target:self
-                                  selector:@selector(timerExpired)
-                                  userInfo:nil
-                                   repeats:YES];
+        _chunkTimer = sentry_scheduledTimerWithTarget(
+            kSentryProfilerChunkExpirationInterval, self, @selector(timerExpired), nil, YES);
     });
 }
 
diff --git a/Sources/Sentry/Profiling/SentryProfilingSwiftHelpers.m b/Sources/Sentry/Profiling/SentryProfilingSwiftHelpers.m
@@ -146,4 +146,25 @@
                 usingBlock:^(NSNotification *_Nonnull notification) { block(); }];
 }
 
+NSTimer *
+sentry_scheduledTimer(NSTimeInterval interval, BOOL repeats, dispatch_block_t block)
+{
+    return [SentryDependencyContainer.sharedInstance.timerFactory
+        scheduledTimerWithTimeInterval:interval
+                               repeats:repeats
+                                 block:^(NSTimer *_Nonnull timer) { block(); }];
+}
+
+NSTimer *
+sentry_scheduledTimerWithTarget(
+    NSTimeInterval interval, id target, SEL selector, _Nullable id userInfo, BOOL repeats)
+{
+    return [SentryDependencyContainer.sharedInstance.timerFactory
+        scheduledTimerWithTimeInterval:interval
+                                target:target
+                              selector:selector
+                              userInfo:userInfo
+                               repeats:repeats];
+}
+
 #endif // SENTRY_TARGET_PROFILING_SUPPORTED
diff --git a/Sources/Sentry/Profiling/SentryTraceProfiler.mm b/Sources/Sentry/Profiling/SentryTraceProfiler.mm
@@ -6,7 +6,6 @@
 
 #    import "SentryLogC.h"
 #    import "SentryMetricProfiler.h"
-#    import "SentryNSTimerFactory.h"
 #    import "SentryProfiledTracerConcurrency.h"
 #    import "SentryProfiler+Private.h"
 #    import "SentryProfilingSwiftHelpers.h"
@@ -88,13 +87,8 @@ + (void)scheduleTimeoutTimer
             return;
         }
 
-        _sentry_threadUnsafe_traceProfileTimeoutTimer =
-            [SentryDependencyContainer.sharedInstance.timerFactory
-                scheduledTimerWithTimeInterval:kSentryProfilerTimeoutInterval
-                                       repeats:NO
-                                         block:^(NSTimer *_Nonnull timer) {
-                                             [self timeoutTimerExpired];
-                                         }];
+        _sentry_threadUnsafe_traceProfileTimeoutTimer = sentry_scheduledTimer(
+            kSentryProfilerTimeoutInterval, NO, ^{ [self timeoutTimerExpired]; });
     });
 }
 
diff --git a/Sources/Sentry/SentryDependencyContainer.m b/Sources/Sentry/SentryDependencyContainer.m
@@ -12,7 +12,6 @@
 #import "SentryInternalDefines.h"
 #import "SentryLogC.h"
 #import "SentryNSProcessInfoWrapper.h"
-#import "SentryNSTimerFactory.h"
 #import "SentryOptions+Private.h"
 #import "SentryRandom.h"
 #import "SentrySDK+Private.h"
diff --git a/Sources/Sentry/SentryHub.m b/Sources/Sentry/SentryHub.m
@@ -12,7 +12,6 @@
 #import "SentryInternalDefines.h"
 #import "SentryLevelMapper.h"
 #import "SentryLogC.h"
-#import "SentryNSTimerFactory.h"
 #import "SentryOptions+Private.h"
 #import "SentryPerformanceTracker.h"
 #import "SentryProfilingConditionals.h"
diff --git a/Sources/Sentry/SentryMetricProfiler.m b/Sources/Sentry/SentryMetricProfiler.m
@@ -8,7 +8,6 @@
 #    import "SentryEvent+Private.h"
 #    import "SentryFormatter.h"
 #    import "SentryLogC.h"
-#    import "SentryNSTimerFactory.h"
 #    import "SentrySwift.h"
 #    import "SentrySystemWrapper.h"
 #    import "SentryTime.h"
diff --git a/Sources/Sentry/SentryNSTimerFactory.m b/Sources/Sentry/SentryNSTimerFactory.m
diff --git a/Sources/Sentry/include/SentryNSTimerFactory.h b/Sources/Sentry/include/SentryNSTimerFactory.h
diff --git a/Sources/Sentry/include/SentryProfilingSwiftHelpers.h b/Sources/Sentry/include/SentryProfilingSwiftHelpers.h
@@ -41,6 +41,9 @@ void sentry_addObserver(id observer, SEL selector, NSNotificationName name, _Nul
 void sentry_removeObserver(id observer);
 void sentry_postNotification(NSNotification *notification);
 id sentry_addObserverForName(NSNotificationName name, dispatch_block_t block);
+NSTimer *sentry_scheduledTimer(NSTimeInterval interval, BOOL repeats, dispatch_block_t block);
+NSTimer *sentry_scheduledTimerWithTarget(
+    NSTimeInterval interval, id target, SEL selector, _Nullable id userInfo, BOOL repeats);
 
 #ifdef __cplusplus
 }
diff --git a/Sources/Swift/Helper/SentryNSTimerFactory.swift b/Sources/Swift/Helper/SentryNSTimerFactory.swift
@@ -0,0 +1,25 @@
+import Foundation
+
+@objc
+@_spi(Private) public class SentryNSTimerFactory: NSObject {
+    
+    @objc @discardableResult
+    @_spi(Private) public func scheduledTimer(withTimeInterval interval: TimeInterval, repeats: Bool, block: @escaping (Timer) -> Void) -> Timer {
+        if !Thread.isMainThread {
+            let warningText = "Timers must be scheduled from the main thread, or they may never fire. See the attribute on the declaration in NSTimer.h. See https://stackoverflow.com/questions/8304702/how-do-i-create-a-nstimer-on-a-background-thread for more info."
+            SentrySDKLog.warning(warningText)
+            assertionFailure(warningText)
+        }
+        return Timer.scheduledTimer(withTimeInterval: interval, repeats: repeats, block: block)
+    }
+    
+    @objc @discardableResult
+    @_spi(Private) public func scheduledTimer(withTimeInterval ti: TimeInterval, target aTarget: Any, selector aSelector: Selector, userInfo: Any?, repeats yesOrNo: Bool) -> Timer {
+        if !Thread.isMainThread {
+            let warningText = "Timers must be scheduled from the main thread, or they may never fire. See the attribute on the declaration in NSTimer.h. See https://stackoverflow.com/questions/8304702/how-do-i-create-a-nstimer-on-a-background-thread for more info."
+            SentrySDKLog.warning(warningText)
+            assertionFailure(warningText)
+        }
+        return Timer.scheduledTimer(timeInterval: ti, target: aTarget, selector: aSelector, userInfo: userInfo, repeats: yesOrNo)
+    }
+}
diff --git a/Tests/SentryProfilerTests/SentryNSTimerFactoryTest.swift b/Tests/SentryProfilerTests/SentryNSTimerFactoryTest.swift
@@ -1,3 +1,4 @@
+@_spi(Private) @testable import Sentry
 import XCTest
 
 class SentryNSTimerFactoryTests: XCTestCase {
diff --git a/Tests/SentryTests/SentryTests-Bridging-Header.h b/Tests/SentryTests/SentryTests-Bridging-Header.h
@@ -152,7 +152,6 @@
 #import "SentryNSDictionarySanitize.h"
 #import "SentryNSError.h"
 #import "SentryNSProcessInfoWrapper.h"
-#import "SentryNSTimerFactory.h"
 #import "SentryNSURLRequestBuilder.h"
 #import "SentryNSURLSessionTaskSearch.h"
 #import "SentryNetworkTracker.h"
