RUMM-1113 PR comments addressed

DataDog · Feb 25, 2021 · 01a6f60 · 01a6f60
1 parent 1dc279d
commit 01a6f60
Show file tree

Hide file tree

Showing 17 changed files with 46 additions and 47 deletions.
diff --git a/Sources/Datadog/Core/Utils/DDError.swift b/Sources/Datadog/Core/Utils/DDError.swift
@@ -8,25 +8,25 @@ import Foundation
 
 /// Common representation of Swift `Error` used by different features.
 internal struct DDError: Equatable {
-    let title: String
+    let type: String
     let message: String
-    let details: String
+    let stack: String
 
     init(error: Error) {
         if isNSErrorOrItsSubclass(error) {
             let nsError = error as NSError
-            self.title = "\(nsError.domain) - \(nsError.code)"
+            self.type = "\(nsError.domain) - \(nsError.code)"
             if nsError.userInfo[NSLocalizedDescriptionKey] != nil {
                 self.message = nsError.localizedDescription
             } else {
                 self.message = nsError.description
             }
-            self.details = "\(nsError)"
+            self.stack = "\(nsError)"
         } else {
             let swiftError = error
-            self.title = "\(type(of: swiftError))"
+            self.type = "\(Swift.type(of: swiftError))"
             self.message = "\(swiftError)"
-            self.details = "\(swiftError)"
+            self.stack = "\(swiftError)"
         }
     }
 }

