chore: Add log when a Swift Integration is loaded (#6976)

* chore: Add log when a Swift Integration is loaded

* Remove unnecessary test

* Move log message to `SentryHub`

* Update test

Author: itaybre

Sentry.xcodeproj/project.pbxproj

@@ -998,6 +998,7 @@
 		F48F767C2E60B555009D4E7D /* SentryNSTimerFactory.swift in Sources */ = {isa = PBXBuildFile; fileRef = F48F767B2E60B555009D4E7D /* SentryNSTimerFactory.swift */; };
 		F48F78692E61DE28009D4E7D /* SentryReachability.swift in Sources */ = {isa = PBXBuildFile; fileRef = F48F78682E61DE28009D4E7D /* SentryReachability.swift */; };
 		F49236EB2E5E4B2F00663673 /* SentryBinaryImageCache.swift in Sources */ = {isa = PBXBuildFile; fileRef = F49236EA2E5E4B2F00663673 /* SentryBinaryImageCache.swift */; };
+		F498EBA62EE0B8E400F57509 /* SentrySwiftIntegrationInstallerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = F498EBA52EE0B8E400F57509 /* SentrySwiftIntegrationInstallerTests.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 */; };
@@ -2376,6 +2377,7 @@
 		F48F767B2E60B555009D4E7D /* SentryNSTimerFactory.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryNSTimerFactory.swift; sourceTree = "<group>"; };
 		F48F78682E61DE28009D4E7D /* SentryReachability.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryReachability.swift; sourceTree = "<group>"; };
 		F49236EA2E5E4B2F00663673 /* SentryBinaryImageCache.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryBinaryImageCache.swift; sourceTree = "<group>"; };
+		F498EBA52EE0B8E400F57509 /* SentrySwiftIntegrationInstallerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentrySwiftIntegrationInstallerTests.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>"; };
@@ -3506,6 +3508,7 @@
 		7B944FA924697E9700A10721 /* Integrations */ = {
 			isa = PBXGroup;
 			children = (
+				F498EBA52EE0B8E400F57509 /* SentrySwiftIntegrationInstallerTests.swift */,
 				843FB3422D156B9900558F18 /* Feedback */,
 				7BF6505D292B77D100BBA5A8 /* MetricKit */,
 				D808FB85281AB2EF009A2A33 /* UIEvents */,
@@ -6372,6 +6375,7 @@
 				623E16C32D6C57C000CF1625 /* SentryANRTypeTests.swift in Sources */,
 				D80694C42B7CC9AE00B820E6 /* SentryReplayEventTests.swift in Sources */,
 				7B34721728086A9D0041F047 /* SentrySwizzleWrapperTests.swift in Sources */,
+				F498EBA62EE0B8E400F57509 /* SentrySwiftIntegrationInstallerTests.swift in Sources */,
 				8EC4CF5025C3A0070093DEE9 /* SentrySpanContextTests.swift in Sources */,
 				6281C5742D3E50DF009D0978 /* ArbitraryDataTests.swift in Sources */,
 				FAD882762EDA6EF50055AA44 /* SentrySDKInfo+Equality.swift in Sources */,

Sources/Sentry/SentryHub.m

@@ -657,6 +657,7 @@ - (void)addInstalledIntegration:(id<SentryIntegrationProtocol>)integration name:
         [_installedIntegrations addObject:integration];
         [_installedIntegrationNames addObject:name];
     }
+    SENTRY_LOG_DEBUG(@"Integration installed: %@", name);
 }
 
 - (void)removeAllIntegrations

Sources/Sentry/SentrySDKInternal.m

@@ -561,7 +561,6 @@ + (void)installIntegrations
         id<SentryObjCIntegrationProtocol> integrationInstance = [[integrationClass alloc] init];
         BOOL shouldInstall = [integrationInstance installWithOptions:options];
         if (shouldInstall) {
-            SENTRY_LOG_DEBUG(@"Integration installed: %@", NSStringFromClass(integrationClass));
             [SentrySDKInternal.currentHub
                 addInstalledIntegration:integrationInstance
                                    name:NSStringFromClass(integrationClass)];

Tests/SentryTests/Integrations/SentrySwiftIntegrationInstallerTests.swift

@@ -0,0 +1,50 @@
+@_spi(Private) @testable import Sentry
+@_spi(Private) import SentryTestUtils
+import XCTest
+
+final class SentrySwiftIntegrationInstallerTests: XCTestCase {
+
+    override func tearDown() {
+        SentrySDKInternal.setCurrentHub(nil)
+
+        super.tearDown()
+    }
+    
+    // We are not testing `SwiftAsyncIntegration`, but use it as an example for an installed integration
+    func testInstall_AddsInstalledIntegrations() {
+        // Arrange
+        let options = Options()
+        options.dsn = TestConstants.dsnAsString(username: "SentrySwiftIntegrationInstallerTests")
+        options.debug = true
+        options.swiftAsyncStacktraces = true
+        
+        let testHub = TestHub(client: nil, andScope: nil)
+        SentrySDKInternal.setCurrentHub(testHub)
+
+        // Act
+        SentrySwiftIntegrationInstaller.install(with: options)
+
+        // Assert
+        XCTAssertEqual(testHub.installedIntegrationNames().count, 1)
+        XCTAssertEqual(try XCTUnwrap(testHub.installedIntegrationNames().first), "SentrySwiftAsyncIntegration")
+        XCTAssertEqual(testHub.installedIntegrations().count, 1)
+    }
+
+    func testInstall_WithDisabledIntegration_DoesNotAddIntegration() {
+        // Arrange
+        let options = Options()
+        options.dsn = TestConstants.dsnAsString(username: "SentrySwiftIntegrationInstallerTests")
+        options.debug = true
+        options.swiftAsyncStacktraces = false
+        
+        let testHub = TestHub(client: nil, andScope: nil)
+        SentrySDKInternal.setCurrentHub(testHub)
+
+        // Act
+        SentrySwiftIntegrationInstaller.install(with: options)
+
+        // Assert
+        XCTAssertEqual(testHub.installedIntegrationNames().count, 0)
+        XCTAssertEqual(testHub.installedIntegrations().count, 0)
+    }
+}

Tests/SentryTests/SentryHubTests.swift

@@ -1324,6 +1324,25 @@ class SentryHubTests: XCTestCase {
         })
     }
 
+    func testAddIntegration() {
+        let oldOutput = SentrySDKLog.getLogOutput()
+        defer {
+            SentrySDKLog.setOutput(oldOutput)
+        }
+        let logOutput = TestLogOutput()
+        SentrySDKLog.setLogOutput(logOutput)
+        SentrySDKLog.configureLog(true, diagnosticLevel: .debug)
+        
+        let sut = fixture.getSut()
+
+        sut.addInstalledIntegration(EmptyIntegration(), name: "MyIntegrationName")
+        
+        let logs = logOutput.loggedMessages.joined()
+        XCTAssertTrue(logs.contains("Integration installed: MyIntegrationName"), "Should log when MyIntegrationName is installed")
+        XCTAssertTrue(sut.hasIntegration("MyIntegrationName"))
+        XCTAssertNotNil(sut.getInstalledIntegration(EmptyIntegration.self))
+    }
+    
     func testModifyIntegrationsConcurrently() {
 
         let sut = fixture.getSut()