Use new TelemetryDeck error logging

cocoatype · Aug 3, 2024 · c1846ca · c1846ca
1 parent 79640d6
commit c1846ca
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 9 deletions.
diff --git a/Modules/Capabilities/ErrorHandling/Sources/ErrorHandler.swift b/Modules/Capabilities/ErrorHandling/Sources/ErrorHandler.swift
@@ -27,15 +27,18 @@ public struct ErrorHandler: ErrorHandling {
     }
 
     public func log(_ error: Error) {
-        let errorDescription: String
+        let errorID: String
         if type(of: error) is NSError.Type {
             let nsError = error as NSError
-            errorDescription = "\(nsError.domain) - \(nsError.code): \(nsError.localizedDescription)"
+            errorID = "\(nsError.domain) - \(nsError.code)"
         } else {
-            errorDescription = String(describing: error)
+            errorID = String(describing: error)
         }
 
-        logger.log(Event(name: Self.logError, info: ["errorDescription": errorDescription]))
+        logger.log(Event(name: Self.logError, info: [
+            Self.telemetryErrorIDKey: errorID,
+            Self.errorDescriptionKey: error.localizedDescription
+        ]))
     }
 
     public func crash(_ message: String) -> Never {
@@ -50,9 +53,14 @@ public struct ErrorHandler: ErrorHandling {
 
     // MARK: Event Names
 
-    private static let logError = Event.Name("logError")
+    private static let logError = Event.Name("TelemetryDeck.Error.occurred")
     private static let crash = Event.Name("crash")
     private static let notImplemented = Event.Name("notImplemented")
+
+    // MARK: Event Keys
+
+    private static let errorDescriptionKey = "errorDescription"
+    private static let telemetryErrorIDKey = "TelemetryDeck.Error.id"
 }
 
 @objc(ErrorHandling)

diff --git a/Modules/Capabilities/ErrorHandling/Tests/ErrorHandlerTests.swift b/Modules/Capabilities/ErrorHandling/Tests/ErrorHandlerTests.swift
@@ -15,8 +15,8 @@ final class ErrorHandlerTests: XCTestCase {
         handler.log(SampleError.sample)
         let event = try XCTUnwrap(logger.loggedEvents.first)
 
-        XCTAssertEqual(event.value, "logError")
-        XCTAssertEqual(event.info, ["errorDescription": "sample"])
+        XCTAssertEqual(event.value, "TelemetryDeck.Error.occurred")
+        XCTAssertEqual(event.info["TelemetryDeck.Error.id"], "sample")
     }
 
     func testLoggingNSErrorLogsInformation() throws {
@@ -27,8 +27,11 @@ final class ErrorHandlerTests: XCTestCase {
         handler.log(error)
         let event = try XCTUnwrap(logger.loggedEvents.first)
 
-        XCTAssertEqual(event.value, "logError")
-        XCTAssertEqual(event.info, ["errorDescription": "sample - 19: The operation couldn’t be completed. (sample error 19.)"])
+        XCTAssertEqual(event.value, "TelemetryDeck.Error.occurred")
+        XCTAssertEqual(event.info, [
+            "TelemetryDeck.Error.id": "sample - 19",
+            "errorDescription": "The operation couldn’t be completed. (sample error 19.)"
+        ])
     }
 
     func testCrashingLogsMessage() throws {