diff --git a/Sources/Datadog/FeaturesIntegration/LoggingWithRUMIntegration.swift b/Sources/Datadog/FeaturesIntegration/LoggingWithRUMIntegration.swift
@@ -29,8 +29,8 @@ internal struct LoggingWithRUMErrorsIntegration {
     func addError(for log: Log) {
         rumErrorsIntegration.addError(
             with: log.error?.message ?? log.message,
-            type: log.error?.title,
-            stack: log.error?.details,
+            type: log.error?.type,
+            stack: log.error?.stack,
             source: .logger
         )
     }

diff --git a/Sources/Datadog/Logger.swift b/Sources/Datadog/Logger.swift
@@ -243,7 +243,7 @@ public class Logger {
         logOutput.writeLogWith(
             level: level,
             message: message,
-            error: error,
+            error: error.flatMap { DDError(error: $0) },
             date: date,
             attributes: LogAttributes(
                 userAttributes: combinedUserAttributes,

diff --git a/Sources/Datadog/Logging/Log/LogBuilder.swift b/Sources/Datadog/Logging/Log/LogBuilder.swift
@@ -25,12 +25,12 @@ internal struct LogBuilder {
     /// Adjusts log's time (device time) to server time.
     let dateCorrector: DateCorrectorType?
 
-    func createLogWith(level: LogLevel, message: String, error: Error?, date: Date, attributes: LogAttributes, tags: Set<String>) -> Log {
+    func createLogWith(level: LogLevel, message: String, error: DDError?, date: Date, attributes: LogAttributes, tags: Set<String>) -> Log {
         return Log(
             date: dateCorrector?.currentCorrection.applying(to: date) ?? date,
             status: logStatus(for: level),
             message: message,
-            error: error.flatMap { DDError(error: $0) },
+            error: error,
             serviceName: serviceName,
             environment: environment,
             loggerName: loggerName,

diff --git a/Sources/Datadog/Logging/Log/LogEncoder.swift b/Sources/Datadog/Logging/Log/LogEncoder.swift
@@ -107,9 +107,9 @@ internal struct LogEncoder {
 
         // Encode log.error properties
         if let someError = log.error {
-            try container.encode(someError.title, forKey: .errorKind)
+            try container.encode(someError.type, forKey: .errorKind)
             try container.encode(someError.message, forKey: .errorMessage)
-            try container.encode(someError.details, forKey: .errorStack)
+            try container.encode(someError.stack, forKey: .errorStack)
         }
 
         // Encode logger info

diff --git a/Sources/Datadog/Logging/LogOutputs/LogConsoleOutput.swift b/Sources/Datadog/Logging/LogOutputs/LogConsoleOutput.swift
@@ -37,7 +37,7 @@ internal struct LogConsoleOutput: LogOutput {
         self.printingFunction = printingFunction
     }
 
-    func writeLogWith(level: LogLevel, message: String, error: Error?, date: Date, attributes: LogAttributes, tags: Set<String>) {
+    func writeLogWith(level: LogLevel, message: String, error: DDError?, date: Date, attributes: LogAttributes, tags: Set<String>) {
         let log = logBuilder.createLogWith(level: level, message: message, error: error, date: date, attributes: attributes, tags: tags)
         printingFunction(formatter.format(log: log))
     }

diff --git a/Sources/Datadog/Logging/LogOutputs/LogFileOutput.swift b/Sources/Datadog/Logging/LogOutputs/LogFileOutput.swift
@@ -13,7 +13,7 @@ internal struct LogFileOutput: LogOutput {
     /// Integration with RUM Errors.
     let rumErrorsIntegration: LoggingWithRUMErrorsIntegration?
 
-    func writeLogWith(level: LogLevel, message: String, error: Error?, date: Date, attributes: LogAttributes, tags: Set<String>) {
+    func writeLogWith(level: LogLevel, message: String, error: DDError?, date: Date, attributes: LogAttributes, tags: Set<String>) {
         let log = logBuilder.createLogWith(level: level, message: message, error: error, date: date, attributes: attributes, tags: tags)
         fileWriter.write(value: log)
 

diff --git a/Sources/Datadog/Logging/LogOutputs/LogOutput.swift b/Sources/Datadog/Logging/LogOutputs/LogOutput.swift
@@ -15,5 +15,5 @@ internal struct LogAttributes {
 
 /// Type writting logs to some destination.
 internal protocol LogOutput {
-    func writeLogWith(level: LogLevel, message: String, error: Error?, date: Date, attributes: LogAttributes, tags: Set<String>)
+    func writeLogWith(level: LogLevel, message: String, error: DDError?, date: Date, attributes: LogAttributes, tags: Set<String>)
 }
diff --git a/Sources/Datadog/Logging/LogOutputs/LogUtilityOutputs.swift b/Sources/Datadog/Logging/LogOutputs/LogUtilityOutputs.swift
@@ -8,7 +8,7 @@ import Foundation
 
 /// `LogOutput` which does nothing.
 internal struct NoOpLogOutput: LogOutput {
-    func writeLogWith(level: LogLevel, message: String, error: Error?, date: Date, attributes: LogAttributes, tags: Set<String>) {}
+    func writeLogWith(level: LogLevel, message: String, error: DDError?, date: Date, attributes: LogAttributes, tags: Set<String>) {}
 }
 
 /// Combines one or more `LogOutputs` into one.
@@ -19,7 +19,7 @@ internal struct CombinedLogOutput: LogOutput {
         self.combinedOutputs = outputs
     }
 
-    func writeLogWith(level: LogLevel, message: String, error: Error?, date: Date, attributes: LogAttributes, tags: Set<String>) {
+    func writeLogWith(level: LogLevel, message: String, error: DDError?, date: Date, attributes: LogAttributes, tags: Set<String>) {
         combinedOutputs.forEach { $0.writeLogWith(level: level, message: message, error: error, date: date, attributes: attributes, tags: tags) }
     }
 }
@@ -28,7 +28,7 @@ internal struct ConditionalLogOutput: LogOutput {
     let conditionedOutput: LogOutput
     let condition: (LogLevel) -> Bool
 
-    func writeLogWith(level: LogLevel, message: String, error: Error?, date: Date, attributes: LogAttributes, tags: Set<String>) {
+    func writeLogWith(level: LogLevel, message: String, error: DDError?, date: Date, attributes: LogAttributes, tags: Set<String>) {
         if condition(level) {
             conditionedOutput.writeLogWith(level: level, message: message, error: error, date: date, attributes: attributes, tags: tags)
         }

diff --git a/Sources/Datadog/OpenTracing/OTSpan.swift b/Sources/Datadog/OpenTracing/OTSpan.swift
@@ -98,9 +98,9 @@ public extension OTSpan {
     ) {
         let dderror = DDError(error: error)
         setError(
-            kind: dderror.title,
+            kind: dderror.type,
             message: dderror.message,
-            stack: dderror.details,
+            stack: dderror.stack,
             file: file,
             line: line
         )

diff --git a/Sources/Datadog/RUM/RUMMonitor/RUMCommand.swift b/Sources/Datadog/RUM/RUMMonitor/RUMCommand.swift
@@ -98,8 +98,8 @@ internal struct RUMAddCurrentViewErrorCommand: RUMCommand {
 
         let dderror = DDError(error: error)
         self.message = dderror.message
-        self.type = dderror.title
-        self.stack = dderror.details
+        self.type = dderror.type
+        self.stack = dderror.stack
     }
 }
 
@@ -217,9 +217,9 @@ internal struct RUMStopResourceWithErrorCommand: RUMResourceCommand {
 
         let dderror = DDError(error: error)
         self.errorMessage = dderror.message
-        self.errorType = dderror.title
+        self.errorType = dderror.type
         // The stack will give the networking error (`NSError`) description in most cases:
-        self.stack = dderror.details
+        self.stack = dderror.stack
     }
 }
 

diff --git a/Tests/DatadogTests/Datadog/Core/Utils/DDErrorTests.swift b/Tests/DatadogTests/Datadog/Core/Utils/DDErrorTests.swift
@@ -16,9 +16,9 @@ class DDErrorTests: XCTestCase {
         let error = SwiftError()
         let dderror = DDError(error: error)
 
-        XCTAssertEqual(dderror.title, "SwiftError")
+        XCTAssertEqual(dderror.type, "SwiftError")
         XCTAssertEqual(dderror.message, #"SwiftError(description: "error description")"#)
-        XCTAssertEqual(dderror.details, #"SwiftError(description: "error description")"#)
+        XCTAssertEqual(dderror.stack, #"SwiftError(description: "error description")"#)
     }
 
     func testFormattingStringConvertibleSwiftError() {
@@ -29,9 +29,9 @@ class DDErrorTests: XCTestCase {
         let error = SwiftError()
         let dderror = DDError(error: error)
 
-        XCTAssertEqual(dderror.title, "SwiftError")
+        XCTAssertEqual(dderror.type, "SwiftError")
         XCTAssertEqual(dderror.message, "error description")
-        XCTAssertEqual(dderror.details, "error description")
+        XCTAssertEqual(dderror.stack, "error description")
     }
 
     func testFormattingNSError() {
@@ -44,10 +44,10 @@ class DDErrorTests: XCTestCase {
         )
         let dderror = DDError(error: error)
 
-        XCTAssertEqual(dderror.title, "custom-domain - 10")
+        XCTAssertEqual(dderror.type, "custom-domain - 10")
         XCTAssertEqual(dderror.message, "error description")
         XCTAssertEqual(
-            dderror.details,
+            dderror.stack,
             """
             Error Domain=custom-domain Code=10 "error description" UserInfo={NSLocalizedDescription=error description}
             """
@@ -65,10 +65,10 @@ class DDErrorTests: XCTestCase {
             )
         )
 
-        XCTAssertEqual(dderrorWithDescription.title, "custom-domain - 10")
+        XCTAssertEqual(dderrorWithDescription.type, "custom-domain - 10")
         XCTAssertEqual(dderrorWithDescription.message, "localized description")
         XCTAssertEqual(
-            dderrorWithDescription.details,
+            dderrorWithDescription.stack,
             """
             Error Domain=custom-domain Code=10 "localized description" UserInfo={NSLocalizedDescription=localized description}
             """
@@ -82,13 +82,13 @@ class DDErrorTests: XCTestCase {
             )
         )
 
-        XCTAssertEqual(dderrorNoDescription.title, "custom-domain - 10")
+        XCTAssertEqual(dderrorNoDescription.type, "custom-domain - 10")
         XCTAssertEqual(
             dderrorNoDescription.message,
             #"Error Domain=custom-domain Code=10 "(null)""#
         )
         XCTAssertEqual(
-            dderrorNoDescription.details,
+            dderrorNoDescription.stack,
             #"Error Domain=custom-domain Code=10 "(null)""#
         )
     }

diff --git a/Tests/DatadogTests/Datadog/Logging/Log/LogBuilderTests.swift b/Tests/DatadogTests/Datadog/Logging/Log/LogBuilderTests.swift
@@ -14,7 +14,7 @@ class LogBuilderTests: XCTestCase {
             serviceName: "test-service-name",
             loggerName: "test-logger-name"
         )
-        let error = ErrorMock("description")
+        let error = DDError(error: ErrorMock("description"))
         let log = builder.createLogWith(
             level: .debug,
             message: "debug message",
@@ -28,7 +28,7 @@ class LogBuilderTests: XCTestCase {
         XCTAssertEqual(log.applicationVersion, "1.2.3")
         XCTAssertEqual(log.status, .debug)
         XCTAssertEqual(log.message, "debug message")
-        XCTAssertEqual(log.error, DDError(error: error))
+        XCTAssertEqual(log.error, error)
         XCTAssertEqual(log.serviceName, "test-service-name")
         XCTAssertEqual(log.loggerName, "test-logger-name")
         XCTAssertEqual(log.tags, ["tag"])

diff --git a/Tests/DatadogTests/Datadog/Logging/LogOutputs/LogConsoleOutputTests.swift b/Tests/DatadogTests/Datadog/Logging/LogOutputs/LogConsoleOutputTests.swift
@@ -9,7 +9,7 @@ import XCTest
 
 // swiftlint:disable multiline_arguments_brackets trailing_closure
 class LogConsoleOutputTests: XCTestCase {
-    private let error = ErrorMock("description")
+    private let error = DDError(error: ErrorMock("description"))
 
     func testItPrintsLogsUsingShortFormat() {
         var messagePrinted: String = ""

diff --git a/Tests/DatadogTests/Datadog/Logging/LogOutputs/LogUtilityOutputsTests.swift b/Tests/DatadogTests/Datadog/Logging/LogOutputs/LogUtilityOutputsTests.swift
@@ -13,14 +13,13 @@ class CombinedLogOutputTests: XCTestCase {
         let output2 = LogOutputMock()
         let output3 = LogOutputMock()
 
-        let error = ErrorMock("desc")
-        let ddError = DDError(error: error)
+        let error = DDError(error: ErrorMock("desc"))
         let combinedOutput = CombinedLogOutput(combine: [output1, output2, output3])
         combinedOutput.writeLogWith(level: .info, message: "info message", error: error, date: .mockDecember15th2019At10AMUTC(), attributes: .mockAny(), tags: [])
 
-        XCTAssertEqual(output1.recordedLog, .init(level: .info, message: "info message", error: ddError, date: .mockDecember15th2019At10AMUTC()))
-        XCTAssertEqual(output2.recordedLog, .init(level: .info, message: "info message", error: ddError, date: .mockDecember15th2019At10AMUTC()))
-        XCTAssertEqual(output3.recordedLog, .init(level: .info, message: "info message", error: ddError, date: .mockDecember15th2019At10AMUTC()))
+        XCTAssertEqual(output1.recordedLog, .init(level: .info, message: "info message", error: error, date: .mockDecember15th2019At10AMUTC()))
+        XCTAssertEqual(output2.recordedLog, .init(level: .info, message: "info message", error: error, date: .mockDecember15th2019At10AMUTC()))
+        XCTAssertEqual(output3.recordedLog, .init(level: .info, message: "info message", error: error, date: .mockDecember15th2019At10AMUTC()))
     }
 
     func testConditionalLogOutput_writesLogToCombinedOutputOnlyIfConditionIsMet() {

diff --git a/Tests/DatadogTests/Datadog/Mocks/LoggingFeatureMocks.swift b/Tests/DatadogTests/Datadog/Mocks/LoggingFeatureMocks.swift
@@ -199,11 +199,11 @@ class LogOutputMock: LogOutput {
 
     var recordedLog: RecordedLog? = nil
 
-    func writeLogWith(level: LogLevel, message: String, error: Error?, date: Date, attributes: LogAttributes, tags: Set<String>) {
+    func writeLogWith(level: LogLevel, message: String, error: DDError?, date: Date, attributes: LogAttributes, tags: Set<String>) {
         recordedLog = RecordedLog(
             level: level,
             message: message,
-            error: error.flatMap { DDError(error: $0) },
+            error: error,
             date: date,
             attributes: attributes,
             tags: tags

diff --git a/...gTests/Datadog/RUM/AutoInstrumentation/Resources/URLSessionRUMResourcesHandlerTests.swift b/...gTests/Datadog/RUM/AutoInstrumentation/Resources/URLSessionRUMResourcesHandlerTests.swift
@@ -168,10 +168,10 @@ class URLSessionRUMResourcesHandlerTests: XCTestCase {
         XCTAssertEqual(resourceStopCommand.resourceKey, taskInterception.identifier.uuidString)
         XCTAssertEqual(resourceStopCommand.time, .mockDecember15th2019At10AMUTC())
         XCTAssertEqual(resourceStopCommand.attributes.count, 0)
-        XCTAssertEqual(resourceStopCommand.errorType, DDError(error: taskError).title)
+        XCTAssertEqual(resourceStopCommand.errorType, DDError(error: taskError).type)
         XCTAssertEqual(resourceStopCommand.errorMessage, DDError(error: taskError).message)
         XCTAssertEqual(resourceStopCommand.errorSource, .network)
-        XCTAssertEqual(resourceStopCommand.stack, DDError(error: taskError).details)
+        XCTAssertEqual(resourceStopCommand.stack, DDError(error: taskError).stack)
         XCTAssertNil(resourceStopCommand.httpStatusCode)
     }
 }