fix: Datadog integration leads to build failures - WPB-11936

WireAnalytics/Package.swift

@@ -3,6 +3,9 @@
 import Foundation
 import PackageDescription
 
+// You can enable/disable Datadog for debugging by overriding the boolean.
+let datadogEnabled = hasEnvironmentVariable("ENABLE_DATADOG", "true")
+
 let package = Package(
     name: "WireAnalytics",
     platforms: [.iOS(.v16), .macOS(.v12)],
@@ -19,20 +22,16 @@ let package = Package(
     targets: [
         .target(
             name: "WireAnalytics",
-            dependencies: resolveWireAnalyticsDependencies() + [
+            dependencies: [
                 .product(name: "Countly", package: "countly-sdk-ios")
             ],
             swiftSettings: swiftSettings
         ),
         .target(
             name: "WireDatadog",
-            dependencies: [
-                .product(name: "DatadogCore", package: "dd-sdk-ios"),
-                .product(name: "DatadogCrashReporting", package: "dd-sdk-ios"),
-                .product(name: "DatadogLogs", package: "dd-sdk-ios"),
-                .product(name: "DatadogRUM", package: "dd-sdk-ios"),
-                .product(name: "DatadogTrace", package: "dd-sdk-ios")
-            ],
+            dependencies: datadogDependencies(),
+            path: "Sources/WireDatadog",
+            sources: datadogFiles(),
             swiftSettings: swiftSettings
         ),
         .target(
@@ -49,12 +48,25 @@ let package = Package(
     ]
 )
 
-func resolveWireAnalyticsDependencies() -> [Target.Dependency] {
-    // You can enable/disable Datadog for debugging by overriding the boolean.
-    if hasEnvironmentVariable("ENABLE_DATADOG", "true") {
-        ["WireDatadog"]
+func datadogDependencies() -> [Target.Dependency] {
+    guard datadogEnabled else {
+        // note: in this case SPM will warn that the dd-sdk-ios is not used
+        return []
+    }
+    return [
+        .product(name: "DatadogCore", package: "dd-sdk-ios"),
+        .product(name: "DatadogCrashReporting", package: "dd-sdk-ios"),
+        .product(name: "DatadogLogs", package: "dd-sdk-ios"),
+        .product(name: "DatadogRUM", package: "dd-sdk-ios"),
+        .product(name: "DatadogTrace", package: "dd-sdk-ios")
+    ]
+}
+
+func datadogFiles() -> [String] {
+    if datadogEnabled {
+        ["WireDatadog.swift", "LogLevel.swift"]
     } else {
-        []
+        ["WireFakeDatadog.swift", "LogLevel.swift"]
     }
 }
 

WireAnalytics/Sources/WireAnalytics/Datadog/WireDatadogProtocol.swift → WireAnalytics/Sources/WireDatadog/LogLevel.swift

@@ -16,10 +16,13 @@
 // along with this program. If not, see http://www.gnu.org/licenses/.
 //
 
-public protocol WireDatadogProtocol {
-
-    /// Unique obfuscated identifier of the current device across app and extensions.
-    var userIdentifier: String { get }
-
-    func enable()
+public extension WireDatadog {
+    enum LogLevel: String, Codable {
+        case debug
+        case info
+        case notice
+        case warn
+        case error
+        case critical
+    }
 }

WireAnalytics/Sources/WireDatadog/WireDatadog.swift

@@ -29,10 +29,10 @@ public final class WireDatadog {
     private let applicationID: String
     private let buildVersion: String
     private let buildNumber: String
-    private let logLevel: LogLevel = .debug
+    private let logLevel: WireDatadog.LogLevel = .debug
 
     public private(set) var userIdentifier: String
-    public private(set) var logger: (any DatadogLogs.LoggerProtocol)?
+    private(set) var logger: (any DatadogLogs.LoggerProtocol)?
 
     public init(
         applicationID: String,
@@ -72,7 +72,7 @@ public final class WireDatadog {
         let loggerConfiguration = Logger.Configuration(
             name: "iOS Wire App",
             networkInfoEnabled: true,
-            remoteLogThreshold: logLevel
+            remoteLogThreshold: logLevel.datadogLevel
         )
         logger = Logger.create(with: loggerConfiguration)
     }
@@ -96,15 +96,15 @@ public final class WireDatadog {
         Datadog.setUserInfo(id: userIdentifier)
 
         logger?.log(
-            level: logLevel,
+            level: logLevel.datadogLevel,
             message: "Datadog startMonitoring for device: \(userIdentifier)",
             error: nil,
             attributes: nil
         )
     }
 
     public func log(
-        level: LogLevel,
+        level: WireDatadog.LogLevel,
         message: String,
         error: (any Error)? = nil,
         attributes: [String: any Encodable]
@@ -114,13 +114,21 @@ public final class WireDatadog {
         finalAttributes["version"] = buildVersion
 
         logger?.log(
-            level: level,
+            level: level.datadogLevel, // TODO: [WPB-11881] review this when WireLogger is available as package
             message: message,
             error: error,
             attributes: finalAttributes
         )
     }
 
+    public func addAttribute(forKey key: String, value: String) {
+        logger?.addTag(withKey: key, value: value)
+    }
+
+    public func removeAttribute(forKey key: String) {
+        logger?.removeAttribute(forKey: key)
+    }
+
     // MARK: Static Helpers
 
     private static func hashedDatadogUserIdentifier(_ uuid: UUID) -> String {
@@ -139,3 +147,22 @@ public final class WireDatadog {
         )
     }
 }
+
+extension WireDatadog.LogLevel {
+    var datadogLevel: LogLevel {
+        switch self {
+        case .debug:
+            .debug
+        case .info:
+            .info
+        case .notice:
+            .notice
+        case .warn:
+            .warn
+        case .error:
+            .error
+        case .critical:
+            .critical
+        }
+    }
+}

WireAnalytics/Sources/WireDatadog/WireFakeDatadog.swift

@@ -0,0 +1,58 @@
+//
+// Wire
+// Copyright (C) 2024 Wire Swiss GmbH
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see http://www.gnu.org/licenses/.
+//
+
+import UIKit
+
+public final class WireDatadog {
+
+    public var userIdentifier: String {
+        ""
+    }
+
+    public init(
+        applicationID: String,
+        buildVersion: String,
+        buildNumber: String,
+        clientToken: String,
+        identifierForVendor: UUID?,
+        environmentName: String
+    ) {
+        // do nothing
+    }
+
+    public func enable() {
+        // do nothing
+    }
+
+    public func log(
+        level: WireDatadog.LogLevel,
+        message: String,
+        error: (any Error)? = nil,
+        attributes: [String: any Encodable]
+    ) {
+        // do nothing
+    }
+
+    public func addAttribute(forKey key: String, value: String) {
+        // do nothing
+    }
+
+    public func removeAttribute(forKey key: String) {
+        // do nothing
+    }
+}

wire-ios-sync-engine/Source/Use cases/SubmitCallQualitySurveyUseCase.swift

@@ -18,7 +18,6 @@
 
 import WireAnalytics
 
-/// sourcery: AutoMockable
 public protocol SubmitCallQualitySurveyUseCaseProtocol {
 
     func invoke(_ review: CallQualitySurveyReview)

wire-ios-sync-engine/Tests/TestsPlans/AllTests.xctestplan

@@ -9,6 +9,7 @@
     }
   ],
   "defaultOptions" : {
+    "codeCoverage" : false,
     "commandLineArgumentEntries" : [
       {
         "argument" : "-XCTestObserverClass InfiniteLoopAfterRunningTests",

wire-ios-sync-engine/Tests/TestsPlans/SecurityTests.xctestplan

@@ -9,6 +9,7 @@
     }
   ],
   "defaultOptions" : {
+    "codeCoverage" : false,
     "commandLineArgumentEntries" : [
       {
         "argument" : "-com.apple.CoreData.ConcurrencyDebug 1",
@@ -18,18 +19,6 @@
     "testTimeoutsEnabled" : true
   },
   "testTargets" : [
-    {
-      "selectedTests" : [
-        "SessionManagerTests_EncryptionAtRestIsEnabledByDefault_Option\/testThatEncryptionAtRestIsEnabled_OnActiveUserSession()",
-        "SessionManagerTests_EncryptionAtRestMigration\/testThatDatabaseIsMigrated_WhenEncryptionAtRestIsDisabled()",
-        "SessionManagerTests_EncryptionAtRestMigration\/testThatDatabaseIsMigrated_WhenEncryptionAtRestIsEnabled()"
-      ],
-      "target" : {
-        "containerPath" : "container:WireSyncEngine.xcodeproj",
-        "identifier" : "169BA1D125ECDBA300374343",
-        "name" : "IntegrationTests"
-      }
-    },
     {
       "selectedTests" : [
         "ZMUserSessionTests_EncryptionAtRest\/testThatDatabaseIsLocked_AfterEnteringBackground()",