Adopt new timeline item debug info and overhaul the timeline item deb… (#781)

* Adopt new timeline item debug info and overhaul the timeline item debug menu

ElementX/Sources/Services/Timeline/TimelineController/MockRoomTimelineController.swift

@@ -65,8 +65,8 @@ class MockRoomTimelineController: RoomTimelineControllerProtocol {
     
     func redact(_ itemID: String) async { }
     
-    func debugDescription(for itemID: String) -> String {
-        "Mock debug description"
+    func debugInfo(for itemID: String) -> TimelineItemDebugInfo {
+        .init(model: "Mock debug description", originalJSON: nil, latestEditJSON: nil)
     }
     
     func retryDecryption(for sessionID: String) async { }

ElementX/Sources/Services/Timeline/TimelineController/RoomTimelineController.swift

@@ -181,21 +181,19 @@ class RoomTimelineController: RoomTimelineControllerProtocol {
     
     // Handle this parallel to the timeline items so we're not forced
     // to bundle the Rust side objects within them
-    func debugDescription(for itemID: String) -> String {
-        var description = "Unknown item"
-        timelineProvider.itemsPublisher.value.forEach { timelineItemProxy in
+    func debugInfo(for itemID: String) -> TimelineItemDebugInfo {
+        for timelineItemProxy in timelineProvider.itemsPublisher.value {
             switch timelineItemProxy {
             case .event(let item):
                 if item.id == itemID {
-                    description = item.debugDescription
-                    return
+                    return item.debugInfo
                 }
             default:
-                break
+                continue
             }
         }
         
-        return description
+        return .init(model: "Unknown item", originalJSON: nil, latestEditJSON: nil)
     }
     
     func retryDecryption(for sessionID: String) async {

ElementX/Sources/Services/Timeline/TimelineController/RoomTimelineControllerProtocol.swift

@@ -58,7 +58,7 @@ protocol RoomTimelineControllerProtocol {
 
     func redact(_ itemID: String) async
     
-    func debugDescription(for itemID: String) -> String
+    func debugInfo(for itemID: String) -> TimelineItemDebugInfo
     
     func retryDecryption(for sessionID: String) async
 }

ElementX/Sources/Services/Timeline/TimelineItemProxy.swift

@@ -42,7 +42,7 @@ enum TimelineItemDeliveryStatus: Hashable {
 }
 
 /// A light wrapper around event timeline items returned from Rust.
-struct EventTimelineItemProxy: CustomDebugStringConvertible {
+struct EventTimelineItemProxy {
     let item: MatrixRustSDK.EventTimelineItem
     
     init(item: MatrixRustSDK.EventTimelineItem) {
@@ -113,22 +113,9 @@ struct EventTimelineItemProxy: CustomDebugStringConvertible {
         Date(timeIntervalSince1970: TimeInterval(item.timestamp() / 1000))
     }
     
-    // MARK: - CustomDebugStringConvertible
-    
-    var debugDescription: String {
+    var debugInfo: TimelineItemDebugInfo {
         let debugInfo = item.debugInfo()
-        
-        var debugDescription = debugInfo.model
-        
-        if let originalJson = debugInfo.originalJson {
-            debugDescription += "\n\n\(originalJson)"
-        }
-        
-        if let latestEditJson = debugInfo.latestEditJson {
-            debugDescription += "\n\n\(latestEditJson)"
-        }
-        
-        return debugDescription
+        return TimelineItemDebugInfo(model: debugInfo.model, originalJSON: debugInfo.originalJson, latestEditJSON: debugInfo.latestEditJson)
     }
 }
 
@@ -142,3 +129,44 @@ extension TimelineItemContentKind {
         }
     }
 }
+
+struct TimelineItemDebugInfo: Identifiable, CustomStringConvertible {
+    let id = UUID()
+    let model: String
+    let originalJSON: String?
+    let latestEditJSON: String?
+    
+    init(model: String, originalJSON: String?, latestEditJSON: String?) {
+        self.model = model
+        
+        self.originalJSON = Self.prettyJsonFormattedString(from: originalJSON)
+        self.latestEditJSON = Self.prettyJsonFormattedString(from: latestEditJSON)
+    }
+    
+    var description: String {
+        var description = model
+        
+        if let originalJSON {
+            description += "\n\n\(originalJSON)"
+        }
+        
+        if let latestEditJSON {
+            description += "\n\n\(latestEditJSON)"
+        }
+        
+        return description
+    }
+    
+    // MARK: - Private
+    
+    private static func prettyJsonFormattedString(from string: String?) -> String? {
+        guard let string,
+              let data = string.data(using: .utf8),
+              let jsonDictionary = try? JSONSerialization.jsonObject(with: data, options: .mutableContainers),
+              let jsonData = try? JSONSerialization.data(withJSONObject: jsonDictionary, options: [.prettyPrinted]) else {
+            return nil
+        }
+        
+        return String(data: jsonData, encoding: .utf8)
+    }
+}