ref: Deprecate integrations option (#5749)

Author: noahsmartin

CHANGELOG-v9.md

@@ -12,6 +12,7 @@ Removes segment property on SentryUser, SentryBaggage, and SentryTraceContext (#
 Removes public SentrySerializable conformance from many public models (#5636)
 Removes Decodable conformances from the public API of model classes (#5691)
 Removes enableTracing property from SentryOptions (#5694)
+Removes `integrations` property from `SentryOptions` (#5749)
 
 ### Fixes
 

CHANGELOG.md

@@ -18,6 +18,7 @@
 - Move continuous profiling payload serialization off of the main thread (#5613)
 - Improve video generation using apple recommended loop (#5612)
 - Use -OSize for release builds (#5721)
+- Mark The `integrations` parameter of `SentryOptions` as deprecated rather than printing a warning (#5749)
 
 ### Fixes
 

SentryTestUtils/TestOptions.swift

@@ -2,16 +2,19 @@ import Foundation
 import Sentry
 
 public extension Options {
+    @available(*, deprecated)
     func setIntegrations(_ integrations: [AnyClass]) {
         self.integrations = integrations.map {
             NSStringFromClass($0)
         }
     }
 
+    @available(*, deprecated)
     func removeAllIntegrations() {
         self.integrations = []
     }
 
+    @available(*, deprecated)
     static func noIntegrations() -> Options {
         let options = Options()
         options.removeAllIntegrations()

Sources/Sentry/Public/SentryOptions.h

@@ -191,10 +191,14 @@ NS_SWIFT_NAME(Options)
 @property (nullable, nonatomic, copy)
     SentryOnCrashedLastRunCallback onCrashedLastRun NS_SWIFT_SENDABLE;
 
+#if !SDK_V9
 /**
  * Array of integrations to install.
  */
-@property (nullable, nonatomic, copy) NSArray<NSString *> *integrations;
+@property (nullable, nonatomic, copy) NSArray<NSString *> *integrations DEPRECATED_MSG_ATTRIBUTE(
+    "Setting `SentryOptions.integrations` is deprecated. Integrations should be enabled or "
+    "disabled using their respective `SentryOptions.enable*` property.");
+#endif // !SDK_V9
 
 /**
  * Array of default integrations. Will be used if @c integrations is @c nil .

Sources/Sentry/SentryOptions.m

@@ -58,7 +58,9 @@ - (instancetype)init
         self.debug = NO;
         self.maxBreadcrumbs = defaultMaxBreadcrumbs;
         self.maxCacheItems = 30;
+#if !SDK_V9
         _integrations = [SentryOptions defaultIntegrations];
+#endif // !SDK_V9
         self.sampleRate = SENTRY_DEFAULT_SAMPLE_RATE;
         self.enableAutoSessionTracking = YES;
         self.enableGraphQLOperationTracking = NO;
@@ -210,13 +212,12 @@ - (void)setFailedRequestTargets:(NSArray *)failedRequestTargets
     _failedRequestTargets = failedRequestTargets;
 }
 
+#if !SDK_V9
 - (void)setIntegrations:(NSArray<NSString *> *)integrations
 {
-    SENTRY_LOG_WARN(
-        @"Setting `SentryOptions.integrations` is deprecated. Integrations should be enabled or "
-        @"disabled using their respective `SentryOptions.enable*` property.");
     _integrations = integrations.mutableCopy;
 }
+#endif // !SDK_V9
 
 - (void)setDsn:(NSString *)dsn
 {

Sources/Sentry/SentrySDKInternal.m

@@ -560,8 +560,15 @@ + (void)installIntegrations
         return;
     }
     SentryOptions *options = [SentrySDKInternal.currentHub getClient].options;
+#if SDK_V9
+    NSMutableArray<NSString *> *integrationNames = [SentryOptions defaultIntegrations].mutableCopy;
+#else
+#    pragma clang diagnostic push
+#    pragma clang diagnostic ignored "-Wdeprecated-declarations"
     NSMutableArray<NSString *> *integrationNames =
         [SentrySDKInternal.currentHub getClient].options.integrations.mutableCopy;
+#    pragma clang diagnostic pop
+#endif // SDK_V9
 
     NSArray<Class> *defaultIntegrations = SentryOptionsInternal.defaultIntegrationClasses;
 

Sources/Sentry/SentyOptionsInternal.m

@@ -196,10 +196,15 @@ + (BOOL)validateOptions:(NSDictionary<NSString *, id> *)options
         sentryOptions.onCrashedLastRun = options[@"onCrashedLastRun"];
     }
 
+#if !SDK_V9
     if ([options[@"integrations"] isKindOfClass:[NSArray class]]) {
+#    pragma clang diagnostic push
+#    pragma clang diagnostic ignored "-Wdeprecated-declarations"
         sentryOptions.integrations =
             [[options[@"integrations"] filteredArrayUsingPredicate:isNSString] mutableCopy];
+#    pragma clang diagnstic pop
     }
+#endif // !SDK_V9
 
     if ([options[@"sampleRate"] isKindOfClass:[NSNumber class]]) {
         sentryOptions.sampleRate = options[@"sampleRate"];

Tests/SentryProfilerTests/SentryProfilingPublicAPITests.swift

@@ -7,6 +7,7 @@ import XCTest
 // swiftlint:disable file_length
 class SentryProfilingPublicAPITests: XCTestCase {
     private class Fixture {
+        @available(*, deprecated, message: "This is deprecated because SentryOptions integrations is deprecated")
         let options: Options = {
             let options = Options.noIntegrations()
             options.dsn = TestConstants.dsnAsString(username: "SentrySDKTests")
@@ -35,7 +36,9 @@ class SentryProfilingPublicAPITests: XCTestCase {
 
         let currentDate = TestCurrentDateProvider()
         lazy var timerFactory = TestSentryNSTimerFactory(currentDateProvider: currentDate)
+        @available(*, deprecated, message: "This is deprecated because SentryOptions integrations is deprecated")
         lazy var client = TestClient(options: options)!
+        @available(*, deprecated, message: "This is deprecated because SentryOptions integrations is deprecated")
         lazy var hub = SentryHub(client: client, andScope: scope)
     }
 
@@ -52,6 +55,7 @@ class SentryProfilingPublicAPITests: XCTestCase {
         SentryDependencyContainer.sharedInstance().dateProvider = fixture.currentDate
     }
 
+    @available(*, deprecated, message: "This is deprecated because SentryOptions integrations is deprecated")
     override func tearDown() {
         super.tearDown()
 
@@ -668,12 +672,14 @@ extension SentryProfilingPublicAPITests {
 }
 
 private extension SentryProfilingPublicAPITests {
+    @available(*, deprecated, message: "This is deprecated because SentryOptions integrations is deprecated")
     func givenSdkWithHub() {
         SentrySDKInternal.setCurrentHub(fixture.hub)
         SentrySDKInternal.setStart(with: fixture.options)
         sentry_sdkInitProfilerTasks(fixture.options, fixture.hub)
     }
 
+    @available(*, deprecated, message: "This is deprecated because SentryOptions integrations is deprecated")
     func givenSdkWithHubButNoClient() {
         SentrySDKInternal.setCurrentHub(SentryHub(client: nil, andScope: nil))
         SentrySDKInternal.setStart(with: fixture.options)

Tests/SentryTests/Integrations/Performance/CoreData/SentryCoreDataTrackingIntegrationTest.swift

@@ -9,6 +9,7 @@ class SentryCoreDataTrackingIntegrationTests: XCTestCase {
         let options: Options
         let coreDataStack: TestCoreDataStack
 
+        @available(*, deprecated, message: "This is deprecated because SentryOptions integrations is deprecated")
         init(testName: String) {
             coreDataStack = TestCoreDataStack(databaseFilename: "db-\(testName.hashValue).sqlite")
             options = Options()
@@ -24,6 +25,7 @@ class SentryCoreDataTrackingIntegrationTests: XCTestCase {
 
     private var fixture: Fixture!
 
+    @available(*, deprecated, message: "This is deprecated because SentryOptions integrations is deprecated")
     override func setUp() {
         super.setUp()
         fixture = Fixture(testName: self.name)

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

@@ -20,6 +20,7 @@ class DataSentryTracingIntegrationTests: XCTestCase {
 
         init() {}
 
+        @available(*, deprecated, message: "This is deprecated because SentryOptions integrations is deprecated")
         func getSut(testName: String, isSDKEnabled: Bool = true, isEnabled: Bool = true) throws -> Data {
             let fileManager = FileManager.default
             let tempDirUrl = URL(fileURLWithPath: NSTemporaryDirectory())
@@ -130,6 +131,7 @@ class DataSentryTracingIntegrationTests: XCTestCase {
 
     // MARK: - Data.init(contentsOfWithSentryTracing:)
 
+    @available(*, deprecated, message: "This is deprecated because SentryOptions integrations is deprecated")
     func testInitContentsOfWithSentryTracing_shouldTraceManually() throws {
         // -- Arrange --
         let expectedData = try fixture.getSut(testName: self.name)
@@ -159,6 +161,7 @@ class DataSentryTracingIntegrationTests: XCTestCase {
         XCTAssertGreaterThan(endTimestamp.timeIntervalSince1970, startTimestamp.timeIntervalSince1970)
     }
 
+    @available(*, deprecated, message: "This is deprecated because SentryOptions integrations is deprecated")
     func testInitContentsOfWithSentryTracingWithOptions_shouldPassOptionsToSystemImplementation() throws {
         // -- Arrange --
         let expectedData = try fixture.getSut(testName: self.name)
@@ -186,6 +189,7 @@ class DataSentryTracingIntegrationTests: XCTestCase {
         XCTAssertEqual(mappedSentryData, expectedData)
     }
 
+    @available(*, deprecated, message: "This is deprecated because SentryOptions integrations is deprecated")
     func testInitContentsOfWithSentryTracing_throwsError_shouldTraceManuallyWithErrorRethrow() throws {
         // -- Arrange --
         let _ = try fixture.getSut(testName: self.name)
@@ -212,6 +216,7 @@ class DataSentryTracingIntegrationTests: XCTestCase {
         XCTAssertGreaterThan(endTimestamp.timeIntervalSince1970, startTimestamp.timeIntervalSince1970)
     }
 
+    @available(*, deprecated, message: "This is deprecated because SentryOptions integrations is deprecated")
     func testInitContentsOfWithSentryTracing_nonFileUrl_shouldNotTraceManually() throws {
         // -- Arrange --
         let _ = try fixture.getSut(testName: self.name)
@@ -225,6 +230,7 @@ class DataSentryTracingIntegrationTests: XCTestCase {
         XCTAssertEqual(parentTransaction.children.count, 0)
     }
 
+    @available(*, deprecated, message: "This is deprecated because SentryOptions integrations is deprecated")
     func testInitContentsOfWithSentryTracing_trackerIsNotEnabled_shouldNotTraceManually() throws {
         // -- Arrange --
         let _ = try fixture.getSut(testName: self.name, isEnabled: false)
@@ -238,6 +244,7 @@ class DataSentryTracingIntegrationTests: XCTestCase {
         XCTAssertEqual(parentTransaction.children.count, 0)
     }
 
+    @available(*, deprecated, message: "This is deprecated because SentryOptions integrations is deprecated")
     func testInitContentsOfWithSentryTracing_fileIsIgnored_shouldNotTraceManually() throws {
         // -- Arrange --
         let _ = try fixture.getSut(testName: self.name)
@@ -251,6 +258,7 @@ class DataSentryTracingIntegrationTests: XCTestCase {
         XCTAssertEqual(parentTransaction.children.count, 0)
     }
 
+    @available(*, deprecated, message: "This is deprecated because SentryOptions integrations is deprecated")
     func testInitContentsOfWithSentryTracing_SDKIsNotStarted_shouldReadData() throws {
         // -- Arrange --
         let _ = try fixture.getSut(testName: self.name, isSDKEnabled: false)
@@ -263,6 +271,7 @@ class DataSentryTracingIntegrationTests: XCTestCase {
         XCTAssertEqual(data, fixture.data)
     }
 
+    @available(*, deprecated, message: "This is deprecated because SentryOptions integrations is deprecated")
     func testInitContentsOfWithSentryTracing_SDKIsClosed_shouldReadData() throws {
         // -- Arrange --
         let _ = try fixture.getSut(testName: self.name)
@@ -278,6 +287,7 @@ class DataSentryTracingIntegrationTests: XCTestCase {
 
     // MARK: - Data.writeWithSentryTracing(to:)
 
+    @available(*, deprecated, message: "This is deprecated because SentryOptions integrations is deprecated")
     func testWriteWithSentryTracing_shouldTraceManuallyWithErrorRethrow() throws {
         // -- Arrange --
         let sut: Data = try fixture.getSut(testName: self.name)
@@ -313,6 +323,7 @@ class DataSentryTracingIntegrationTests: XCTestCase {
         XCTAssertGreaterThan(endTimestamp.timeIntervalSince1970, startTimestamp.timeIntervalSince1970)
     }
 
+    @available(*, deprecated, message: "This is deprecated because SentryOptions integrations is deprecated")
     func testWriteWithSentryTracingWithOptions_shouldPassOptionsToSystemImplementation() throws {
         // -- Arrange --
         let sut: Data = try fixture.getSut(testName: self.name)
@@ -344,6 +355,7 @@ class DataSentryTracingIntegrationTests: XCTestCase {
         XCTAssertEqual(writtenData, sut)
     }
 
+    @available(*, deprecated, message: "This is deprecated because SentryOptions integrations is deprecated")
     func testWriteWithSentryTracing_throwsError_shouldTraceManuallyWithErrorRethrow() throws {
         // -- Arrange --
         let sut: Data = try fixture.getSut(testName: self.name)
@@ -370,6 +382,7 @@ class DataSentryTracingIntegrationTests: XCTestCase {
         XCTAssertGreaterThan(endTimestamp.timeIntervalSince1970, startTimestamp.timeIntervalSince1970)
     }
 
+    @available(*, deprecated, message: "This is deprecated because SentryOptions integrations is deprecated")
     func testWriteWithSentryTracing_nonFileUrl_shouldNotTraceManually() throws {
         // -- Arrange --
         let sut: Data = try fixture.getSut(testName: self.name)
@@ -382,6 +395,7 @@ class DataSentryTracingIntegrationTests: XCTestCase {
         XCTAssertEqual(parentTransaction.children.count, 0)
     }
 
+    @available(*, deprecated, message: "This is deprecated because SentryOptions integrations is deprecated")
     func testWriteWithSentryTracing_trackerIsNotEnabled_shouldNotTraceManually() throws {
         // -- Arrange --
         let sut: Data = try fixture.getSut(testName: self.name, isEnabled: false)
@@ -394,6 +408,7 @@ class DataSentryTracingIntegrationTests: XCTestCase {
         XCTAssertEqual(parentTransaction.children.count, 0)
     }
 
+    @available(*, deprecated, message: "This is deprecated because SentryOptions integrations is deprecated")
     func testWriteWithSentryTracing_fileIsIgnored_shouldNotTraceManually() throws {
         // -- Arrange --
         let sut: Data = try fixture.getSut(testName: self.name)
@@ -413,6 +428,7 @@ class DataSentryTracingIntegrationTests: XCTestCase {
         XCTAssertEqual(parentTransaction.children.count, 0)
     }
 
+    @available(*, deprecated, message: "This is deprecated because SentryOptions integrations is deprecated")
     func testWriteWithSentryTracing_SDKIsNotStarted_shouldWriteFile() throws {
         // -- Arrange --
         let sut: Data = try fixture.getSut(testName: self.name, isSDKEnabled: false)
@@ -431,6 +447,7 @@ class DataSentryTracingIntegrationTests: XCTestCase {
         XCTAssertEqual(writtenData, fixture.data)
     }
 
+    @available(*, deprecated, message: "This is deprecated because SentryOptions integrations is deprecated")
     func testWriteWithSentryTracing_SDKIsClosed_shouldWriteFile() throws {
         // -- Arrange --
         let sut: Data = try fixture.getSut(testName: self.name)