feat(v9): Mark deprecated APIs as deprecated (#5599)

Author: noahsmartin

Sources/Sentry/Profiling/SentryLaunchProfiling.m

@@ -164,9 +164,12 @@
         return sentry_launchShouldHaveContinuousProfilingV2(options);
     }
 
+#    pragma clang diagnostic push
+#    pragma clang diagnostic ignored "-Wdeprecated-declarations"
     if ([options isContinuousProfilingEnabled]) {
         return (SentryLaunchProfileConfig) { options.enableAppLaunchProfiling, nil, nil };
     }
+#    pragma clang diagnostic pop
 
     return sentry_launchShouldHaveTransactionProfiling(options);
 }

Sources/Sentry/Public/SentryOptions.h

@@ -543,7 +543,9 @@ typedef void (^SentryProfilingConfigurationBlock)(SentryProfileOptions *_Nonnull
  * @c SentryProfileOptions.startOnAppStart and @c SentryProfileOptions.lifecycle .
  * @note Profiling is automatically disabled if a thread sanitizer is attached.
  */
-@property (nonatomic, assign) BOOL enableAppLaunchProfiling;
+@property (nonatomic, assign) BOOL enableAppLaunchProfiling DEPRECATED_MSG_ATTRIBUTE(
+    "This property is deprecated and will be removed in a future version of the SDK. See "
+    "SentryProfileOptions.startOnAppStart and SentryProfileOptions.lifecycle");
 
 /**
  * @note Profiling is not supported on watchOS or tvOS.
@@ -570,7 +572,9 @@ typedef void (^SentryProfilingConfigurationBlock)(SentryProfileOptions *_Nonnull
  * @warning This property is deprecated and will be removed in a future version of the SDK. See
  * @c  SentryProfileOptions.sessionSampleRate.
  */
-@property (nullable, nonatomic, strong) NSNumber *profilesSampleRate;
+@property (nullable, nonatomic, strong) NSNumber *profilesSampleRate DEPRECATED_MSG_ATTRIBUTE(
+    "This property is deprecated and will be removed in a future version of the SDK. See "
+    "SentryProfileOptions.sessionSampleRate");
 
 /**
  * @note Profiling is not supported on watchOS or tvOS.
@@ -584,7 +588,11 @@ typedef void (^SentryProfilingConfigurationBlock)(SentryProfileOptions *_Nonnull
  * @warning This property is deprecated and will be removed in a future version of the SDK. See
  * @c SentryProfileOptions.sessionSampleRate .
  */
-@property (nullable, nonatomic) SentryTracesSamplerCallback profilesSampler NS_SWIFT_SENDABLE;
+@property (nullable, nonatomic)
+    SentryTracesSamplerCallback profilesSampler NS_SWIFT_SENDABLE DEPRECATED_MSG_ATTRIBUTE(
+        "This property is deprecated and will be removed in a future version of the SDK. See "
+        "SentryProfileOptions.sessionSampleRate");
+;
 
 /**
  * If profiling should be enabled or not.
@@ -597,7 +605,8 @@ typedef void (^SentryProfilingConfigurationBlock)(SentryProfileOptions *_Nonnull
  * @note Profiling is automatically disabled if a thread sanitizer is attached.
  * @warning This property is deprecated and will be removed in a future version of the SDK.
  */
-@property (nonatomic, assign, readonly) BOOL isProfilingEnabled;
+@property (nonatomic, assign, readonly) BOOL isProfilingEnabled DEPRECATED_MSG_ATTRIBUTE(
+    "This property is deprecated and will be removed in a future version of the SDK");
 
 /**
  * @brief Whether to enable the sampling profiler.

Sources/Sentry/SentryOptions.m

@@ -153,7 +153,10 @@ - (instancetype)init
         self.tracesSampleRate = nil;
 #if SENTRY_TARGET_PROFILING_SUPPORTED
         _enableProfiling = NO;
+#    pragma clang diagnostic push
+#    pragma clang diagnostic ignored "-Wdeprecated-declarations"
         self.profilesSampleRate = SENTRY_INITIAL_PROFILES_SAMPLE_RATE;
+#    pragma clang diagnostic pop
 #endif // SENTRY_TARGET_PROFILING_SUPPORTED
         self.enableCoreDataTracing = YES;
         _enableSwizzling = YES;
@@ -538,12 +541,18 @@ - (BOOL)validateOptions:(NSDictionary<NSString *, id> *)options
 
 #if SENTRY_TARGET_PROFILING_SUPPORTED
     if ([options[@"profilesSampleRate"] isKindOfClass:[NSNumber class]]) {
+#    pragma clang diagnostic push
+#    pragma clang diagnostic ignored "-Wdeprecated-declarations"
         self.profilesSampleRate = options[@"profilesSampleRate"];
+#    pragma clang diagnostic pop
     }
 
+#    pragma clang diagnostic push
+#    pragma clang diagnostic ignored "-Wdeprecated-declarations"
     if ([self isBlock:options[@"profilesSampler"]]) {
         self.profilesSampler = options[@"profilesSampler"];
     }
+#    pragma clang diagnostic pop
 
     [self setBool:options[@"enableProfiling"]
             block:^(BOOL value) { self->_enableProfiling = value; }];

Sources/Sentry/SentrySampling.m

@@ -108,15 +108,18 @@
                                                  forSampleRate:@1.0
                                                 withSampleRand:@1.0];
     }
-#    pragma clang diagnostic pop
 
     NSNumber *callbackRate = _sentry_samplerCallbackRate(
         options.profilesSampler, context, SENTRY_DEFAULT_PROFILES_SAMPLE_RATE);
+#    pragma clang diagnostic pop
     if (callbackRate != nil) {
         return _sentry_calcSample(callbackRate);
     }
 
+#    pragma clang diagnostic push
+#    pragma clang diagnostic ignored "-Wdeprecated-declarations"
     return _sentry_calcSampleFromNumericalRate(options.profilesSampleRate);
+#    pragma clang diagnostic pop
 }
 
 SentrySamplerDecision *

Sources/Sentry/SentrySdkInfo.m

@@ -22,8 +22,11 @@ + (instancetype)global
 - (instancetype)initWithOptions:(SentryOptions *_Nullable)options
 {
 
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
     NSArray<NSString *> *features =
         [SentryEnabledFeaturesBuilder getEnabledFeaturesWithOptions:options];
+#pragma clang diagnostic pop
 
     NSMutableArray<NSString *> *integrations =
         [SentrySDK.currentHub trimmedInstalledIntegrationNames];

Sources/Swift/Helper/SentryEnabledFeaturesBuilder.swift

@@ -3,6 +3,7 @@ import Foundation
 @objcMembers @_spi(Private) public class SentryEnabledFeaturesBuilder: NSObject {
 
     // swiftlint:disable cyclomatic_complexity function_body_length
+    @available(*, deprecated, message: "This is only marked as deprecated because enableAppLaunchProfiling is marked as deprecated. Once that is removed this can be removed.")
     public static func getEnabledFeatures(options: Options?) -> [String] {
         guard let options = options else {
             return []

Tests/SentryProfilerTests/SentryAppLaunchProfilingTests.swift

@@ -2,6 +2,7 @@
 import XCTest
 
 #if os(iOS) || os(macOS) || targetEnvironment(macCatalyst)
+@available(*, deprecated, message: "App launch profiling is deprecated in favor of continuous profiling.")
 final class SentryAppLaunchProfilingTests: XCTestCase {
     private var fixture: SentryProfileTestFixture!
 
@@ -17,6 +18,7 @@ final class SentryAppLaunchProfilingTests: XCTestCase {
 }
 
 // MARK: transaction based profiling
+@available(*, deprecated, message: "App launch profiling is deprecated in favor of continuous profiling.")
 extension SentryAppLaunchProfilingTests {
     // test that the launch trace instance is nil after stopping the launch
     // profiler
@@ -95,6 +97,7 @@ extension SentryAppLaunchProfilingTests {
 
 // MARK: transaction based profiling iOS-only
 #if !os(macOS)
+@available(*, deprecated, message: "App launch profiling is deprecated in favor of continuous profiling.")
 extension SentryAppLaunchProfilingTests {
     // test that if a launch trace profiler is running and SentryTimeToDisplayTracker reports the app had its initial frame drawn and isn't waiting for full drawing, that the profile is stopped
     func testLaunchTraceProfileStoppedOnInitialDisplayWithoutWaitingForFullDisplay() throws {
@@ -145,6 +148,7 @@ extension SentryAppLaunchProfilingTests {
 #endif // !os(macOS)
 
 // MARK: continuous profiling v1
+@available(*, deprecated, message: "Continuos profiling V1 is deprecated.")
 extension SentryAppLaunchProfilingTests {
     // test continuous launch profiling configuration
     func testContinuousLaunchProfileV1Configuration() throws {
@@ -205,6 +209,7 @@ extension SentryAppLaunchProfilingTests {
 
 // MARK: continuous profiling v1 iOS-only
 #if !os(macOS)
+@available(*, deprecated, message: "Continuos profiling V1 is deprecated.")
 extension SentryAppLaunchProfilingTests {
     // test that if a launch continuous profiler is running and SentryTimeToDisplayTracker reports the app is fully drawn, that the profiler continues running
     func testLaunchContinuousProfileV1NotStoppedOnFullyDisplayed() throws {
@@ -250,6 +255,7 @@ extension SentryAppLaunchProfilingTests {
 #endif // !os(macOS)
 
 // MARK: continuous profiling v2
+@available(*, deprecated, message: "This is only deprecated because SentryAppLaunchProfilingTests is deprecated. Once trace based and continuous profiling v1 is removed this deprecation can be removed.")
 extension SentryAppLaunchProfilingTests {
     func testContinuousLaunchProfileV2TraceLifecycleConfiguration() throws {
         // Arrange
@@ -488,6 +494,7 @@ extension SentryAppLaunchProfilingTests {
 
 // MARK: continuous profiling v2 iOS-only
 #if !os(macOS)
+@available(*, deprecated, message: "This is only deprecated because SentryAppLaunchProfilingTests is deprecated. Once trace based and continuous profiling v1 is removed this deprecation can be removed.")
 extension SentryAppLaunchProfilingTests {
     func testLaunchContinuousProfileV2TraceLifecycleNotStoppedOnFullyDisplayed() throws {
         // Arrange

Tests/SentryProfilerTests/SentryAppStartProfilingConfigurationTests.swift

@@ -28,6 +28,7 @@ final class SentryAppStartProfilingConfigurationTests: XCTestCase {
     }
 }
 
+@available(*, deprecated, message: "This is only marked as deprecated because enableAppLaunchProfiling is marked as deprecated. Once that is removed this can be removed.")
 extension SentryAppStartProfilingConfigurationTests {
     func testValidCombinations() {
         for config in SentryAppStartProfilingConfigurationTests.validConfigurations {
@@ -61,6 +62,7 @@ extension SentryAppStartProfilingConfigurationTests {
 }
 
 private extension SentryAppStartProfilingConfigurationTests {
+    @available(*, deprecated, message: "This is only marked as deprecated because enableAppLaunchProfiling is marked as deprecated. Once that is removed this can be removed.")
     private func performTest(expectedOptions: LaunchProfileOptions, shouldProfileLaunch: Bool) {
         let actualOptions = Options()
         actualOptions.enableAppLaunchProfiling = expectedOptions.enableAppLaunchProfiling

Tests/SentryProfilerTests/SentryContinuousProfilerTests.swift

@@ -5,6 +5,7 @@ import XCTest
 
 #if os(iOS) || os(macOS) || targetEnvironment(macCatalyst)
 
+@available(*, deprecated, message: "This is only marked as deprecated because profilesSampleRate is marked as deprecated. Once that is removed this can be removed.")
 final class SentryContinuousProfilerTests: XCTestCase {
     private var fixture: SentryProfileTestFixture!
 
@@ -206,6 +207,7 @@ final class SentryContinuousProfilerTests: XCTestCase {
     }
 }
 
+@available(*, deprecated, message: "This is only marked as deprecated because profilesSampleRate is marked as deprecated. Once that is removed this can be removed.")
 private extension SentryContinuousProfilerTests {
     func addMockSamples(mockAddresses: [NSNumber]) throws {
         let mockThreadMetadata = SentryProfileTestFixture.ThreadMetadata(id: 1, priority: 2, name: "main")

Tests/SentryProfilerTests/SentryProfileTestFixture.swift

@@ -39,6 +39,7 @@ class SentryProfileTestFixture {
     lazy var framesTracker = TestFramesTracker(displayLinkWrapper: displayLinkWrapper, dateProvider: currentDateProvider, dispatchQueueWrapper: dispatchQueueWrapper, notificationCenter: notificationCenter, keepDelayedFramesDuration: 0)
 #endif // !os(macOS)
 
+    @available(*, deprecated, message: "This is only marked as deprecated because profilesSampleRate is marked as deprecated. Once that is removed this can be removed.")
     init() {
         SentryDependencyContainer.sharedInstance().dispatchQueueWrapper = dispatchQueueWrapper
         SentryDependencyContainer.sharedInstance().dateProvider = currentDateProvider